Merge pull request #102 from smartcontractkit/jh/update-extraArgs-binding-and-extraArgsCodec

Refactor extraArgs and extraDataCodec

Author: huangzhen1997

pkg/ccip/bindings/onramp/onramp.go

@@ -4,6 +4,7 @@ import (
 	"math/big"
 
 	"github.com/xssnick/tonutils-go/address"
+	"github.com/xssnick/tonutils-go/tlb"
 	"github.com/xssnick/tonutils-go/tvm/cell"
 
 	"github.com/smartcontractkit/chainlink-ton/pkg/ccip/bindings/common"
@@ -17,12 +18,14 @@ type CCIPMessageSent struct {
 
 // GenericExtraArgsV2 represents generic extra arguments for transactions.
 type GenericExtraArgsV2 struct {
-	GasLimit                 *big.Int `tlb:"## 256"`
-	AllowOutOfOrderExecution bool     `tlb:"bool"`
+	_                        tlb.Magic `tlb:"#181dcf10"` //nolint:revive // Ignore opcode tag // hex encoded bytes4(keccak256("CCIP EVMExtraArgsV2")), can be verified with hexutil.MustDecode("0x181dcf10")
+	GasLimit                 *big.Int  `tlb:"## 256"`
+	AllowOutOfOrderExecution bool      `tlb:"bool"`
 }
 
 // SVMExtraArgsV1 represents extra arguments for SVM transactions.
 type SVMExtraArgsV1 struct {
+	_                        tlb.Magic                          `tlb:"#1f3b3aba"` //nolint:revive // Ignore opcode tag // hex encoded bytes4(keccak256("CCIP SVMExtraArgsV1")), can be verified with hexutil.MustDecode("0x1f3b3aba")
 	ComputeUnits             uint32                             `tlb:"## 32"`
 	AccountIsWritableBitmap  uint64                             `tlb:"## 64"`
 	AllowOutOfOrderExecution bool                               `tlb:"bool"`

pkg/ccip/codec/extradatacodec.go

@@ -38,39 +38,41 @@ func (d ExtraDataDecoder) DecodeExtraArgsToMap(extraArgs ccipocr3.Bytes) (map[st
 	var val reflect.Value
 	var typ reflect.Type
 	outputMap := make(map[string]any)
-	switch string(extraArgs[:4]) {
-	case string(evmExtraArgsV2Tag):
-		var args onramp.GenericExtraArgsV2
-		c, err := cell.FromBOC(extraArgs[4:])
-		if err != nil {
-			return outputMap, fmt.Errorf("decode BOC: %w", err)
-		}
+	c, err := cell.FromBOC(extraArgs)
+	if err != nil {
+		return outputMap, fmt.Errorf("failed to decode BOC: %w", err)
+	}
+	tag, err := c.BeginParse().LoadSlice(32)
+	if err != nil {
+		return outputMap, fmt.Errorf("failed to load tag from cell: %w", err)
+	}
 
+	switch hexutil.Encode(tag) {
+	case hexutil.Encode(evmExtraArgsV2Tag):
+		var args onramp.GenericExtraArgsV2
 		if err = tlb.LoadFromCell(&args, c.BeginParse()); err != nil {
 			return nil, fmt.Errorf("failed to tlb load extra args from cell: %w", err)
 		}
-
 		val = reflect.ValueOf(args)
 		typ = reflect.TypeOf(args)
-	case string(svmExtraArgsV1Tag):
-		var tlbArgs onramp.SVMExtraArgsV1
-		c, err := cell.FromBOC(extraArgs[4:])
-		if err != nil {
-			return outputMap, fmt.Errorf("decode BOC: %w", err)
-		}
 
+	case hexutil.Encode(svmExtraArgsV1Tag):
+		var tlbArgs onramp.SVMExtraArgsV1
 		if err = tlb.LoadFromCell(&tlbArgs, c.BeginParse()); err != nil {
 			return nil, fmt.Errorf("failed to tlb load extra args from cell: %w", err)
 		}
-
 		val = reflect.ValueOf(tlbArgs)
 		typ = reflect.TypeOf(tlbArgs)
+
 	default:
-		return nil, fmt.Errorf("unknown extra args tag: %x", extraArgs[:4])
+		return nil, fmt.Errorf("unknown extra args tag: %x", tag)
 	}
 
 	for i := 0; i < val.NumField(); i++ {
 		field := typ.Field(i)
+		if !field.IsExported() {
+			continue
+		}
 		fieldValue := val.Field(i).Interface()
 		outputMap[field.Name] = fieldValue
 	}

pkg/ccip/codec/extradatacodec_test.go

@@ -29,7 +29,7 @@ func Test_decodeExtraArgs(t *testing.T) {
 
 	t.Run("decode extra args into map svm", func(t *testing.T) {
 		destGasAmount := uint32(10000)
-		bitmap := uint64(0)
+		bitmap := uint64(5)
 		extraArgs := onramp.SVMExtraArgsV1{
 			ComputeUnits:             destGasAmount,
 			AccountIsWritableBitmap:  bitmap,
@@ -44,7 +44,7 @@ func Test_decodeExtraArgs(t *testing.T) {
 		c, err := tlb.ToCell(extraArgs)
 		require.NoError(t, err)
 
-		output, err := extraDataDecoder.DecodeExtraArgsToMap(append(svmExtraArgsV1Tag, c.ToBOC()...))
+		output, err := extraDataDecoder.DecodeExtraArgsToMap(c.ToBOC())
 		require.NoError(t, err)
 		require.Len(t, output, 5)
 
@@ -70,7 +70,7 @@ func Test_decodeExtraArgs(t *testing.T) {
 		c, err := tlb.ToCell(extraArgs)
 		require.NoError(t, err)
 
-		output, err := extraDataDecoder.DecodeExtraArgsToMap(append(evmExtraArgsV2Tag, c.ToBOC()...))
+		output, err := extraDataDecoder.DecodeExtraArgsToMap(c.ToBOC())
 		require.NoError(t, err)
 		require.Len(t, output, 2)