@chainlink/ccip-sdk 0.0.0 → 0.90.0

package/dist/chain.d.ts

@@ -0,0 +1,344 @@
+import util from 'util';
+import type { BytesLike } from 'ethers';
+import type { EVMExtraArgsV1, EVMExtraArgsV2, ExtraArgs, SVMExtraArgsV1, SuiExtraArgsV1 } from './extra-args.ts';
+import type { LeafHasher } from './hasher/common.ts';
+import type { AnyMessage, CCIPCommit, CCIPExecution, CCIPMessage, CCIPRequest, CommitReport, ExecutionReceipt, ExecutionReport, Lane, Log_, NetworkInfo, OffchainTokenData } from './types.ts';
+export declare const ChainFamily: {
+    readonly EVM: "evm";
+    readonly Solana: "solana";
+    readonly Aptos: "aptos";
+    readonly Sui: "sui";
+};
+export type ChainFamily = (typeof ChainFamily)[keyof typeof ChainFamily];
+export type LogFilter = {
+    startBlock?: number;
+    startTime?: number;
+    endBlock?: number;
+    endBefore?: string;
+    address?: string;
+    topics?: string[] | string[][];
+    page?: number;
+};
+export type ChainTransaction = {
+    chain: Chain;
+    hash: string;
+    logs: readonly Log_[];
+    blockNumber: number;
+    timestamp: number;
+    from: string;
+    error?: unknown;
+};
+export type TokenInfo = {
+    readonly symbol: string;
+    readonly decimals: number;
+    readonly name?: string;
+};
+export type RateLimiterState = {
+    tokens: bigint;
+    capacity: bigint;
+    rate: bigint;
+} | null;
+export type TokenPoolRemote = {
+    remoteToken: string;
+    remotePools: string[];
+    inboundRateLimiterState: RateLimiterState;
+    outboundRateLimiterState: RateLimiterState;
+};
+/**
+ * Works like an interface for a base Chain class, but provides implementation (which can be
+ * specialized) for some basic methods
+ */
+export declare abstract class Chain<F extends ChainFamily = ChainFamily> {
+    abstract readonly network: NetworkInfo<F>;
+    abstract destroy?(): Promise<void>;
+    [util.inspect.custom](): string;
+    /**
+     * Fetch the timestamp of a given block
+     * @param block - block number or 'finalized'
+     * @returns timestamp of the block, in seconds
+     */
+    abstract getBlockTimestamp(block: number | 'finalized'): Promise<number>;
+    /**
+     * Fetch a transaction by its hash
+     * @param hash - transaction hash
+     * @returns generic transaction details
+     */
+    abstract getTransaction(hash: string): Promise<ChainTransaction>;
+    /**
+     * An async generator that yields logs based on the provided options.
+     * @param opts - options object
+     * @param opts.startBlock - if provided, fetch and generate logs forward starting from this block;
+     *   otherwise, returns logs backwards in time from endBlock;
+     *   optionally, startTime may be provided to fetch logs forward starting from this time;
+     * @param opts.endBlock - if omitted, use latest block
+     * @param opts.endBefore - optional hint signature for end of iteration, instead of endBlock
+     * @param opts.address - if provided, fetch logs for this address only (may be required in some
+     *   networks/implementations)
+     * @param opts.topics - if provided, fetch logs for these topics only;
+     *   if string[], it's assumed to be a list of topic0s (i.e. string[] or string[][0], event_ids);
+     *   some networks/implementations may not be able to filter topics other than topic0s, so one may
+     *   want to assume those are optimization hints, instead of hard filters, and verify results
+     * @param opts.page - if provided, try to use this page/range for batches
+     * @returns an async iterable iterator of logs
+     */
+    abstract getLogs(opts: LogFilter): AsyncIterableIterator<Log_>;
+    /**
+     * Fetch the typeAndVersion tag of a given CCIP contract
+     * @param address - CCIP contract address
+     * @returns typeAndVersion tag, validated and split
+     */
+    abstract typeAndVersion(address: string): Promise<[type_: string, version: string, typeAndVersion: string] | [type_: string, version: string, typeAndVersion: string, suffix: string]>;
+    /**
+     * Fetch the Router address set in OnRamp config
+     * Used to discover OffRamp connected to OnRamp
+     * @param onRamp - OnRamp contract address
+     * @param destChainSelector - destination chain selector
+     * @returns Router address
+     */
+    abstract getRouterForOnRamp(onRamp: string, destChainSelector: bigint): Promise<string>;
+    /**
+     * Fetch the Router address set in OffRamp config
+     * @param offRamp - OffRamp contract address
+     * @param sourceChainSelector - source chain selector
+     * @returns Router address
+     */
+    abstract getRouterForOffRamp(offRamp: string, sourceChainSelector: bigint): Promise<string>;
+    /**
+     * Get the native token address for a Router
+     * @param router - router contract address
+     * @returns native token address (usually wrapped)
+     */
+    abstract getNativeTokenForRouter(router: string): Promise<string>;
+    /**
+     * Fetch the OffRamps allowlisted in a Router
+     * Used to discover OffRamp connected to an OnRamp
+     * @param router - Router contract address
+     * @param sourceChainSelector - source chain selector
+     * @returns array of OffRamp addresses
+     */
+    abstract getOffRampsForRouter(router: string, sourceChainSelector: bigint): Promise<string[]>;
+    /**
+     * Fetch the OnRamp registered in a Router for a destination chain
+     * @param router - Router contract address
+     * @param destChainSelector - destination chain selector
+     * @returns OnRamp addresses
+     */
+    abstract getOnRampForRouter(router: string, destChainSelector: bigint): Promise<string>;
+    /**
+     * Fetch the OnRamp address set in OffRamp config
+     * Used to discover OffRamp connected to an OnRamp
+     * @param offRamp - OffRamp contract address
+     * @param sourceChainSelector - source chain selector
+     * @returns OnRamp address
+     */
+    abstract getOnRampForOffRamp(offRamp: string, sourceChainSelector: bigint): Promise<string>;
+    /**
+     * Fetch the CommitStore set in OffRamp config (CCIP<=v1.5)
+     * For CCIP>=v1.6, it should return the offRamp address
+     * @param offRamp - OffRamp contract address
+     * @returns CommitStore address
+     */
+    abstract getCommitStoreForOffRamp(offRamp: string): Promise<string>;
+    /**
+     * Fetch the TokenPool's token/mint
+     * @param tokenPool - TokenPool address
+     * @returns Token or mint address
+     */
+    abstract getTokenForTokenPool(tokenPool: string): Promise<string>;
+    /**
+     * Fetch token metadata
+     * @param token - Token address
+     * @returns Token symbol and decimals, and optionally name
+     */
+    abstract getTokenInfo(token: string): Promise<TokenInfo>;
+    /**
+     * Fetch TokenAdminRegistry configured in a given OnRamp, Router, etc
+     * Needed to map a source token to its dest counterparts
+     * @param onRamp - Some contract for which we can fetch a TokenAdminRegistry
+     */
+    abstract getTokenAdminRegistryFor(address: string): Promise<string>;
+    /**
+     * Build, derive, load or fetch a wallet for this instance which will be used in any tx send operation
+     * @param opts.wallet - cli or environmental parameters to help pick a wallet
+     * @returns address of fetched (and stored internally) account
+     */
+    abstract getWalletAddress(opts?: {
+        wallet?: unknown;
+    }): Promise<string>;
+    /**
+     * Fetch the current fee for a given intended message
+     * @param router - router address on this chain
+     * @param destChainSelector - dest network selector
+     * @param message - message to send
+     */
+    abstract getFee(router: string, destChainSelector: bigint, message: AnyMessage): Promise<bigint>;
+    /**
+     * Send a CCIP message through a router using loaded wallet
+     * @param router - router address on this chain
+     * @param destChainSelector - dest network selector
+     * @param message - message to send
+     * @param opts.wallet - cli or environmental parameters to help pick a wallet
+     * @param opts.approveMax - approve the maximum amount of tokens to transfer
+     */
+    abstract sendMessage(router: string, destChainSelector: bigint, message: AnyMessage & {
+        fee: bigint;
+    }, opts?: {
+        wallet?: unknown;
+        approveMax?: boolean;
+    }): Promise<ChainTransaction>;
+    /**
+     * Fetch supported offchain token data for a request from this network
+     * @param request - CCIP request, with tx, logs and message
+     * @returns array with one offchain token data for each token transfer in request
+     */
+    abstract fetchOffchainTokenData(request: CCIPRequest): Promise<OffchainTokenData[]>;
+    /**
+     * Execute messages in report in an offRamp
+     * @param offRamp - offRamp address on this dest chain
+     * @param execReport - execution report containing messages to execute, proofs and offchainTokenData
+     * @param opts - general options for execution
+     * @returns transaction hash of the execution
+     */
+    abstract executeReport(offRamp: string, execReport: ExecutionReport, opts?: Record<string, unknown>): Promise<ChainTransaction>;
+    /**
+     * Look for a CommitReport at dest for given CCIP request
+     * May be specialized by some subclasses
+     *
+     * @param dest - Destination network provider
+     * @param request - CCIP request info
+     * @param hints - Additional filtering hints
+     * @returns CCIP commit info
+     **/
+    fetchCommitReport(commitStore: string, request: {
+        lane: Lane;
+        message: {
+            header: {
+                sequenceNumber: bigint;
+            };
+        };
+        timestamp?: number;
+    }, hints?: {
+        startBlock?: number;
+        page?: number;
+    }): Promise<CCIPCommit>;
+    /**
+     * Default/generic implementation of fetchExecutionReceipts
+     * @param offRamp - Off-ramp address
+     * @param messageIds - Set of message IDs to fetch receipts for
+     * @param hints - Additional filtering hints
+     * @returns Async generator of CCIP execution receipts
+     */
+    fetchExecutionReceipts(offRamp: string, messageIds: Set<string>, hints?: {
+        startBlock?: number;
+        startTime?: number;
+        page?: number;
+        commit?: CommitReport;
+    }): AsyncGenerator<CCIPExecution>;
+    /**
+     * List tokens supported by given TokenAdminRegistry contract
+     * @param address - Usually TokenAdminRegistry, but chain may support receiving Router, OnRamp, etc
+     * @param opts.page - Page range, if needed
+     * @retursn array of supported token addresses
+     */
+    abstract getSupportedTokens(address: string, opts?: {
+        page?: number;
+    }): Promise<string[]>;
+    /**
+     * Get TokenConfig for a given token address in a TokenAdminRegistry
+     * @param address - TokenAdminRegistry contract address
+     * @param token - Token address
+     */
+    abstract getRegistryTokenConfig(registry: string, token: string): Promise<{
+        administrator: string;
+        pendingAdministrator?: string;
+        tokenPool?: string;
+    }>;
+    /**
+     * Get TokenPool state and configurations
+     * @param tokenPool - Token pool address
+     */
+    abstract getTokenPoolConfigs(tokenPool: string): Promise<{
+        token: string;
+        router: string;
+        typeAndVersion?: string;
+    }>;
+    /**
+     * Get TokenPool remote configurations
+     * @param tokenPool - Token pool address
+     * @param remoteChainSelector - If provided, only return remotes for the specified chain (may error if remote not supported)
+     * @param Record of network *names* and remote configurations (remoteToken, remotePools, rateLimitStates)
+     */
+    abstract getTokenPoolRemotes(tokenPool: string, remoteChainSelector?: bigint): Promise<Record<string, TokenPoolRemote>>;
+    /**
+     * Fetch list and info of supported feeTokens
+     * @param router address on this chain
+     * @returns mapping of token addresses to respective TokenInfo objects
+     */
+    abstract listFeeTokens(router: string): Promise<Record<string, TokenInfo>>;
+}
+export type ChainStatic<F extends ChainFamily = ChainFamily> = Function & {
+    readonly family: F;
+    readonly decimals: number;
+    /**
+     * async constructor: builds a Chain from a rpc endpoint url
+     * @param url - rpc endpoint url
+     */
+    fromUrl(url: string): Promise<Chain<F>>;
+    /**
+     * Try to decode a CCIP message *from* a log/event *originated* from this *source* chain,
+     * but which may *target* other dest chain families
+     * iow: the parsing is specific to this chain family, but content may be intended to alien chains
+     * e.g: EVM-born (abi.encoded) bytearray may output message.computeUnits for Solana
+     * @param log - Chain generic log
+     * @returns decoded CCIP message with merged extraArgs
+     */
+    decodeMessage(log: Pick<Log_, 'data'>): CCIPMessage | undefined;
+    /**
+     * Try to decode an extraArgs array serialized for this chain family
+     * @param extraArgs - extra args bytes (Uint8Array, HexString or base64)
+     * @returns object containing decoded extraArgs and their tags
+     */
+    decodeExtraArgs(extraArgs: BytesLike): (EVMExtraArgsV1 & {
+        _tag: 'EVMExtraArgsV1';
+    }) | (EVMExtraArgsV2 & {
+        _tag: 'EVMExtraArgsV2';
+    }) | (SVMExtraArgsV1 & {
+        _tag: 'SVMExtraArgsV1';
+    }) | (SuiExtraArgsV1 & {
+        _tag: 'SuiExtraArgsV1';
+    }) | undefined;
+    encodeExtraArgs(extraArgs: ExtraArgs): string;
+    /**
+     * Decode a commit (CommitReportAccepted) event
+     * @param log - Chain generic log
+     * @param lane - if passed, filter or validate reports by lane
+     * @returns Array of commit reports contained in the log
+     */
+    decodeCommits(log: Pick<Log_, 'data'>, lane?: Lane): CommitReport[] | undefined;
+    /**
+     * Decode a receipt (ExecutioStateChanged) event
+     * @param log - Chain generic log
+     * @returns ExecutionReceipt or undefined if not a recognized receipt
+     */
+    decodeReceipt(log: Pick<Log_, 'data'>): ExecutionReceipt | undefined;
+    /**
+     * Receive a bytes array and try to decode and normalize it as an address of this chain family
+     * @param bytes - Bytes array (Uint8Array, HexString or Base64)
+     * @returns Address in this chain family's format
+     */
+    getAddress(bytes: BytesLike): string;
+    /**
+     * Create a leaf hasher for this dest chain and lane
+     * @param lane - source, dest and onramp lane info
+     * @returns LeafHasher is a function that takes a message and returns a hash of it
+     */
+    getDestLeafHasher(lane: Lane): LeafHasher;
+    /**
+     * Try to parse an error or bytearray generated by this chain family
+     * @param error - catched object, string or bytearray
+     * @returns Ordered record with messages/properties, or undefined if not a recognized error
+     */
+    parse?(data: unknown): Record<string, unknown> | undefined | null;
+};
+export type ChainGetter = (idOrSelectorOrName: number | string | bigint) => Promise<Chain>;
+//# sourceMappingURL=chain.d.ts.map

package/dist/chain.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chain.d.ts","sourceRoot":"","sources":["../src/chain.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAA;AAEvB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AAIvC,OAAO,KAAK,EACV,cAAc,EACd,cAAc,EACd,SAAS,EACT,cAAc,EACd,cAAc,EACf,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,KAAK,EACV,UAAU,EACV,UAAU,EACV,aAAa,EACb,WAAW,EACX,WAAW,EACX,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,IAAI,EACJ,IAAI,EACJ,WAAW,EACX,iBAAiB,EAClB,MAAM,YAAY,CAAA;AAEnB,eAAO,MAAM,WAAW;;;;;CAKd,CAAA;AACV,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAA;AAExE,MAAM,MAAM,SAAS,GAAG;IACtB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,EAAE,CAAA;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,KAAK,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,SAAS,IAAI,EAAE,CAAA;IACrB,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;CACb,GAAG,IAAI,CAAA;AAER,MAAM,MAAM,eAAe,GAAG;IAC5B,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,EAAE,CAAA;IACrB,uBAAuB,EAAE,gBAAgB,CAAA;IACzC,wBAAwB,EAAE,gBAAgB,CAAA;CAC3C,CAAA;AAED;;;GAGG;AACH,8BAAsB,KAAK,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW;IAC7D,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;IACzC,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC;IAElC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAIrB;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IACxE;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAChE;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,GAAG,qBAAqB,CAAC,IAAI,CAAC;IAC9D;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CACrB,OAAO,EAAE,MAAM,GACd,OAAO,CACN,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,CAAC,GACxD,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAC3E;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IACvF;;;;;OAKG;IACH,QAAQ,CAAC,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAC3F;;;;OAIG;IACH,QAAQ,CAAC,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IACjE;;;;;;OAMG;IACH,QAAQ,CAAC,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAC7F;;;;;OAKG;IACH,QAAQ,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IACvF;;;;;;OAMG;IACH,QAAQ,CAAC,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAC3F;;;;;OAKG;IACH,QAAQ,CAAC,wBAAwB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IACnE;;;;OAIG;IACH,QAAQ,CAAC,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IACjE;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IACxD;;;;OAIG;IACH,QAAQ,CAAC,wBAAwB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IACnE;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IACvE;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC;IAChG;;;;;;;OAOG;IACH,QAAQ,CAAC,WAAW,CAClB,MAAM,EAAE,MAAM,EACd,iBAAiB,EAAE,MAAM,EACzB,OAAO,EAAE,UAAU,GAAG;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,EACrC,IAAI,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,GAChD,OAAO,CAAC,gBAAgB,CAAC;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,sBAAsB,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IACnF;;;;;;OAMG;IACH,QAAQ,CAAC,aAAa,CACpB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,eAAe,EAC3B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAE5B;;;;;;;;QAQI;IACE,iBAAiB,CACrB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE;QACP,IAAI,EAAE,IAAI,CAAA;QACV,OAAO,EAAE;YAAE,MAAM,EAAE;gBAAE,cAAc,EAAE,MAAM,CAAA;aAAE,CAAA;SAAE,CAAA;QAC/C,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,EACD,KAAK,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAC7C,OAAO,CAAC,UAAU,CAAC;IAItB;;;;;;OAMG;IACI,sBAAsB,CAC3B,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,EACvB,KAAK,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,YAAY,CAAA;KAAE,GACxF,cAAc,CAAC,aAAa,CAAC;IAIhC;;;;;OAKG;IACH,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAEzF;;;;OAIG;IACH,QAAQ,CAAC,sBAAsB,CAC7B,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC;QACT,aAAa,EAAE,MAAM,CAAA;QACrB,oBAAoB,CAAC,EAAE,MAAM,CAAA;QAC7B,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAC;IAEF;;;OAGG;IACH,QAAQ,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;QACvD,KAAK,EAAE,MAAM,CAAA;QACb,MAAM,EAAE,MAAM,CAAA;QACd,cAAc,CAAC,EAAE,MAAM,CAAA;KACxB,CAAC;IAEF;;;;;OAKG;IACH,QAAQ,CAAC,mBAAmB,CAC1B,SAAS,EAAE,MAAM,EACjB,mBAAmB,CAAC,EAAE,MAAM,GAC3B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAE3C;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CAC3E;AAGD,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI,QAAQ,GAAG;IACxE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;IAClB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB;;;OAGG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IACvC;;;;;;;OAOG;IACH,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,WAAW,GAAG,SAAS,CAAA;IAC/D;;;;OAIG;IACH,eAAe,CACb,SAAS,EAAE,SAAS,GAElB,CAAC,cAAc,GAAG;QAAE,IAAI,EAAE,gBAAgB,CAAA;KAAE,CAAC,GAC7C,CAAC,cAAc,GAAG;QAAE,IAAI,EAAE,gBAAgB,CAAA;KAAE,CAAC,GAC7C,CAAC,cAAc,GAAG;QAAE,IAAI,EAAE,gBAAgB,CAAA;KAAE,CAAC,GAC7C,CAAC,cAAc,GAAG;QAAE,IAAI,EAAE,gBAAgB,CAAA;KAAE,CAAC,GAC7C,SAAS,CAAA;IACb,eAAe,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAAA;IAC7C;;;;;OAKG;IACH,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,YAAY,EAAE,GAAG,SAAS,CAAA;IAC/E;;;;OAIG;IACH,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,gBAAgB,GAAG,SAAS,CAAA;IACpE;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,CAAA;IACpC;;;;OAIG;IACH,iBAAiB,CAAC,IAAI,EAAE,IAAI,GAAG,UAAU,CAAA;IACzC;;;;OAIG;IACH,KAAK,CAAC,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,GAAG,IAAI,CAAA;CAClE,CAAA;AAED,MAAM,MAAM,WAAW,GAAG,CAAC,kBAAkB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,KAAK,OAAO,CAAC,KAAK,CAAC,CAAA"}

package/dist/chain.js

@@ -0,0 +1,41 @@
+import util from 'util';
+import { fetchCommitReport } from "./commits.js";
+import { fetchExecutionReceipts } from "./execution.js";
+export const ChainFamily = {
+    EVM: 'evm',
+    Solana: 'solana',
+    Aptos: 'aptos',
+    Sui: 'sui',
+};
+/**
+ * Works like an interface for a base Chain class, but provides implementation (which can be
+ * specialized) for some basic methods
+ */
+export class Chain {
+    [util.inspect.custom]() {
+        return `${this.constructor.name} { ${this.network.name} }`;
+    }
+    /**
+     * Look for a CommitReport at dest for given CCIP request
+     * May be specialized by some subclasses
+     *
+     * @param dest - Destination network provider
+     * @param request - CCIP request info
+     * @param hints - Additional filtering hints
+     * @returns CCIP commit info
+     **/
+    async fetchCommitReport(commitStore, request, hints) {
+        return fetchCommitReport(this, commitStore, request, hints);
+    }
+    /**
+     * Default/generic implementation of fetchExecutionReceipts
+     * @param offRamp - Off-ramp address
+     * @param messageIds - Set of message IDs to fetch receipts for
+     * @param hints - Additional filtering hints
+     * @returns Async generator of CCIP execution receipts
+     */
+    async *fetchExecutionReceipts(offRamp, messageIds, hints) {
+        yield* fetchExecutionReceipts(this, offRamp, messageIds, hints);
+    }
+}
+//# sourceMappingURL=chain.js.map

package/dist/chain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chain.js","sourceRoot":"","sources":["../src/chain.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAA;AAIvB,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAA;AAwBvD,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,GAAG,EAAE,KAAK;IACV,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,KAAK;CACF,CAAA;AA0CV;;;GAGG;AACH,MAAM,OAAgB,KAAK;IAIzB,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QACnB,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAA;IAC5D,CAAC;IA+JD;;;;;;;;QAQI;IACJ,KAAK,CAAC,iBAAiB,CACrB,WAAmB,EACnB,OAIC,EACD,KAA8C;QAE9C,OAAO,iBAAiB,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;IAC7D,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,CAAC,sBAAsB,CAC3B,OAAe,EACf,UAAuB,EACvB,KAAyF;QAEzF,KAAK,CAAC,CAAC,sBAAsB,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,CAAA;IACjE,CAAC;CAmDF"}

package/dist/commits.d.ts

@@ -0,0 +1,25 @@
+import type { Chain } from './chain.ts';
+import { type CCIPCommit, type Lane } from './types.ts';
+/**
+ * Look for a CommitReport at dest for given CCIPRequest
+ * Provides a basic/generic implementation, but subclasses of Chain may override with more specific
+ * logic in Chain.fetchCommitReport method
+ *
+ * @param dest - Destination network provider
+ * @param request - CCIP request info
+ * @param hints - Additional filtering hints
+ * @returns CCIP commit info
+ **/
+export declare function fetchCommitReport(dest: Chain, commitStore: string, { lane, message: { header }, timestamp: requestTimestamp, }: {
+    lane: Lane;
+    message: {
+        header: {
+            sequenceNumber: bigint;
+        };
+    };
+    timestamp?: number;
+}, hints?: {
+    startBlock?: number;
+    page?: number;
+}): Promise<CCIPCommit>;
+//# sourceMappingURL=commits.d.ts.map

package/dist/commits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commits.d.ts","sourceRoot":"","sources":["../src/commits.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAe,MAAM,YAAY,CAAA;AACpD,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,IAAI,EAAe,MAAM,YAAY,CAAA;AAEpE;;;;;;;;;IASI;AACJ,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,KAAK,EACX,WAAW,EAAE,MAAM,EACnB,EACE,IAAI,EACJ,OAAO,EAAE,EAAE,MAAM,EAAE,EACnB,SAAS,EAAE,gBAAgB,GAC5B,EAAE;IACD,IAAI,EAAE,IAAI,CAAA;IACV,OAAO,EAAE;QAAE,MAAM,EAAE;YAAE,cAAc,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAA;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,EACD,KAAK,CAAC,EAAE;IAAE,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAC7C,OAAO,CAAC,UAAU,CAAC,CAiBrB"}

package/dist/commits.js

@@ -0,0 +1,29 @@
+import { CCIPVersion } from "./types.js";
+/**
+ * Look for a CommitReport at dest for given CCIPRequest
+ * Provides a basic/generic implementation, but subclasses of Chain may override with more specific
+ * logic in Chain.fetchCommitReport method
+ *
+ * @param dest - Destination network provider
+ * @param request - CCIP request info
+ * @param hints - Additional filtering hints
+ * @returns CCIP commit info
+ **/
+export async function fetchCommitReport(dest, commitStore, { lane, message: { header }, timestamp: requestTimestamp, }, hints) {
+    for await (const log of dest.getLogs({
+        ...hints,
+        ...(!hints?.startBlock ? { startTime: requestTimestamp } : { startBlock: hints.startBlock }),
+        address: commitStore,
+        topics: [lane.version < CCIPVersion.V1_6 ? 'ReportAccepted' : 'CommitReportAccepted'],
+    })) {
+        const report = dest.constructor.decodeCommits(log, lane)?.[0];
+        if (!report || report.maxSeqNr < header.sequenceNumber)
+            continue;
+        // since we walk forward from some startBlock/startTime, give up if we find a newer report
+        if (report.minSeqNr > header.sequenceNumber)
+            break;
+        return { report, log };
+    }
+    throw new Error(`Could not find commit after ${hints?.startBlock ?? requestTimestamp} for sequenceNumber=${header.sequenceNumber}`);
+}
+//# sourceMappingURL=commits.js.map

package/dist/commits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commits.js","sourceRoot":"","sources":["../src/commits.ts"],"names":[],"mappings":"AACA,OAAO,EAA8B,WAAW,EAAE,MAAM,YAAY,CAAA;AAEpE;;;;;;;;;IASI;AACJ,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,IAAW,EACX,WAAmB,EACnB,EACE,IAAI,EACJ,OAAO,EAAE,EAAE,MAAM,EAAE,EACnB,SAAS,EAAE,gBAAgB,GAK5B,EACD,KAA8C;IAE9C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC;QACnC,GAAG,KAAK;QACR,GAAG,CAAC,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,CAAC;QAC5F,OAAO,EAAE,WAAW;QACpB,MAAM,EAAE,CAAC,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,sBAAsB,CAAC;KACtF,CAAC,EAAE,CAAC;QACH,MAAM,MAAM,GAAI,IAAI,CAAC,WAA2B,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QAC9E,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,cAAc;YAAE,SAAQ;QAChE,0FAA0F;QAC1F,IAAI,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,cAAc;YAAE,MAAK;QAClD,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,CAAA;IACxB,CAAC;IAED,MAAM,IAAI,KAAK,CACb,+BAA+B,KAAK,EAAE,UAAU,IAAI,gBAAgB,uBAAuB,MAAM,CAAC,cAAc,EAAE,CACnH,CAAA;AACH,CAAC"}