Extra Args encoding/decoding by andrejrakic · Pull Request #42 · smartcontractkit/ccip-javascript-sdk

andrejrakic · 2025-09-19T14:54:27Z

This PR implements encoding/decoding functionality for EVMExtraArgsV2 and SVMExtraArgsV1. To test it, run:

cd packages/ccip-svm && pnpm test

Copilot

Pull Request Overview

This PR implements encoding/decoding functionality for CCIP extra args targeting both EVM (EVMExtraArgsV2) and SVM (SVMExtraArgsV1) destinations. The implementation provides type-safe encoding/decoding with proper serialization formats for each chain type.

Adds EVM extra args V2 encoder/decoder using ABI encoding with gas limit and execution order configuration
Adds SVM extra args V1 encoder/decoder using Borsh-like serialization for Solana-specific parameters
Includes comprehensive test coverage for both implementations with round-trip validation

Reviewed Changes

Copilot reviewed 6 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
packages/ccip-svm/src/index.ts	Exports the new encoder modules
packages/ccip-svm/src/encoders/evmExtraArgsV2.ts	EVM extra args V2 encoding/decoding using ABI parameters
packages/ccip-svm/src/encoders/svmExtraArgsV1.ts	SVM extra args V1 encoding/decoding using Borsh-like serialization
packages/ccip-svm/src/tests/evmExtraArgsV2.test.ts	Comprehensive test suite for EVM extra args functionality
packages/ccip-svm/src/tests/svmExtraArgsV1.test.ts	Comprehensive test suite for SVM extra args functionality
packages/ccip-svm/package.json	Updates test script and adds vitest dependency

Files not reviewed (2)

packages/ccip-svm/package-lock.json: Language not supported
pnpm-lock.yaml: Language not supported

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

packages/ccip-svm/src/encoders/evmExtraArgsV2.ts

packages/ccip-svm/src/encoders/svmExtraArgsV1.ts

zeuslawyer

LGTM. Please consider the DevX angle /comments carefully before merging.

packages/ccip-svm/package.json

packages/ccip-svm/src/__tests__/evmExtraArgsV2.test.ts

packages/ccip-svm/src/encoders/svmExtraArgsV1.ts

packages/ccip-svm/src/encoders/evmExtraArgsV2.ts

packages/ccip-svm/src/encoders/svmExtraArgsV1.ts

zeuslawyer · 2025-09-22T01:50:26Z

packages/ccip-svm/src/encoders/svmExtraArgsV1.ts

+}
+
+/**
+ * Creates properly encoded extraArgs buffer for SVM destinations


Consider linking to docs or otherwise putting in some details into how the extraArgs are computed? many users of the SDK will not fully understand the operations within the implementation of the function so would help them to know where to 'study up' on this?

@andrejrakic to not be brittle for future versions should re link to one level higher in the docs tree? docs urls may change too

https://docs.chain.link/ccip/api-reference/svm instead of /v0.1.1 etc?

zeuslawyer · 2025-09-22T01:57:09Z

packages/ccip-svm/src/encoders/svmExtraArgsV1.ts

+    allowOutOfOrderExecution = true,
+    tokenReceiver,
+    accounts = []
+}: SVMExtraArgsV1): Uint8Array {


Just had a thought: To make this encodeFunction easier to use (in evm and SVM) should it return hex rather than Uint8Array? In the tests for example we have convert the value of expected into uint8Array
From a devx perspective will most people recognise hex more?

we could offer a utility (if needed by the SDK) to convert hex to Uint8Array but is there a better devx if encode/decode etc work with 0x-prefixed hexes to make it more familiar to users (including where uncaught exceptions arise etc?)

Or can we provide a util function to convert to human readable

Added hex utility functions to a new hex.ts file and update both implementation and test files to leverage it. Here's how one can use it:

// Convert bytes to hex const bytes = new Uint8Array([0x18, 0x1d, 0xcf, 0x10]) const hex = toHex(bytes) // "0x181dcf10" // Convert hex to bytes const bytes2 = fromHex("0x181dcf10") // Uint8Array([24, 29, 207, 16]) const bytes3 = fromHexBuffer("181dcf10") // Same result, using Buffer

…0% coverage. Add prettier and eslint

Copilot

Pull Request Overview

Copilot reviewed 12 out of 15 changed files in this pull request and generated 4 comments.

Files not reviewed (2)

packages/ccip-svm/package-lock.json: Language not supported
pnpm-lock.yaml: Language not supported

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-23T21:00:10Z

packages/ccip-svm/src/utils/hex.ts

+  const cleanHex = hex.startsWith('0x') ? hex.slice(2) : hex
+  return new Uint8Array(Buffer.from(cleanHex, 'hex'))


The fromHexBuffer function duplicates the hex cleaning logic from fromHex. Consider consolidating this logic or having fromHexBuffer call fromHex to avoid code duplication.

Suggested change

const cleanHex = hex.startsWith('0x') ? hex.slice(2) : hex

return new Uint8Array(Buffer.from(cleanHex, 'hex'))

return fromHex(hex)

@andrejrakic please consider

Copilot · 2025-09-23T21:00:11Z

packages/ccip-svm/src/encoders/svmExtraArgsV1.ts

+
+  // Serialize token_receiver ([u8; 32])
+  const encoder = getAddressEncoder()
+  const tokenReceiverBytes = tokenReceiver ? encoder.encode(tokenReceiver) : new Uint8Array(32) // Default/zero address


The magic number 32 should be defined as a named constant (e.g., ADDRESS_SIZE = 32) to improve code readability and maintainability.

@andrejrakic +1 to this

packages/ccip-svm/src/encoders/evmExtraArgsV2.ts

packages/ccip-svm/src/encoders/svmExtraArgsV1.ts

zeuslawyer

LGTM - minor comments + copilot suggestions. Merge when ready!

packages/ccip-svm/src/__tests__/evmExtraArgsV2.test.ts

zeuslawyer · 2025-09-22T08:34:24Z

packages/ccip-svm/src/encoders/svmExtraArgsV1.ts

+    allowOutOfOrderExecution = true,
+    tokenReceiver,
+    accounts = []
+}: SVMExtraArgsV1): Uint8Array {


Or can we provide a util function to convert to human readable

packages/ccip-svm/package.json

packages/ccip-svm/src/encoders/evmExtraArgsV2.ts

zeuslawyer · 2025-09-24T02:25:51Z

packages/ccip-svm/src/encoders/svmExtraArgsV1.ts

+}
+
+/**
+ * Creates properly encoded extraArgs buffer for SVM destinations


@andrejrakic to not be brittle for future versions should re link to one level higher in the docs tree? docs urls may change too

https://docs.chain.link/ccip/api-reference/svm instead of /v0.1.1 etc?

zeuslawyer · 2025-09-24T02:26:22Z

packages/ccip-svm/src/encoders/svmExtraArgsV1.ts

+
+  // Serialize token_receiver ([u8; 32])
+  const encoder = getAddressEncoder()
+  const tokenReceiverBytes = tokenReceiver ? encoder.encode(tokenReceiver) : new Uint8Array(32) // Default/zero address


@andrejrakic +1 to this

packages/ccip-svm/src/encoders/svmExtraArgsV1.ts

zeuslawyer · 2025-09-24T02:26:52Z

packages/ccip-svm/src/utils/hex.ts

+  const cleanHex = hex.startsWith('0x') ? hex.slice(2) : hex
+  return new Uint8Array(Buffer.from(cleanHex, 'hex'))


@andrejrakic please consider

zeuslawyer

LGTM

…gs, updating related tests and error messages

andrejrakic added 2 commits September 19, 2025 15:47

feat: implement EVM Extra Args V2 encoding and decoding

5083e86

feat: Add SVM Extra Args V1 encoding and decoding functionality

cba258c

andrejrakic self-assigned this Sep 19, 2025

andrejrakic requested a review from Copilot September 19, 2025 14:54

Copilot AI reviewed Sep 19, 2025

View reviewed changes

packages/ccip-svm/src/encoders/evmExtraArgsV2.ts Outdated Show resolved Hide resolved

packages/ccip-svm/src/encoders/svmExtraArgsV1.ts Outdated Show resolved Hide resolved

andrejrakic marked this pull request as ready for review September 19, 2025 14:55

andrejrakic requested review from a team, pappas999, thodges-gh and zeuslawyer as code owners September 19, 2025 14:55

product-security-plaid-test bot requested a review from michelemin September 19, 2025 14:55

andrejrakic changed the title ~~Extra Args encoding/decoding~~ DEVREL-172: Extra Args encoding/decoding Sep 19, 2025

andrejrakic changed the title ~~DEVREL-172: Extra Args encoding/decoding~~ Extra Args encoding/decoding Sep 19, 2025

fix: Remove unnecessary blank lines in decodeEVMExtraArgsV2 function

0a744a8

zeuslawyer approved these changes Sep 22, 2025

View reviewed changes

andrejrakic added 2 commits September 23, 2025 22:39

chore: refactor extraArgs tests to jest from vitest by keeping the 10…

0670d40

…0% coverage. Add prettier and eslint

feat: add hex utility functions

60ec5c5

andrejrakic requested a review from Copilot September 23, 2025 20:58

Copilot AI reviewed Sep 23, 2025

View reviewed changes

andrejrakic requested a review from zeuslawyer September 23, 2025 21:09

zeuslawyer approved these changes Sep 24, 2025

View reviewed changes

zeuslawyer approved these changes Sep 30, 2025

View reviewed changes

refactor: introduce minimum length constants for EVM and SVM Extra Ar…

1143e79

…gs, updating related tests and error messages

andrejrakic merged commit 2d71be4 into svm-main Oct 2, 2025
2 checks passed

andrejrakic deleted the 172/extra-args branch October 2, 2025 13:14

		const cleanHex = hex.startsWith('0x') ? hex.slice(2) : hex
		return new Uint8Array(Buffer.from(cleanHex, 'hex'))

	const cleanHex = hex.startsWith('0x') ? hex.slice(2) : hex
	return new Uint8Array(Buffer.from(cleanHex, 'hex'))
	return fromHex(hex)

Conversation

andrejrakic commented Sep 19, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

zeuslawyer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

zeuslawyer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zeuslawyer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants