Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement extra args codec #16016

Open
wants to merge 11 commits into
base: solana-offchain-plugin
Choose a base branch
from

Conversation

huangzhen1997
Copy link
Contributor

@huangzhen1997 huangzhen1997 commented Jan 21, 2025

Jira
extra args codec for OCR message. Convert []byte into map[string]any format depends on the source chain.

Copy link
Contributor

Flakeguard Summary

Ran new or updated tests between develop and a757a6e (NONEVM-1163/implement-extra-args-codec).

View Flaky Detector Details | Compare Changes

Found Flaky Tests ❌

Name Pass Ratio Panicked? Timed Out? Race? Runs Successes Failures Skips Package Package Panicked? Avg Duration Code Owners
Test_decodeExtraArgs 0.00% false false false 3 0 3 0 github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/ccipevm false 40ms @smartcontractkit/ccip-offchain
Test_decodeExtraArgs/SVMv1 0.00% false false false 3 0 3 0 github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/ccipevm false 0s @smartcontractkit/ccip-offchain

Artifacts

For detailed logs of the failed tests, please refer to the artifact failed-test-results-with-logs.json.

Copy link
Contributor

github-actions bot commented Jan 21, 2025

AER Report: CI Core

aer_workflow , commit , Detect Changes , Scheduled Run Frequency , Clean Go Tidy & Generate , Core Tests (go_core_tests) , GolangCI Lint (core/scripts) , Core Tests (go_core_tests_integration) , GolangCI Lint (.) , Core Tests (go_core_ccip_deployment_tests) , test-scripts , GolangCI Lint (integration-tests/load) , Core Tests (go_core_fuzz) , GolangCI Lint (integration-tests) , Core Tests (go_core_race_tests) , GolangCI Lint (deployment) , lint , SonarQube Scan

1. File is not goimports-ed with -local:

[job id where the error happened]: Golang Lint (integration-tests)

Source of Error:
Golang Lint (integration-tests)	2025-01-22T22:02:03.0630820Z integration-tests/smoke/ccip/ccip_reader_test.go:17: File is not `goimports`-ed with -local github.com/smartcontractkit/chainlink (goimports)
Golang Lint (integration-tests)	2025-01-22T22:02:03.0632056Z 	common2 "github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/common"

Why: The file ccip_reader_test.go is not formatted according to the goimports tool with the -local flag set to github.com/smartcontractkit/chainlink.

Suggested fix: Run goimports -local github.com/smartcontractkit/chainlink -w integration-tests/smoke/ccip/ccip_reader_test.go to format the file correctly.

2. Received unexpected error:

[job id where the error happened]: Core Tests (go_core_tests)

Source of Error:
Run tests	2025-01-22T22:05:38.0295432Z helpers_test.go:81: 
Run tests	2025-01-22T22:05:38.0296629Z 	Error Trace:	/home/runner/work/chainlink/chainlink/core/capabilities/ccip/ccipevm/helpers_test.go:81
Run tests	2025-01-22T22:05:38.0297618Z 	Error: 	Received unexpected error:
Run tests	2025-01-22T22:05:38.0299296Z 	 	abi decode extra args decodeSVMExtraArgsV1: abi: improperly encoded boolean value
Run tests	2025-01-22T22:05:38.0300389Z 	Test: 	Test_decodeExtraArgs/decode_extra_args_into_map_svm

Why: The test Test_decodeExtraArgs/decode_extra_args_into_map_svm failed because the ABI decoding function encountered an improperly encoded boolean value.

Suggested fix: Investigate the encoding process for the boolean value in the decodeSVMExtraArgsV1 function to ensure it conforms to the expected ABI format.

AER Report: Operator UI CI ran successfully ✅

aer_workflow , commit

@huangzhen1997 huangzhen1997 changed the base branch from develop to solana-offchain-plugin January 21, 2025 19:41
@huangzhen1997 huangzhen1997 changed the base branch from solana-offchain-plugin to develop January 21, 2025 19:42
@huangzhen1997 huangzhen1997 changed the title Use SVM ABI, needs to check test Implement extra args codec Jan 21, 2025
@@ -43,6 +50,61 @@ func decodeExtraArgsV1V2(extraArgs []byte) (gasLimit *big.Int, err error) {
return ifaces[0].(*big.Int), nil
}

func decodeExtraArgsSVMV1(extraArgs []byte) (*message_hasher.ClientSVMExtraArgsV1, error) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a method to decode from an EVM source chain right?

EVMExtraArgsKey: gas,
}, nil

case chainsel.FamilySolana:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The switch on family here is on the source chain selector, meaning this case applies when source was Solana chain.
Thus decoding this requires Solana decoder.
But the implementation is using EVM decoder.

Copy link
Contributor

Flakeguard Summary

Ran new or updated tests between develop and 7253bba (NONEVM-1163/implement-extra-args-codec).

View Flaky Detector Details | Compare Changes

Found Flaky Tests ❌

Name Pass Ratio Panicked? Timed Out? Race? Runs Successes Failures Skips Package Package Panicked? Avg Duration Code Owners
Test_decodeExtraArgs 0.00% false false false 3 0 3 0 github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/ccipevm false 43.333333ms @smartcontractkit/ccip-offchain
Test_decodeExtraArgs/SVMv1 0.00% false false false 3 0 3 0 github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/ccipevm false 3.333333ms @smartcontractkit/ccip-offchain

Artifacts

For detailed logs of the failed tests, please refer to the artifact failed-test-results-with-logs.json.

Comment on lines 33 to 41
case chainsel.FamilyEVM:
gas, err1 := decodeExtraArgsV1V2(extraArgs)
if err1 != nil {
return nil, fmt.Errorf("failed to decode EVM extra data, %w", err)
}

return map[string]any{
EVMExtraArgsKey: gas,
}, nil
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd be tempted to do some minor refactoring here so you can write it like this:

Suggested change
case chainsel.FamilyEVM:
gas, err1 := decodeExtraArgsV1V2(extraArgs)
if err1 != nil {
return nil, fmt.Errorf("failed to decode EVM extra data, %w", err)
}
return map[string]any{
EVMExtraArgsKey: gas,
}, nil
case chainsel.FamilyEVM:
return decodeExtraArgsV1V2(extraArgs)

Maybe even some moderate refactoring to avoid having SVM code in the EVM package.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

decodeExtraArgsV1V2 returns *big.int. The return type needs to be map[string]any

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The way I understand, the SVMExtraArgsv1 is defined for EVM onchain, and requires abi decoding, which is all EVM

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I said there would be minor refactoring.

@huangzhen1997 huangzhen1997 changed the base branch from develop to solana-offchain-plugin January 21, 2025 21:20
@huangzhen1997 huangzhen1997 marked this pull request as ready for review January 21, 2025 22:25
@huangzhen1997 huangzhen1997 requested review from a team as code owners January 21, 2025 22:25
@huangzhen1997 huangzhen1997 requested review from pavel-raykov, asoliman92, makramkd, dimkouv and mateusz-sekara and removed request for a team January 21, 2025 22:25
Copy link
Contributor

Flakeguard Summary

Ran new or updated tests between solana-offchain-plugin and 36a5ad1 (NONEVM-1163/implement-extra-args-codec).

View Flaky Detector Details | Compare Changes

Found Flaky Tests ❌

Name Pass Ratio Panicked? Timed Out? Race? Runs Successes Failures Skips Package Package Panicked? Avg Duration Code Owners
Test_decodeExtraArgs 0.00% false false false 3 0 3 0 github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/ccipevm false 40ms @smartcontractkit/ccip-offchain
Test_decodeExtraArgs/decode_extra_args_into_map_svm 0.00% false false false 3 0 3 0 github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/ccipevm false 0s @smartcontractkit/ccip-offchain

Artifacts

For detailed logs of the failed tests, please refer to the artifact failed-test-results-with-logs.json.

Copy link
Contributor

Flakeguard Summary

Ran new or updated tests between solana-offchain-plugin and 3fa671b (NONEVM-1163/implement-extra-args-codec).

View Flaky Detector Details | Compare Changes

Found Flaky Tests ❌

Name Pass Ratio Panicked? Timed Out? Race? Runs Successes Failures Skips Package Package Panicked? Avg Duration Code Owners
Test_decodeExtraArgs 0.00% false false false 3 0 3 0 github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/ccipevm false 43.333333ms @smartcontractkit/ccip-offchain
Test_decodeExtraArgs/decode_extra_args_into_map_svm 0.00% false false false 3 0 3 0 github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/ccipevm false 0s @smartcontractkit/ccip-offchain

Artifacts

For detailed logs of the failed tests, please refer to the artifact failed-test-results-with-logs.json.

Comment on lines 33 to 41
case chainsel.FamilyEVM:
gas, err1 := decodeExtraArgsV1V2(extraArgs)
if err1 != nil {
return nil, fmt.Errorf("failed to decode EVM extra data, %w", err)
}

return map[string]any{
EVMExtraArgsKey: gas,
}, nil
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The way I understand, the SVMExtraArgsv1 is defined for EVM onchain, and requires abi decoding, which is all EVM


func DecodeExtraArgsToMap(extraArgs []byte) (map[string]any, error) {
outputMap := make(map[string]any)
var args ccip_router.SVMExtraArgs
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This type is wrong.
This is used in the Any2SVMRampMessage, where SVM is a target family. The SVMExtraArgs will be provided by source chain, when SVM is the destination.

However this is ccipsolana codec, which should be decoding the message when SVM is the source chain.
The right type here should be AnyExtraArgs, which is used inside SVM2AnyRampMessage, here:
https://github.com/smartcontractkit/chainlink-ccip/blob/6b09016243f66e494499e8bac9947706908d1497/chains/solana/gobindings/ccip_router/types.go#L510

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although I don't think AnyExtraArgs is the right structure. Instead it should be EVMExtraArgsv1 or EVMExtraArgsv2. But that is something we should talk to onchain folks about.

Copy link
Contributor

Flakeguard Summary

Ran new or updated tests between solana-offchain-plugin and af29932 (NONEVM-1163/implement-extra-args-codec).

View Flaky Detector Details | Compare Changes

Found Flaky Tests ❌

Name Pass Ratio Panicked? Timed Out? Race? Runs Successes Failures Skips Package Package Panicked? Avg Duration Code Owners
Test_decodeExtraArgs 0.00% false false false 3 0 3 0 github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/ccipevm false 43.333333ms @smartcontractkit/ccip-offchain
Test_decodeExtraArgs/decode_extra_args_into_map_svm 0.00% false false false 3 0 3 0 github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/ccipevm false 0s @smartcontractkit/ccip-offchain
Test_decodeExtraArgs 0.00% false false false 3 0 3 0 github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/ccipsolana false 0s @smartcontractkit/ccip-offchain
Test_decodeExtraArgs/decode_extra_args_into_map_svm 0.00% false false false 3 0 3 0 github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/ccipsolana false 0s @smartcontractkit/ccip-offchain

Artifacts

For detailed logs of the failed tests, please refer to the artifact failed-test-results-with-logs.json.

solana.SystemProgramID,
},
extraArgs := ccip_router.AnyExtraArgs{
// TODO wait for onchain team fix this AnyExtraArgs
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the source chain here is SVM, we won't need these SVM specific fields here, since you will not go from SVM -> SVM.
Atleast not until CCIP supports another SVM chain apart from Solana.

For testing right now, we should be good with just EVM specific fields in this struct.

Copy link
Contributor

Flakeguard Summary

Ran new or updated tests between solana-offchain-plugin and 2597b48 (NONEVM-1163/implement-extra-args-codec).

View Flaky Detector Details | Compare Changes

Found Flaky Tests ❌

Name Pass Ratio Panicked? Timed Out? Race? Runs Successes Failures Skips Package Package Panicked? Avg Duration Code Owners
Test_decodeExtraArgs 0.00% false false false 3 0 3 0 github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/ccipsolana false 0s @smartcontractkit/ccip-offchain
Test_decodeExtraArgs/decode_extra_args_into_map_svm 0.00% false false false 3 0 3 0 github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/ccipsolana false 0s @smartcontractkit/ccip-offchain

Artifacts

For detailed logs of the failed tests, please refer to the artifact failed-test-results-with-logs.json.

t.Run("decode extra args into map svm", func(t *testing.T) {
key, err := solana.NewRandomPrivateKey()
require.NoError(t, err)
encoded, err := d.contract.EncodeSVMExtraArgsV1(nil, message_hasher.ClientSVMExtraArgsV1{
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@prashantkumar1982 This is the failing test I was talking about. By inspecting the encoded bytes, I suspect this EncodeSVMExtraArgsV1 is not working properly.

Copy link
Contributor

Flakeguard Summary

Ran new or updated tests between solana-offchain-plugin and a99bdcc (NONEVM-1163/implement-extra-args-codec).

View Flaky Detector Details | Compare Changes

Found Flaky Tests ❌

Name Pass Ratio Panicked? Timed Out? Race? Runs Successes Failures Skips Package Package Panicked? Avg Duration Code Owners
Test_decodeExtraArgs 0.00% false false false 3 0 3 0 github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/ccipevm false 40ms @smartcontractkit/ccip-offchain
Test_decodeExtraArgs/decode_extra_args_into_map_svm 0.00% false false false 3 0 3 0 github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/ccipevm false 0s @smartcontractkit/ccip-offchain

Artifacts

For detailed logs of the failed tests, please refer to the artifact failed-test-results-with-logs.json.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants