Implement extra args codec #16016

huangzhen1997 · 2025-01-21T19:15:29Z

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

github-actions · 2025-01-21T19:23:46Z

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.

github-actions · 2025-01-21T19:28:28Z

AER Report: CI Core ran successfully ✅

aer_workflow , commit

AER Report: Operator UI CI ran successfully ✅

aer_workflow , commit

prashantkumar1982 · 2025-01-21T19:53:01Z

core/capabilities/ccip/ccipevm/helpers.go

@@ -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) {


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

prashantkumar1982 · 2025-01-21T19:54:08Z

core/capabilities/ccip/ccipevm/extraargscodec.go

+			EVMExtraArgsKey: gas,
+		}, nil
+
+	case chainsel.FamilySolana:


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.

github-actions · 2025-01-21T19:54:41Z

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.

winder · 2025-01-21T19:56:26Z

core/capabilities/ccip/ccipevm/extraargscodec.go

+	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


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.

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

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

Yes, I said there would be minor refactoring.

…a-args-codec

winder · 2025-01-27T20:44:54Z

core/capabilities/ccip/ccipsolana/helpers.go

+// 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) {


Previously, the EVM version had this comment and a special offset. What happened to it?

case string(svmExtraArgsV1Tag): // for SVMExtraArgs there's the four bytes plus another 32 bytes padding for the dynamic array method = svmV1DecodeName extraByteOffset = 36

prashantkumar1982 · 2025-01-28T22:55:47Z

integration-tests/smoke/ccip/ccip_reader_test.go

@@ -20,6 +20,10 @@ import (

 	ccipcommon "github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/common"

+<<<<<<< HEAD


Merge conflicts need resolving.

winder · 2025-01-28T23:41:32Z

core/capabilities/ccip/ccipevm/helpers.go

+		// for SVMExtraArgs there's the four bytes plus another 32 bytes padding for the dynamic array
+		// https://github.com/smartcontractkit/chainlink/blob/33c0bda696b0ed97f587a46eacd5c65bed9fb2c1/contracts/src/v0.8/ccip/libraries/Client.sol#L57
+		method = svmV1DecodeName
+		extraByteOffset = 36


I still don't see why this is 36 instead of 4. It looks like it's encoded the same way as EVM args are encoded: https://github.com/smartcontractkit/chainlink/blob/33c0bda696b0ed97f587a46eacd5c65bed9fb2c1/contracts/src/v0.8/ccip/libraries/Client.sol#L74C35-L74C62

https://chainlink-core.slack.com/archives/C0779R3AH8R/p1737837136262789?thread_ts=1737484810.494739&cid=C0779R3AH8R

prashantkumar1982 · 2025-01-29T22:23:49Z

core/capabilities/ccip/ccipsolana/helpers.go

Could we rename or move these functions related to decoding to appropriately named files?
helpers.go seems like a bad place.
Maybe call them extradatadecoder.go

winder · 2025-01-30T13:24:32Z

core/capabilities/ccip/ccipevm/extradatadecoder.go

+		// for SVMExtraArgs there's the four bytes plus another 32 bytes padding for the dynamic array
+		// https://github.com/smartcontractkit/chainlink/blob/33c0bda696b0ed97f587a46eacd5c65bed9fb2c1/contracts/src/v0.8/ccip/libraries/Client.sol#L57
+		// this is a temporary solution, the evm on-chain side will fix it, so the offset should just be 4 instead of 36


Thanks for the link, but this doesn't really answer why there are 32 bytes of padding. I'm imagining that this behavior could change in the future, maybe we add a new SVM arg or there is an EVM optimization. When that causes the "abi decode extra args" error below, we should give the future dev something more concrete to work with.

I've created an unassigned ticket https://smartcontract-it.atlassian.net/browse/BCI-4180

cl-sonarqube-production · 2025-01-30T19:16:57Z

Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube

Use SVM ABI, needs to check test

a757a6e

huangzhen1997 changed the base branch from develop to solana-offchain-plugin January 21, 2025 19:41

huangzhen1997 changed the base branch from solana-offchain-plugin to develop January 21, 2025 19:42

goimport

7253bba

huangzhen1997 changed the title ~~Use SVM ABI, needs to check test~~ Implement extra args codec Jan 21, 2025

prashantkumar1982 reviewed Jan 21, 2025

View reviewed changes

winder reviewed Jan 21, 2025

View reviewed changes

huangzhen1997 added 2 commits January 21, 2025 14:57

update

0ec8119

rename

82a162f

huangzhen1997 changed the base branch from develop to solana-offchain-plugin January 21, 2025 21:20

huangzhen1997 requested review from prashantkumar1982 and winder January 21, 2025 21:27

Merge branch 'solana-offchain-plugin' into NONEVM-1163/implement-extr…

2c7bd05

…a-args-codec

huangzhen1997 marked this pull request as ready for review January 21, 2025 22:25

huangzhen1997 requested review from a team as code owners January 21, 2025 22:25

huangzhen1997 requested review from pavel-raykov, asoliman92, makramkd, dimkouv and mateusz-sekara and removed request for a team January 21, 2025 22:25

winder reviewed Jan 27, 2025

View reviewed changes

merge develop

ee10849

huangzhen1997 requested review from AnieeG and kylesmartin as code owners January 28, 2025 21:08

implement and add test

f2952a0

huangzhen1997 requested review from prashantkumar1982 and winder January 28, 2025 22:13

huangzhen1997 added 2 commits January 28, 2025 16:19

update comments

a1eacf6

goimport

0b15808

prashantkumar1982 reviewed Jan 28, 2025

View reviewed changes

fix conflicts

55b33e3

winder reviewed Jan 28, 2025

View reviewed changes

prashantkumar1982 approved these changes Jan 29, 2025

View reviewed changes

huangzhen1997 added 3 commits January 29, 2025 13:17

update

8d4d702

update

fc7f0f7

add comment

9939559

prashantkumar1982 reviewed Jan 29, 2025

View reviewed changes

refactor

6e6441d

winder reviewed Jan 30, 2025

View reviewed changes

update comment

7e96d52

huangzhen1997 requested a review from winder January 30, 2025 15:50

huangzhen1997 added 5 commits January 30, 2025 12:13

add unit test

2e8de08

update

5c76148

lint

5bcf509

mod tidy

8af2a50

update

aa9841d

winder approved these changes Jan 30, 2025

View reviewed changes

huangzhen1997 merged commit 57d0294 into solana-offchain-plugin Jan 30, 2025
201 of 204 checks passed

huangzhen1997 deleted the NONEVM-1163/implement-extra-args-codec branch January 30, 2025 20:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement extra args codec #16016

Implement extra args codec #16016

huangzhen1997 commented Jan 21, 2025 •

edited

Loading

github-actions bot commented Jan 21, 2025

github-actions bot commented Jan 21, 2025 •

edited

Loading

prashantkumar1982 Jan 21, 2025

prashantkumar1982 Jan 21, 2025

github-actions bot commented Jan 21, 2025

winder Jan 21, 2025

huangzhen1997 Jan 21, 2025

prashantkumar1982 Jan 21, 2025

winder Jan 21, 2025

winder Jan 27, 2025

prashantkumar1982 Jan 28, 2025

winder Jan 28, 2025

huangzhen1997 Jan 29, 2025

prashantkumar1982 Jan 29, 2025

winder Jan 30, 2025

huangzhen1997 Jan 30, 2025

cl-sonarqube-production bot commented Jan 30, 2025

		// 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) {

		@@ -20,6 +20,10 @@ import (

		ccipcommon "github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/common"

		<<<<<<< HEAD

Implement extra args codec #16016

Implement extra args codec #16016

Conversation

huangzhen1997 commented Jan 21, 2025 • edited Loading

github-actions bot commented Jan 21, 2025

Flakeguard Summary

Found Flaky Tests ❌

Artifacts

github-actions bot commented Jan 21, 2025 • edited Loading

AER Report: CI Core ran successfully ✅

AER Report: Operator UI CI ran successfully ✅

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 21, 2025

Flakeguard Summary

Found Flaky Tests ❌

Artifacts

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cl-sonarqube-production bot commented Jan 30, 2025

Quality Gate passed

huangzhen1997 commented Jan 21, 2025 •

edited

Loading

github-actions bot commented Jan 21, 2025 •

edited

Loading