@chainlink/ccip-sdk 0.95.0 → 0.96.0

package/dist/ton/send.d.ts

@@ -0,0 +1,52 @@
+import { type Cell } from '@ton/core';
+import { type TonClient, Address } from '@ton/ton';
+import type { UnsignedTONTx } from './types.ts';
+import type { AnyMessage, WithLogger } from '../types.ts';
+/** Opcode for Router ccipSend operation */
+export declare const CCIP_SEND_OPCODE = 829853077;
+/** Default gas buffer to add to fee for transaction execution */
+export declare const DEFAULT_GAS_BUFFER: bigint;
+/** Default gas limit for destination chain execution */
+export declare const DEFAULT_GAS_LIMIT = 200000n;
+/**
+ * WRAPPED_NATIVE address for TON - sentinel address representing native TON.
+ * Used as feeToken for native TON payments in FeeQuoter calls.
+ */
+export declare const WRAPPED_NATIVE: Address;
+/**
+ * Builds the Router ccipSend message cell.
+ *
+ * Relies on TL-B structure (Router_CCIPSend) from chainlink-ton repo.
+ */
+export declare function buildCcipSendCell(destChainSelector: bigint, message: AnyMessage, feeTokenAddress?: Address | null, queryId?: bigint): Cell;
+/**
+ * Gets the fee for sending a CCIP message by calling FeeQuoter.validatedFee.
+ *
+ * @param ctx - Context with TonClient provider and logger
+ * @param router - Router contract address
+ * @param destChainSelector - Destination chain selector
+ * @param message - CCIP message to quote
+ * @returns Fee amount in nanotons
+ */
+export declare function getFee(ctx: {
+    provider: TonClient;
+} & WithLogger, router: string, destChainSelector: bigint, message: AnyMessage): Promise<bigint>;
+/**
+ * Generates an unsigned CCIP send transaction for the Router.
+ *
+ * @param ctx - Context with TonClient provider and logger
+ * @param _sender - Sender address (unused, for interface compatibility)
+ * @param router - Router contract address
+ * @param destChainSelector - Destination chain selector
+ * @param message - CCIP message with fee included
+ * @param opts - Optional gas buffer override
+ * @returns Unsigned transaction ready for signing
+ */
+export declare function generateUnsignedCcipSend(ctx: {
+    provider: TonClient;
+} & WithLogger, _sender: string, router: string, destChainSelector: bigint, message: AnyMessage & {
+    fee: bigint;
+}, opts?: {
+    gasBuffer?: bigint;
+}): Omit<UnsignedTONTx, 'family'>;
+//# sourceMappingURL=send.d.ts.map

package/dist/ton/send.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"send.d.ts","sourceRoot":"","sources":["../../src/ton/send.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,EAAqB,MAAM,WAAW,CAAA;AACxD,OAAO,EAAE,KAAK,SAAS,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAGlD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAG/C,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAGzD,2CAA2C;AAC3C,eAAO,MAAM,gBAAgB,YAAa,CAAA;AAE1C,iEAAiE;AACjE,eAAO,MAAM,kBAAkB,QAAgB,CAAA;AAE/C,wDAAwD;AACxD,eAAO,MAAM,iBAAiB,UAAW,CAAA;AAEzC;;;GAGG;AACH,eAAO,MAAM,cAAc,SAE1B,CAAA;AAoDD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,iBAAiB,EAAE,MAAM,EACzB,OAAO,EAAE,UAAU,EACnB,eAAe,GAAE,OAAO,GAAG,IAAW,EACtC,OAAO,SAAK,GACX,IAAI,CA0BN;AAED;;;;;;;;GAQG;AACH,wBAAsB,MAAM,CAC1B,GAAG,EAAE;IAAE,QAAQ,EAAE,SAAS,CAAA;CAAE,GAAG,UAAU,EACzC,MAAM,EAAE,MAAM,EACd,iBAAiB,EAAE,MAAM,EACzB,OAAO,EAAE,UAAU,GAClB,OAAO,CAAC,MAAM,CAAC,CAsDjB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,wBAAwB,CACtC,GAAG,EAAE;IAAE,QAAQ,EAAE,SAAS,CAAA;CAAE,GAAG,UAAU,EACzC,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,iBAAiB,EAAE,MAAM,EACzB,OAAO,EAAE,UAAU,GAAG;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,EACrC,IAAI,CAAC,EAAE;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GAC5B,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAkB/B"}

package/dist/ton/send.js

@@ -0,0 +1,166 @@
+import { beginCell, toNano } from '@ton/core';
+import { Address } from '@ton/ton';
+import { zeroPadValue } from 'ethers';
+import { CCIPError, CCIPErrorCode } from "../errors/index.js";
+import { EVMExtraArgsV2Tag } from "../extra-args.js";
+import { bytesToBuffer, getDataBytes } from "../utils.js";
+/** Opcode for Router ccipSend operation */
+export const CCIP_SEND_OPCODE = 0x31768d95;
+/** Default gas buffer to add to fee for transaction execution */
+export const DEFAULT_GAS_BUFFER = toNano('0.5');
+/** Default gas limit for destination chain execution */
+export const DEFAULT_GAS_LIMIT = 200000n;
+/**
+ * WRAPPED_NATIVE address for TON - sentinel address representing native TON.
+ * Used as feeToken for native TON payments in FeeQuoter calls.
+ */
+export const WRAPPED_NATIVE = Address.parse('0:0000000000000000000000000000000000000000000000000000000000000001');
+/**
+ * Encodes token amounts as a snaked cell.
+ * Empty cell for no tokens.
+ */
+function encodeTokenAmounts(tokenAmounts) {
+    if (!tokenAmounts || tokenAmounts.length === 0) {
+        return beginCell().endCell();
+    }
+    const builder = beginCell();
+    for (const ta of tokenAmounts) {
+        builder.storeRef(beginCell().storeAddress(Address.parse(ta.token)).storeUint(ta.amount, 256).endCell());
+    }
+    return builder.endCell();
+}
+/**
+ * Encodes extraArgs as a Cell using the GenericExtraArgsV2 (EVMExtraArgsV2) format.
+ *
+ * Format per chainlink-ton TL-B:
+ * - tag: 32-bit opcode (0x181dcf10)
+ * - gasLimit: Maybe<uint256> (1 bit flag + 256 bits if present)
+ * - allowOutOfOrderExecution: 1 bit (must be true)
+ */
+function encodeExtraArgsCell(extraArgs) {
+    const allowOutOfOrderExecution = true;
+    let gasLimit = 0n;
+    let hasGasLimit = false;
+    if ('gasLimit' in extraArgs && extraArgs.gasLimit > 0n) {
+        hasGasLimit = true;
+        gasLimit = extraArgs.gasLimit;
+    }
+    const builder = beginCell()
+        .storeUint(Number(EVMExtraArgsV2Tag), 32) // 0x181dcf10
+        .storeBit(hasGasLimit);
+    if (hasGasLimit) {
+        builder.storeUint(gasLimit, 256);
+    }
+    return builder.storeBit(allowOutOfOrderExecution).endCell();
+}
+/**
+ * Builds the Router ccipSend message cell.
+ *
+ * Relies on TL-B structure (Router_CCIPSend) from chainlink-ton repo.
+ */
+export function buildCcipSendCell(destChainSelector, message, feeTokenAddress = null, queryId = 0n) {
+    // Get receiver bytes and pad to 32 bytes for cross-chain encoding
+    const paddedReceiver = bytesToBuffer(zeroPadValue(getDataBytes(message.receiver), 32));
+    // Data cell (ref 0)
+    const dataCell = beginCell()
+        .storeBuffer(bytesToBuffer(message.data || '0x'))
+        .endCell();
+    // Token amounts snaked cell (ref 1)
+    const tokenAmountsCell = encodeTokenAmounts(message.tokenAmounts);
+    // ExtraArgs cell (ref 2)
+    const extraArgsCell = encodeExtraArgsCell(message.extraArgs);
+    return beginCell()
+        .storeUint(CCIP_SEND_OPCODE, 32) // opcode
+        .storeUint(Number(queryId), 64) // queryID
+        .storeUint(destChainSelector, 64) // destChainSelector
+        .storeUint(paddedReceiver.length, 8) // receiver length in bytes
+        .storeBuffer(paddedReceiver) // receiver bytes (32 bytes, left-padded)
+        .storeRef(dataCell) // ref 0: data
+        .storeRef(tokenAmountsCell) // ref 1: tokenAmounts
+        .storeAddress(feeTokenAddress) // null = addr_none for native TON
+        .storeRef(extraArgsCell) // ref 2: extraArgs
+        .endCell();
+}
+/**
+ * Gets the fee for sending a CCIP message by calling FeeQuoter.validatedFee.
+ *
+ * @param ctx - Context with TonClient provider and logger
+ * @param router - Router contract address
+ * @param destChainSelector - Destination chain selector
+ * @param message - CCIP message to quote
+ * @returns Fee amount in nanotons
+ */
+export async function getFee(ctx, router, destChainSelector, message) {
+    const { provider, logger = console } = ctx;
+    const routerAddress = Address.parse(router);
+    // FeeQuoter requires WRAPPED_NATIVE for native TON
+    const feeTokenAddress = message.feeToken ? Address.parse(message.feeToken) : WRAPPED_NATIVE;
+    // Get FeeQuoter address via OnRamp
+    let feeQuoterAddress;
+    try {
+        const { stack: onRampStack } = await provider.runMethod(routerAddress, 'onRamp', [
+            { type: 'int', value: destChainSelector },
+        ]);
+        const onRampAddress = onRampStack.readAddress();
+        logger.debug('OnRamp:', onRampAddress.toString());
+        const { stack: feeQuoterStack } = await provider.runMethod(onRampAddress, 'feeQuoter', [
+            { type: 'int', value: destChainSelector },
+        ]);
+        feeQuoterAddress = feeQuoterStack.readAddress();
+        logger.debug('FeeQuoter:', feeQuoterAddress.toString());
+    }
+    catch (e) {
+        throw new CCIPError(CCIPErrorCode.CONTRACT_TYPE_INVALID, `Could not get FeeQuoter address: ${e instanceof Error ? e.message : String(e)}`);
+    }
+    // Build stack parameters for validatedFee call
+    const paddedReceiver = bytesToBuffer(zeroPadValue(getDataBytes(message.receiver), 32));
+    const receiverSlice = beginCell().storeBuffer(paddedReceiver).endCell();
+    const dataCell = beginCell()
+        .storeBuffer(bytesToBuffer(message.data || '0x'))
+        .endCell();
+    const tokenAmountsCell = encodeTokenAmounts(message.tokenAmounts);
+    const extraArgsCell = encodeExtraArgsCell(message.extraArgs);
+    const feeTokenSlice = beginCell().storeAddress(feeTokenAddress).endCell();
+    const { stack: feeStack } = await provider.runMethod(feeQuoterAddress, 'validatedFee', [
+        { type: 'int', value: 0n },
+        { type: 'int', value: destChainSelector },
+        { type: 'slice', cell: receiverSlice },
+        { type: 'cell', cell: dataCell },
+        { type: 'cell', cell: tokenAmountsCell },
+        { type: 'slice', cell: feeTokenSlice },
+        { type: 'cell', cell: extraArgsCell },
+    ]);
+    const fee = feeStack.readBigNumber();
+    if (fee < 0n) {
+        throw new CCIPError(CCIPErrorCode.MESSAGE_INVALID, `Invalid fee: ${fee}`);
+    }
+    logger.debug('CCIP fee:', fee.toString(), 'nanotons');
+    return fee;
+}
+/**
+ * Generates an unsigned CCIP send transaction for the Router.
+ *
+ * @param ctx - Context with TonClient provider and logger
+ * @param _sender - Sender address (unused, for interface compatibility)
+ * @param router - Router contract address
+ * @param destChainSelector - Destination chain selector
+ * @param message - CCIP message with fee included
+ * @param opts - Optional gas buffer override
+ * @returns Unsigned transaction ready for signing
+ */
+export function generateUnsignedCcipSend(ctx, _sender, router, destChainSelector, message, opts) {
+    const { logger = console } = ctx;
+    const gasBuffer = opts?.gasBuffer ?? DEFAULT_GAS_BUFFER;
+    // Router accepts addr_none for native TON (unlike FeeQuoter which needs WRAPPED_NATIVE)
+    const feeTokenAddress = message.feeToken ? Address.parse(message.feeToken) : null;
+    const ccipSendCell = buildCcipSendCell(destChainSelector, message, feeTokenAddress);
+    const totalValue = message.fee + gasBuffer;
+    logger.debug('Generating ccipSend tx to router:', router);
+    logger.debug('Total value:', totalValue.toString(), 'nanotons');
+    return {
+        to: router,
+        body: ccipSendCell,
+        value: totalValue,
+    };
+}
+//# sourceMappingURL=send.js.map

package/dist/ton/send.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"send.js","sourceRoot":"","sources":["../../src/ton/send.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,SAAS,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AACxD,OAAO,EAAkB,OAAO,EAAE,MAAM,UAAU,CAAA;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAA;AAGrC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AAEpD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAEzD,2CAA2C;AAC3C,MAAM,CAAC,MAAM,gBAAgB,GAAG,UAAU,CAAA;AAE1C,iEAAiE;AACjE,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;AAE/C,wDAAwD;AACxD,MAAM,CAAC,MAAM,iBAAiB,GAAG,OAAQ,CAAA;AAEzC;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,OAAO,CAAC,KAAK,CACzC,oEAAoE,CACrE,CAAA;AAED;;;GAGG;AACH,SAAS,kBAAkB,CACzB,YAAsE;IAEtE,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/C,OAAO,SAAS,EAAE,CAAC,OAAO,EAAE,CAAA;IAC9B,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,EAAE,CAAA;IAC3B,KAAK,MAAM,EAAE,IAAI,YAAY,EAAE,CAAC;QAC9B,OAAO,CAAC,QAAQ,CACd,SAAS,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,EAAE,CACtF,CAAA;IACH,CAAC;IACD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;AAC1B,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,mBAAmB,CAAC,SAAkC;IAC7D,MAAM,wBAAwB,GAAG,IAAI,CAAA;IAErC,IAAI,QAAQ,GAAG,EAAE,CAAA;IACjB,IAAI,WAAW,GAAG,KAAK,CAAA;IAEvB,IAAI,UAAU,IAAI,SAAS,IAAI,SAAS,CAAC,QAAQ,GAAG,EAAE,EAAE,CAAC;QACvD,WAAW,GAAG,IAAI,CAAA;QAClB,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAA;IAC/B,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,EAAE;SACxB,SAAS,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,EAAE,CAAC,CAAC,aAAa;SACtD,QAAQ,CAAC,WAAW,CAAC,CAAA;IAExB,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;IAClC,CAAC;IAED,OAAO,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC,OAAO,EAAE,CAAA;AAC7D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAC/B,iBAAyB,EACzB,OAAmB,EACnB,kBAAkC,IAAI,EACtC,OAAO,GAAG,EAAE;IAEZ,kEAAkE;IAClE,MAAM,cAAc,GAAG,aAAa,CAAC,YAAY,CAAC,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;IAEtF,oBAAoB;IACpB,MAAM,QAAQ,GAAG,SAAS,EAAE;SACzB,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC;SAChD,OAAO,EAAE,CAAA;IAEZ,oCAAoC;IACpC,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;IAEjE,yBAAyB;IACzB,MAAM,aAAa,GAAG,mBAAmB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IAE5D,OAAO,SAAS,EAAE;SACf,SAAS,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,SAAS;SACzC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC,UAAU;SACzC,SAAS,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,oBAAoB;SACrD,SAAS,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,2BAA2B;SAC/D,WAAW,CAAC,cAAc,CAAC,CAAC,yCAAyC;SACrE,QAAQ,CAAC,QAAQ,CAAC,CAAC,cAAc;SACjC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,sBAAsB;SACjD,YAAY,CAAC,eAAe,CAAC,CAAC,kCAAkC;SAChE,QAAQ,CAAC,aAAa,CAAC,CAAC,mBAAmB;SAC3C,OAAO,EAAE,CAAA;AACd,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,GAAyC,EACzC,MAAc,EACd,iBAAyB,EACzB,OAAmB;IAEnB,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,EAAE,GAAG,GAAG,CAAA;IAC1C,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IAE3C,mDAAmD;IACnD,MAAM,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,CAAA;IAE3F,mCAAmC;IACnC,IAAI,gBAAyB,CAAA;IAC7B,IAAI,CAAC;QACH,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,MAAM,QAAQ,CAAC,SAAS,CAAC,aAAa,EAAE,QAAQ,EAAE;YAC/E,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,iBAAiB,EAAE;SAC1C,CAAC,CAAA;QACF,MAAM,aAAa,GAAG,WAAW,CAAC,WAAW,EAAE,CAAA;QAC/C,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAA;QAEjD,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,MAAM,QAAQ,CAAC,SAAS,CAAC,aAAa,EAAE,WAAW,EAAE;YACrF,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,iBAAiB,EAAE;SAC1C,CAAC,CAAA;QACF,gBAAgB,GAAG,cAAc,CAAC,WAAW,EAAE,CAAA;QAC/C,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,gBAAgB,CAAC,QAAQ,EAAE,CAAC,CAAA;IACzD,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,IAAI,SAAS,CACjB,aAAa,CAAC,qBAAqB,EACnC,oCAAoC,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CACjF,CAAA;IACH,CAAC;IAED,+CAA+C;IAC/C,MAAM,cAAc,GAAG,aAAa,CAAC,YAAY,CAAC,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;IACtF,MAAM,aAAa,GAAG,SAAS,EAAE,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,OAAO,EAAE,CAAA;IACvE,MAAM,QAAQ,GAAG,SAAS,EAAE;SACzB,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC;SAChD,OAAO,EAAE,CAAA;IACZ,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;IACjE,MAAM,aAAa,GAAG,mBAAmB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IAC5D,MAAM,aAAa,GAAG,SAAS,EAAE,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,OAAO,EAAE,CAAA;IAEzE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,MAAM,QAAQ,CAAC,SAAS,CAAC,gBAAgB,EAAE,cAAc,EAAE;QACrF,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE;QAC1B,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,iBAAiB,EAAE;QACzC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE;QACtC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE;QAChC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE;QACxC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE;QACtC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE;KACtC,CAAC,CAAA;IAEF,MAAM,GAAG,GAAG,QAAQ,CAAC,aAAa,EAAE,CAAA;IACpC,IAAI,GAAG,GAAG,EAAE,EAAE,CAAC;QACb,MAAM,IAAI,SAAS,CAAC,aAAa,CAAC,eAAe,EAAE,gBAAgB,GAAG,EAAE,CAAC,CAAA;IAC3E,CAAC;IACD,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,GAAG,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAA;IACrD,OAAO,GAAG,CAAA;AACZ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,wBAAwB,CACtC,GAAyC,EACzC,OAAe,EACf,MAAc,EACd,iBAAyB,EACzB,OAAqC,EACrC,IAA6B;IAE7B,MAAM,EAAE,MAAM,GAAG,OAAO,EAAE,GAAG,GAAG,CAAA;IAChC,MAAM,SAAS,GAAG,IAAI,EAAE,SAAS,IAAI,kBAAkB,CAAA;IAEvD,wFAAwF;IACxF,MAAM,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IAEjF,MAAM,YAAY,GAAG,iBAAiB,CAAC,iBAAiB,EAAE,OAAO,EAAE,eAAe,CAAC,CAAA;IACnF,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,GAAG,SAAS,CAAA;IAE1C,MAAM,CAAC,KAAK,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAA;IACzD,MAAM,CAAC,KAAK,CAAC,cAAc,EAAE,UAAU,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAA;IAE/D,OAAO;QACL,EAAE,EAAE,MAAM;QACV,IAAI,EAAE,YAAY;QAClB,KAAK,EAAE,UAAU;KAClB,CAAA;AACH,CAAC"}

package/dist/types.d.ts

@@ -1,5 +1,6 @@
 import type { AbiParametersToPrimitiveTypes, ExtractAbiEvent } from 'abitype';
 import type { BytesLike, Log } from 'ethers';
+import type { APICCIPRequestMetadata } from './api/types.ts';
 import type OffRamp_1_6_ABI from './evm/abi/OffRamp_1_6.ts';
 import type { CCIPMessage_EVM, CCIPMessage_V1_6_EVM } from './evm/messages.ts';
 import type { ExtraArgs } from './extra-args.ts';
@@ -77,6 +78,17 @@ type ChainFamilyWithId<F extends ChainFamily> = F extends typeof ChainFamily.EVM
 } : never;
 /**
  * Network information including chain selector and metadata.
+ *
+ * @example
+ * ```typescript
+ * const info: NetworkInfo = {
+ *   chainSelector: 16015286601757825753n,
+ *   name: 'ethereum-testnet-sepolia',
+ *   networkType: 'TESTNET',
+ *   family: 'EVM',
+ *   chainId: 11155111,
+ * }
+ * ```
  */
 export type NetworkInfo<F extends ChainFamily = ChainFamily> = {
     /** Unique chain selector used by CCIP. */
@@ -88,6 +100,16 @@ export type NetworkInfo<F extends ChainFamily = ChainFamily> = {
 } & ChainFamilyWithId<F>;
 /**
  * CCIP lane configuration connecting source and destination chains.
+ *
+ * @example
+ * ```typescript
+ * const lane: Lane = {
+ *   sourceChainSelector: 16015286601757825753n, // Ethereum Sepolia
+ *   destChainSelector: 12532609583862916517n,   // Polygon Mumbai
+ *   onRamp: '0x1234...abcd',
+ *   version: '1.6.0',
+ * }
+ * ```
  */
 export interface Lane<V extends CCIPVersion = CCIPVersion> {
     /** Source chain selector. */
@@ -114,6 +136,17 @@ export type Log_ = Pick<Log, 'topics' | 'index' | 'address' | 'blockNumber' | 't
 };
 /**
  * Generic transaction structure compatible across chain families.
+ *
+ * @example
+ * ```typescript
+ * const tx: ChainTransaction = {
+ *   hash: '0xabc123...',
+ *   logs: [],
+ *   blockNumber: 12345678,
+ *   timestamp: 1704067200,
+ *   from: '0x1234...abcd',
+ * }
+ * ```
  */
 export type ChainTransaction = {
     /** Transaction hash. */
@@ -141,6 +174,28 @@ export interface CCIPRequest<V extends CCIPVersion = CCIPVersion> {
     log: Log_;
     /** Transaction that emitted the request. */
     tx: Pick<ChainTransaction, 'hash' | 'logs' | 'blockNumber' | 'timestamp' | 'from' | 'error'>;
+    /**
+     * API-enriched metadata. Present only when fetched via CCIP API.
+     *
+     * @remarks
+     * When a request is fetched using {@link Chain.getMessageById} or as a fallback
+     * in {@link Chain.getMessagesInTx}, this field contains additional information
+     * including message status, execution details, and network info.
+     *
+     * When constructed from on-chain data only, this field is `undefined`.
+     *
+     * @example
+     * ```typescript
+     * const request = await chain.getMessageById(messageId)
+     * if (request.metadata) {
+     *   console.log('Status:', request.metadata.status)
+     *   console.log('Delivery time:', request.metadata.deliveryTime)
+     * }
+     * ```
+     *
+     * @see {@link APICCIPRequestMetadata}
+     */
+    metadata?: APICCIPRequestMetadata;
 }
 /**
  * Commit report structure from the OffRamp CommitReportAccepted event.
@@ -210,6 +265,16 @@ export declare const IntentStatus: {
 export type IntentStatus = (typeof IntentStatus)[keyof typeof IntentStatus];
 /**
  * Receipt of a CCIP message execution on the destination chain.
+ *
+ * @example
+ * ```typescript
+ * const receipt: ExecutionReceipt = {
+ *   messageId: '0xabc123...',
+ *   sequenceNumber: 42n,
+ *   state: ExecutionState.Success,
+ *   sourceChainSelector: 16015286601757825753n,
+ * }
+ * ```
  */
 export type ExecutionReceipt = {
     /** Unique message identifier. */
@@ -247,6 +312,17 @@ export type OffchainTokenData = {
 } | undefined;
 /**
  * Execution report containing message, proofs, and offchain token data.
+ *
+ * @example
+ * ```typescript
+ * const report: ExecutionReport = {
+ *   message: { messageId: '0x...', ... },
+ *   proofs: ['0xproof1...', '0xproof2...'],
+ *   proofFlagBits: 0n,
+ *   merkleRoot: '0xroot...',
+ *   offchainTokenData: [],
+ * }
+ * ```
  */
 export type ExecutionReport<M extends CCIPMessage = CCIPMessage> = {
     /** The CCIP message to execute. */
@@ -262,6 +338,16 @@ export type ExecutionReport<M extends CCIPMessage = CCIPMessage> = {
 };
 /**
  * A message to be sent to another network.
+ *
+ * @example
+ * ```typescript
+ * const message: AnyMessage = {
+ *   receiver: '0x1234...abcd',
+ *   extraArgs: { gasLimit: 200_000n, allowOutOfOrderExecution: true },
+ *   data: '0xdeadbeef',
+ *   tokenAmounts: [{ token: '0xtoken...', amount: 1000000n }],
+ * }
+ * ```
  */
 export type AnyMessage = {
     /** Receiver address on the destination chain. */
@@ -279,7 +365,22 @@ export type AnyMessage = {
     feeToken?: string;
 };
 /**
- * Partial [[AnyMessage]], which populates default fields like `extraArgs` if needed
+ * Partial {@link AnyMessage}, which populates default fields like `extraArgs` if needed.
+ *
+ * @example
+ * ```typescript
+ * // Minimal input - only receiver required, defaults applied for extraArgs
+ * const input: MessageInput = {
+ *   receiver: '0x1234...abcd',
+ * }
+ *
+ * // With custom gas limit
+ * const inputWithGas: MessageInput = {
+ *   receiver: '0x1234...abcd',
+ *   extraArgs: { gasLimit: 500_000n },
+ *   data: '0xdeadbeef',
+ * }
+ * ```
  */
 export type MessageInput = Partial<AnyMessage> & {
     receiver: AnyMessage['receiver'];

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAC7E,OAAO,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAA;AAE5C,OAAO,KAAK,eAAe,MAAM,0BAA0B,CAAA;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAA;AAC9E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAA;AAChE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AAC1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AAE1D,YAAY,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AAEzD;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAA;IACnC,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAA;IAClC,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAA;IAClC,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAA;CACpC,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI;KACpC,CAAC,IAAI,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAAG,MAAM,CAAC,GAC7C,CAAC,CAAC,CAAC,CAAC,SAAS,OAAO,EAAE,GACpB,CAAC,CAAC,CAAC,CAAC,SAAS,OAAO,EAAE,GACpB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAC/B,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,OAAO,EAAE,GAC7B,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GACxC,KAAK,GACT,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,OAAO,EAAE,GAC7B,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,OAAO,EAAE,GAC7B,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GACxC,KAAK,GACP,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,OAAO,EAAE,GAC7B,KAAK,GACL,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GACpC,CAAC,SAAS,MAAM,CAAC,GACf,CAAC,CAAC,CAAC,CAAC,GACJ,CAAC,SAAS,MAAM,CAAC,GACf,CAAC,CAAC,CAAC,CAAC,GACJ,KAAK;CACd,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;;CAOd,CAAA;AACV,6DAA6D;AAC7D,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAA;AAExE;;GAEG;AACH,eAAO,MAAM,WAAW;;;CAGd,CAAA;AACV,sDAAsD;AACtD,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAA;AAExE;;GAEG;AACH,eAAO,MAAM,WAAW;;;;CAId,CAAA;AACV,4DAA4D;AAC5D,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAA;AAExE,iEAAiE;AACjE,KAAK,iBAAiB,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,SAC7C,OAAO,WAAW,CAAC,GAAG,GACtB,OAAO,WAAW,CAAC,GAAG,GACtB;IAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAChD,CAAC,SAAS,OAAO,WAAW,CAAC,MAAM,GACjC;IAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAChD,CAAC,SAAS,OAAO,WAAW,CAAC,KAAK,GAAG,OAAO,WAAW,CAAC,GAAG,GACzD;IAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAA;CAAE,GACrE,KAAK,CAAA;AAEb;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI;IAC7D,0CAA0C;IAC1C,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,mCAAmC;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,gCAAgC;IAChC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAA;CAClC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAA;AAExB;;GAEG;AACH,MAAM,WAAW,IAAI,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW;IACvD,6BAA6B;IAC7B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,kCAAkC;IAClC,iBAAiB,EAAE,MAAM,CAAA;IACzB,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAA;IACd,2CAA2C;IAC3C,OAAO,EAAE,CAAC,CAAA;CACX;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI,CAAC,SAC5D,OAAO,WAAW,CAAC,IAAI,GACvB,OAAO,WAAW,CAAC,IAAI,GACvB,eAAe,CAAC,CAAC,CAAC,GAClB,oBAAoB,GAAG,uBAAuB,GAAG,oBAAoB,GAAG,oBAAoB,CAAA;AAEhG;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,aAAa,GAAG,iBAAiB,CAAC,GAAG;IACjG,0CAA0C;IAC1C,IAAI,EAAE,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,wDAAwD;IACxD,EAAE,CAAC,EAAE,gBAAgB,CAAA;CACtB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,wCAAwC;IACxC,IAAI,EAAE,SAAS,IAAI,EAAE,CAAA;IACrB,gDAAgD;IAChD,WAAW,EAAE,MAAM,CAAA;IACnB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAA;IACjB,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,4CAA4C;IAC5C,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW;IAC9D,2CAA2C;IAC3C,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAA;IACb,mCAAmC;IACnC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;IACvB,iCAAiC;IACjC,GAAG,EAAE,IAAI,CAAA;IACT,4CAA4C;IAC5C,EAAE,EAAE,IAAI,CAAC,gBAAgB,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,WAAW,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;CAC7F;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,6BAA6B,CACtD,eAAe,CAAC,OAAO,eAAe,EAAE,sBAAsB,CAAC,CAAC,QAAQ,CAAC,CAC1E,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;AAEZ;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,8BAA8B;IAC9B,MAAM,EAAE,YAAY,CAAA;IACpB,iCAAiC;IACjC,GAAG,EAAE,IAAI,CAAA;CACV;AAED;;GAEG;AACH,eAAO,MAAM,cAAc;IACzB,gCAAgC;;IAEhC,wCAAwC;;IAExC,wBAAwB;;CAEhB,CAAA;AACV,kDAAkD;AAClD,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAA;AAEjF;;;GAGG;AACH,eAAO,MAAM,aAAa;IACxB,0DAA0D;;IAE1D,0CAA0C;;IAE1C,mDAAmD;;IAEnD,iDAAiD;;IAEjD,oDAAoD;;IAEpD,+CAA+C;;IAE/C,oDAAoD;;IAEpD,oDAAoD;;IAEpD,qCAAqC;;CAE7B,CAAA;AACV,yDAAyD;AACzD,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAA;AAE9E;;;GAGG;AACH,eAAO,MAAM,YAAY;IACvB,4CAA4C;;IAE5C,qCAAqC;;IAErC,qBAAqB;;CAEb,CAAA;AACV,oDAAoD;AACpD,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAA;AAE3E;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,iCAAiC;IACjC,SAAS,EAAE,MAAM,CAAA;IACjB,sCAAsC;IACtC,cAAc,EAAE,MAAM,CAAA;IACtB,+BAA+B;IAC/B,KAAK,EAAE,cAAc,CAAA;IACrB,4CAA4C;IAC5C,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,uDAAuD;IACvD,UAAU,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/C,gDAAgD;IAChD,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,8BAA8B;IAC9B,OAAO,EAAE,gBAAgB,CAAA;IACzB,oCAAoC;IACpC,GAAG,EAAE,IAAI,CAAA;IACT,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,SAAS,CAAA;AAEpF;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI;IACjE,mCAAmC;IACnC,OAAO,EAAE,CAAC,CAAA;IACV,qCAAqC;IACrC,MAAM,EAAE,SAAS,SAAS,EAAE,CAAA;IAC5B,wCAAwC;IACxC,aAAa,EAAE,MAAM,CAAA;IACrB,oCAAoC;IACpC,UAAU,EAAE,MAAM,CAAA;IAClB,mDAAmD;IACnD,iBAAiB,EAAE,SAAS,iBAAiB,EAAE,CAAA;CAChD,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,iDAAiD;IACjD,QAAQ,EAAE,SAAS,CAAA;IACnB,yDAAyD;IACzD,SAAS,EAAE,SAAS,CAAA;IACpB,8BAA8B;IAC9B,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB,gCAAgC;IAChC,YAAY,CAAC,EAAE,SAAS;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAC3D,sDAAsD;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG;IAC/C,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;IAChC,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAC7E,OAAO,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAA;AAE5C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAA;AAC5D,OAAO,KAAK,eAAe,MAAM,0BAA0B,CAAA;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAA;AAC9E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAA;AAChE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AAC1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AAE1D,YAAY,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AAEzD;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAA;IACnC,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAA;IAClC,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAA;IAClC,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAA;CACpC,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI;KACpC,CAAC,IAAI,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAAG,MAAM,CAAC,GAC7C,CAAC,CAAC,CAAC,CAAC,SAAS,OAAO,EAAE,GACpB,CAAC,CAAC,CAAC,CAAC,SAAS,OAAO,EAAE,GACpB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAC/B,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,OAAO,EAAE,GAC7B,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GACxC,KAAK,GACT,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,OAAO,EAAE,GAC7B,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,OAAO,EAAE,GAC7B,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GACxC,KAAK,GACP,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,OAAO,EAAE,GAC7B,KAAK,GACL,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GACpC,CAAC,SAAS,MAAM,CAAC,GACf,CAAC,CAAC,CAAC,CAAC,GACJ,CAAC,SAAS,MAAM,CAAC,GACf,CAAC,CAAC,CAAC,CAAC,GACJ,KAAK;CACd,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;;CAOd,CAAA;AACV,6DAA6D;AAC7D,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAA;AAExE;;GAEG;AACH,eAAO,MAAM,WAAW;;;CAGd,CAAA;AACV,sDAAsD;AACtD,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAA;AAExE;;GAEG;AACH,eAAO,MAAM,WAAW;;;;CAId,CAAA;AACV,4DAA4D;AAC5D,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAA;AAExE,iEAAiE;AACjE,KAAK,iBAAiB,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,SAC7C,OAAO,WAAW,CAAC,GAAG,GACtB,OAAO,WAAW,CAAC,GAAG,GACtB;IAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAChD,CAAC,SAAS,OAAO,WAAW,CAAC,MAAM,GACjC;IAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAChD,CAAC,SAAS,OAAO,WAAW,CAAC,KAAK,GAAG,OAAO,WAAW,CAAC,GAAG,GACzD;IAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAA;CAAE,GACrE,KAAK,CAAA;AAEb;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI;IAC7D,0CAA0C;IAC1C,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,mCAAmC;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,gCAAgC;IAChC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAA;CAClC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAA;AAExB;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,IAAI,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW;IACvD,6BAA6B;IAC7B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,kCAAkC;IAClC,iBAAiB,EAAE,MAAM,CAAA;IACzB,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAA;IACd,2CAA2C;IAC3C,OAAO,EAAE,CAAC,CAAA;CACX;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI,CAAC,SAC5D,OAAO,WAAW,CAAC,IAAI,GACvB,OAAO,WAAW,CAAC,IAAI,GACvB,eAAe,CAAC,CAAC,CAAC,GAClB,oBAAoB,GAAG,uBAAuB,GAAG,oBAAoB,GAAG,oBAAoB,CAAA;AAEhG;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,aAAa,GAAG,iBAAiB,CAAC,GAAG;IACjG,0CAA0C;IAC1C,IAAI,EAAE,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,wDAAwD;IACxD,EAAE,CAAC,EAAE,gBAAgB,CAAA;CACtB,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,wCAAwC;IACxC,IAAI,EAAE,SAAS,IAAI,EAAE,CAAA;IACrB,gDAAgD;IAChD,WAAW,EAAE,MAAM,CAAA;IACnB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAA;IACjB,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,4CAA4C;IAC5C,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW;IAC9D,2CAA2C;IAC3C,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAA;IACb,mCAAmC;IACnC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;IACvB,iCAAiC;IACjC,GAAG,EAAE,IAAI,CAAA;IACT,4CAA4C;IAC5C,EAAE,EAAE,IAAI,CAAC,gBAAgB,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,WAAW,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;IAE5F;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,CAAC,EAAE,sBAAsB,CAAA;CAClC;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,6BAA6B,CACtD,eAAe,CAAC,OAAO,eAAe,EAAE,sBAAsB,CAAC,CAAC,QAAQ,CAAC,CAC1E,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;AAEZ;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,8BAA8B;IAC9B,MAAM,EAAE,YAAY,CAAA;IACpB,iCAAiC;IACjC,GAAG,EAAE,IAAI,CAAA;CACV;AAED;;GAEG;AACH,eAAO,MAAM,cAAc;IACzB,gCAAgC;;IAEhC,wCAAwC;;IAExC,wBAAwB;;CAEhB,CAAA;AACV,kDAAkD;AAClD,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAA;AAEjF;;;GAGG;AACH,eAAO,MAAM,aAAa;IACxB,0DAA0D;;IAE1D,0CAA0C;;IAE1C,mDAAmD;;IAEnD,iDAAiD;;IAEjD,oDAAoD;;IAEpD,+CAA+C;;IAE/C,oDAAoD;;IAEpD,oDAAoD;;IAEpD,qCAAqC;;CAE7B,CAAA;AACV,yDAAyD;AACzD,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAA;AAE9E;;;GAGG;AACH,eAAO,MAAM,YAAY;IACvB,4CAA4C;;IAE5C,qCAAqC;;IAErC,qBAAqB;;CAEb,CAAA;AACV,oDAAoD;AACpD,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAA;AAE3E;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,iCAAiC;IACjC,SAAS,EAAE,MAAM,CAAA;IACjB,sCAAsC;IACtC,cAAc,EAAE,MAAM,CAAA;IACtB,+BAA+B;IAC/B,KAAK,EAAE,cAAc,CAAA;IACrB,4CAA4C;IAC5C,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,uDAAuD;IACvD,UAAU,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/C,gDAAgD;IAChD,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,8BAA8B;IAC9B,OAAO,EAAE,gBAAgB,CAAA;IACzB,oCAAoC;IACpC,GAAG,EAAE,IAAI,CAAA;IACT,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,SAAS,CAAA;AAEpF;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI;IACjE,mCAAmC;IACnC,OAAO,EAAE,CAAC,CAAA;IACV,qCAAqC;IACrC,MAAM,EAAE,SAAS,SAAS,EAAE,CAAA;IAC5B,wCAAwC;IACxC,aAAa,EAAE,MAAM,CAAA;IACrB,oCAAoC;IACpC,UAAU,EAAE,MAAM,CAAA;IAClB,mDAAmD;IACnD,iBAAiB,EAAE,SAAS,iBAAiB,EAAE,CAAA;CAChD,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,iDAAiD;IACjD,QAAQ,EAAE,SAAS,CAAA;IACnB,yDAAyD;IACzD,SAAS,EAAE,SAAS,CAAA;IACpB,8BAA8B;IAC9B,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB,gCAAgC;IAChC,YAAY,CAAC,EAAE,SAAS;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAC3D,sDAAsD;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG;IAC/C,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;IAChC,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA"}

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AA0DA;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,GAAG,EAAE,KAAK;IACV,MAAM,EAAE,KAAK;IACb,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,KAAK;IACV,OAAO,EAAE,SAAS;CACV,CAAA;AAIV;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;CACV,CAAA;AAIV;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,IAAI,EAAE,OAAO;IACb,IAAI,EAAE,OAAO;IACb,IAAI,EAAE,OAAO;CACL,CAAA;AA6GV;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,gCAAgC;IAChC,UAAU,EAAE,CAAC;IACb,wCAAwC;IACxC,OAAO,EAAE,CAAC;IACV,wBAAwB;IACxB,MAAM,EAAE,CAAC;CACD,CAAA;AAIV;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,0DAA0D;IAC1D,IAAI,EAAE,MAAM;IACZ,0CAA0C;IAC1C,eAAe,EAAE,kBAAkB;IACnC,mDAAmD;IACnD,SAAS,EAAE,WAAW;IACtB,iDAAiD;IACjD,OAAO,EAAE,SAAS;IAClB,oDAAoD;IACpD,OAAO,EAAE,SAAS;IAClB,+CAA+C;IAC/C,MAAM,EAAE,QAAQ;IAChB,oDAAoD;IACpD,SAAS,EAAE,WAAW;IACtB,oDAAoD;IACpD,QAAQ,EAAE,UAAU;IACpB,qCAAqC;IACrC,OAAO,EAAE,SAAS;CACV,CAAA;AAIV;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,4CAA4C;IAC5C,OAAO,EAAE,SAAS;IAClB,qCAAqC;IACrC,SAAS,EAAE,WAAW;IACtB,qBAAqB;IACrB,MAAM,EAAE,QAAQ;CACR,CAAA"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AA2DA;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,GAAG,EAAE,KAAK;IACV,MAAM,EAAE,KAAK;IACb,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,KAAK;IACV,OAAO,EAAE,SAAS;CACV,CAAA;AAIV;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;CACV,CAAA;AAIV;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,IAAI,EAAE,OAAO;IACb,IAAI,EAAE,OAAO;IACb,IAAI,EAAE,OAAO;CACL,CAAA;AAoKV;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,gCAAgC;IAChC,UAAU,EAAE,CAAC;IACb,wCAAwC;IACxC,OAAO,EAAE,CAAC;IACV,wBAAwB;IACxB,MAAM,EAAE,CAAC;CACD,CAAA;AAIV;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,0DAA0D;IAC1D,IAAI,EAAE,MAAM;IACZ,0CAA0C;IAC1C,eAAe,EAAE,kBAAkB;IACnC,mDAAmD;IACnD,SAAS,EAAE,WAAW;IACtB,iDAAiD;IACjD,OAAO,EAAE,SAAS;IAClB,oDAAoD;IACpD,OAAO,EAAE,SAAS;IAClB,+CAA+C;IAC/C,MAAM,EAAE,QAAQ;IAChB,oDAAoD;IACpD,SAAS,EAAE,WAAW;IACtB,oDAAoD;IACpD,QAAQ,EAAE,UAAU;IACpB,qCAAqC;IACrC,OAAO,EAAE,SAAS;CACV,CAAA;AAIV;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,4CAA4C;IAC5C,OAAO,EAAE,SAAS;IAClB,qCAAqC;IACrC,SAAS,EAAE,WAAW;IACtB,qBAAqB;IACrB,MAAM,EAAE,QAAQ;CACR,CAAA"}

package/dist/utils.d.ts

@@ -10,7 +10,8 @@ import { type NetworkInfo, type WithLogger, ChainFamily } from './types.ts';
  * @param timestamp - target timestamp
  * @param precision - returned blockNumber should be within this many blocks before timestamp
  * @returns blockNumber of a block at provider which is close but before target timestamp
- **/
+ * @throws {@link CCIPBlockBeforeTimestampNotFoundError} if no block exists before the given timestamp
+ */
 export declare function getSomeBlockNumberBefore(getBlockTimestamp: (blockNumber: number) => Promise<number>, recentBlockNumber: number, timestamp: number, { precision, logger }?: {
     precision?: number;
 } & WithLogger): Promise<number>;
@@ -22,6 +23,7 @@ export declare function getSomeBlockNumberBefore(getBlockTimestamp: (blockNumber
  *   - Chain ID as number, bigint or string (EVM: "1", Aptos: "aptos:1", Solana: genesisHash)
  *   - Chain name as string ("ethereum-mainnet")
  * @returns Complete NetworkInfo object
+ * @throws {@link CCIPChainNotFoundError} if chain is not found
  */
 export declare const networkInfo: import("micro-memoize").Memoized<(selectorOrIdOrName: bigint | number | string) => NetworkInfo, {}>;
 /**
@@ -68,11 +70,19 @@ export declare function bigIntReviver(_key: string, value: unknown): unknown;
 export declare function parseJson<T = unknown>(text: string): T;
 /**
  * Decode address from a 32-byte hex string
- **/
+ * @param address - Address bytes to decode
+ * @param family - Chain family for address format (defaults to EVM)
+ * @returns Decoded address string
+ * @throws {@link CCIPChainFamilyUnsupportedError} if chain family is not supported
+ */
 export declare function decodeAddress(address: BytesLike, family?: ChainFamily): string;
 /**
  * Validate a value is a txHash string in some supported chain family
- **/
+ * @param txHash - Value to check
+ * @param family - Optional chain family to validate against
+ * @returns true if value is a valid transaction hash
+ * @throws {@link CCIPChainFamilyUnsupportedError} if specified chain family is not supported
+ */
 export declare function isSupportedTxHash(txHash: unknown, family?: ChainFamily): txHash is string;
 /**
  * Version of decodeAddress which is aware of custom cross-chain OnRamp formats
@@ -101,6 +111,7 @@ export declare function isBase64(data: unknown): data is string;
  * Converts various data formats to Uint8Array.
  * @param data - Bytes, number array, or Base64 string.
  * @returns Uint8Array representation.
+ * @throws {@link CCIPDataFormatUnsupportedError} if data format is not recognized
  */
 export declare function getDataBytes(data: BytesLike | readonly number[]): Uint8Array;
 /**
@@ -178,6 +189,7 @@ export declare function withRetry<T>(operation: () => Promise<T>, config: WithRe
  * Parses a typeAndVersion string into its components.
  * @param typeAndVersion - String in format "TypeName vX.Y.Z".
  * @returns Tuple of [type, version, original, suffix?].
+ * @throws {@link CCIPTypeVersionInvalidError} if string format is invalid
  */
 export declare function parseTypeAndVersion(typeAndVersion: string): Awaited<ReturnType<Chain['typeAndVersion']>>;
 type RateLimitOpts = {

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAG/B,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,OAAO,EAMb,MAAM,QAAQ,CAAA;AAIf,OAAO,KAAK,EAAE,KAAK,EAAe,MAAM,YAAY,CAAA;AAcpD,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,UAAU,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAE3E;;;;;;;;IAQI;AACJ,wBAAsB,wBAAwB,CAC5C,iBAAiB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,EAC3D,iBAAiB,EAAE,MAAM,EACzB,SAAS,EAAE,MAAM,EACjB,EAAE,SAAc,EAAE,MAAgB,EAAE,GAAE;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,UAAe,GAC7E,OAAO,CAAC,MAAM,CAAC,CA2DjB;AAkBD;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,wDACF,MAAM,GAAG,MAAM,GAAG,MAAM,KAC3C,WAAW,KAmCZ,CAAA;AAGF;;;;IAII;AACJ,wBAAiB,mBAAmB,CAClC,MAAM,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,CAAC;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC;;;;;;;;kBAqBlG;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAKpE;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAKnE;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,CAEtD;AAED;;IAEI;AACJ,wBAAgB,aAAa,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM,GAAE,WAA6B,GAAG,MAAM,CAI/F;AAED;;IAEI;AACJ,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,MAAM,IAAI,MAAM,CAazF;AAED;;IAEI;AACJ,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,SAAS,EAClB,MAAM,GAAE,WAA6B,GACpC,MAAM,CAIR;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,MAAM,EAAE,GAAG,MAAM,CAGtE;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,CAAC,EAAE,OAAO,GAAG,UAAU,CAE1E;AACD;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,MAAM,CAKtD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,MAAM,EAAE,GAAG,UAAU,CAa5E;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS,MAAM,EAAE,GAAG,MAAM,CAE1E;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,SAAS,GAAG,SAAS,MAAM,EAAE,GAAG,UAAU,CA6BlF;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,GAAG,EAAE,OAAO,EACZ,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM,KAAK,OAAO,EACrD,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAiBT;AAED;;;;GAIG;AACH,eAAO,MAAM,KAAK,GAAI,IAAI,MAAM,qBAA8D,CAAA;AAE9F;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,uCAAuC;IACvC,UAAU,EAAE,MAAM,CAAA;IAClB,2DAA2D;IAC3D,cAAc,EAAE,MAAM,CAAA;IACtB,mDAAmD;IACnD,iBAAiB,EAAE,MAAM,CAAA;IACzB,oDAAoD;IACpD,UAAU,EAAE,MAAM,CAAA;IAClB,uDAAuD;IACvD,qBAAqB,EAAE,OAAO,CAAA;IAC9B,yCAAyC;IACzC,MAAM,CAAC,EAAE;QAAE,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;QAAC,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAA;KAAE,CAAA;CACrF,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,SAAS,CAAC,CAAC,EAC/B,SAAS,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAC3B,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,CAAC,CAAC,CAyDZ;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAe9C;AAGD,KAAK,aAAa,GAAG;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,CAAA;AAsFlF;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,GAAE,OAAO,CAAC,aAAa,CAAM,EACjC,EAAE,MAAgB,EAAE,GAAE,UAAe,GACpC,OAAO,KAAK,CA0Fd;AAGD,QAAA,MAAM,IAAI;aAKW,CAAC,CAAC,CAAC,EAAE,OAAO,KAAK,MAAM,CAAC,GAAG;QAClC,MAAM,EAAE,MAAM,CAAA;QACd,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACxC;CAWN,CAAA;AACP,OAAO,EAAE,IAAI,EAAE,CAAA"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAG/B,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,OAAO,EAMb,MAAM,QAAQ,CAAA;AAIf,OAAO,KAAK,EAAE,KAAK,EAAe,MAAM,YAAY,CAAA;AAcpD,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,UAAU,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAE3E;;;;;;;;;GASG;AACH,wBAAsB,wBAAwB,CAC5C,iBAAiB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,EAC3D,iBAAiB,EAAE,MAAM,EACzB,SAAS,EAAE,MAAM,EACjB,EAAE,SAAc,EAAE,MAAgB,EAAE,GAAE;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,UAAe,GAC7E,OAAO,CAAC,MAAM,CAAC,CA2DjB;AAkBD;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW,wDACF,MAAM,GAAG,MAAM,GAAG,MAAM,KAC3C,WAAW,KAmCZ,CAAA;AAGF;;;;IAII;AACJ,wBAAiB,mBAAmB,CAClC,MAAM,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,CAAC;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC;;;;;;;;kBAqBlG;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAKpE;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAKnE;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,CAEtD;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM,GAAE,WAA6B,GAAG,MAAM,CAI/F;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,MAAM,IAAI,MAAM,CAazF;AAED;;IAEI;AACJ,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,SAAS,EAClB,MAAM,GAAE,WAA6B,GACpC,MAAM,CAIR;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,MAAM,EAAE,GAAG,MAAM,CAGtE;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,CAAC,EAAE,OAAO,GAAG,UAAU,CAE1E;AACD;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,MAAM,CAKtD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,MAAM,EAAE,GAAG,UAAU,CAa5E;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS,MAAM,EAAE,GAAG,MAAM,CAE1E;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,SAAS,GAAG,SAAS,MAAM,EAAE,GAAG,UAAU,CA6BlF;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,GAAG,EAAE,OAAO,EACZ,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM,KAAK,OAAO,EACrD,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAiBT;AAED;;;;GAIG;AAEH,eAAO,MAAM,KAAK,GAAI,IAAI,MAAM,qBAAgE,CAAA;AAEhG;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,uCAAuC;IACvC,UAAU,EAAE,MAAM,CAAA;IAClB,2DAA2D;IAC3D,cAAc,EAAE,MAAM,CAAA;IACtB,mDAAmD;IACnD,iBAAiB,EAAE,MAAM,CAAA;IACzB,oDAAoD;IACpD,UAAU,EAAE,MAAM,CAAA;IAClB,uDAAuD;IACvD,qBAAqB,EAAE,OAAO,CAAA;IAC9B,yCAAyC;IACzC,MAAM,CAAC,EAAE;QAAE,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;QAAC,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAA;KAAE,CAAA;CACrF,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,SAAS,CAAC,CAAC,EAC/B,SAAS,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAC3B,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,CAAC,CAAC,CAyDZ;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAe9C;AAGD,KAAK,aAAa,GAAG;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,CAAA;AAsFlF;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,GAAE,OAAO,CAAC,aAAa,CAAM,EACjC,EAAE,MAAgB,EAAE,GAAE,UAAe,GACpC,OAAO,KAAK,CA0Fd;AAGD,QAAA,MAAM,IAAI;aAKW,CAAC,CAAC,CAAC,EAAE,OAAO,KAAK,MAAM,CAAC,GAAG;QAClC,MAAM,EAAE,MAAM,CAAA;QACd,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACxC;CAWN,CAAA;AACP,OAAO,EAAE,IAAI,EAAE,CAAA"}

package/dist/utils.js

@@ -16,7 +16,8 @@ import { ChainFamily } from "./types.js";
  * @param timestamp - target timestamp
  * @param precision - returned blockNumber should be within this many blocks before timestamp
  * @returns blockNumber of a block at provider which is close but before target timestamp
- **/
+ * @throws {@link CCIPBlockBeforeTimestampNotFoundError} if no block exists before the given timestamp
+ */
 export async function getSomeBlockNumberBefore(getBlockTimestamp, recentBlockNumber, timestamp, { precision = 10, logger = console } = {}) {
     let beforeBlockNumber = Math.max(1, recentBlockNumber - precision * 1000);
     let beforeTimestamp = await getBlockTimestamp(beforeBlockNumber);
@@ -69,9 +70,9 @@ export async function getSomeBlockNumberBefore(getBlockTimestamp, recentBlockNum
     return beforeBlockNumber;
 }
 /**
- * Checks if a chain is a testnet
+ * Converts a chain ID to complete NetworkInfo.
+ * Memoized to return the same object reference for a given chainId.
  */
-// memoized so we always output the same object for a given chainId
 const networkInfoFromChainId = memoize((chainId) => {
     const sel = SELECTORS[chainId];
     if (!sel?.name)
@@ -92,6 +93,7 @@ const networkInfoFromChainId = memoize((chainId) => {
  *   - Chain ID as number, bigint or string (EVM: "1", Aptos: "aptos:1", Solana: genesisHash)
  *   - Chain name as string ("ethereum-mainnet")
  * @returns Complete NetworkInfo object
+ * @throws {@link CCIPChainNotFoundError} if chain is not found
  */
 export const networkInfo = memoize(function networkInfo_(selectorOrIdOrName) {
     let chainId, match;
@@ -195,7 +197,11 @@ export function parseJson(text) {
 }
 /**
  * Decode address from a 32-byte hex string
- **/
+ * @param address - Address bytes to decode
+ * @param family - Chain family for address format (defaults to EVM)
+ * @returns Decoded address string
+ * @throws {@link CCIPChainFamilyUnsupportedError} if chain family is not supported
+ */
 export function decodeAddress(address, family = ChainFamily.EVM) {
     const chain = supportedChains[family];
     if (!chain)
@@ -204,7 +210,11 @@ export function decodeAddress(address, family = ChainFamily.EVM) {
 }
 /**
  * Validate a value is a txHash string in some supported chain family
- **/
+ * @param txHash - Value to check
+ * @param family - Optional chain family to validate against
+ * @returns true if value is a valid transaction hash
+ * @throws {@link CCIPChainFamilyUnsupportedError} if specified chain family is not supported
+ */
 export function isSupportedTxHash(txHash, family) {
     let chains;
     if (!family)
@@ -265,6 +275,7 @@ export function isBase64(data) {
  * Converts various data formats to Uint8Array.
  * @param data - Bytes, number array, or Base64 string.
  * @returns Uint8Array representation.
+ * @throws {@link CCIPDataFormatUnsupportedError} if data format is not recognized
  */
 export function getDataBytes(data) {
     if (Array.isArray(data))
@@ -362,7 +373,8 @@ export function convertKeysToCamelCase(obj, mapValues, key) {
  * @param ms - Duration in milliseconds.
  * @returns Promise that resolves after the specified duration.
  */
-export const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms).unref());
+// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- unref is Node.js-only; browsers return number
+export const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms).unref?.());
 /**
  * Executes an async operation with retry logic and exponential backoff.
  * Only retries on transient errors (as determined by shouldRetry from errors/utils).
@@ -428,6 +440,7 @@ export async function withRetry(operation, config) {
  * Parses a typeAndVersion string into its components.
  * @param typeAndVersion - String in format "TypeName vX.Y.Z".
  * @returns Tuple of [type, version, original, suffix?].
+ * @throws {@link CCIPTypeVersionInvalidError} if string format is invalid
  */
 export function parseTypeAndVersion(typeAndVersion) {
     const match = typeAndVersion.match(/^(\w.+\S)\s+v?(\d+\.\d+(?:\.\d+)?)([^\d.].*)?$/);