@matterlabs/zksync-js 0.0.1

package/dist/adapters/ethers/resources/deposits/routes/eth.d.ts

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

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

@@ -0,0 +1,10 @@
+import type { TransactionRequest } from 'ethers';
+import type { DepositParams } from '../../../../../core/types/flows/deposits';
+import type { RouteStrategy } from '../../../../../core/types/flows/route';
+import type { BuildCtx as DepositBuildCtx } from '../context';
+export type DepositQuoteExtras = {
+    baseCost: bigint;
+    mintValue: bigint;
+    l1GasLimit?: bigint;
+};
+export type DepositRouteStrategy = RouteStrategy<DepositParams, TransactionRequest, DepositQuoteExtras, DepositBuildCtx>;

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

@@ -0,0 +1,9 @@
+import { Interface, type Log, type Provider, type TransactionReceipt } from 'ethers';
+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 waitForL2ExecutionFromL1Tx(l1: Provider, l2: Provider, l1TxHash: Hex): Promise<{
+    l2Receipt: TransactionReceipt;
+    l2TxHash: Hex;
+}>;

package/dist/adapters/ethers/resources/token-info.d.ts

@@ -0,0 +1,31 @@
+import { type Provider } from 'ethers';
+import type { Address } from '../../../core/types/primitives';
+/**
+ * Read the `BASE_TOKEN_ASSET_ID` from the L2 NativeTokenVault.
+ * This is the encoded assetId of the chain’s base token.
+ */
+export declare function ntvBaseAssetId(l2: Provider, ntv: Address): Promise<`0x${string}`>;
+/**
+ * Read the `L1_CHAIN_ID` that the L2 NativeTokenVault is anchored to.
+ * Needed when encoding asset IDs.
+ */
+export declare function ntvL1ChainId(l2: Provider, ntv: Address): Promise<bigint>;
+/**
+ * Ensure a token is registered in the L2 NativeTokenVault and return its assetId.
+ * (Will register on-chain if not yet registered.)
+ */
+export declare function ntvAssetIdForToken(l2: Provider, ntv: Address, token: Address): Promise<`0x${string}`>;
+/**
+ * Check if the chain is ETH-based (i.e. base token == ETH).
+ */
+export declare function isEthBasedChain(l2: Provider, ntv: Address): Promise<boolean>;
+/**
+ * Check if a given token address is the chain’s base token.
+ */
+export declare function isBaseToken(l2: Provider, ntv: Address, token: Address): Promise<boolean>;
+/**
+ * Check if the token should be treated as "ETH" on this L2.
+ * - If it equals the universal ETH alias (0x…800A), return true immediately.
+ * - Else compare the token’s assetId to the ETH sentinel assetId via the NTV.
+ */
+export declare function isEthTokenOnThisChain(l2: Provider, ntv: Address, token: Address): Promise<boolean>;

package/dist/adapters/ethers/resources/utils.d.ts

@@ -0,0 +1,39 @@
+import { ethers } from 'ethers';
+import type { Address } from '../../../core/types';
+import type { EthersClient } from '../client';
+import type { Eip1559GasOverrides, ResolvedEip1559Fees } from '../../../core/types/flows/base';
+export declare function encodeNativeTokenVaultAssetId(chainId: bigint, address: string): string;
+export declare function encodeNativeTokenVaultTransferData(amount: bigint, receiver: Address, token: Address): string;
+export declare function encodeSecondBridgeDataV1(assetId: string, transferData: string): string;
+export declare function encodeNTVAssetId(chainId: bigint, address: string): string;
+export declare function encodeNTVTransferData(amount: bigint, receiver: Address, token: Address): string;
+export declare function scaleGasLimit(gasLimit: bigint): bigint;
+export declare function checkBaseCost(baseCost: ethers.BigNumberish, value: ethers.BigNumberish | Promise<ethers.BigNumberish>): Promise<void>;
+export type ResolvedFeeOverrides = ResolvedEip1559Fees & {
+    gasPriceForBaseCost: bigint;
+};
+export declare function getFeeOverrides(client: EthersClient, overrides?: Eip1559GasOverrides): Promise<ResolvedFeeOverrides>;
+export declare function getL2FeeOverrides(client: EthersClient, overrides?: Eip1559GasOverrides): Promise<ResolvedEip1559Fees>;
+export declare function getGasPriceWei(client: EthersClient): Promise<bigint>;
+export declare function buildDirectRequestStruct(args: {
+    chainId: bigint;
+    mintValue: bigint;
+    l2GasLimit: bigint;
+    gasPerPubdata: bigint;
+    refundRecipient: Address;
+    l2Contract: Address;
+    l2Value: bigint;
+}): {
+    chainId: bigint;
+    l2Contract: `0x${string}`;
+    mintValue: bigint;
+    l2Value: bigint;
+    l2Calldata: string;
+    l2GasLimit: bigint;
+    l2GasPerPubdataByteLimit: bigint;
+    factoryDeps: `0x${string}`[];
+    refundRecipient: `0x${string}`;
+};
+export declare function encodeSecondBridgeArgs(token: Address, amount: bigint, l2Receiver: Address): `0x${string}`;
+export declare function encodeSecondBridgeErc20Args(token: Address, amount: bigint, l2Receiver: Address): `0x${string}`;
+export declare function encodeSecondBridgeEthArgs(amount: bigint, l2Receiver: Address, ethToken?: Address): `0x${string}`;

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

@@ -0,0 +1,19 @@
+import type { EthersClient } from '../../client';
+import type { Address } from '../../../../core/types/primitives';
+import type { WithdrawParams, WithdrawRoute } from '../../../../core/types/flows/withdrawals';
+import type { CommonCtx, ResolvedEip1559Fees } from '../../../../core/types/flows/base';
+export interface BuildCtx extends CommonCtx {
+    client: EthersClient;
+    l1AssetRouter: Address;
+    l1Nullifier: Address;
+    l2AssetRouter: Address;
+    l2NativeTokenVault: Address;
+    l2BaseTokenSystem: Address;
+    baseIsEth: boolean;
+    l2GasLimit: bigint;
+    gasBufferPct: number;
+    fee: ResolvedEip1559Fees;
+}
+export declare function commonCtx(p: WithdrawParams, client: EthersClient): Promise<BuildCtx & {
+    route: WithdrawRoute;
+}>;

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

@@ -0,0 +1,56 @@
+import { type TransactionRequest, type TransactionReceipt } from 'ethers';
+import type { EthersClient } from '../../client';
+import type { WithdrawParams, WithdrawQuote, WithdrawPlan, WithdrawHandle, WithdrawalWaitable, WithdrawRoute, WithdrawalStatus } from '../../../../core/types/flows/withdrawals';
+import type { Hex } from '../../../../core/types/primitives';
+import type { WithdrawRouteStrategy, TransactionReceiptZKsyncOS } from './routes/types';
+import { createFinalizationServices, type FinalizationServices } from './services/finalization';
+export declare const ROUTES: Record<WithdrawRoute, WithdrawRouteStrategy>;
+export interface WithdrawalsResource {
+    quote(p: WithdrawParams): Promise<WithdrawQuote>;
+    tryQuote(p: WithdrawParams): Promise<{
+        ok: true;
+        value: WithdrawQuote;
+    } | {
+        ok: false;
+        error: unknown;
+    }>;
+    prepare(p: WithdrawParams): Promise<WithdrawPlan<TransactionRequest>>;
+    tryPrepare(p: WithdrawParams): Promise<{
+        ok: true;
+        value: WithdrawPlan<TransactionRequest>;
+    } | {
+        ok: false;
+        error: unknown;
+    }>;
+    create(p: WithdrawParams): Promise<WithdrawHandle<TransactionRequest>>;
+    tryCreate(p: WithdrawParams): Promise<{
+        ok: true;
+        value: WithdrawHandle<TransactionRequest>;
+    } | {
+        ok: false;
+        error: unknown;
+    }>;
+    status(h: WithdrawalWaitable | Hex): Promise<WithdrawalStatus>;
+    wait(h: WithdrawalWaitable | Hex, opts: {
+        for: 'l2' | 'ready' | 'finalized';
+        pollMs?: number;
+        timeoutMs?: number;
+    }): Promise<TransactionReceiptZKsyncOS | TransactionReceipt | null>;
+    finalize(l2TxHash: Hex): Promise<{
+        status: WithdrawalStatus;
+        receipt?: TransactionReceipt;
+    }>;
+    tryFinalize(l2TxHash: Hex): Promise<{
+        ok: true;
+        value: {
+            status: WithdrawalStatus;
+            receipt?: TransactionReceipt;
+        };
+    } | {
+        ok: false;
+        error: unknown;
+    }>;
+}
+export declare function createWithdrawalsResource(client: EthersClient): WithdrawalsResource;
+export { createFinalizationServices };
+export type { FinalizationServices };

package/dist/adapters/ethers/resources/withdrawals/routes/erc20-nonbase.d.ts

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

package/dist/adapters/ethers/resources/withdrawals/routes/eth-nonbase.d.ts

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

package/dist/adapters/ethers/resources/withdrawals/routes/eth.d.ts

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

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

@@ -0,0 +1,18 @@
+import type { TransactionRequest, TransactionReceipt } from 'ethers';
+import type { WithdrawParams } from '../../../../../core/types/flows/withdrawals';
+import type { RouteStrategy } from '../../../../../core/types/flows/route';
+import type { BuildCtx as WithdrawBuildCtx } from '../context';
+import type { Address, Hex } from '../../../../../core/types';
+export type WithdrawQuoteExtras = Record<string, never>;
+export type WithdrawRouteStrategy = RouteStrategy<WithdrawParams, TransactionRequest, WithdrawQuoteExtras, WithdrawBuildCtx>;
+export interface L2ToL1Log {
+    l2ShardId?: number;
+    isService?: boolean;
+    txNumberInBlock?: number;
+    sender?: Address;
+    key?: Hex;
+    value?: Hex;
+}
+export type TransactionReceiptZKsyncOS = TransactionReceipt & {
+    l2ToL1Logs?: L2ToL1Log[];
+};

package/dist/adapters/ethers/resources/withdrawals/services/finalization.d.ts

@@ -0,0 +1,33 @@
+import { type TransactionReceipt } from 'ethers';
+import type { Address, Hex } from '../../../../../core/types/primitives';
+import type { EthersClient } from '../../../client';
+import { type FinalizeReadiness, type FinalizeDepositParams, type WithdrawalKey, type FinalizationEstimate } from '../../../../../core/types/flows/withdrawals';
+export interface FinalizationServices {
+    /**
+     * Build finalizeDeposit params.
+     */
+    fetchFinalizeDepositParams(l2TxHash: Hex): Promise<{
+        params: FinalizeDepositParams;
+        nullifier: Address;
+    }>;
+    /**
+     * Read the Nullifier mapping to check finalization status.
+     */
+    isWithdrawalFinalized(key: WithdrawalKey): Promise<boolean>;
+    /**
+     * Simulate finalizeDeposit on L1 Nullifier to check readiness.
+     */
+    simulateFinalizeReadiness(params: FinalizeDepositParams): Promise<FinalizeReadiness>;
+    /**
+     * Estimate gas & fees for finalizeDeposit on L1 Nullifier.
+     */
+    estimateFinalization(params: FinalizeDepositParams): Promise<FinalizationEstimate>;
+    /**
+     * Call finalizeDeposit on L1 Nullifier.
+     */
+    finalizeDeposit(params: FinalizeDepositParams): Promise<{
+        hash: string;
+        wait: () => Promise<TransactionReceipt>;
+    }>;
+}
+export declare function createFinalizationServices(client: EthersClient): FinalizationServices;

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

@@ -0,0 +1,4 @@
+import type { AbstractProvider, JsonRpcApiProvider } from 'ethers';
+import { createZksRpc } from '../../core/rpc/zks';
+export declare function zksRpcFromEthers(l2Provider: JsonRpcApiProvider): ReturnType<typeof createZksRpc>;
+export declare function zksRpcFromEthers(l2Provider: AbstractProvider): ReturnType<typeof createZksRpc>;