Implement extra args codec #16016
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
There was a problem hiding this comment. Could we rename or move these functions related to decoding to appropriately named files? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| package ccipsolana | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "reflect" | ||
|
|
||
| agbinary "github.com/gagliardetto/binary" | ||
|
|
||
| "github.com/smartcontractkit/chainlink-ccip/chains/solana/gobindings/ccip_router" | ||
| ) | ||
|
|
||
| // DecodeExtraArgsToMap is a helper function for converting Borsh encoded extra args bytes into map[string]any, which will be saved in ocr report.message.ExtraArgsDecoded | ||
| func DecodeExtraArgsToMap(extraArgs []byte) (map[string]any, error) { | ||
|
There was a problem hiding this comment. Good rule of thumb to add a docstring to exported methods There was a problem hiding this comment. Previously, the EVM version had this comment and a special offset. What happened to it? |
||
| outputMap := make(map[string]any) | ||
| var args ccip_router.AnyExtraArgs | ||
| decoder := agbinary.NewBorshDecoder(extraArgs) | ||
| err := args.UnmarshalWithDecoder(decoder) | ||
| if err != nil { | ||
| return outputMap, fmt.Errorf("failed to decode extra args: %w", err) | ||
| } | ||
|
|
||
| val := reflect.ValueOf(args) | ||
| typ := reflect.TypeOf(args) | ||
|
|
||
| for i := 0; i < val.NumField(); i++ { | ||
| field := typ.Field(i) | ||
| fieldValue := val.Field(i).Interface() | ||
| outputMap[field.Name] = fieldValue | ||
| } | ||
|
|
||
| return outputMap, nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| package ccipsolana | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "testing" | ||
|
|
||
| agbinary "github.com/gagliardetto/binary" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/smartcontractkit/chainlink-ccip/chains/solana/gobindings/ccip_router" | ||
| ) | ||
|
|
||
| func Test_decodeExtraArgs(t *testing.T) { | ||
| t.Run("decode extra args into map svm", func(t *testing.T) { | ||
| extraArgs := ccip_router.AnyExtraArgs{ | ||
| GasLimit: agbinary.Uint128{Lo: 5000, Hi: 0}, | ||
| AllowOutOfOrderExecution: false, | ||
| } | ||
|
|
||
| var buf bytes.Buffer | ||
| encoder := agbinary.NewBorshEncoder(&buf) | ||
| err := extraArgs.MarshalWithEncoder(encoder) | ||
| require.NoError(t, err) | ||
| output, err := DecodeExtraArgsToMap(buf.Bytes()) | ||
| require.NoError(t, err) | ||
| require.Len(t, output, 2) | ||
|
There was a problem hiding this comment. Can you add |
||
|
|
||
| gasLimit, exist := output["GasLimit"] | ||
| require.True(t, exist) | ||
| require.Equal(t, agbinary.Uint128{Lo: 5000, Hi: 0}, gasLimit) | ||
|
|
||
| ooe, exist := output["AllowOutOfOrderExecution"] | ||
| require.True(t, exist) | ||
| require.Equal(t, false, ooe) | ||
| }) | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| package common | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| chainsel "github.com/smartcontractkit/chain-selectors" | ||
|
|
||
| "github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/ccipevm" | ||
| "github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/ccipsolana" | ||
|
|
||
| cciptypes "github.com/smartcontractkit/chainlink-ccip/pkg/types/ccipocr3" | ||
| ) | ||
|
|
||
| type ExtraArgsCodec struct{} | ||
|
|
||
| func NewExtraArgsCodec() ExtraArgsCodec { | ||
| return ExtraArgsCodec{} | ||
| } | ||
|
|
||
| func (ExtraArgsCodec) DecodeExtraData(extraArgs cciptypes.Bytes, sourceChainSelector cciptypes.ChainSelector) (map[string]any, error) { | ||
| family, err := chainsel.GetSelectorFamily(uint64(sourceChainSelector)) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get chain family for selector %d: %w", sourceChainSelector, err) | ||
| } | ||
|
|
||
| switch family { | ||
| case chainsel.FamilyEVM: | ||
| return ccipevm.DecodeExtraArgsToMap(extraArgs) | ||
|
|
||
| case chainsel.FamilySolana: | ||
| return ccipsolana.DecodeExtraArgsToMap(extraArgs) | ||
|
|
||
| default: | ||
| return nil, fmt.Errorf("unsupported family for extra args type %s", family) | ||
| } | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: move these comments to the actual case block where you set extraByteOffset