@matterlabs/zksync-js 0.0.14 → 0.0.16

package/dist/adapters/viem/index.d.ts

@@ -11,5 +11,10 @@ export type { WithdrawalsResource, FinalizationServices } from './resources/with
 export { createTokensResource } from './resources/tokens';
 export { createContractsResource } from './resources/contracts';
 export type { ContractsResource, ContractInstances } from './resources/contracts';
+export { createInteropResource } from './resources/interop';
+export { createInteropFinalizationServices } from './resources/interop';
+export type { InteropResource, InteropFinalizationServices } from './resources/interop';
+export type { ViemTransactionRequest } from './resources/interop/routes/types';
+export type { InteropConfig, ChainRef } from './resources/interop/types';
 export * from './errors/error-ops';
 export * from './errors/revert';

package/dist/adapters/viem/index.js

@@ -1,10 +1,9 @@
-export { buildDirectRequestStruct, createContractsResource, createDepositsResource, createFinalizationServices, createTokensResource, createViemSdk, createWithdrawalsResource, encodeNativeTokenVaultTransferData, encodeSecondBridgeArgs, encodeSecondBridgeDataV1, encodeSecondBridgeErc20Args, encodeSecondBridgeEthArgs, getL2TransactionHashFromLogs } from '../../chunk-75IOOODG.js';
-import '../../chunk-EOBXYHTZ.js';
+export { buildDirectRequestStruct, createContractsResource, createDepositsResource, createFinalizationServices, createInteropFinalizationServices, createInteropResource, createTokensResource, createViemSdk, createWithdrawalsResource, encodeNativeTokenVaultTransferData, encodeSecondBridgeArgs, encodeSecondBridgeDataV1, encodeSecondBridgeErc20Args, encodeSecondBridgeEthArgs, getL2TransactionHashFromLogs } from '../../chunk-3KH5PCD6.js';
+import '../../chunk-NLUCYVMX.js';
 import '../../chunk-3HHUZXSV.js';
-export { createViemClient as createClient, createViemClient } from '../../chunk-OTXPSNNC.js';
-export { classifyReadinessFromRevert, createErrorHandlers, decodeRevert, registerErrorAbi, toZKsyncError } from '../../chunk-XDRCN4FC.js';
+export { createViemClient as createClient, createViemClient } from '../../chunk-CK5UFAZK.js';
+export { classifyReadinessFromRevert, createErrorHandlers, decodeRevert, registerErrorAbi, toZKsyncError } from '../../chunk-SBGBYZJM.js';
 import '../../chunk-BWKWWLY4.js';
-import '../../chunk-HP3EWKJL.js';
-import '../../chunk-DYJKK5FW.js';
-import '../../chunk-JY62QO3W.js';
+import '../../chunk-JSBMIT4S.js';
+import '../../chunk-UEKFQAOS.js';
 import '../../chunk-MT4X5FEO.js';

package/dist/adapters/viem/resources/interop/address.d.ts

@@ -0,0 +1,18 @@
+import type { Address, Hex } from '../../../../core/types/primitives';
+/**
+ * Formats an ERC-7930 interoperable address (version 1) that describes an EVM chain
+ * without specifying a destination address. Mirrors InteroperableAddress.formatEvmV1(chainId).
+ */
+export declare function formatInteropEvmChain(chainId: bigint): Hex;
+/**
+ * Formats an ERC-7930 interoperable address (version 1) that describes an EVM address
+ * without a chain reference. Mirrors InteroperableAddress.formatEvmV1(address).
+ */
+export declare function formatInteropEvmAddress(address: Address): Hex;
+/**
+ * Codec for interop address encoding used by route builders.
+ */
+export declare const interopCodec: {
+    formatChain: typeof formatInteropEvmChain;
+    formatAddress: typeof formatInteropEvmAddress;
+};

package/dist/adapters/viem/resources/interop/attributes/resource.d.ts

@@ -0,0 +1,6 @@
+import { type AttributesResource } from '../../../../../core/resources/interop/attributes/resource';
+import type { InteropParams } from '../../../../../core/types/flows/interop';
+import type { BuildCtx } from '../context';
+import type { InteropAttributes } from '../../../../../core/resources/interop/plan';
+export declare function getInteropAttributes(params: InteropParams, ctx: BuildCtx): InteropAttributes;
+export declare function createViemAttributesResource(): AttributesResource;

package/dist/adapters/viem/resources/interop/context.d.ts

@@ -0,0 +1,31 @@
+import type { PublicClient } from 'viem';
+import type { ViemClient } from '../../client';
+import type { Address } from '../../../../core/types/primitives';
+import type { CommonCtx } from '../../../../core/types/flows/base';
+import type { InteropParams } from '../../../../core/types/flows/interop';
+import { type TxGasOverrides } from '../../../../core/types/fees';
+import type { TokensResource } from '../../../../core/types/flows/token';
+import type { AttributesResource } from '../../../../core/resources/interop/attributes/resource';
+import type { ContractsResource } from '../contracts';
+export interface BuildCtx extends CommonCtx {
+    client: ViemClient;
+    tokens: TokensResource;
+    contracts: ContractsResource;
+    bridgehub: Address;
+    dstChainId: bigint;
+    dstPublicClient: PublicClient;
+    chainId: bigint;
+    interopCenter: Address;
+    interopHandler: Address;
+    l2MessageVerification: Address;
+    l2AssetRouter: Address;
+    l2NativeTokenVault: Address;
+    baseTokens: {
+        src: Address;
+        dst: Address;
+        matches: boolean;
+    };
+    attributes: AttributesResource;
+    gasOverrides?: TxGasOverrides;
+}
+export declare function commonCtx(dstPublicClient: PublicClient, params: InteropParams, client: ViemClient, tokens: TokensResource, contracts: ContractsResource, attributes: AttributesResource): Promise<BuildCtx>;

package/dist/adapters/viem/resources/interop/index.d.ts

@@ -0,0 +1,65 @@
+import type { ViemClient } from '../../client';
+import type { Hex } from '../../../../core/types/primitives';
+import type { AttributesResource } from '../../../../core/resources/interop/attributes/resource';
+import type { InteropRoute, InteropPlan, InteropQuote, InteropStatus, InteropFinalizationResult, InteropParams, InteropHandle, InteropWaitable, InteropFinalizationInfo } from '../../../../core/types/flows/interop';
+import type { ContractsResource } from '../contracts';
+import type { TokensResource } from '../../../../core/types/flows/token';
+import type { InteropRouteStrategy, ViemTransactionRequest } from './routes/types';
+import { createInteropFinalizationServices, type InteropFinalizationServices } from './services/finalization';
+import { type LogsQueryOptions } from './services/finalization/data-fetchers';
+import type { ChainRef, InteropConfig } from './types';
+export declare const ROUTES: Record<InteropRoute, InteropRouteStrategy>;
+export interface InteropResource {
+    quote(dstChain: ChainRef, params: InteropParams): Promise<InteropQuote>;
+    tryQuote(dstChain: ChainRef, params: InteropParams): Promise<{
+        ok: true;
+        value: InteropQuote;
+    } | {
+        ok: false;
+        error: unknown;
+    }>;
+    prepare(dstChain: ChainRef, params: InteropParams): Promise<InteropPlan<ViemTransactionRequest>>;
+    tryPrepare(dstChain: ChainRef, params: InteropParams): Promise<{
+        ok: true;
+        value: InteropPlan<ViemTransactionRequest>;
+    } | {
+        ok: false;
+        error: unknown;
+    }>;
+    create(dstChain: ChainRef, params: InteropParams): Promise<InteropHandle<ViemTransactionRequest>>;
+    tryCreate(dstChain: ChainRef, params: InteropParams): Promise<{
+        ok: true;
+        value: InteropHandle<ViemTransactionRequest>;
+    } | {
+        ok: false;
+        error: unknown;
+    }>;
+    status(dstChain: ChainRef, h: InteropWaitable, opts?: LogsQueryOptions): Promise<InteropStatus>;
+    wait(dstChain: ChainRef, h: InteropWaitable, opts?: {
+        pollMs?: number;
+        timeoutMs?: number;
+    }): Promise<InteropFinalizationInfo>;
+    tryWait(dstChain: ChainRef, h: InteropWaitable, opts?: {
+        pollMs?: number;
+        timeoutMs?: number;
+    }): Promise<{
+        ok: true;
+        value: InteropFinalizationInfo;
+    } | {
+        ok: false;
+        error: unknown;
+    }>;
+    finalize(dstChain: ChainRef, h: InteropWaitable | InteropFinalizationInfo, opts?: LogsQueryOptions): Promise<InteropFinalizationResult>;
+    tryFinalize(dstChain: ChainRef, h: InteropWaitable | InteropFinalizationInfo, opts?: LogsQueryOptions): Promise<{
+        ok: true;
+        value: InteropFinalizationResult;
+    } | {
+        ok: false;
+        error: unknown;
+    }>;
+    getInteropRoot(dstChain: ChainRef, rootChainId: bigint, batchNumber: bigint): Promise<Hex>;
+    verifyBundle(dstChain: ChainRef, h: InteropWaitable | InteropFinalizationInfo): Promise<InteropFinalizationResult>;
+}
+export declare function createInteropResource(client: ViemClient, config?: InteropConfig, tokens?: TokensResource, contracts?: ContractsResource, attributes?: AttributesResource): InteropResource;
+export { createInteropFinalizationServices };
+export type { InteropFinalizationServices };

package/dist/adapters/viem/resources/interop/resolvers.d.ts

@@ -0,0 +1,4 @@
+import { type PublicClient } from 'viem';
+import type { ChainRef } from './types';
+/** Resolve a chain ref (URL string or PublicClient) into a PublicClient. */
+export declare function resolveChainRef(ref: ChainRef): PublicClient;

package/dist/adapters/viem/resources/interop/routes/direct.d.ts

@@ -0,0 +1,2 @@
+import type { InteropRouteStrategy } from './types';
+export declare function routeDirect(): InteropRouteStrategy;

package/dist/adapters/viem/resources/interop/routes/indirect.d.ts

@@ -0,0 +1,2 @@
+import type { InteropRouteStrategy } from './types';
+export declare function routeIndirect(): InteropRouteStrategy;

package/dist/adapters/viem/resources/interop/routes/types.d.ts

@@ -0,0 +1,23 @@
+import type { InteropParams } from '../../../../../core/types/flows/interop';
+import type { BuildCtx } from '../context';
+import type { PlanStep, ApprovalNeed } from '../../../../../core/types/flows/base';
+import type { QuoteExtras, InteropFee } from '../../../../../core/types/flows/interop';
+/** Minimal transaction request for a viem L2 interop step. */
+export interface ViemTransactionRequest {
+    to?: `0x${string}`;
+    data?: `0x${string}`;
+    value?: bigint;
+    gas?: bigint;
+    gasLimit?: bigint;
+    maxFeePerGas?: bigint;
+    maxPriorityFeePerGas?: bigint;
+}
+export interface InteropRouteStrategy {
+    preflight(params: InteropParams, ctx: BuildCtx): Promise<void>;
+    build(params: InteropParams, ctx: BuildCtx): Promise<{
+        steps: Array<PlanStep<ViemTransactionRequest>>;
+        approvals: ApprovalNeed[];
+        quoteExtras: QuoteExtras;
+        interopFee: InteropFee;
+    }>;
+}

package/dist/adapters/viem/resources/interop/services/erc20.d.ts

@@ -0,0 +1,25 @@
+import type { Address, Hex } from '../../../../../core/types/primitives';
+import type { InteropParams } from '../../../../../core/types/flows/interop';
+import type { ApprovalNeed } from '../../../../../core/types/flows/base';
+import type { BuildCtx } from '../context';
+import type { ViemTransactionRequest } from '../routes/types';
+/** Collect unique ERC-20 token addresses referenced by `sendErc20` actions. */
+export declare function getErc20Tokens(params: InteropParams): Address[];
+/** Build NTV `ensureTokenIsRegistered` steps for each ERC-20 token. */
+export declare function buildEnsureTokenSteps(erc20Tokens: Address[], ctx: BuildCtx): Array<{
+    key: string;
+    kind: string;
+    description: string;
+    tx: ViemTransactionRequest;
+}>;
+/**
+ * Check allowance for each approval and return approve steps only where needed.
+ */
+export declare function buildApproveSteps(approvals: ApprovalNeed[], ctx: BuildCtx): Promise<Array<{
+    key: string;
+    kind: string;
+    description: string;
+    tx: ViemTransactionRequest;
+}>>;
+/** Resolve asset IDs for each ERC-20 token via a static-call to NTV. */
+export declare function resolveErc20AssetIds(erc20Tokens: Address[], ctx: BuildCtx): Promise<Map<string, Hex>>;

package/dist/adapters/viem/resources/interop/services/fee.d.ts

@@ -0,0 +1,12 @@
+import type { InteropParams } from '../../../../../core/types/flows/interop';
+import type { BuildCtx } from '../context';
+import type { InteropFeeInfo } from '../../../../../core/resources/interop/plan';
+/**
+ * Resolve fee information for a bundle.
+ *
+ * - useFixed=false (default when fees is unset): reads interopProtocolFee and
+ *   returns the total as fee.value so the caller can add it to the sendBundle msg.value.
+ * - useFixed=true: reads ZK_INTEROP_FEE and zkToken address, returns an
+ *   ApprovalNeed for the ZK token. The route handles the allowance check.
+ */
+export declare function buildFeeInfo(params: InteropParams, ctx: BuildCtx, numStarters: number): Promise<InteropFeeInfo>;

package/dist/adapters/viem/resources/interop/services/finalization/bundle.d.ts

@@ -0,0 +1,19 @@
+import { type PublicClient, type TransactionReceipt } from 'viem';
+import type { Hex } from '../../../../../../core/types/primitives';
+import type { InteropFinalizationInfo } from '../../../../../../core/types/flows/interop';
+import type { ViemClient } from '../../../../client';
+import type { InteropPhase } from '../../../../../../core/types/flows/interop';
+import type { InteropTopics } from '../../../../../../core/resources/interop/events';
+import { type LogsQueryOptions } from './data-fetchers';
+export declare function getBundleStatus(client: ViemClient, dstProvider: PublicClient, topics: InteropTopics, bundleHash: Hex, opts?: LogsQueryOptions): Promise<{
+    phase: InteropPhase;
+    dstExecTxHash?: Hex;
+}>;
+export declare function executeBundle(client: ViemClient, dstProvider: PublicClient, info: InteropFinalizationInfo, opts?: LogsQueryOptions): Promise<{
+    hash: Hex;
+    wait: () => Promise<TransactionReceipt>;
+}>;
+export declare function verifyBundle(client: ViemClient, dstProvider: PublicClient, info: InteropFinalizationInfo): Promise<{
+    hash: Hex;
+    wait: () => Promise<TransactionReceipt>;
+}>;

package/dist/adapters/viem/resources/interop/services/finalization/data-fetchers.d.ts

@@ -0,0 +1,17 @@
+import type { PublicClient } from 'viem';
+import type { Address, Hex } from '../../../../../../core/types/primitives';
+import type { Log } from '../../../../../../core/types/transactions';
+export interface LogsQueryOptions {
+    maxBlocksBack?: number;
+    logChunkSize?: number;
+}
+export declare function getTxReceipt(provider: PublicClient, txHash: Hex): Promise<{
+    logs: {
+        address: `0x${string}`;
+        topics: Hex[];
+        data: `0x${string}`;
+        transactionHash: `0x${string}`;
+    }[];
+} | null>;
+export declare function getLogs(provider: PublicClient, address: Address, topics: Array<Hex | null>, opts?: LogsQueryOptions): Promise<Log[]>;
+export declare function getInteropRoot(provider: PublicClient, rootChainId: bigint, batchNumber: bigint): Promise<Hex>;

package/dist/adapters/viem/resources/interop/services/finalization/decoders.d.ts

@@ -0,0 +1,11 @@
+import type { Hex } from '../../../../../../core/types/primitives';
+import type { Log } from '../../../../../../core/types/transactions';
+export declare function decodeInteropBundleSent(log: {
+    data: Hex;
+    topics: Hex[];
+}): {
+    bundleHash: Hex;
+    sourceChainId: bigint;
+    destinationChainId: bigint;
+};
+export declare function decodeL1MessageData(log: Log): Hex;

package/dist/adapters/viem/resources/interop/services/finalization/index.d.ts

@@ -0,0 +1,13 @@
+import type { PublicClient } from 'viem';
+import type { InteropStatus, InteropWaitable, InteropFinalizationInfo, InteropFinalizationResult } from '../../../../../../core/types/flows/interop';
+import type { ViemClient } from '../../../../client';
+import type { LogsQueryOptions } from './data-fetchers';
+export interface InteropFinalizationServices {
+    status(dstProvider: PublicClient, input: InteropWaitable, opts?: LogsQueryOptions): Promise<InteropStatus>;
+    wait(dstProvider: PublicClient, gwProvider: PublicClient, input: InteropWaitable, opts?: {
+        pollMs?: number;
+        timeoutMs?: number;
+    }): Promise<InteropFinalizationInfo>;
+    finalize(dstProvider: PublicClient, info: InteropFinalizationInfo, opts?: LogsQueryOptions): Promise<InteropFinalizationResult>;
+}
+export declare function createInteropFinalizationServices(client: ViemClient): InteropFinalizationServices;

package/dist/adapters/viem/resources/interop/services/finalization/polling.d.ts

@@ -0,0 +1,7 @@
+import type { PublicClient } from 'viem';
+import type { InteropWaitable, InteropFinalizationInfo } from '../../../../../../core/types/flows/interop';
+import type { ViemClient } from '../../../../client';
+export declare function waitForFinalization(client: ViemClient, dstProvider: PublicClient, gwProvider: PublicClient, input: InteropWaitable, opts?: {
+    pollMs?: number;
+    timeoutMs?: number;
+}): Promise<InteropFinalizationInfo>;

package/dist/adapters/viem/resources/interop/services/finalization/status.d.ts

@@ -0,0 +1,5 @@
+import type { PublicClient } from 'viem';
+import type { InteropStatus, InteropWaitable } from '../../../../../../core/types/flows/interop';
+import type { ViemClient } from '../../../../client';
+import type { LogsQueryOptions } from './data-fetchers';
+export declare function getStatus(client: ViemClient, dstProvider: PublicClient, input: InteropWaitable, opts?: LogsQueryOptions): Promise<InteropStatus>;

package/dist/adapters/viem/resources/interop/services/finalization/topics.d.ts

@@ -0,0 +1,4 @@
+import type { InteropTopics } from '../../../../../../core/resources/interop/events';
+export declare function getTopics(): {
+    topics: InteropTopics;
+};

package/dist/adapters/viem/resources/interop/services/gas.d.ts

@@ -0,0 +1,12 @@
+import type { ViemTransactionRequest } from '../routes/types';
+import type { BuildCtx } from '../context';
+/**
+ * Estimates the combined L2 gas cost for all steps in an interop plan.
+ *
+ * Fetches gas price once, then estimates gas for each step using ctx.sender as the
+ * from address. Applies the standard buffer and sums gasLimit × maxFeePerGas across
+ * all steps. Returns undefined if estimation fails for any step.
+ */
+export declare function quoteStepsL2Fee(steps: Array<{
+    tx: ViemTransactionRequest;
+}>, ctx: BuildCtx): Promise<bigint | undefined>;

package/dist/adapters/viem/resources/interop/services/starter-data.d.ts

@@ -0,0 +1,6 @@
+import type { Hex } from '../../../../../core/types/primitives';
+import type { InteropParams } from '../../../../../core/types/flows/interop';
+import type { BuildCtx } from '../context';
+import type { InteropStarterData } from '../../../../../core/resources/interop/plan';
+/** Build interop starter data for all actions in the bundle. */
+export declare function getStarterData(params: InteropParams, ctx: BuildCtx, erc20AssetIds: Map<string, Hex>): Promise<InteropStarterData[]>;

package/dist/adapters/viem/resources/interop/types.d.ts

@@ -0,0 +1,8 @@
+import type { PublicClient } from 'viem';
+/** String URL or live PublicClient — used only in resource/SDK config. */
+export type ChainRef = string | PublicClient;
+/** One-time configuration for the interop resource. */
+export interface InteropConfig {
+    /** Gateway chain — used to fetch GW chain ID for interop root polling. */
+    gwChain: ChainRef;
+}