Class: SolanaChain

Defined in: solana/index.ts:230

Solana chain implementation supporting Solana networks.

Provides methods for sending CCIP cross-chain messages, querying message status, fetching fee quotes, and manually executing pending messages on Solana networks.

Remarks

Solana uses CCIP v1.6+ protocol only.

Examples

Create from RPC URL

TypeScript

import { SolanaChain } from '@chainlink/ccip-sdk'

const chain = await SolanaChain.fromUrl('https://api.devnet.solana.com')
console.log(`Connected to: ${chain.network.name}`)

Query messages in a transaction

TypeScript

const requests = await chain.getMessagesInTx('5abc123...')
for (const req of requests) {
  console.log(`Message ID: ${req.message.messageId}`)
}

Extends

• Chain<typeof Solana>

Indexable

[key: symbol]: () => string

Constructors

Constructor

new SolanaChain(connection: Connection, network: NetworkInfo, ctx?: ChainContext): SolanaChain

Defined in: solana/index.ts:245

Creates a new SolanaChain instance.

Parameters

Parameter	Type	Description
connection	Connection	Solana connection instance.
network	NetworkInfo	Network information for this chain.
ctx?	ChainContext	-

Returns

SolanaChain

Overrides

Chain<typeof ChainFamily.Solana>.constructor

Properties

abort

readonly abort: AbortSignal

Defined in: chain.ts:890

Fires when the chain should tear down: either Chain.destroy was called, or the ChainContext abort signal fired. Listeners registered with { once: true } therefore self-unregister on whichever condition happens first, so no listener ever outlives its chain on a long-lived context.

Inherited from

Chain.abort

---

apiClient

readonly apiClient: CCIPAPIClient | null

Defined in: chain.ts:877

CCIP API client (null if opted out)

Inherited from

Chain.apiClient

---

apiRetryConfig

readonly apiRetryConfig: Required<ApiRetryConfig> | null

Defined in: chain.ts:879

Retry configuration for API fallback operations (null if API client is disabled)

Inherited from

Chain.apiRetryConfig

---

commitment

commitment: Commitment = 'confirmed'

Defined in: solana/index.ts:238

---

connection

connection: Connection

Defined in: solana/index.ts:237

---

destroy

destroy: (reason?: unknown) => void

Defined in: chain.ts:942

Cleanup method to release resources (e.g., close connections).

Parameters

Parameter	Type
reason?	unknown

Returns

void

Inherited from

Chain.destroy

---

logger

logger: Logger

Defined in: chain.ts:875

Inherited from

Chain.logger

---

network

readonly network: NetworkInfo<"SVM">

Defined in: chain.ts:874

Inherited from

Chain.network

---

verificationsIndexer?

readonly optional verificationsIndexer?: readonly string[]

Defined in: chain.ts:881

Default CCIP v2 indexer base URLs for getVerifications (undefined → network defaults)

Inherited from

Chain.verificationsIndexer

---

verifierTransport?

readonly optional verifierTransport?: VerifierTransport

Defined in: chain.ts:883

Transport for direct verifier reads (undefined → grpc-web over fetch)

Inherited from

Chain.verifierTransport

---

decimals

readonly static decimals: 9 = 9

Defined in: solana/index.ts:235

---

family

readonly static family: "SVM" = ChainFamily.Solana

Defined in: solana/index.ts:234

Methods

_fetchTokenMetadata()

_fetchTokenMetadata(mintPublicKey: PublicKey): Promise<{ name: string; symbol: string; } | null>

Defined in: solana/index.ts:956

Fetches token metadata from Metaplex.

Parameters

Parameter	Type	Description
mintPublicKey	PublicKey	Token mint public key.

Returns

Promise<{ name: string; symbol: string; } | null>

Token name and symbol, or null if not found.

---

_getRouterConfig()

_getRouterConfig(router: string): Promise<DecodeStruct<{ fields: [{ name: "version"; type: "u8"; }, { name: "defaultCodeVersion"; type: { defined: "CodeVersion"; }; }, { name: "svmChainSelector"; type: "u64"; }, { name: "owner"; type: "publicKey"; }, { name: "proposedOwner"; type: "publicKey"; }, { name: "feeQuoter"; type: "publicKey"; }, { name: "rmnRemote"; type: "publicKey"; }, { name: "linkTokenMint"; type: "publicKey"; }, { name: "feeAggregator"; type: "publicKey"; }]; kind: "struct"; }, RecursiveDepth4<[{ name: "RampMessageHeader"; type: { fields: [{ name: "messageId"; type: { array: ["u8", 32]; }; }, { name: "sourceChainSelector"; type: "u64"; }, { name: "destChainSelector"; type: "u64"; }, { name: "sequenceNumber"; type: "u64"; }, { name: "nonce"; type: "u64"; }]; kind: "struct"; }; }, { name: "SVM2AnyRampMessage"; type: { fields: [{ name: "header"; type: { defined: "RampMessageHeader"; }; }, { name: "sender"; type: "publicKey"; }, { name: "data"; type: "bytes"; }, { name: "receiver"; type: "bytes"; }, { name: "extraArgs"; type: "bytes"; }, { name: "feeToken"; type: "publicKey"; }, { name: "tokenAmounts"; type: { vec: { defined: "SVM2AnyTokenTransfer"; }; }; }, { name: "feeTokenAmount"; type: { defined: "CrossChainAmount"; }; }, { name: "feeValueJuels"; type: { defined: "CrossChainAmount"; }; }]; kind: "struct"; }; }, { name: "SVM2AnyTokenTransfer"; type: { fields: [{ name: "sourcePoolAddress"; type: "publicKey"; }, { name: "destTokenAddress"; type: "bytes"; }, { name: "extraData"; type: "bytes"; }, { name: "amount"; type: { defined: "CrossChainAmount"; }; }, { name: "destExecData"; type: "bytes"; }]; kind: "struct"; }; }], DecodedHelper<[{ name: "RampMessageHeader"; type: { fields: [{ name: "messageId"; type: { array: [..., ...]; }; }, { name: "sourceChainSelector"; type: "u64"; }, { name: "destChainSelector"; type: "u64"; }, { name: "sequenceNumber"; type: "u64"; }, { name: "nonce"; type: "u64"; }]; kind: "struct"; }; }, { name: "SVM2AnyRampMessage"; type: { fields: [{ name: "header"; type: { defined: "RampMessageHeader"; }; }, { name: "sender"; type: "publicKey"; }, { name: "data"; type: "bytes"; }, { name: "receiver"; type: "bytes"; }, { name: "extraArgs"; type: "bytes"; }, { name: "feeToken"; type: "publicKey"; }, { name: "tokenAmounts"; type: { vec: { defined: ...; }; }; }, { name: "feeTokenAmount"; type: { defined: "CrossChainAmount"; }; }, { name: "feeValueJuels"; type: { defined: "CrossChainAmount"; }; }]; kind: "struct"; }; }, { name: "SVM2AnyTokenTransfer"; type: { fields: [{ name: "sourcePoolAddress"; type: "publicKey"; }, { name: "destTokenAddress"; type: "bytes"; }, { name: "extraData"; type: "bytes"; }, { name: "amount"; type: { defined: "CrossChainAmount"; }; }, { name: "destExecData"; type: "bytes"; }]; kind: "struct"; }; }], DecodedHelper<[{ name: "RampMessageHeader"; type: { fields: [{ name: "messageId"; type: { array: ...; }; }, { name: "sourceChainSelector"; type: "u64"; }, { name: "destChainSelector"; type: "u64"; }, { name: "sequenceNumber"; type: "u64"; }, { name: "nonce"; type: "u64"; }]; kind: "struct"; }; }, { name: "SVM2AnyRampMessage"; type: { fields: [{ name: "header"; type: { defined: ...; }; }, { name: "sender"; type: "publicKey"; }, { name: "data"; type: "bytes"; }, { name: "receiver"; type: "bytes"; }, { name: "extraArgs"; type: "bytes"; }, { name: "feeToken"; type: "publicKey"; }, { name: "tokenAmounts"; type: { vec: ...; }; }, { name: "feeTokenAmount"; type: { defined: ...; }; }, { name: "feeValueJuels"; type: { defined: ...; }; }]; kind: "struct"; }; }, { name: "SVM2AnyTokenTransfer"; type: { fields: [{ name: "sourcePoolAddress"; type: "publicKey"; }, { name: "destTokenAddress"; type: "bytes"; }, { name: "extraData"; type: "bytes"; }, { name: "amount"; type: { defined: ...; }; }, { name: "destExecData"; type: "bytes"; }]; kind: "struct"; }; }], DecodedHelper<[{ name: "RampMessageHeader"; type: { fields: [{ name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }]; kind: "struct"; }; }, { name: "SVM2AnyRampMessage"; type: { fields: [{ name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }]; kind: "struct"; }; }, { name: "SVM2AnyTokenTransfer"; type: { fields: [{ name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }]; kind: "struct"; }; }], EmptyDefined>>>>>>

Defined in: solana/index.ts:2225

Gets the router configuration from the Config PDA.

Parameters

Parameter	Type	Description
router	string	Router program address.

Returns

Promise<DecodeStruct<{ fields: [{ name: "version"; type: "u8"; }, { name: "defaultCodeVersion"; type: { defined: "CodeVersion"; }; }, { name: "svmChainSelector"; type: "u64"; }, { name: "owner"; type: "publicKey"; }, { name: "proposedOwner"; type: "publicKey"; }, { name: "feeQuoter"; type: "publicKey"; }, { name: "rmnRemote"; type: "publicKey"; }, { name: "linkTokenMint"; type: "publicKey"; }, { name: "feeAggregator"; type: "publicKey"; }]; kind: "struct"; }, RecursiveDepth4<[{ name: "RampMessageHeader"; type: { fields: [{ name: "messageId"; type: { array: ["u8", 32]; }; }, { name: "sourceChainSelector"; type: "u64"; }, { name: "destChainSelector"; type: "u64"; }, { name: "sequenceNumber"; type: "u64"; }, { name: "nonce"; type: "u64"; }]; kind: "struct"; }; }, { name: "SVM2AnyRampMessage"; type: { fields: [{ name: "header"; type: { defined: "RampMessageHeader"; }; }, { name: "sender"; type: "publicKey"; }, { name: "data"; type: "bytes"; }, { name: "receiver"; type: "bytes"; }, { name: "extraArgs"; type: "bytes"; }, { name: "feeToken"; type: "publicKey"; }, { name: "tokenAmounts"; type: { vec: { defined: "SVM2AnyTokenTransfer"; }; }; }, { name: "feeTokenAmount"; type: { defined: "CrossChainAmount"; }; }, { name: "feeValueJuels"; type: { defined: "CrossChainAmount"; }; }]; kind: "struct"; }; }, { name: "SVM2AnyTokenTransfer"; type: { fields: [{ name: "sourcePoolAddress"; type: "publicKey"; }, { name: "destTokenAddress"; type: "bytes"; }, { name: "extraData"; type: "bytes"; }, { name: "amount"; type: { defined: "CrossChainAmount"; }; }, { name: "destExecData"; type: "bytes"; }]; kind: "struct"; }; }], DecodedHelper<[{ name: "RampMessageHeader"; type: { fields: [{ name: "messageId"; type: { array: [..., ...]; }; }, { name: "sourceChainSelector"; type: "u64"; }, { name: "destChainSelector"; type: "u64"; }, { name: "sequenceNumber"; type: "u64"; }, { name: "nonce"; type: "u64"; }]; kind: "struct"; }; }, { name: "SVM2AnyRampMessage"; type: { fields: [{ name: "header"; type: { defined: "RampMessageHeader"; }; }, { name: "sender"; type: "publicKey"; }, { name: "data"; type: "bytes"; }, { name: "receiver"; type: "bytes"; }, { name: "extraArgs"; type: "bytes"; }, { name: "feeToken"; type: "publicKey"; }, { name: "tokenAmounts"; type: { vec: { defined: ...; }; }; }, { name: "feeTokenAmount"; type: { defined: "CrossChainAmount"; }; }, { name: "feeValueJuels"; type: { defined: "CrossChainAmount"; }; }]; kind: "struct"; }; }, { name: "SVM2AnyTokenTransfer"; type: { fields: [{ name: "sourcePoolAddress"; type: "publicKey"; }, { name: "destTokenAddress"; type: "bytes"; }, { name: "extraData"; type: "bytes"; }, { name: "amount"; type: { defined: "CrossChainAmount"; }; }, { name: "destExecData"; type: "bytes"; }]; kind: "struct"; }; }], DecodedHelper<[{ name: "RampMessageHeader"; type: { fields: [{ name: "messageId"; type: { array: ...; }; }, { name: "sourceChainSelector"; type: "u64"; }, { name: "destChainSelector"; type: "u64"; }, { name: "sequenceNumber"; type: "u64"; }, { name: "nonce"; type: "u64"; }]; kind: "struct"; }; }, { name: "SVM2AnyRampMessage"; type: { fields: [{ name: "header"; type: { defined: ...; }; }, { name: "sender"; type: "publicKey"; }, { name: "data"; type: "bytes"; }, { name: "receiver"; type: "bytes"; }, { name: "extraArgs"; type: "bytes"; }, { name: "feeToken"; type: "publicKey"; }, { name: "tokenAmounts"; type: { vec: ...; }; }, { name: "feeTokenAmount"; type: { defined: ...; }; }, { name: "feeValueJuels"; type: { defined: ...; }; }]; kind: "struct"; }; }, { name: "SVM2AnyTokenTransfer"; type: { fields: [{ name: "sourcePoolAddress"; type: "publicKey"; }, { name: "destTokenAddress"; type: "bytes"; }, { name: "extraData"; type: "bytes"; }, { name: "amount"; type: { defined: ...; }; }, { name: "destExecData"; type: "bytes"; }]; kind: "struct"; }; }], DecodedHelper<[{ name: "RampMessageHeader"; type: { fields: [{ name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }]; kind: "struct"; }; }, { name: "SVM2AnyRampMessage"; type: { fields: [{ name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }]; kind: "struct"; }; }, { name: "SVM2AnyTokenTransfer"; type: { fields: [{ name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }, { name: ...; type: ...; }]; kind: "struct"; }; }], EmptyDefined>>>>>>

Router configuration including feeQuoter.

---

cleanUpBuffers()

cleanUpBuffers(opts: { waitDeactivation?: boolean; wallet: unknown; }): Promise<void>

Defined in: solana/index.ts:1590

Clean up and recycle buffers and address lookup tables owned by wallet

Parameters

Parameter	Type	Description
opts	{ waitDeactivation?: boolean; wallet: unknown; }	cleanUp options - wallet - wallet instance to sign txs - waitDeactivation - Whether to wait for lookup table deactivation cool down period (513 slots) to pass before closing; by default, we deactivate (if needed) and move on, to close other ready ALTs
opts.waitDeactivation?	boolean	-
opts.wallet	unknown	-

Returns

Promise<void>

Throws

CCIPWalletInvalidError if wallet is not a valid Solana wallet

---

estimateReceiveExecution()

estimateReceiveExecution(opts: { message: Omit<EstimateMessageInput, "onRampAddress" | "offRampAddress">; offRamp: string; } | { messageId: string; }): Promise<number>

Defined in: solana/index.ts:1527

Estimate ccipReceive execution cost (gas, computeUnits) for this destination chain.

Parameters

Parameter	Type	Description
opts	{ message: Omit<EstimateMessageInput, "onRampAddress" | "offRampAddress">; offRamp: string; } | { messageId: string; }	Either: - { offRamp, message } — estimate from message fields directly. message must include sourceChainSelector, messageId, receiver, and optionally sender, data, destTokenAmounts. - { messageId } — fetch the message from the CCIP API via getMessageById, resolve the offRamp from the message metadata or getExecutionInput, then estimate. Requires apiClient to be available.

Returns

Promise<number>

Estimated execution cost (gas for EVM, compute units for Solana)

Overrides

Chain.estimateReceiveExecution

---

execute()

execute(opts: ExecuteOpts & { wallet: unknown; } & { clearLeftoverAccounts?: boolean; waitDeactivation?: boolean; }): Promise<CCIPExecution>

Defined in: solana/index.ts:1471

Execute messages in report in an offRamp.

Parameters

Parameter	Type	Description
opts	ExecuteOpts & { wallet: unknown; } & { clearLeftoverAccounts?: boolean; waitDeactivation?: boolean; }	ExecuteOpts with chain-specific wallet to sign and send tx.

Returns

Promise<CCIPExecution>

Promise resolving to transaction of the execution.

Throws

CCIPWalletInvalidError if wallet is not a valid Solana wallet

Throws

CCIPPartialTransactionSubmissionError if a transaction fails after earlier ones (e.g. buffering) confirmed, and no retry strategy is left

Overrides

Chain.execute

---

fetchCCVResults()

protected fetchCCVResults(messageId: string, policy: VerificationPolicy, opts: { indexer?: NetworkType | readonly string[]; offRamp: string; request: { lane: { destChainSelector: bigint; onRamp: string; sourceChainSelector: bigint; version: CCIPVersion; }; log: { blockTimestamp: number; }; message: { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; }; }; } & VerificationSourcesOpts & Pick<LogFilter, "startBlock" | "watch" | "page">): Promise<VerifierResult[]>

Defined in: chain.ts:1983

Collect a CCIP v2.0 message's CCV results against the destination policy, from every source: opts.ccvData, then the CCIP API raced against the indexers, then opts.verifiers (read via ChainContext.verifierTransport). For families' getVerifications implementations.

Parameters

Parameter	Type	Description
messageId	string	The message id
policy	VerificationPolicy	This destination's CCV policy for the message
opts	{ indexer?: NetworkType | readonly string[]; offRamp: string; request: { lane: { destChainSelector: bigint; onRamp: string; sourceChainSelector: bigint; version: CCIPVersion; }; log: { blockTimestamp: number; }; message: { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; }; }; } & VerificationSourcesOpts & Pick<LogFilter, "startBlock" | "watch" | "page">	The getVerifications options

Returns

Promise<VerifierResult[]>

The results covering policy

Throws

CCIPMessageNotVerifiedYetError if the sources can't cover policy

Inherited from

Chain.fetchCCVResults

---

generateUnsignedExecute()

generateUnsignedExecute(__namedParameters: ExecuteOpts & { payer: string; }): Promise<UnsignedSolanaTx>

Defined in: solana/index.ts:1443

Generate unsigned tx to manuallyExecute a message.

Parameters

Parameter	Type	Description
__namedParameters	ExecuteOpts & { payer: string; }	ExecuteOpts with payer address which will send the exec tx

Returns

Promise<UnsignedSolanaTx>

Promise resolving to chain-family specific unsigned txs

Throws

CCIPExecutionReportChainMismatchError if message is not a Solana message

Overrides

Chain.generateUnsignedExecute

---

generateUnsignedSendMessage()

generateUnsignedSendMessage(opts: SendMessageOpts & { sender: string; }): Promise<UnsignedSolanaTx>

Defined in: solana/index.ts:1388

Generate unsigned txs for ccipSend'ing a message.

Parameters

Parameter	Type	Description
opts	SendMessageOpts & { sender: string; }	SendMessageOpts with sender address

Returns

Promise<UnsignedSolanaTx>

Promise resolving to chain-family specific unsigned txs

Overrides

Chain.generateUnsignedSendMessage

---

getBalance()

getBalance(opts: GetBalanceOpts): Promise<bigint>

Defined in: solana/index.ts:930

Query token balance for an address.

Parameters

Parameter	Type	Description
opts	GetBalanceOpts	Balance query options

Returns

Promise<bigint>

Token balance information including raw and formatted values

Throws

CCIPTokenAccountNotFoundError if token account not found

Overrides

Chain.getBalance

---

getBlockInfo()

getBlockInfo(block: number | "finalized" | "latest"): Promise<BlockInfo>

Defined in: solana/index.ts:382

Fetch info (number and timestamp) for a given block or finality tag.

Parameters

Parameter	Type	Description
block	number | "finalized" | "latest"	Block number, or tag like 'finalized' or 'latest'

Returns

Promise<BlockInfo>

Block info with number and timestamp

Throws

CCIPBlockTimeNotFoundError if block time cannot be retrieved

Overrides

Chain.getBlockInfo

---

getBlockTimestamp()

getBlockTimestamp(block: number | bigint | "finalized" | "latest"): Promise<number>

Defined in: chain.ts:971

Fetch the timestamp of a given block.

Parameters

Parameter	Type	Description
block	number | bigint | "finalized" | "latest"	Block number or finality tag

Returns

Promise<number>

Unix timestamp in seconds

Deprecated

Use Chain.getBlockInfo instead.

Inherited from

Chain.getBlockTimestamp

---

getExecutionInput()

getExecutionInput(opts: { request: CCIPRequest; verifications: CCIPVerifications; } & Pick<LogFilter, "page">): Promise<ExecutionInput>

Defined in: chain.ts:1240

Fetch input data needed for executing messages Should be called on the source instance

Parameters

Parameter	Type	Description
opts	{ request: CCIPRequest; verifications: CCIPVerifications; } & Pick<LogFilter, "page">	getExecutionInput options containing request and verifications

Returns

Promise<ExecutionInput>

input payload to be passed to execute

See

execute - method to execute a message

Inherited from

Chain.getExecutionInput

---

getExecutionReceipts()

getExecutionReceipts(opts: { messageId?: string; offRamp: string; sequenceNumber?: bigint; sourceChainSelector?: bigint; verifications?: CCIPVerifications; } & Pick<LogFilter, "startBlock" | "startTime" | "watch" | "page" | "since">): AsyncIterableIterator<CCIPExecution>

Defined in: solana/index.ts:1846

Default/generic implementation of getExecutionReceipts. Yields execution receipts for a given offRamp.

Parameters

Parameter	Type	Description
opts	{ messageId?: string; offRamp: string; sequenceNumber?: bigint; sourceChainSelector?: bigint; verifications?: CCIPVerifications; } & Pick<LogFilter, "startBlock" | "startTime" | "watch" | "page" | "since">	getExecutionReceipts options

Returns

AsyncIterableIterator<CCIPExecution>

Async generator of CCIPExecution receipts

Overrides

Chain.getExecutionReceipts

---

getFee()

getFee(opts: Omit<SendMessageOpts, "approveMax">): Promise<bigint>

Defined in: solana/index.ts:1375

Fetch the current fee for a given intended message.

Parameters

Parameter	Type	Description
opts	Omit<SendMessageOpts, "approveMax">	SendMessageOpts without approveMax

Returns

Promise<bigint>

Fee amount in the feeToken's smallest units

Overrides

Chain.getFee

---

getFeeTokens()

getFeeTokens(router: string): Promise<Record<string, TokenInfo>>

Defined in: solana/index.ts:2159

Fetch list and info of supported feeTokens.

Parameters

Parameter	Type	Description
router	string	Router address on this chain

Returns

Promise<Record<string, TokenInfo>>

Promise resolving to mapping of token addresses to TokenInfo objects

Overrides

Chain.getFeeTokens

---

getLaneFeatures()

getLaneFeatures(opts: { destChainSelector: bigint; router: string; token?: string; }): Promise<Partial<LaneFeatures>>

Defined in: chain.ts:2089

Retrieve features for a lane (router/destChainSelector/token triplet).

Parameters

Parameter	Type
opts	{ destChainSelector: bigint; router: string; token?: string; }
opts.destChainSelector	bigint
opts.router	string
opts.token?	string

Returns

Promise<Partial<LaneFeatures>>

Promise resolving to partial lane features record

Throws

CCIPNotImplementedError if not implemented for this chain family

Example

Get lane features

TypeScript

const features = await chain.getLaneFeatures({
  router: '0x...',
  destChainSelector: 4949039107694359620n,
})
// FINALITY_FAST has three states:
// - undefined: FTF is not supported on this lane (pre-v2.0)
// - 0: the lane supports FTF, but it is not enabled for this token
// - > 0: FTF is enabled with this many block confirmations
const ftf = features[LaneFeature.FINALITY_FAST]
if (ftf != null && ftf > 0) {
  console.log(`FTF enabled with ${ftf} block confirmations`)
} else if (ftf === 0) {
  console.log('FTF supported on this lane but not enabled for this token')
}

Inherited from

Chain.getLaneFeatures

---

getLaneLatency()

getLaneLatency(destChainSelector: bigint, numberOfBlocks?: number): Promise<LaneLatencyResponse>

Defined in: chain.ts:2048

Fetches estimated lane latency to a destination chain. Uses this chain's selector as the source.

Parameters

Parameter	Type	Description
destChainSelector	bigint	Destination CCIP chain selector (bigint)
numberOfBlocks?	number	Optional number of block confirmations to use for latency calculation. When omitted or 0, uses the lane's default finality. When provided as a positive integer, the API returns latency for that custom finality value.

Returns

Promise<LaneLatencyResponse>

Promise resolving to LaneLatencyResponse containing:

• totalMs - Estimated delivery time in milliseconds

Throws

CCIPApiClientNotAvailableError if apiClient was disabled (set to null)

Throws

CCIPLaneLatencyInsufficientDataError if the API has too little history for the lane

Throws

CCIPHttpError if API request fails (network error, 4xx, 5xx status)

Remarks

Each call makes a fresh API request. Consider caching results if making frequent calls for the same lane.

Examples

Get estimated delivery time

TypeScript

const chain = await EVMChain.fromUrl('https://eth-mainnet.example.com')
try {
  const latency = await chain.getLaneLatency(4949039107694359620n) // Arbitrum
  console.log(`Estimated delivery: ${Math.round(latency.totalMs / 60000)} minutes`)
} catch (err) {
  if (err instanceof CCIPHttpError) {
    console.error(`API error: ${err.context.apiErrorCode}`)
  }
}

Get latency with custom block confirmations

TypeScript

const latency = await chain.getLaneLatency(4949039107694359620n, 10)
console.log(`Latency with 10 confirmations: ${Math.round(latency.totalMs / 60000)} minutes`)

Inherited from

Chain.getLaneLatency

---

getLogs()

getLogs(opts: { address?: string; endBefore?: string; endBlock?: number | bigint | "finalized" | "latest"; page?: number | bigint; since?: { blockTimestamp?: number | bigint; }; startBlock?: number | bigint; startTime?: number | bigint; topics?: (string | string[] | null)[]; typeAndVersions?: readonly (string | RegExp)[]; watch?: boolean | AbortSignal; } & { programs?: true | string[]; }): AsyncGenerator<SolanaLog>

Defined in: solana/index.ts:497

Retrieves logs from Solana transactions with enhanced chronological ordering.

Behavior:

• If opts.startBlock or opts.startTime is provided:

  • Fetches ALL signatures for the address going back in time
  • Continues fetching until finding signatures older than the start target
  • Filters out signatures older than start criteria
  • Returns logs in chronological order (oldest first)

• If opts.startBlock and opts.startTime are omitted:

  • Uses slot 0 as the forward start for non-watch queries

Parameters

Parameter	Type	Description
opts	{ address?: string; endBefore?: string; endBlock?: number | bigint | "finalized" | "latest"; page?: number | bigint; since?: { blockTimestamp?: number | bigint; }; startBlock?: number | bigint; startTime?: number | bigint; topics?: (string | string[] | null)[]; typeAndVersions?: readonly (string | RegExp)[]; watch?: boolean | AbortSignal; } & { programs?: true | string[]; }	Log filter options containing: - startBlock: Starting slot number (inclusive) Solana's special case: if startBlock=0, fetch only one page of getSignaturesForAddress - startTime: Starting Unix timestamp (inclusive) - endBlock: Ending slot number (inclusive) - endBefore: Fetch signatures before this transaction - address: Program address to filter logs by (required for Solana) - topics: Array of topics to filter logs by (optional); either 0x-8B discriminants or event names - watch: Watch for new logs - programs: Special option to allow querying by address of interest, but yielding matching logs from specific (string address) program or any (true)

Returns

AsyncGenerator<SolanaLog>

AsyncIterableIterator of parsed ChainLog objects.

Throws

CCIPLogsAddressRequiredError if address is not provided

Throws

CCIPTopicsInvalidError if topics contain invalid values

Overrides

Chain.getLogs

---

getMessageById()

getMessageById(messageId: string, _opts?: { onRamp?: string; page?: number; }): Promise<CCIPRequest<CCIPVersion>>

Defined in: chain.ts:1188

Fetch a CCIP message by its unique message ID.

Parameters

Parameter	Type	Description
messageId	string	The unique message ID (0x + 64 hex chars)
_opts?	{ onRamp?: string; page?: number; }	Optional: onRamp hint for non-EVM chains
_opts.onRamp?	string	-
_opts.page?	number	-

Returns

Promise<CCIPRequest<CCIPVersion>>

CCIPRequest with metadata populated from API

Remarks

Uses the CCIP API to retrieve message details. The returned request includes a metadata field with API-specific information.

Example

TypeScript

const request = await chain.getMessageById(messageId)
console.log(`Sender: ${request.message.sender}`)

if (request.metadata) {
  console.log(`Status: ${request.metadata.status}`)
  if (request.metadata.deliveryTime) {
    console.log(`Delivered in ${request.metadata.deliveryTime}ms`)
  }
}

Throws

CCIPApiClientNotAvailableError if API disabled

Throws

CCIPMessageIdNotFoundError if message not found

Throws

CCIPOnRampRequiredError if onRamp is required but not provided

Throws

CCIPHttpError if API request fails

Inherited from

Chain.getMessageById

---

getMessagesInBatch()

getMessagesInBatch<R extends { lane: { destChainSelector: bigint; onRamp: string; sourceChainSelector: bigint; version: CCIPVersion; }; log: { blockTimestamp: number; }; message: { sequenceNumber: bigint; } | { sequenceNumber: bigint; } | { sequenceNumber: bigint; } | { sequenceNumber: bigint; } | { sequenceNumber: bigint; } | { sequenceNumber: bigint; }; }>(request: R, range: Pick<CommitReport, "minSeqNr" | "maxSeqNr">, opts?: Pick<LogFilter, "page">): Promise<R["message"][]>

Defined in: solana/index.ts:561

Fetches all CCIP messages contained in a given commit batch. To be implemented for chains supporting CCIPVersion v1.6.0 and earlier

Type Parameters

Type Parameter	Description
R extends { lane: { destChainSelector: bigint; onRamp: string; sourceChainSelector: bigint; version: CCIPVersion; }; log: { blockTimestamp: number; }; message: { sequenceNumber: bigint; } | { sequenceNumber: bigint; } | { sequenceNumber: bigint; } | { sequenceNumber: bigint; } | { sequenceNumber: bigint; } | { sequenceNumber: bigint; }; }

Parameters

Parameter	Type	Description
request	R	CCIPRequest to fetch batch for
range	Pick<CommitReport, "minSeqNr" | "maxSeqNr">	batch range { minSeqnr, maxSeqNr }, e.g. from CommitReport
opts?	Pick<LogFilter, "page">	Optional parameters (e.g., page for pagination width)

Returns

Promise<R["message"][]>

Array of messages in the batch

Overrides

Chain.getMessagesInBatch

---

getMessagesInRange()

getMessagesInRange(opts: { address?: string; endBefore?: string; endBlock?: number | bigint | "finalized" | "latest"; page?: number | bigint; since?: { blockTimestamp?: number | bigint; }; startBlock?: number | bigint; startTime?: number | bigint; topics?: (string | string[] | null)[]; typeAndVersions?: readonly (string | RegExp)[]; watch?: boolean | AbortSignal; }): AsyncIterableIterator<CCIPRequest<CCIPVersion>>

Defined in: chain.ts:1154

Discover and decode CCIP messages within a block/slot/checkpoint range.

Parameters

Parameter	Type	Description
opts	{ address?: string; endBefore?: string; endBlock?: number | bigint | "finalized" | "latest"; page?: number | bigint; since?: { blockTimestamp?: number | bigint; }; startBlock?: number | bigint; startTime?: number | bigint; topics?: (string | string[] | null)[]; typeAndVersions?: readonly (string | RegExp)[]; watch?: boolean | AbortSignal; }	LogFilter options (startBlock, endBlock, address, topics, page)
opts.address?	string	Contract address to filter logs by.
opts.endBefore?	string	Cursor hint for the exclusive upper end of iteration on chains that support it.
opts.endBlock?	number | bigint | "finalized" | "latest"	Ending block number (inclusive).
opts.page?	number | bigint	Page size for pagination.
opts.since?	{ blockTimestamp?: number | bigint; }	Resume hint: the last log emitted by a previous getLogs call on the same address/filter. Any subset of fields may be provided; each chain uses what it can. Two layers of behavior: 1. Start floors (ALL chains — see withSinceStart): blockNumber and blockTimestamp stand in for startBlock/startTime — each effective floor is the LARGER of the explicitly requested bound and the hint's — so a since carrying either satisfies the start requirement on its own. Blocks/versions are always fetched and emitted complete. 2. Block completeness: all chains implementations must guarantee all logs in some block are yielded in the same call before it returns. 3. Exclusive resume (chains with a native per-log cursor): the hinted log itself is NOT re-emitted, and other logs in the same block/tx may also not be; some chains may attempt to yield logs in the same block or transaction, but from 2., the contract guarantees only that logs from the next block or tx on are emitted, so for an hermetic poller, it's safer to only ever pass the last finalized log in the previous call as since hint. The hint only ever RAISES the start floors — startBlock is the scan floor (the scan never starts below it) and, when a startBlock exists, startTime is evaluated at filter-time just before emitting. A stale, foreign or malformed hint may be ignored (the usual walk runs). At-least-once is the only guarantee all families share: dedupe by (transactionHash, index). Cursors are FILTER-SCOPED: a hint produced by a NARROWER filter must never be replayed on a wider one. Where the cursor is a per-block prefix (EVM), the wider filter's earlier-index logs in the hinted block count as already emitted and are SKIPPED — a loss, not a duplicate. The SDK cannot validate this: the hint carries the log's own topics, never the breadth of the filter that produced it, so a wide sweep and a narrow one over the same block hand out a byte-identical hint while requiring opposite resume behavior (an address mismatch IS detectable and is rejected; a topic-subset resume is not). Key each cursor by the filter that produced it, and start a new filter from its own startBlock. Per-family resume — EVM/Solana/TON: the hinted block/tx streams whole and logs at/before the hinted index are skipped (later same-block/same-tx logs still flow; TON floors its v3 /messages fast path at the hint's created_lt). Aptos: event index on single-topic streams, blockNumber + 1 on multi-topic ones. Sui: inclusive checkpoint floors (re-delivered). Canton: unsupported.
opts.since.blockTimestamp?	number | bigint	-
opts.startBlock?	number | bigint	Starting block number (inclusive). Required unless startTime is provided; explicit 0 is allowed.
opts.startTime?	number | bigint	Starting Unix timestamp (inclusive).
opts.topics?	(string | string[] | null)[]	Topics to filter logs by.
opts.typeAndVersions?	readonly (string | RegExp)[]	Restrict logs to contracts whose Chain.typeAndVersion matches any of these. Useful when filtering by topic alone (no address) would otherwise match logs from many unrelated contract types — e.g. ConfigSet is emitted by OnRamp, OffRamp, CommitStore, FeeQuoter, TokenPool, and PriceRegistry alike. Pass e.g. ['OnRamp'] to keep only on-ramps. See passesTypeAndVersion for the exact matching rule. undefined/empty means no restriction (default), and costs nothing — typeAndVersion is never called.
opts.watch?	boolean | AbortSignal	watch mode: polls for new logs after fetching since start (required), until endBlock finality tag (e.g. endBlock=finalized polls only finalized logs); can be an AbortSignal to cancel loop

Returns

AsyncIterableIterator<CCIPRequest<CCIPVersion>>

Async iterator of CCIPRequest objects in native log order

Remarks

This is the range-scanning equivalent of getMessagesInTx. Results are yielded in native log order (block number + log index for EVM, slot order for Solana). Non-CCIP logs in the range are silently skipped.

On Solana, the address parameter is required (router program address). On EVM, it is optional but recommended for public RPCs that require address filtering.

Throws

CCIPChainFamilyUnsupportedError if a pre-v1.6 message is found on a non-EVM chain

Throws

CCIPLogsAddressRequiredError on Solana if address is not provided (thrown by underlying Chain.getLogs)

See

• getMessagesInBatch - Batch discovery by sequence number range
• getMessagesInTx - Per-transaction message discovery

Example

Scan a block range on EVM

TypeScript

for await (const request of chain.getMessagesInRange({
  startBlock: 1000000,
  endBlock: 1001000,
  address: '0xOnRampAddress...', // optional on EVM
})) {
  console.log(`seqNr=${request.message.sequenceNumber} dest=${request.lane.destChainSelector}`)
}

Inherited from

Chain.getMessagesInRange

---

getMessagesInTx()

getMessagesInTx(tx: string | ChainTransaction): Promise<CCIPRequest<CCIPVersion>[]>

Defined in: chain.ts:1095

Fetch all CCIP requests in a transaction.

Parameters

Parameter	Type	Description
tx	string | ChainTransaction	ChainTransaction or txHash to fetch requests from

Returns

Promise<CCIPRequest<CCIPVersion>[]>

Promise resolving to CCIP messages in the transaction (at least one)

Throws

CCIPTransactionNotFoundError if transaction does not exist

Throws

CCIPMessageNotFoundInTxError if no CCIPSendRequested events in tx

Example

Get messages from transaction

TypeScript

const chain = await EVMChain.fromUrl('https://eth-mainnet.example.com')
const requests = await chain.getMessagesInTx('0xabc123...')
for (const req of requests) {
  console.log(`Message ID: ${req.message.messageId}`)
}

Inherited from

Chain.getMessagesInTx

---

getNativeTokenForRouter()

getNativeTokenForRouter(_router: string): Promise<string>

Defined in: solana/index.ts:768

Get the native token address for a Router.

Parameters

Parameter	Type	Description
_router	string	Router contract address

Returns

Promise<string>

Promise resolving to native token address (usually wrapped)

Overrides

Chain.getNativeTokenForRouter

---

getOffchainTokenData()

getOffchainTokenData(request: { log: { }; message: { ccipReceiveGasLimit: number; ccvAndExecutorHash: string; data: string; destBlob: string; destChainSelector: bigint; encodedMessage: string; executionGasLimit: number; feeToken: string; feeTokenAmount: bigint; finality: FinalityRequested; messageId: string; messageNumber: bigint; offRampAddress: string; onRampAddress: string; receipts: readonly { destBytesOverhead: bigint; destGasLimit: bigint; extraArgs: string; feeTokenAmount: bigint; issuer: string; }[]; receiver: string; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; tokenAmountBeforeTokenPoolFees: bigint; tokenAmounts: readonly { amount: bigint; destTokenAddress: string; extraData: string; sourcePoolAddress: string; sourceTokenAddress: string; tokenReceiver: string; }[]; verifierBlobs: readonly string[]; } | { data: string; feeToken: string; feeTokenAmount: bigint; gasLimit: bigint; messageId: string; nonce: bigint; receiver: string; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; sourceTokenData: readonly string[]; strict: boolean; tokenAmounts: readonly { amount: bigint; token: string; }[]; } | { data: string; feeToken: string; feeTokenAmount: bigint; gasLimit: bigint; messageId: string; nonce: bigint; receiver: string; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; sourceTokenData: readonly string[]; strict: boolean; tokenAmounts: readonly { amount: bigint; destGasAmount: bigint; destTokenAddress: string; extraData: string; sourcePoolAddress: string; token: string; }[]; } | { allowOutOfOrderExecution: boolean; data: string; destChainSelector: bigint; extraArgs: string; feeToken: string; feeTokenAmount: bigint; feeValueJuels: bigint; gasLimit: bigint; messageId: string; nonce: bigint; receiver: string; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; tokenAmounts: readonly { amount: bigint; destExecData: string; destGasAmount: bigint; destTokenAddress: string; extraData: string; sourcePoolAddress: string; }[]; } | { accountIsWritableBitmap: bigint; accounts: string[]; allowOutOfOrderExecution: boolean; computeUnits: bigint; data: string; destChainSelector: bigint; extraArgs: string; feeToken: string; feeTokenAmount: bigint; feeValueJuels: bigint; messageId: string; nonce: bigint; receiver: string; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; tokenAmounts: readonly { amount: bigint; destExecData: string; destGasAmount: bigint; destTokenAddress: string; extraData: string; sourcePoolAddress: string; }[]; tokenReceiver: string; } | { allowOutOfOrderExecution: boolean; data: string; destChainSelector: bigint; extraArgs: string; feeToken: string; feeTokenAmount: bigint; feeValueJuels: bigint; gasLimit: bigint; messageId: string; nonce: bigint; receiver: string; receiverObjectIds: string[]; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; tokenAmounts: readonly { amount: bigint; destExecData: string; destGasAmount: bigint; destTokenAddress: string; extraData: string; sourcePoolAddress: string; }[]; tokenReceiver: string; }; }): Promise<OffchainTokenData[]>

Defined in: chain.ts:1734

Fetch supported offchain token data for a request from this network. It logs but doesn't throw in case it can't fetch attestation, as the transfers may not be from the expected attestation providers. It returns default offchainData=undefined for those.

Parameters

Parameter	Type	Description
request	{ log: { }; message: { ccipReceiveGasLimit: number; ccvAndExecutorHash: string; data: string; destBlob: string; destChainSelector: bigint; encodedMessage: string; executionGasLimit: number; feeToken: string; feeTokenAmount: bigint; finality: FinalityRequested; messageId: string; messageNumber: bigint; offRampAddress: string; onRampAddress: string; receipts: readonly { destBytesOverhead: bigint; destGasLimit: bigint; extraArgs: string; feeTokenAmount: bigint; issuer: string; }[]; receiver: string; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; tokenAmountBeforeTokenPoolFees: bigint; tokenAmounts: readonly { amount: bigint; destTokenAddress: string; extraData: string; sourcePoolAddress: string; sourceTokenAddress: string; tokenReceiver: string; }[]; verifierBlobs: readonly string[]; } | { data: string; feeToken: string; feeTokenAmount: bigint; gasLimit: bigint; messageId: string; nonce: bigint; receiver: string; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; sourceTokenData: readonly string[]; strict: boolean; tokenAmounts: readonly { amount: bigint; token: string; }[]; } | { data: string; feeToken: string; feeTokenAmount: bigint; gasLimit: bigint; messageId: string; nonce: bigint; receiver: string; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; sourceTokenData: readonly string[]; strict: boolean; tokenAmounts: readonly { amount: bigint; destGasAmount: bigint; destTokenAddress: string; extraData: string; sourcePoolAddress: string; token: string; }[]; } | { allowOutOfOrderExecution: boolean; data: string; destChainSelector: bigint; extraArgs: string; feeToken: string; feeTokenAmount: bigint; feeValueJuels: bigint; gasLimit: bigint; messageId: string; nonce: bigint; receiver: string; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; tokenAmounts: readonly { amount: bigint; destExecData: string; destGasAmount: bigint; destTokenAddress: string; extraData: string; sourcePoolAddress: string; }[]; } | { accountIsWritableBitmap: bigint; accounts: string[]; allowOutOfOrderExecution: boolean; computeUnits: bigint; data: string; destChainSelector: bigint; extraArgs: string; feeToken: string; feeTokenAmount: bigint; feeValueJuels: bigint; messageId: string; nonce: bigint; receiver: string; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; tokenAmounts: readonly { amount: bigint; destExecData: string; destGasAmount: bigint; destTokenAddress: string; extraData: string; sourcePoolAddress: string; }[]; tokenReceiver: string; } | { allowOutOfOrderExecution: boolean; data: string; destChainSelector: bigint; extraArgs: string; feeToken: string; feeTokenAmount: bigint; feeValueJuels: bigint; gasLimit: bigint; messageId: string; nonce: bigint; receiver: string; receiverObjectIds: string[]; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; tokenAmounts: readonly { amount: bigint; destExecData: string; destGasAmount: bigint; destTokenAddress: string; extraData: string; sourcePoolAddress: string; }[]; tokenReceiver: string; }; }	CCIP request, with tx.hash and message
request.log	{ }	-
request.message	{ ccipReceiveGasLimit: number; ccvAndExecutorHash: string; data: string; destBlob: string; destChainSelector: bigint; encodedMessage: string; executionGasLimit: number; feeToken: string; feeTokenAmount: bigint; finality: FinalityRequested; messageId: string; messageNumber: bigint; offRampAddress: string; onRampAddress: string; receipts: readonly { destBytesOverhead: bigint; destGasLimit: bigint; extraArgs: string; feeTokenAmount: bigint; issuer: string; }[]; receiver: string; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; tokenAmountBeforeTokenPoolFees: bigint; tokenAmounts: readonly { amount: bigint; destTokenAddress: string; extraData: string; sourcePoolAddress: string; sourceTokenAddress: string; tokenReceiver: string; }[]; verifierBlobs: readonly string[]; } | { data: string; feeToken: string; feeTokenAmount: bigint; gasLimit: bigint; messageId: string; nonce: bigint; receiver: string; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; sourceTokenData: readonly string[]; strict: boolean; tokenAmounts: readonly { amount: bigint; token: string; }[]; } | { data: string; feeToken: string; feeTokenAmount: bigint; gasLimit: bigint; messageId: string; nonce: bigint; receiver: string; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; sourceTokenData: readonly string[]; strict: boolean; tokenAmounts: readonly { amount: bigint; destGasAmount: bigint; destTokenAddress: string; extraData: string; sourcePoolAddress: string; token: string; }[]; } | { allowOutOfOrderExecution: boolean; data: string; destChainSelector: bigint; extraArgs: string; feeToken: string; feeTokenAmount: bigint; feeValueJuels: bigint; gasLimit: bigint; messageId: string; nonce: bigint; receiver: string; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; tokenAmounts: readonly { amount: bigint; destExecData: string; destGasAmount: bigint; destTokenAddress: string; extraData: string; sourcePoolAddress: string; }[]; } | { accountIsWritableBitmap: bigint; accounts: string[]; allowOutOfOrderExecution: boolean; computeUnits: bigint; data: string; destChainSelector: bigint; extraArgs: string; feeToken: string; feeTokenAmount: bigint; feeValueJuels: bigint; messageId: string; nonce: bigint; receiver: string; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; tokenAmounts: readonly { amount: bigint; destExecData: string; destGasAmount: bigint; destTokenAddress: string; extraData: string; sourcePoolAddress: string; }[]; tokenReceiver: string; } | { allowOutOfOrderExecution: boolean; data: string; destChainSelector: bigint; extraArgs: string; feeToken: string; feeTokenAmount: bigint; feeValueJuels: bigint; gasLimit: bigint; messageId: string; nonce: bigint; receiver: string; receiverObjectIds: string[]; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; tokenAmounts: readonly { amount: bigint; destExecData: string; destGasAmount: bigint; destTokenAddress: string; extraData: string; sourcePoolAddress: string; }[]; tokenReceiver: string; }	-

Returns

Promise<OffchainTokenData[]>

Promise resolving to array with one offchain token data for each token transfer

Example

Get offchain token data for USDC transfer

TypeScript

const offchainData = await source.getOffchainTokenData(request)
// Use in execution report

Inherited from

Chain.getOffchainTokenData

---

getOffRampConfig()

getOffRampConfig(offRamp: string, sourceChainSelector: bigint): Promise<{ bump: number; defaultCcvs: string[]; feeQuoter: string; isEnabled: boolean; isRmnVerificationDisabled: boolean; laneCodeVersion: { default: {[key: string]: never; }; v1?: undefined; } | { default?: undefined; v1: {[key: string]: never; }; }; laneMandatedCcvs: string[]; minSeqNr?: bigint; offrampLookupTable: string; onRamps: string[]; rmn: string; rmnRemote: string; router: string; sourceChainSelector: bigint; typeAndVersion: string; version: number; }>

Defined in: solana/index.ts:714

Fetch the full OffRamp configuration for a given source chain.

Parameters

Parameter	Type	Description
offRamp	string	OffRamp contract address.
sourceChainSelector	bigint	Source chain selector.

Returns

Promise<{ bump: number; defaultCcvs: string[]; feeQuoter: string; isEnabled: boolean; isRmnVerificationDisabled: boolean; laneCodeVersion: { default: {[key: string]: never; }; v1?: undefined; } | { default?: undefined; v1: {[key: string]: never; }; }; laneMandatedCcvs: string[]; minSeqNr?: bigint; offrampLookupTable: string; onRamps: string[]; rmn: string; rmnRemote: string; router: string; sourceChainSelector: bigint; typeAndVersion: string; version: number; }>

Merged OffRamp config — at minimum router, onRamp, type, version, typeAndVersion.

Remarks

Returns a merged object containing every static (per-contract) and per-source field exposed by the underlying contract. Concrete subclasses preserve the contract-native field names and return richer objects than the OffRampConfig base interface declares — they may include extra fields available only on specific versions (e.g. EVM v2.0 exposes onRamps: string[]).

Overrides

Chain.getOffRampConfig

---

getOffRampsForRouter()

getOffRampsForRouter(router: string, sourceChainSelector: bigint): Promise<string[]>

Defined in: solana/index.ts:793

Chain.getOffRampsForRouter

Both 1.6 and v2 routers maintain allowed_offramp marker PDAs per (sourceChainSelector, offRamp) pair, seeded as [allowed_offramp, selectorLE, offRamp]. The offRamp pubkey lives only in the seeds (marker data is just the 8-byte discriminator), so we:

1. enumerate all allowed_offramp marker accounts owned by the router (filtered by 8-byte data length),
2. read each marker's transaction history (offRamps reference their marker when executing commit/execute),
3. for every account key seen in those txs, re-derive the marker PDA for our sourceChainSelector and keep the keys that reproduce the marker address. A match proves both that the key is the offRamp program and that it's allowed for this source chain. All matching offRamps are returned (not just the first), so lanes with multiple historical offRamps are fully discovered.

Parameters

Parameter	Type
router	string
sourceChainSelector	bigint

Returns

Promise<string[]>

Throws

CCIPSolanaOffRampEventsNotFoundError if no OffRamp markers match for this source chain.

Overrides

Chain.getOffRampsForRouter

---

getOnRampConfig()

getOnRampConfig(onRamp: string, destChainSelector: bigint): Promise<{ addressBytesLength: number; allowedSenders: string[]; allowListEnabled: boolean; baseExecutionGasCost: number; defaultCcvs: string[]; defaultCodeVersion: { default: {[key: string]: never; }; v1?: undefined; } | { default?: undefined; v1: {[key: string]: never; }; }; defaultExecutor: string; destChainSelector: bigint; feeAggregator: string; feeQuoter: string; laneCodeVersion: { default: {[key: string]: never; }; v1?: undefined; } | { default?: undefined; v1: {[key: string]: never; }; }; laneMandatedCcvs: string[]; linkTokenMint: string; maxFeePerMessage: number; messageNetworkFee: number; offramp: Buffer<ArrayBufferLike>; owner: string; proposedOwner: string; rmn: string; rmnRemote: string; router: string; svmChainSelector: bigint; tokenReceiverAllowed: boolean; tokenTransferNetworkFee: number; typeAndVersion: string; version: number; } | { allowedSenders: string[]; allowListEnabled: boolean; defaultCodeVersion: { default: {[key: string]: never; }; v1?: undefined; } | { default?: undefined; v1: {[key: string]: never; }; }; destChainSelector: bigint; feeAggregator: string; feeQuoter: string; feeQuoterConfig: { chainSelector: bigint; config: { chainFamilySelector: number[]; defaultTokenDestGasOverhead: number; defaultTokenFeeUsdcents: number; defaultTxGasLimit: number; destDataAvailabilityMultiplierBps: number; destDataAvailabilityOverheadGas: number; destGasOverhead: number; destGasPerDataAvailabilityByte: number; destGasPerPayloadByteBase: number; destGasPerPayloadByteHigh: number; destGasPerPayloadByteThreshold: number; enforceOutOfOrder: boolean; gasMultiplierWeiPerEth: bigint; gasPriceStalenessThreshold: number; isEnabled: boolean; laneCodeVersion: { default: {[key: string]: never; }; v1?: undefined; } | { default?: undefined; v1: {[key: string]: never; }; }; maxDataBytes: number; maxNumberOfTokensPerMsg: number; maxPerMsgGasLimit: number; networkFeeUsdcents: number; }; defaultCodeVersion: { default: {[key: string]: never; }; v1?: undefined; } | { default?: undefined; v1: {[key: string]: never; }; }; linkTokenLocalDecimals: number; linkTokenMint: string; maxFeeJuelsPerMsg: bigint; onramp: string; owner: string; proposedOwner: string; state: { usdPerUnitGas: { timestamp: bigint; value: number[]; }; }; version: number; }; laneCodeVersion: { default: {[key: string]: never; }; v1?: undefined; } | { default?: undefined; v1: {[key: string]: never; }; }; linkTokenMint: string; owner: string; proposedOwner: string; rmnRemote: string; router: string; svmChainSelector: bigint; typeAndVersion: string; version: number; }>

Defined in: solana/index.ts:613

Fetch the full OnRamp configuration for a given destination chain.

Parameters

Parameter	Type	Description
onRamp	string	OnRamp contract address.
destChainSelector	bigint	Destination chain selector.

Returns

Promise<{ addressBytesLength: number; allowedSenders: string[]; allowListEnabled: boolean; baseExecutionGasCost: number; defaultCcvs: string[]; defaultCodeVersion: { default: {[key: string]: never; }; v1?: undefined; } | { default?: undefined; v1: {[key: string]: never; }; }; defaultExecutor: string; destChainSelector: bigint; feeAggregator: string; feeQuoter: string; laneCodeVersion: { default: {[key: string]: never; }; v1?: undefined; } | { default?: undefined; v1: {[key: string]: never; }; }; laneMandatedCcvs: string[]; linkTokenMint: string; maxFeePerMessage: number; messageNetworkFee: number; offramp: Buffer<ArrayBufferLike>; owner: string; proposedOwner: string; rmn: string; rmnRemote: string; router: string; svmChainSelector: bigint; tokenReceiverAllowed: boolean; tokenTransferNetworkFee: number; typeAndVersion: string; version: number; } | { allowedSenders: string[]; allowListEnabled: boolean; defaultCodeVersion: { default: {[key: string]: never; }; v1?: undefined; } | { default?: undefined; v1: {[key: string]: never; }; }; destChainSelector: bigint; feeAggregator: string; feeQuoter: string; feeQuoterConfig: { chainSelector: bigint; config: { chainFamilySelector: number[]; defaultTokenDestGasOverhead: number; defaultTokenFeeUsdcents: number; defaultTxGasLimit: number; destDataAvailabilityMultiplierBps: number; destDataAvailabilityOverheadGas: number; destGasOverhead: number; destGasPerDataAvailabilityByte: number; destGasPerPayloadByteBase: number; destGasPerPayloadByteHigh: number; destGasPerPayloadByteThreshold: number; enforceOutOfOrder: boolean; gasMultiplierWeiPerEth: bigint; gasPriceStalenessThreshold: number; isEnabled: boolean; laneCodeVersion: { default: {[key: string]: never; }; v1?: undefined; } | { default?: undefined; v1: {[key: string]: never; }; }; maxDataBytes: number; maxNumberOfTokensPerMsg: number; maxPerMsgGasLimit: number; networkFeeUsdcents: number; }; defaultCodeVersion: { default: {[key: string]: never; }; v1?: undefined; } | { default?: undefined; v1: {[key: string]: never; }; }; linkTokenLocalDecimals: number; linkTokenMint: string; maxFeeJuelsPerMsg: bigint; onramp: string; owner: string; proposedOwner: string; state: { usdPerUnitGas: { timestamp: bigint; value: number[]; }; }; version: number; }; laneCodeVersion: { default: {[key: string]: never; }; v1?: undefined; } | { default?: undefined; v1: {[key: string]: never; }; }; linkTokenMint: string; owner: string; proposedOwner: string; rmnRemote: string; router: string; svmChainSelector: bigint; typeAndVersion: string; version: number; }>

Merged OnRamp config — at minimum router, type, version, typeAndVersion.

Remarks

Returns a merged object containing every static (per-contract) and per-destination field exposed by the underlying contract. Concrete subclasses (e.g. EVMChain) preserve the contract-native field names and return richer objects than the OnRampConfig base interface declares — they may include extra fields available only on specific versions.

Overrides

Chain.getOnRampConfig

---

getOnRampForRouter()

getOnRampForRouter(router: string, _destChainSelector: bigint): Promise<string>

Defined in: solana/index.ts:857

Fetch the OnRamp registered in a Router for a destination chain.

Parameters

Parameter	Type	Description
router	string	Router contract address
_destChainSelector	bigint	Destination chain selector

Returns

Promise<string>

Promise resolving to OnRamp address

Overrides

Chain.getOnRampForRouter

---

getOnRampsForOffRamp()

getOnRampsForOffRamp(offRamp: string, sourceChainSelector: bigint): Promise<string[]>

Defined in: chain.ts:1438

Fetch the OnRamps addresses set in OffRamp config. Used to discover OffRamp connected to an OnRamp.

Parameters

Parameter	Type	Description
offRamp	string	OffRamp contract address
sourceChainSelector	bigint	Source chain selector

Returns

Promise<string[]>

Promise resolving to OnRamps addresses

Remarks

Default implementation reads from Chain.getOffRampConfig; if the concrete config exposes an onRamps: string[] (e.g. EVM v2.0 with multiple historical OnRamps), it is returned as-is; otherwise [cfg.onRamp] is returned.

Example

Get onRamp from offRamp config

TypeScript

const [onRamp] = await dest.getOnRampsForOffRamp(offRampAddress, sourceSelector)
console.log(`OnRamp: ${onRamp}`)

Inherited from

Chain.getOnRampsForOffRamp

---

getRegistryTokenConfig()

getRegistryTokenConfig(registry: string, token: string): Promise<{ administrator: string; pendingAdministrator?: string; tokenPool?: string; }>

Defined in: solana/index.ts:1926

Fetch token configuration from a TokenAdminRegistry.

Parameters

Parameter	Type	Description
registry	string	TokenAdminRegistry contract address.
token	string	Token address to query.

Returns

Promise<{ administrator: string; pendingAdministrator?: string; tokenPool?: string; }>

RegistryTokenConfig containing administrator and pool information.

Remarks

The TokenAdminRegistry is a contract that tracks token administrators and their associated pools. Each token has an administrator who can update pool configurations.

Throws

CCIPTokenNotConfiguredError if token is not configured in registry

Overrides

Chain.getRegistryTokenConfig

---

getRequiredCCVs()?

optional getRequiredCCVs(opts: { message: GetRequiredCCVsMessage; offRamp: string; }): Promise<GetRequiredCCVsResult>

Defined in: chain.ts:2675

Resolve the CCV set the destination OffRamp will require for a candidate message, and whether its finality is accepted (a rejection throws CCIPFinalityNotAllowedError). A read via the getCCVsForMessage resolver; EVM destinations only. The set is informative and sender-scoped.

Parameters

Parameter	Type	Description
opts	{ message: GetRequiredCCVsMessage; offRamp: string; }	Destination OffRamp (v2.0) address and the candidate message (GetRequiredCCVsMessage).
opts.message	GetRequiredCCVsMessage	-
opts.offRamp	string	-

Returns

Promise<GetRequiredCCVsResult>

{ requiredCCVs, optionalCCVs, optionalThreshold }.

Inherited from

Chain.getRequiredCCVs

---

getRouterForOffRamp()

getRouterForOffRamp(offRamp: string, sourceChainSelector: bigint): Promise<string>

Defined in: chain.ts:1372

Fetch the Router address set in OffRamp config.

Parameters

Parameter	Type	Description
offRamp	string	OffRamp contract address
sourceChainSelector	bigint	Source chain selector

Returns

Promise<string>

Promise resolving to Router address

Remarks

Default implementation reads .router from Chain.getOffRampConfig; subclasses generally need not override this.

Throws

CCIPContractTypeInvalidError if address is not an OffRamp

Example

Get router from offRamp

TypeScript

const router = await chain.getRouterForOffRamp(offRampAddress, sourceSelector)
console.log(`Router: ${router}`)

Inherited from

Chain.getRouterForOffRamp

---

getRouterForOnRamp()

getRouterForOnRamp(onRamp: string, _destChainSelector: bigint): Promise<string>

Defined in: solana/index.ts:608

On Solana, Router is OnRamp

Parameters

Parameter	Type
onRamp	string
_destChainSelector	bigint

Returns

Promise<string>

Overrides

Chain.getRouterForOnRamp

---

getSupportedTokens()

getSupportedTokens(router: string): Promise<string[]>

Defined in: solana/index.ts:2131

List tokens supported by given TokenAdminRegistry contract.

Parameters

Parameter	Type	Description
router	string	Usually TokenAdminRegistry, but chain may support receiving Router, OnRamp, etc.

Returns

Promise<string[]>

Promise resolving to array of supported token addresses

Overrides

Chain.getSupportedTokens

---

getTokenAdminRegistryFor()

getTokenAdminRegistryFor(address: string): Promise<string>

Defined in: solana/index.ts:1363

Fetch TokenAdminRegistry configured in a given OnRamp, Router, etc. Needed to map a source token to its dest counterparts.

Parameters

Parameter	Type	Description
address	string	Contract address (OnRamp, Router, etc.)

Returns

Promise<string>

Promise resolving to TokenAdminRegistry address

Throws

CCIPContractNotRouterError if address is not a Router

Overrides

Chain.getTokenAdminRegistryFor

---

getTokenForTokenPool()

getTokenForTokenPool(tokenPool: string): Promise<string>

Defined in: chain.ts:1455

Fetch the TokenPool's token/mint.

Parameters

Parameter	Type	Description
tokenPool	string	TokenPool address

Returns

Promise<string>

Promise resolving to token or mint address

Example

Get token for pool

TypeScript

const token = await chain.getTokenForTokenPool(tokenPoolAddress)
console.log(`Token: ${token}`)

Inherited from

Chain.getTokenForTokenPool

---

getTokenInfo()

getTokenInfo(token: string): Promise<TokenInfo>

Defined in: solana/index.ts:866

Fetch token metadata.

Parameters

Parameter	Type	Description
token	string	Token address

Returns

Promise<TokenInfo>

Promise resolving to token symbol, decimals, and optionally name

Throws

CCIPSplTokenInvalidError if token is not a valid SPL token

Throws

CCIPTokenDataParseError if token data cannot be parsed

Overrides

Chain.getTokenInfo

---

getTokenPoolConfig()

getTokenPoolConfig(tokenPool: string, _feeOpts?: TokenTransferFeeOpts): Promise<{ router: string; token: string; tokenPoolProgram: string; typeAndVersion?: string; }>

Defined in: solana/index.ts:1983

Fetch configuration of a token pool.

Parameters

Parameter	Type	Description
tokenPool	string	Token pool contract address.
_feeOpts?	TokenTransferFeeOpts	Optional parameters to also fetch token transfer fee config.

Returns

Promise<{ router: string; token: string; tokenPoolProgram: string; typeAndVersion?: string; }>

TokenPoolConfig containing token, router, version info, and optionally fee config.

Remarks

Return type varies by chain:

• EVM: typeAndVersion is always present (required)
• Solana: Includes extra tokenPoolProgram field
• Aptos: Standard fields only
• Sui/TON: Throws CCIPNotImplementedError

Throws

CCIPTokenPoolStateNotFoundError if token pool state not found

Overrides

Chain.getTokenPoolConfig

---

getTokenPoolRemote()

getTokenPoolRemote(tokenPool: string, remoteChainSelector: bigint): Promise<TokenPoolRemote>

Defined in: chain.ts:2438

Fetch remote chain configuration for a token pool for a specific destination.

Parameters

Parameter	Type	Description
tokenPool	string	Token pool address on the current chain.
remoteChainSelector	bigint	Chain selector of the desired remote chain.

Returns

Promise<TokenPoolRemote>

TokenPoolRemote config for the specified remote chain.

Remarks

Convenience wrapper around getTokenPoolRemotes that returns a single configuration instead of a Record. Use this when you need configuration for a specific destination chain.

Example

TypeScript

const arbitrumSelector = 4949039107694359620n
const remote = await chain.getTokenPoolRemote(poolAddress, arbitrumSelector)
console.log(`Remote token: ${remote.remoteToken}`)
console.log(`Remote pools: ${remote.remotePools.join(', ')}`)

Throws

CCIPTokenPoolChainConfigNotFoundError if no configuration found for the specified remote chain.

Inherited from

Chain.getTokenPoolRemote

---

getTokenPoolRemotes()

getTokenPoolRemotes(tokenPool: string, remoteChainSelector?: bigint): Promise<Record<string, TokenPoolRemote>>

Defined in: solana/index.ts:2023

Fetch remote chain configurations for a token pool.

Parameters

Parameter	Type	Description
tokenPool	string	Token pool address on the current chain.
remoteChainSelector?	bigint	Optional chain selector to filter results to a single destination.

Returns

Promise<Record<string, TokenPoolRemote>>

Record where keys are chain names (e.g., "ethereum-mainnet") and values are TokenPoolRemote configs.

Remarks

A token pool maintains configurations for each destination chain it supports. The returned Record maps chain names to their respective configurations.

Throws

CCIPTokenPoolStateNotFoundError if token pool state not found

Throws

CCIPTokenPoolChainConfigNotFoundError if chain config not found for specified selector

Overrides

Chain.getTokenPoolRemotes

---

getTokenPrice()

getTokenPrice(opts: { router: string; timestamp?: number; token: string; }): Promise<TokenPrice>

Defined in: solana/index.ts:2184

Fetch the on-chain USD price of a token from the FeeQuoter or PriceRegistry.

Parameters

Parameter	Type	Description
opts	{ router: string; timestamp?: number; token: string; }	-
opts.router	string	-
opts.timestamp?	number	-
opts.token	string	-

Returns

Promise<TokenPrice>

Promise resolving to TokenPrice with the USD price per whole token.

Remarks

On EVM, the price contract is resolved via the Router's OnRamp: PriceRegistry for v1.2/v1.5 lanes, FeeQuoter for v1.6+ lanes. When timestamp is provided on EVM, the price is read at the block closest to that timestamp (requires archive node). On Solana and Aptos, the FeeQuoter is resolved directly from the Router config; timestamp is not yet supported and will be ignored.

Overrides

Chain.getTokenPrice

---

getTotalFeesEstimate()

getTotalFeesEstimate(_opts: Omit<SendMessageOpts, "approveMax">): Promise<TotalFeesEstimate>

Defined in: chain.ts:2563

Estimate total fees for a cross-chain message.

Returns two components:

• ccipFee: from Router.getFee(), denominated in the message's feeToken (native token if omitted). Includes gas, DON costs, and FeeQuoter-level token transfer overhead (all CCIP versions).
• tokenTransferFee: pool-level BPS fee deducted from the transferred token amount (v2.0+ only). The recipient receives amount - feeDeducted on the destination chain. Absent on pre-v2.0 lanes or data-only messages.

Parameters

Parameter	Type	Description
_opts	Omit<SendMessageOpts, "approveMax">	SendMessageOpts without approveMax

Returns

Promise<TotalFeesEstimate>

Promise resolving to TotalFeesEstimate

Throws

CCIPNotImplementedError if not implemented for this chain family

Inherited from

Chain.getTotalFeesEstimate

---

getTransaction()

getTransaction(hash: string): Promise<SolanaTransaction>

Defined in: solana/index.ts:405

Fetch a transaction by its hash.

Parameters

Parameter	Type	Description
hash	string	Transaction hash

Returns

Promise<SolanaTransaction>

Promise resolving to generic transaction details

Throws

CCIPTransactionNotFoundError if transaction not found

Overrides

Chain.getTransaction

---

getTransactionsForAddress()

getTransactionsForAddress(opts: { address?: string; endBefore?: string; endBlock?: number | bigint | "finalized" | "latest"; page?: number | bigint; since?: { blockTimestamp?: number | bigint; }; startBlock?: number | bigint; startTime?: number | bigint; typeAndVersions?: readonly (string | RegExp)[]; watch?: boolean | AbortSignal; } & { excludeAddresses?: string[]; pollInterval?: number; }): AsyncGenerator<SolanaTransaction>

Defined in: solana/index.ts:451

Internal method to get transactions for an address with pagination.

Parameters

Parameter	Type	Description
opts	{ address?: string; endBefore?: string; endBlock?: number | bigint | "finalized" | "latest"; page?: number | bigint; since?: { blockTimestamp?: number | bigint; }; startBlock?: number | bigint; startTime?: number | bigint; typeAndVersions?: readonly (string | RegExp)[]; watch?: boolean | AbortSignal; } & { excludeAddresses?: string[]; pollInterval?: number; }	Log filter options.

Returns

AsyncGenerator<SolanaTransaction>

Async generator of Solana transactions.

---

getVerifications()

getVerifications(opts: { indexer?: NetworkType | readonly string[]; offRamp: string; request: { lane: { destChainSelector: bigint; onRamp: string; sourceChainSelector: bigint; version: CCIPVersion; }; log: { blockTimestamp: number; }; message: { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; }; }; } & VerificationSourcesOpts & Pick<LogFilter, "startBlock" | "watch" | "page">): Promise<CCIPVerifications>

Defined in: solana/index.ts:1631

Solana specialization: for v2 lanes, resolve the verification policy from the offRamp's getCcvsForMsg view and fetch CCV results from the indexers (no onchain commit exists); for v1.x, use getProgramAccounts to fetch commit reports from PDAs

Parameters

Parameter

Type

opts

{ indexer?: NetworkType | readonly string[]; offRamp: string; request: { lane: { destChainSelector: bigint; onRamp: string; sourceChainSelector: bigint; version: CCIPVersion; }; log: { blockTimestamp: number; }; message: { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; } | { messageId: string; sequenceNumber: bigint; }; }; } & VerificationSourcesOpts & Pick<LogFilter, "startBlock" | "watch" | "page">

Returns

Promise<CCIPVerifications>

Overrides

Chain.getVerifications

---

resolveEncodedMessage()

protected resolveEncodedMessage(request: { message: { messageId: string; } | { messageId: string; } | { messageId: string; } | { messageId: string; } | { messageId: string; } | { messageId: string; }; }): Promise<string>

Defined in: chain.ts:1963

The MessageV1Codec-encoded form of a CCIP v2.0 request's message: taken from the request when it carries one (decoded from source logs), else fetched from the CCIP API (whose getMessageById requests don't).

Parameters

Parameter	Type	Description
request	{ message: { messageId: string; } | { messageId: string; } | { messageId: string; } | { messageId: string; } | { messageId: string; } | { messageId: string; }; }	The v2.0 request
request.message	{ messageId: string; } | { messageId: string; } | { messageId: string; } | { messageId: string; } | { messageId: string; } | { messageId: string; }	-

Returns

Promise<string>

The 0x-prefixed encoded message

Throws

CCIPApiClientNotAvailableError if it must be fetched and the API is disabled

Inherited from

Chain.resolveEncodedMessage

---

resolveExecuteOpts()

protected resolveExecuteOpts(opts: ExecuteOpts): Promise<{ input: ExecutionInput; offRamp: string; } & { forceBuffer?: boolean; forceLookupTable?: boolean; gasLimit?: number; receiver?: string; tokensGasLimit?: number; txGasLimit?: number; }>

Defined in: chain.ts:1751

Resolves ExecuteOpts that may contain a messageId (API shorthand) into the canonical { offRamp, input } form required by generateUnsignedExecute.

When opts already contains input the method is a no-op and returns it unchanged. When opts contains only a messageId it calls apiClient.getExecutionInput and merges the result back with any extra opts fields (e.g. gasLimit). If opts.gasLimit is undefined and estimateReceiveExecution is available, try to estimate gasLimitOverride

Parameters

Parameter	Type
opts	ExecuteOpts

Returns

Promise<{ input: ExecutionInput; offRamp: string; } & { forceBuffer?: boolean; forceLookupTable?: boolean; gasLimit?: number; receiver?: string; tokensGasLimit?: number; txGasLimit?: number; }>

Throws

CCIPApiClientNotAvailableError if messageId is provided but no apiClient

Inherited from

Chain.resolveExecuteOpts

---

sendMessage()

sendMessage(opts: SendMessageOpts & { txGasLimit?: number; wallet: unknown; }): Promise<CCIPRequest<CCIPVersion>>

Defined in: solana/index.ts:1420

Send a CCIP message through a router using provided wallet.

Parameters

Parameter	Type	Description
opts	SendMessageOpts & { txGasLimit?: number; wallet: unknown; }	SendMessageOpts with chain-specific wallet for signing

Returns

Promise<CCIPRequest<CCIPVersion>>

Promise resolving to CCIP request with message details

Throws

CCIPWalletInvalidError if wallet is not a valid Solana wallet

Throws

CCIPPartialTransactionSubmissionError if ccipSend fails after the approvals were split into (and confirmed in) an earlier transaction

Overrides

Chain.sendMessage

---

simulateLockOrBurn()?

optional simulateLockOrBurn(opts: { amount: bigint; destChainSelector: bigint; finality?: FinalityRequested; onRamp: string; originalSender?: string; receiver?: string; token: string; tokenArgs?: string; tokenReceiver?: string; }): Promise<{ destPoolData: string; destTokenAddress: string; destTokenAmount: bigint; sourcePoolAddress: string; }>

Defined in: chain.ts:2616

Simulate the source pool's lockOrBurn for a prospective token transfer and return the pool-reported destTokenAddress, destPoolData (the value the destination pool's releaseOrMint consumes as sourcePoolData) and destTokenAmount (the post-fee amount the OnRamp writes into the emitted message), plus the resolved source pool address.

Optional; currently implemented for EVM chains. Used by estimateReceiveExecution to feed the destination-liquidity simulation the same source pool data a real transfer would carry.

Parameters

Parameter	Type	Description
opts	{ amount: bigint; destChainSelector: bigint; finality?: FinalityRequested; onRamp: string; originalSender?: string; receiver?: string; token: string; tokenArgs?: string; tokenReceiver?: string; }	lane (onRamp, destChainSelector), token and amount (source decimals), and optionally originalSender, receiver, tokenReceiver, tokenArgs, and the requested finality
opts.amount	bigint	Amount in the source token's decimals
opts.destChainSelector	bigint	Destination chain selector
opts.finality?	FinalityRequested	Requested finality (v2 pools take it as the 2nd lockOrBurn argument)
opts.onRamp	string	OnRamp registered on the source Router for the destination chain
opts.originalSender?	string	Sender of the prospective message
opts.receiver?	string	Receiver on the destination chain
opts.token	string	Source token address
opts.tokenArgs?	string	Message-level GenericExtraArgsV3.tokenArgs, passed through to IPoolV2 pools
opts.tokenReceiver?	string	Token receiver on the destination chain (v3 extraArgs); when set, takes precedence over receiver as the pool's lockOrBurnIn.receiver, mirroring the OnRamp

Returns

Promise<{ destPoolData: string; destTokenAddress: string; destTokenAmount: bigint; sourcePoolAddress: string; }>

resolved sourcePoolAddress, destTokenAddress + destPoolData as returned by the pool, and the post-fee destTokenAmount

Inherited from

Chain.simulateLockOrBurn

---

typeAndVersion()

typeAndVersion(address: string): Promise<[string, string, string, string]>

Defined in: solana/index.ts:588

Fetch typeAndVersion for a given CCIP contract address.

Parameters

Parameter	Type	Description
address	string	CCIP contract address

Returns

Promise<[string, string, string, string]>

Promise resolving to tuple:

• type - Parsed type of the contract, e.g. OnRamp
• version - Parsed version of the contract, e.g. 1.6.0
• typeAndVersion - Original (unparsed) typeAndVersion() string
• suffix - Suffix of the version, if any (e.g. -dev)

Overrides

Chain.typeAndVersion

---

waitFinalized()

waitFinalized(opts: { abort?: AbortSignal; finality?: number | bigint | "finalized" | "latest"; pollInterval?: number; reorgSafetyBlocks?: number; } & { request: { log: { blockTimestamp: number | bigint; }; }; } | { log: { blockTimestamp: number | bigint; }; }): Promise<BlockInfo | undefined>

Defined in: chain.ts:1017

Confirm a log tx is finalized or wait for it to be finalized.

Parameters

Parameter	Type	Description
opts	{ abort?: AbortSignal; finality?: number | bigint | "finalized" | "latest"; pollInterval?: number; reorgSafetyBlocks?: number; } & { request: { log: { blockTimestamp: number | bigint; }; }; } | { log: { blockTimestamp: number | bigint; }; }	Options containing the request, finality level, and optional cancel promise

Returns

Promise<BlockInfo | undefined>

Some block info at or after tx finalization

Throws

CCIPTransactionNotFinalizedError if the transaction is not included (e.g., due to a reorg)

Example

Wait for message finality

TypeScript

const request = await source.getMessagesInTx(txHash)
try {
  await source.waitFinalized({ request: request[0] })
  console.log('Transaction finalized')
} catch (err) {
  if (err instanceof CCIPTransactionNotFinalizedError) {
    console.log('Transaction not yet finalized')
  }
}

Inherited from

Chain.waitFinalized

---

_getConnection()

static _getConnection(url: string, ctx?: WithLogger & { abort?: AbortSignal; fetch?: (input: string | URL | Request, init?: RequestInit) => Promise<Response>; }): Connection

Defined in: solana/index.ts:328

Creates a Solana connection from a URL.

Parameters

Parameter	Type	Description
url	string	RPC endpoint URL (https://, http://, wss://, or ws://).
ctx?	WithLogger & { abort?: AbortSignal; fetch?: (input: string | URL | Request, init?: RequestInit) => Promise<Response>; }	context containing logger.

Returns

Connection

Solana Connection instance.

Throws

CCIPDataFormatUnsupportedError if URL format is invalid

---

buildMessageForDest()

static buildMessageForDest(message: MessageInput): AnyMessage & { extraArgs: SVMExtraArgsV1; }

Defined in: solana/index.ts:2255

Returns a copy of a message, populating missing fields like extraArgs with defaults. It's expected to return a message suitable at least for basic token transfers.

Parameters

Parameter	Type	Description
message	MessageInput	AnyMessage (from source), containing at least receiver

Returns

AnyMessage & { extraArgs: SVMExtraArgsV1; }

A message suitable for sendMessage to this destination chain family

Remarks

Solana-specific receiver/tokenReceiver handling:

• Explicit tokenReceiver in extraArgs: both receiver and tokenReceiver are kept as provided.
• Tokens but no explicit tokenReceiver: receiver is set to PublicKey.default and tokenReceiver is set to message.receiver.
• No tokens: tokenReceiver is set to PublicKey.default and receiver is message.receiver.

Accepts gasLimit as an alias for computeUnits in extraArgs.

Throws

CCIPArgumentInvalidError if tokenReceiver missing when sending tokens with data

Throws

CCIPArgumentInvalidError if extraArgs contains unknown fields for SVMExtraArgsV1

Overrides

Chain.buildMessageForDest

---

decodeCommits()

static decodeCommits(log: Pick<ChainLog, "data">, lane?: Omit<Lane<CCIPVersion>, "destChainSelector">): { maxSeqNr: bigint; merkleRoot: string; minSeqNr: bigint; onRampAddress: string; sourceChainSelector: bigint; }[] | undefined

Defined in: solana/index.ts:1179

Decodes commit reports from a Solana log event.

Parameters

Parameter	Type	Description
log	Pick<ChainLog, "data">	Log with data field.
lane?	Omit<Lane<CCIPVersion>, "destChainSelector">	Lane info for filtering.

Returns

{ maxSeqNr: bigint; merkleRoot: string; minSeqNr: bigint; onRampAddress: string; sourceChainSelector: bigint; }[] | undefined

Array of CommitReport or undefined if not valid.

Throws

CCIPLogDataMissingError if log data is missing

---

decodeExtraArgs()

static decodeExtraArgs(extraArgs: BytesLike): EVMExtraArgsV1 & { allowOutOfOrderExecution: boolean; } & { _tag: "EVMExtraArgsV2"; } | GenericExtraArgsV3 & { _tag: "GenericExtraArgsV3"; } | EVMExtraArgsV1 & { allowOutOfOrderExecution: boolean; } & { receiverObjectIds: string[]; tokenReceiver: string; } & { _tag: "SuiExtraArgsV1"; } | undefined

Defined in: solana/index.ts:1125

Decodes extra arguments from Solana CCIP messages (Borsh-encoded, produced BY Solana targeting remote chain families).

Handles:

• GenericExtraArgsV2 (EVMExtraArgsV2 tag) — Solana → EVM 1.6
• GenericExtraArgsV3 — Solana → EVM 2.0
• SuiExtraArgsV1 — Solana → Sui

Parameters

Parameter	Type	Description
extraArgs	BytesLike	Encoded extra arguments bytes.

Returns

Decoded extra arguments or undefined if unknown format.

EVMExtraArgsV1 & { allowOutOfOrderExecution: boolean; } & { _tag: "EVMExtraArgsV2"; }

---

GenericExtraArgsV3 & { _tag: "GenericExtraArgsV3"; }

---

EVMExtraArgsV1 & { allowOutOfOrderExecution: boolean; } & { receiverObjectIds: string[]; tokenReceiver: string; } & { _tag: "SuiExtraArgsV1"; }

---

undefined

Throws

CCIPExtraArgsLengthInvalidError if extra args length is invalid

---

decodeMessage()

static decodeMessage(log: { data: unknown; }): CCIPMessage | undefined

Defined in: solana/index.ts:1024

Decodes a CCIP message from a Solana log event.

Parameters

Parameter	Type	Description
log	{ data: unknown; }	Log with data field.
log.data	unknown	-

Returns

CCIPMessage | undefined

Decoded CCIPMessage or undefined if not valid.

Throws

CCIPExtraArgsInvalidError if extra args cannot be decoded

---

decodeReceipt()

static decodeReceipt(log: Pick<ChainLog, "data" | "tx" | "index">): ExecutionReceipt | undefined

Defined in: solana/index.ts:1235

Decodes an execution receipt from a Solana log event.

Parameters

Parameter	Type	Description
log	Pick<ChainLog, "data" | "tx" | "index">	Log with data, tx, and index fields.

Returns

ExecutionReceipt | undefined

ExecutionReceipt or undefined if not valid.

Throws

CCIPLogDataMissingError if log data is missing

Throws

CCIPExecutionStateInvalidError if execution state is invalid

---

encodeExtraArgs()

static encodeExtraArgs(args: ExtraArgs): string

Defined in: solana/index.ts:1168

Encodes extra arguments for Solana CCIP messages in Borsh format.

Handles messages FROM Solana TO remote chain families:

• EVMExtraArgsV2 / GenericExtraArgsV2 (EVM dest): Borsh {gasLimit: u128, ...}
• GenericExtraArgsV3 (EVM v2 dest): Borsh {gas_limit: u32, finality, ccvs, ...}
• SuiExtraArgsV1 (Sui dest): Borsh {gasLimit: u64, ...}

Parameters

Parameter	Type	Description
args	ExtraArgs	Extra arguments to encode.

Returns

string

Encoded extra arguments as hex string.

---

fromConnection()

static fromConnection(connection: Connection, ctx?: ChainContext): Promise<SolanaChain>

Defined in: solana/index.ts:350

Creates a SolanaChain instance from an existing connection.

Parameters

Parameter	Type	Description
connection	Connection	Solana Connection instance.
ctx?	ChainContext	context containing logger.

Returns

Promise<SolanaChain>

A new SolanaChain instance.

---

fromUrl()

static fromUrl(url: string, ctx?: ChainContext): Promise<SolanaChain>

Defined in: solana/index.ts:372

Creates a SolanaChain instance from an RPC URL.

Parameters

Parameter	Type	Description
url	string	RPC endpoint URL (https://, http://, wss://, or ws://).
ctx?	ChainContext	Optional context containing logger and API client configuration.

Returns

Promise<SolanaChain>

A new SolanaChain instance connected to the specified network.

Throws

CCIPChainNotFoundError if chain cannot be identified from genesis hash

Example

TypeScript

// Create from devnet URL
const chain = await SolanaChain.fromUrl('https://api.devnet.solana.com')

// With custom logger
const chain = await SolanaChain.fromUrl(url, { logger: customLogger })

---

getAddress()

static getAddress(bytes: BytesLike | PublicKey): string

Defined in: solana/index.ts:1321

Converts bytes to a Solana address (Base58).

Parameters

Parameter	Type	Description
bytes	BytesLike | PublicKey	Bytes to convert.

Returns

string

Base58-encoded Solana address.

---

getDestLeafHasher()

static getDestLeafHasher(lane: Lane, ctx?: WithLogger): LeafHasher<"1.6.0">

Defined in: solana/index.ts:1355

Gets the leaf hasher for Solana destination chains.

Parameters

Parameter	Type	Description
lane	Lane	Lane configuration.
ctx?	WithLogger	-

Returns

LeafHasher<"1.6.0">

Leaf hasher function.

---

isTxHash()

static isTxHash(v: unknown): v is string

Defined in: solana/index.ts:1340

Validates a transaction hash format for Solana

Parameters

Parameter	Type
v	unknown

Returns

v is string

---

parse()

static parse(data: unknown): { ccipReceiveGasLimit: number; ccvAndExecutorHash: string; data: string; destBlob: string; destChainSelector: bigint; encodedMessage: string; executionGasLimit: number; feeToken: string; feeTokenAmount: bigint; finality: FinalityRequested; messageId: string; messageNumber: bigint; offRampAddress: string; onRampAddress: string; receipts: readonly { destBytesOverhead: bigint; destGasLimit: bigint; extraArgs: string; feeTokenAmount: bigint; issuer: string; }[]; receiver: string; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; tokenAmountBeforeTokenPoolFees: bigint; tokenAmounts: readonly TokenTransferV1[]; verifierBlobs: readonly string[]; } | { data: string; feeToken: string; feeTokenAmount: bigint; gasLimit: bigint; messageId: string; nonce: bigint; receiver: string; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; sourceTokenData: readonly string[]; strict: boolean; tokenAmounts: readonly { amount: bigint; token: string; }[]; } | CCIPMessage_V1_6_EVM | CCIPMessage_V1_6_Solana | object & Record<"error", unknown> | EVMExtraArgsV1 & { allowOutOfOrderExecution: boolean; } & { _tag: "EVMExtraArgsV2"; } | GenericExtraArgsV3 & { _tag: "GenericExtraArgsV3"; } | EVMExtraArgsV1 & { allowOutOfOrderExecution: boolean; } & { receiverObjectIds: string[]; tokenReceiver: string; } & { _tag: "SuiExtraArgsV1"; } | object & Record<"program", unknown> | { message: unknown; program: string; } | undefined

Defined in: solana/index.ts:1601

Parses raw Solana data into typed structures.

Parameters

Parameter	Type	Description
data	unknown	Raw data to parse.

Returns

Parsed data or undefined.

Type Literal

{ ccipReceiveGasLimit: number; ccvAndExecutorHash: string; data: string; destBlob: string; destChainSelector: bigint; encodedMessage: string; executionGasLimit: number; feeToken: string; feeTokenAmount: bigint; finality: FinalityRequested; messageId: string; messageNumber: bigint; offRampAddress: string; onRampAddress: string; receipts: readonly { destBytesOverhead: bigint; destGasLimit: bigint; extraArgs: string; feeTokenAmount: bigint; issuer: string; }[]; receiver: string; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; tokenAmountBeforeTokenPoolFees: bigint; tokenAmounts: readonly TokenTransferV1[]; verifierBlobs: readonly string[]; }

---

Type Literal

{ data: string; feeToken: string; feeTokenAmount: bigint; gasLimit: bigint; messageId: string; nonce: bigint; receiver: string; sender: string; sequenceNumber: bigint; sourceChainSelector: bigint; sourceTokenData: readonly string[]; strict: boolean; tokenAmounts: readonly { amount: bigint; token: string; }[]; }

---

CCIPMessage_V1_6_EVM

---

CCIPMessage_V1_6_Solana

---

object & Record<"error", unknown>

---

EVMExtraArgsV1 & { allowOutOfOrderExecution: boolean; } & { _tag: "EVMExtraArgsV2"; }

---

GenericExtraArgsV3 & { _tag: "GenericExtraArgsV3"; }

---

EVMExtraArgsV1 & { allowOutOfOrderExecution: boolean; } & { receiverObjectIds: string[]; tokenReceiver: string; } & { _tag: "SuiExtraArgsV1"; }

---

object & Record<"program", unknown>

---

Type Literal

{ message: unknown; program: string; }

---

undefined