@matterlabs/zksync-js 0.0.8 → 0.0.10

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

@@ -4,10 +4,14 @@ export * from './sdk';
 export * from './resources/utils';
 export { createDepositsResource } from './resources/deposits';
 export type { DepositsResource } from './resources/deposits';
+export { getL2TransactionHashFromLogs } from './resources/deposits/services/verification';
 export { createWithdrawalsResource } from './resources/withdrawals';
 export { createFinalizationServices } from './resources/withdrawals';
 export type { WithdrawalsResource, FinalizationServices } from './resources/withdrawals';
 export { createTokensResource } from './resources/tokens';
+export { createInteropResource } from './resources/interop';
+export { createInteropFinalizationServices } from './resources/interop';
+export type { InteropResource, InteropFinalizationServices } from './resources/interop';
 export * from './errors/error-ops';
 export * from './errors/revert';
 export type * from './typechain';

package/dist/adapters/ethers/index.js

@@ -1,9 +1,9 @@
-export { createEthersClient as createClient, createEthersClient } from '../../chunk-FGXRG2JS.js';
-export { buildDirectRequestStruct, createDepositsResource, createEthersSdk, createFinalizationServices, createTokensResource, createWithdrawalsResource, encodeNativeTokenVaultTransferData, encodeSecondBridgeArgs, encodeSecondBridgeDataV1, encodeSecondBridgeErc20Args, encodeSecondBridgeEthArgs } from '../../chunk-63DNJXS3.js';
-export { classifyReadinessFromRevert, createErrorHandlers, decodeRevert, registerErrorAbi, toZKsyncError } from '../../chunk-NVULC4JB.js';
-import '../../chunk-NODVRI3E.js';
-import '../../chunk-QZVYN3YA.js';
-import '../../chunk-5V2JRM5J.js';
-import '../../chunk-SHQQI3UD.js';
-import '../../chunk-3GFCAGGI.js';
+export { createEthersClient as createClient, createEthersClient } from '../../chunk-HOZTREW6.js';
+export { buildDirectRequestStruct, createDepositsResource, createEthersSdk, createFinalizationServices, createInteropFinalizationServices, createInteropResource, createTokensResource, createWithdrawalsResource, encodeNativeTokenVaultTransferData, encodeSecondBridgeArgs, encodeSecondBridgeDataV1, encodeSecondBridgeErc20Args, encodeSecondBridgeEthArgs, getL2TransactionHashFromLogs } from '../../chunk-MBEMIFYS.js';
+export { classifyReadinessFromRevert, createErrorHandlers, decodeRevert, registerErrorAbi, toZKsyncError } from '../../chunk-QDJOEVGJ.js';
+import '../../chunk-AIFHAPJC.js';
+import '../../chunk-ZVHFVUDE.js';
+import '../../chunk-UIXU35ZU.js';
+import '../../chunk-SRPKTXIF.js';
+import '../../chunk-FBKBF7YM.js';
 import '../../chunk-C3AGOEHR.js';

package/dist/adapters/ethers/resources/contracts/types.d.ts

@@ -11,6 +11,9 @@ export interface ContractInstances {
     l2AssetRouter: Contract;
     l2NativeTokenVault: Contract;
     l2BaseTokenSystem: Contract;
+    interopCenter: Contract;
+    interopHandler: Contract;
+    l2MessageVerification: Contract;
 }
 /**
  * Contracts resource interface providing access to resolved addresses
@@ -57,4 +60,16 @@ export interface ContractsResource {
      * Returns the L2 Base Token System contract instance.
      */
     l2BaseTokenSystem(): Promise<Contract>;
+    /**
+     * Returns the Interop Center contract instance.
+     */
+    interopCenter(): Promise<Contract>;
+    /**
+     * Returns the Interop Handler contract instance.
+     */
+    interopHandler(): Promise<Contract>;
+    /**
+     * Returns the L2 Message Verification contract instance.
+     */
+    l2MessageVerification(): Promise<Contract>;
 }

package/dist/adapters/ethers/resources/deposits/context.d.ts

@@ -2,7 +2,7 @@ import type { EthersClient } from '../../client';
 import type { Address, Hex } from '../../../../core/types/primitives';
 import type { DepositParams, DepositRoute } from '../../../../core/types/flows/deposits';
 import type { CommonCtx } from '../../../../core/types/flows/base';
-import type { TxOverrides } from '../../../../core/types/fees';
+import { type TxGasOverrides } from '../../../../core/types/fees';
 import type { ResolvedToken, TokensResource } from '../../../../core/types/flows/token';
 import type { ContractsResource } from '../contracts';
 export interface BuildCtx extends CommonCtx {
@@ -14,7 +14,7 @@ export interface BuildCtx extends CommonCtx {
     baseTokenL1: Address;
     baseIsEth: boolean;
     l1AssetRouter: Address;
-    gasOverrides?: TxOverrides;
+    gasOverrides?: TxGasOverrides;
     l2GasLimit?: bigint;
     gasPerPubdata: bigint;
     operatorTip: bigint;
@@ -33,7 +33,7 @@ export declare function commonCtx(p: DepositParams, client: EthersClient, tokens
     bridgehub: `0x${string}`;
     chainIdL2: bigint;
     sender: `0x${string}`;
-    gasOverrides: TxOverrides | undefined;
+    gasOverrides: TxGasOverrides | undefined;
     l2GasLimit: bigint | undefined;
     gasPerPubdata: bigint;
     operatorTip: bigint;

package/dist/adapters/ethers/resources/deposits/services/gas.d.ts

@@ -1,14 +1,14 @@
 import type { TransactionRequest } from 'ethers';
 import type { BuildCtx } from '../context';
 import type { DepositRoute } from '../../../../../core/types/flows/deposits';
-import type { TxOverrides } from '../../../../../core/types/fees';
+import type { TxGasOverrides } from '../../../../../core/types/fees';
 import type { Address } from '../../../../../core/types/primitives';
 import { type GasQuote } from '../../../../../core/resources/deposits/gas';
 export type { GasQuote };
 export type QuoteL1GasInput = {
     ctx: BuildCtx;
     tx: TransactionRequest;
-    overrides?: TxOverrides;
+    overrides?: TxGasOverrides;
     fallbackGasLimit?: bigint;
 };
 export type QuoteL2GasInput = {

package/dist/adapters/ethers/resources/deposits/services/verification.d.ts

@@ -2,7 +2,7 @@ import { Interface, type Log, type Provider, type TransactionReceipt } from 'eth
 import type { Hex } from '../../../../../core/types/primitives';
 export declare const I_BRIDGEHUB: Interface;
 export declare const TOPIC_BRIDGEHUB_NPR: string;
-export declare function extractL2TxHashFromL1Logs(logs: ReadonlyArray<Log>): Hex | null;
+export declare function getL2TransactionHashFromLogs(logs: ReadonlyArray<Log>): Hex | null;
 export declare function waitForL2ExecutionFromL1Tx(l1: Provider, l2: Provider, l1TxHash: Hex): Promise<{
     l2Receipt: TransactionReceipt;
     l2TxHash: Hex;

package/dist/adapters/ethers/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/ethers/resources/interop/attributes/resource.d.ts

@@ -0,0 +1,9 @@
+import { Interface } from 'ethers';
+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 createEthersAttributesResource(opts?: {
+    iface?: Interface;
+}): AttributesResource;

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

@@ -0,0 +1,36 @@
+import type { AbstractProvider } from 'ethers';
+import { Interface } from 'ethers';
+import type { EthersClient } 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: EthersClient;
+    tokens: TokensResource;
+    contracts: ContractsResource;
+    bridgehub: Address;
+    dstChainId: bigint;
+    dstProvider: AbstractProvider;
+    chainId: bigint;
+    interopCenter: Address;
+    interopHandler: Address;
+    l2MessageVerification: Address;
+    l2AssetRouter: Address;
+    l2NativeTokenVault: Address;
+    baseTokens: {
+        src: Address;
+        dst: Address;
+        matches: boolean;
+    };
+    ifaces: {
+        interopCenter: Interface;
+        interopHandler: Interface;
+    };
+    attributes: AttributesResource;
+    gasOverrides?: TxGasOverrides;
+}
+export declare function commonCtx(dstProvider: AbstractProvider, params: InteropParams, client: EthersClient, tokens: TokensResource, contracts: ContractsResource, attributes: AttributesResource): Promise<BuildCtx>;

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

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

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

@@ -0,0 +1,9 @@
+import { type AbstractProvider } from 'ethers';
+import type { InteropWaitable as InteropWaitableBase } from '../../../../core/types/flows/interop';
+import type { DstChain, InteropWaitable } from './types';
+/** Resolve a destination chain input (URL string or provider) into an AbstractProvider. */
+export declare function resolveDstProvider(dstChain: DstChain): AbstractProvider;
+export declare function resolveWaitableInput(waitableInput: InteropWaitable): {
+    dstProvider: AbstractProvider;
+    waitable: InteropWaitableBase;
+};

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

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

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

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

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

@@ -0,0 +1,13 @@
+import type { TransactionRequest } from 'ethers';
+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 } from '../../../../../core/types/flows/interop';
+export interface InteropRouteStrategy {
+    preflight(params: InteropParams, ctx: BuildCtx): Promise<void>;
+    build(params: InteropParams, ctx: BuildCtx): Promise<{
+        steps: Array<PlanStep<TransactionRequest>>;
+        approvals: ApprovalNeed[];
+        quoteExtras: QuoteExtras;
+    }>;
+}

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

@@ -0,0 +1,15 @@
+import { type TransactionRequest } from 'ethers';
+import type { Address, Hex } from '../../../../../core/types/primitives';
+import type { InteropParams } from '../../../../../core/types/flows/interop';
+import type { BuildCtx } from '../context';
+/** 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: TransactionRequest;
+}>;
+/** 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/ethers/resources/interop/services/finalization/bundle.d.ts

@@ -0,0 +1,15 @@
+import { type AbstractProvider, type TransactionReceipt } from 'ethers';
+import type { Hex } from '../../../../../../core/types/primitives';
+import type { InteropFinalizationInfo } from '../../../../../../core/types/flows/interop';
+import type { EthersClient } 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: EthersClient, dstProvider: AbstractProvider, topics: InteropTopics, bundleHash: Hex, opts?: LogsQueryOptions): Promise<{
+    phase: InteropPhase;
+    dstExecTxHash?: Hex;
+}>;
+export declare function executeBundle(client: EthersClient, dstProvider: AbstractProvider, info: InteropFinalizationInfo, opts?: LogsQueryOptions): Promise<{
+    hash: Hex;
+    wait: () => Promise<TransactionReceipt>;
+}>;

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

@@ -0,0 +1,17 @@
+import { type AbstractProvider } from 'ethers';
+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: AbstractProvider, txHash: Hex): Promise<{
+    logs: {
+        address: Address;
+        topics: Hex[];
+        data: Hex;
+        transactionHash: Hex;
+    }[];
+} | null>;
+export declare function getLogs(provider: AbstractProvider, address: Address, topics: Array<Hex | null>, opts?: LogsQueryOptions): Promise<Log[]>;
+export declare function getInteropRoot(provider: AbstractProvider, rootChainId: bigint, batchNumber: bigint): Promise<Hex>;

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

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

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

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

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

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

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

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

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

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

package/dist/adapters/ethers/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/ethers/resources/interop/types.d.ts

@@ -0,0 +1,16 @@
+import type { AbstractProvider } from 'ethers';
+import type { InteropParams as InteropParamsBase, InteropHandle as InteropHandleBase, InteropWaitable as InteropWaitableBase, InteropFinalizationInfo as InteropFinalizationInfoBase } from '../../../../core/types/flows/interop';
+export type DstChain = string | AbstractProvider;
+export interface InteropParams extends InteropParamsBase {
+    dstChain: DstChain;
+}
+export interface InteropHandle<Tx> extends InteropHandleBase<Tx> {
+    dstChain: DstChain;
+}
+export interface InteropFinalizationInfo extends InteropFinalizationInfoBase {
+    dstChain: DstChain;
+}
+export type InteropWaitable = InteropHandle<unknown> | {
+    dstChain: DstChain;
+    waitable: InteropWaitableBase;
+};

package/dist/adapters/ethers/resources/withdrawals/context.d.ts

@@ -2,7 +2,7 @@ import type { EthersClient } from '../../client';
 import type { Address } from '../../../../core/types/primitives';
 import { type WithdrawParams, type WithdrawRoute } from '../../../../core/types/flows/withdrawals';
 import type { CommonCtx } from '../../../../core/types/flows/base';
-import type { TxOverrides } from '../../../../core/types/fees';
+import { type TxGasOverrides } from '../../../../core/types/fees';
 import type { Hex } from '../../../../core/types/primitives';
 import type { ResolvedToken, TokensResource } from '../../../../core/types/flows/token';
 import type { ContractsResource } from '../contracts';
@@ -20,7 +20,7 @@ export interface BuildCtx extends CommonCtx {
     l2AssetRouter: Address;
     l2NativeTokenVault: Address;
     l2BaseTokenSystem: Address;
-    gasOverrides?: TxOverrides;
+    gasOverrides?: TxGasOverrides;
 }
 export declare function commonCtx(p: WithdrawParams, client: EthersClient, tokens: TokensResource, contracts: ContractsResource): Promise<BuildCtx & {
     route: WithdrawRoute;