P1sar/feat/add resourceid to substrate call#543 (#550)

* initial try to add resourceID to substrate chain call

* substrate extrincit sub call extended with optional params resourceID

* update config docs

* substrate test image reference update to stable one

* update accroding to PR comments

* substrate chain version updated in e2e tests doecker compose

* tests config included to enable extanded substrate call

* wrongly added additional resourceID removedd

* small readme upddate

Author: P1sar

Makefile

@@ -76,7 +76,7 @@ install-subkey:
 ## Runs go test for all packages except the solidity bindings
 test:
 	@echo "  >  \033[32mRunning tests...\033[0m "
-	go test `go list ./... | grep -v bindings | grep -v e2e`
+	go test -v `go list ./... | grep -v bindings | grep -v e2e`
 
 test-e2e:
 	@echo "  >  \033[32mRunning e2e tests...\033[0m "

README.md

@@ -81,6 +81,7 @@ Ethereum chains support the following additional options:
     "http": "true",                  // Whether the chain connection is ws or http (default: false)
     "startBlock": "1234",            // The block to start processing events from (default: 0)
     "blockConfirmations": "10"       // Number of blocks to wait before processing a block
+    "useExtendedCall": "true"        // Extend extrinsic calls to substrate with ResourceID. Used for backward compatibility with example pallet. *Default: false*
 }
 ```
 

chains/substrate/chain.go

@@ -100,9 +100,11 @@ func InitializeChain(cfg *core.ChainConfig, logger log15.Logger, sysErr chan<- e
 		startBlock = uint64(curr.Number)
 	}
 
+	ue := parseUseExtended(cfg)
+
 	// Setup listener & writer
 	l := NewListener(conn, cfg.Name, cfg.Id, startBlock, logger, bs, stop, sysErr, m)
-	w := NewWriter(conn, logger, sysErr, m)
+	w := NewWriter(conn, logger, sysErr, m, ue)
 	return &Chain{
 		cfg:      cfg,
 		conn:     conn,
@@ -117,12 +119,6 @@ func (c *Chain) Start() error {
 	if err != nil {
 		return err
 	}
-
-	err = c.writer.start()
-	if err != nil {
-		return err
-	}
-
 	c.conn.log.Debug("Successfully started chain", "chainId", c.cfg.Id)
 	return nil
 }

chains/substrate/config.go

@@ -19,3 +19,14 @@ func parseStartBlock(cfg *core.ChainConfig) uint64 {
 	}
 	return 0
 }
+
+func parseUseExtended(cfg *core.ChainConfig) bool {
+	if b, ok := cfg.Opts["useExtendedCall"]; ok {
+		res, err := strconv.ParseBool(b)
+		if err != nil {
+			panic(err)
+		}
+		return res
+	}
+	return false
+}

chains/substrate/test_helper_test.go

@@ -93,8 +93,8 @@ func TestMain(m *testing.M) {
 	if err != nil {
 		panic(err)
 	}
-	alice := NewWriter(aliceConn, AliceTestLogger, wSysErr, nil)
-	bob := NewWriter(bobConn, BobTestLogger, wSysErr, nil)
+	alice := NewWriter(aliceConn, AliceTestLogger, wSysErr, nil, true)
+	bob := NewWriter(bobConn, BobTestLogger, wSysErr, nil, true)
 	context = testContext{
 		client:         client,
 		listener:       l,

chains/substrate/types.go

@@ -69,7 +69,6 @@ func (w *writer) createFungibleProposal(m msg.Message) (*proposal, error) {
 	if err != nil {
 		return nil, err
 	}
-
 	call, err := types.NewCall(
 		&meta,
 		method,
@@ -79,6 +78,13 @@ func (w *writer) createFungibleProposal(m msg.Message) (*proposal, error) {
 	if err != nil {
 		return nil, err
 	}
+	if w.extendCall {
+		eRID, err := types.EncodeToBytes(m.ResourceId)
+		if err != nil {
+			return nil, err
+		}
+		call.Args = append(call.Args, eRID...)
+	}
 
 	return &proposal{
 		depositNonce: depositNonce,
@@ -111,6 +117,13 @@ func (w *writer) createNonFungibleProposal(m msg.Message) (*proposal, error) {
 	if err != nil {
 		return nil, err
 	}
+	if w.extendCall {
+		eRID, err := types.EncodeToBytes(m.ResourceId)
+		if err != nil {
+			return nil, err
+		}
+		call.Args = append(call.Args, eRID...)
+	}
 
 	return &proposal{
 		depositNonce: depositNonce,
@@ -133,10 +146,17 @@ func (w *writer) createGenericProposal(m msg.Message) (*proposal, error) {
 		method,
 		types.NewHash(m.Payload[0].([]byte)),
 	)
-
 	if err != nil {
 		return nil, err
 	}
+	if w.extendCall {
+		eRID, err := types.EncodeToBytes(m.ResourceId)
+		if err != nil {
+			return nil, err
+		}
+
+		call.Args = append(call.Args, eRID...)
+	}
 	return &proposal{
 		depositNonce: types.U64(m.DepositNonce),
 		call:         call,

chains/substrate/writer.go

@@ -24,25 +24,23 @@ var AcknowledgeProposal utils.Method = utils.BridgePalletName + ".acknowledge_pr
 var TerminatedError = errors.New("terminated")
 
 type writer struct {
-	conn    *Connection
-	log     log15.Logger
-	sysErr  chan<- error
-	metrics *metrics.ChainMetrics
+	conn       *Connection
+	log        log15.Logger
+	sysErr     chan<- error
+	metrics    *metrics.ChainMetrics
+	extendCall bool // Extend extrinsic calls to substrate with ResourceID.Used for backward compatibility with example pallet.
 }
 
-func NewWriter(conn *Connection, log log15.Logger, sysErr chan<- error, m *metrics.ChainMetrics) *writer {
+func NewWriter(conn *Connection, log log15.Logger, sysErr chan<- error, m *metrics.ChainMetrics, extendCall bool) *writer {
 	return &writer{
-		conn:    conn,
-		log:     log,
-		sysErr:  sysErr,
-		metrics: m,
+		conn:       conn,
+		log:        log,
+		sysErr:     sysErr,
+		metrics:    m,
+		extendCall: extendCall,
 	}
 }
 
-func (w *writer) start() error {
-	return nil
-}
-
 func (w *writer) ResolveMessage(m msg.Message) bool {
 	var prop *proposal
 	var err error
@@ -106,7 +104,6 @@ func (w *writer) resolveResourceId(id [32]byte) (string, error) {
 	if !exists {
 		return "", fmt.Errorf("resource %x not found on chain", id)
 	}
-
 	return string(res), nil
 }
 

docker-compose-e2e.yml

@@ -16,7 +16,7 @@ services:
     - "8546:8545"
 
   sub-chain:
-    image: "chainsafe/chainbridge-substrate-chain:v1.2.0"
+    image: "chainsafe/chainbridge-substrate-chain:v1.3.0"
     container_name: sub-chain
     command: chainbridge-substrate-chain --dev --alice --ws-external --rpc-external
     ports:

docs/configuration.md

@@ -42,6 +42,7 @@ Substrate supports the following additonal options:
 ```
 {
     "startBlock": "1234" // The block to start processing events from (default: 0)
+    "useExtendedCall": "true" // Extend extrinsic calls to substrate with ResourceID. Used for backward compatibility with example pallet.
 }
 ```
 

e2e/substrate/substrate.go

@@ -45,7 +45,7 @@ func CreateConfig(key string, chain msg.ChainId) *core.ChainConfig {
 		Insecure:       true,
 		FreshStart:     true,
 		BlockstorePath: os.TempDir(),
-		Opts:           map[string]string{},
+		Opts:           map[string]string{"useExtendedCall": "true"},
 	}
 }