swap: exchange chain id on handshake

swap/protocol.go

@@ -34,6 +34,9 @@ var (
 	// ErrEmptyAddressInSignature is used when the empty address is used for the chequebook in the handshake
 	ErrEmptyAddressInSignature = errors.New("empty address in handshake")
 
+	// ErrDifferentChainId is used when the chain id exchanged during the handshake does not match
+	ErrDifferentChainId = errors.New("different chain id")
+
 	// ErrInvalidHandshakeMsg is used when the message received during handshake does not conform to the
 	// structure of the HandshakeMsg
 	ErrInvalidHandshakeMsg = errors.New("invalid handshake message")
@@ -98,6 +101,10 @@ func (s *Swap) verifyHandshake(msg interface{}) error {
 		return ErrEmptyAddressInSignature
 	}
 
+	if handshake.ChainID != s.chainID {
+		return ErrDifferentChainId
+	}
+
 	return s.chequebookFactory.VerifyContract(handshake.ContractAddress)
 }
 
@@ -107,6 +114,7 @@ func (s *Swap) run(p *p2p.Peer, rw p2p.MsgReadWriter) error {
 
 	handshake, err := protoPeer.Handshake(context.Background(), &HandshakeMsg{
 		ContractAddress: s.GetParams().ContractAddress,
+		ChainID:         s.chainID,
 	}, s.verifyHandshake)
 	if err != nil {
 		return err

swap/protocol_test.go

@@ -18,6 +18,7 @@ package swap
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"io/ioutil"
 	"os"
@@ -44,68 +45,174 @@ func init() {
 	log.Root().SetHandler(log.LvlFilterHandler(log.Lvl(*loglevel), log.StreamHandler(colorable.NewColorableStderr(), log.TerminalFormat(true))))
 }
 
-/*
-TestHandshake creates two mock nodes and initiates an exchange;
-it expects a handshake to take place between the two nodes
-(the handshake would fail because we don't actually use real nodes here)
-*/
-func TestHandshake(t *testing.T) {
-	var err error
+// protocol tester based on a swap instance
+type swapTester struct {
+	*p2ptest.ProtocolTester
+	swap *Swap
+}
 
-	// setup test swap object
+// creates a new protocol tester for swap with a deployed chequebook
+func newSwapTester(t *testing.T) (*swapTester, func(), error) {
 	swap, clean := newTestSwap(t, ownerKey, nil)
-	defer clean()
 
-	ctx := context.Background()
-	err = testDeploy(ctx, swap)
+	err := testDeploy(context.Background(), swap)
 	if err != nil {
-		t.Fatal(err)
+		return nil, nil, err
 	}
+
 	// setup the protocolTester, which will allow protocol testing by sending messages
-	protocolTester := p2ptest.NewProtocolTester(swap.owner.privateKey, 2, swap.run)
+	protocolTester := p2ptest.NewProtocolTester(swap.owner.privateKey, 1, swap.run)
+	return &swapTester{
+		ProtocolTester: protocolTester,
+		swap:           swap,
+	}, clean, nil
+}
+
+// creates a test exchange for the handshakes
+func HandshakeMsgExchange(lhs, rhs *HandshakeMsg, id enode.ID) []p2ptest.Exchange {
+	return []p2ptest.Exchange{
+		{
+			Expects: []p2ptest.Expect{
+				{
+					Code: 0,
+					Msg:  lhs,
+					Peer: id,
+				},
+			},
+		},
+		{
+			Triggers: []p2ptest.Trigger{
+				{
+					Code: 0,
+					Msg:  rhs,
+					Peer: id,
+				},
+			},
+		},
+	}
+}
 
-	// shortcut to creditor node
-	debitor := protocolTester.Nodes[0]
-	creditor := protocolTester.Nodes[1]
+// helper function for testing the handshake
+// lhs is the HandshakeMsg we expect to be sent, rhs the one we receive
+// disconnects is a list of disconnect events to be expected
+func (s *swapTester) testHandshake(lhs, rhs *HandshakeMsg, disconnects ...*p2ptest.Disconnect) error {
+	if err := s.TestExchanges(HandshakeMsgExchange(lhs, rhs, s.Nodes[0].ID())...); err != nil {
+		return err
+	}
 
-	// set balance artifially
-	swap.saveBalance(creditor.ID(), -42)
+	if len(disconnects) > 0 {
+		return s.TestDisconnected(disconnects...)
+	}
 
-	// create the expected cheque to be received
-	cheque := newTestCheque()
+	// If we don't expect disconnect, ensure peers remain connected
+	err := s.TestDisconnected(&p2ptest.Disconnect{
+		Peer:  s.Nodes[0].ID(),
+		Error: nil,
+	})
 
-	// sign the cheque
-	cheque.Signature, err = cheque.Sign(swap.owner.privateKey)
+	if err == nil {
+		return fmt.Errorf("Unexpected peer disconnect")
+	}
+
+	if err.Error() != "timed out waiting for peers to disconnect" {
+		return err
+	}
+
+	return nil
+}
+
+// creates a new HandshakeMsg
+func newSwapHandshakeMsg(contractAddress common.Address, chainID uint64) *HandshakeMsg {
+	return &HandshakeMsg{
+		ContractAddress: contractAddress,
+		ChainID:         chainID,
+	}
+}
+
+// creates the correct HandshakeMsg based on Swap instance
+func correctSwapHandshakeMsg(swap *Swap) *HandshakeMsg {
+	return newSwapHandshakeMsg(swap.GetParams().ContractAddress, swap.chainID)
+}
+
+// TestHandshake tests the correct handshake scenario
+func TestHandshake(t *testing.T) {
+	// setup the protocolTester, which will allow protocol testing by sending messages
+	protocolTester, clean, err := newSwapTester(t)
+	defer clean()
 	if err != nil {
 		t.Fatal(err)
 	}
 
-	// run the exchange:
-	// trigger a `EmitChequeMsg`
-	// expect HandshakeMsg on each node
-	err = protocolTester.TestExchanges(p2ptest.Exchange{
-		Label: "TestHandshake",
-		Triggers: []p2ptest.Trigger{
-			{
-				Code: 0,
-				Msg: &HandshakeMsg{
-					ContractAddress: swap.GetParams().ContractAddress,
-				},
-				Peer: creditor.ID(),
-			},
+	err = protocolTester.testHandshake(
+		correctSwapHandshakeMsg(protocolTester.swap),
+		correctSwapHandshakeMsg(protocolTester.swap),
+	)
+	if err != nil {
+		t.Fatal(err)
+	}
+}
+
+// TestHandshakeInvalidChainID tests that a handshake with the wrong chain id is rejected
+func TestHandshakeInvalidChainID(t *testing.T) {
+	// setup the protocolTester, which will allow protocol testing by sending messages
+	protocolTester, clean, err := newSwapTester(t)
+	defer clean()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	err = protocolTester.testHandshake(
+		correctSwapHandshakeMsg(protocolTester.swap),
+		newSwapHandshakeMsg(protocolTester.swap.GetParams().ContractAddress, 1234),
+		&p2ptest.Disconnect{
+			Peer:  protocolTester.Nodes[0].ID(),
+			Error: errors.New("Handshake error: Message handler error: (msg code 0): different chain id"),
 		},
-		Expects: []p2ptest.Expect{
-			{
-				Code: 0,
-				Msg: &HandshakeMsg{
-					ContractAddress: swap.GetParams().ContractAddress,
-				},
-				Peer: debitor.ID(),
-			},
+	)
+	if err != nil {
+		t.Fatal(err)
+	}
+}
+
+// TestHandshakeEmptyContract tests that a handshake with an empty contract address is rejected
+func TestHandshakeEmptyContract(t *testing.T) {
+	// setup the protocolTester, which will allow protocol testing by sending messages
+	protocolTester, clean, err := newSwapTester(t)
+	defer clean()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	err = protocolTester.testHandshake(
+		correctSwapHandshakeMsg(protocolTester.swap),
+		newSwapHandshakeMsg(common.Address{}, 1234),
+		&p2ptest.Disconnect{
+			Peer:  protocolTester.Nodes[0].ID(),
+			Error: errors.New("Handshake error: Message handler error: (msg code 0): empty address in handshake"),
 		},
-	})
+	)
+	if err != nil {
+		t.Fatal(err)
+	}
+}
 
-	// there should be no error at this point
+// TestHandshakeInvalidContract tests that a handshake with an address that's not a valid chequebook
+func TestHandshakeInvalidContract(t *testing.T) {
+	// setup the protocolTester, which will allow protocol testing by sending messages
+	protocolTester, clean, err := newSwapTester(t)
+	defer clean()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	err = protocolTester.testHandshake(
+		correctSwapHandshakeMsg(protocolTester.swap),
+		newSwapHandshakeMsg(ownerAddress, protocolTester.swap.chainID),
+		&p2ptest.Disconnect{
+			Peer:  protocolTester.Nodes[0].ID(),
+			Error: errors.New("Handshake error: Message handler error: (msg code 0): not deployed by factory"),
+		},
+	)
 	if err != nil {
 		t.Fatal(err)
 	}

swap/simulations_test.go

@@ -230,7 +230,7 @@ func newSharedBackendSwaps(t *testing.T, nodeCount int) (*swapSimulationParams,
 		if err != nil {
 			t.Fatal(err)
 		}
-		params.swaps[i] = newSwapInstance(stores[i], owner, testBackend, defParams, factory)
+		params.swaps[i] = newSwapInstance(stores[i], owner, testBackend, 10, defParams, factory)
 	}
 
 	params.backend = testBackend

swap/swap.go

@@ -62,6 +62,7 @@ type Swap struct {
 	contract          contract.Contract          // reference to the smart contract
 	chequebookFactory contract.SimpleSwapFactory // the chequebook factory used
 	honeyPriceOracle  HoneyOracle                // oracle which resolves the price of honey (in Wei)
+	chainID           uint64                     // id of the chain the backend is connected to
 }
 
 // Owner encapsulates information related to accessing the contract
@@ -130,7 +131,7 @@ func swapRotatingFileHandler(logdir string) (log.Handler, error) {
 }
 
 // newSwapInstance is a swap constructor function without integrity checks
-func newSwapInstance(stateStore state.Store, owner *Owner, backend contract.Backend, params *Params, chequebookFactory contract.SimpleSwapFactory) *Swap {
+func newSwapInstance(stateStore state.Store, owner *Owner, backend contract.Backend, chainID uint64, params *Params, chequebookFactory contract.SimpleSwapFactory) *Swap {
 	return &Swap{
 		store:             stateStore,
 		peers:             make(map[enode.ID]*Peer),
@@ -139,6 +140,7 @@ func newSwapInstance(stateStore state.Store, owner *Owner, backend contract.Back
 		params:            params,
 		chequebookFactory: chequebookFactory,
 		honeyPriceOracle:  NewHoneyPriceOracle(),
+		chainID:           chainID,
 	}
 }
 
@@ -193,6 +195,7 @@ func New(dbPath string, prvkey *ecdsa.PrivateKey, backendURL string, params *Par
 		stateStore,
 		owner,
 		backend,
+		chainID.Uint64(),
 		params,
 		factory,
 	)

swap/swap_test.go

@@ -1371,7 +1371,7 @@ func newBaseTestSwapWithParams(t *testing.T, key *ecdsa.PrivateKey, params *Para
 	if err != nil {
 		t.Fatal(err)
 	}
-	swap := newSwapInstance(stateStore, owner, backend, params, factory)
+	swap := newSwapInstance(stateStore, owner, backend, 10, params, factory)
 	return swap, dir
 }
 

swap/types.go

@@ -36,6 +36,7 @@ type Cheque struct {
 
 // HandshakeMsg is exchanged on peer handshake
 type HandshakeMsg struct {
+	ChainID         uint64
 	ContractAddress common.Address
 }