@matterlabs/zksync-js 0.0.1 → 0.0.3

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

@@ -7,6 +7,7 @@ export type { DepositsResource } from './resources/deposits';
 export { createWithdrawalsResource } from './resources/withdrawals';
 export { createFinalizationServices } from './resources/withdrawals';
 export type { WithdrawalsResource, FinalizationServices } from './resources/withdrawals';
+export { createTokensResource } from './resources/tokens';
 export * from './errors/error-ops';
 export * from './errors/revert';
 export type * from './typechain';

package/dist/adapters/ethers/index.js

@@ -1,8 +1,9 @@
-export { createEthersClient as createClient, createEthersClient } from '../../chunk-3LALBFFE.js';
-export { buildDirectRequestStruct, checkBaseCost, classifyReadinessFromRevert, createDepositsResource, createErrorHandlers, createEthersSdk, createFinalizationServices, createWithdrawalsResource, decodeRevert, encodeNTVAssetId, encodeNTVTransferData, encodeNativeTokenVaultAssetId, encodeNativeTokenVaultTransferData, encodeSecondBridgeArgs, encodeSecondBridgeDataV1, encodeSecondBridgeErc20Args, encodeSecondBridgeEthArgs, getFeeOverrides, getGasPriceWei, getL2FeeOverrides, registerErrorAbi, scaleGasLimit, toZKsyncError } from '../../chunk-CGO27P7F.js';
-import '../../chunk-263G6636.js';
-import '../../chunk-DI2CJDPZ.js';
-import '../../chunk-4HLJJKIY.js';
-import '../../chunk-Y75OMFK6.js';
-import '../../chunk-B77GWPO5.js';
-import '../../chunk-6GCT6TLS.js';
+export { buildDirectRequestStruct, createDepositsResource, createEthersSdk, createFinalizationServices, createTokensResource, createWithdrawalsResource, encodeNativeTokenVaultTransferData, encodeSecondBridgeArgs, encodeSecondBridgeDataV1, encodeSecondBridgeErc20Args, encodeSecondBridgeEthArgs } from '../../chunk-5YWP4CZP.js';
+import '../../chunk-LL3WKCFJ.js';
+import '../../chunk-NEC2ZKHI.js';
+export { createEthersClient as createClient, createEthersClient } from '../../chunk-3MRGU4HV.js';
+export { classifyReadinessFromRevert, createErrorHandlers, decodeRevert, registerErrorAbi, toZKsyncError } from '../../chunk-XRE7H466.js';
+import '../../chunk-6K6VJQAL.js';
+import '../../chunk-NCAIVYBR.js';
+import '../../chunk-M5J2MM2U.js';
+import '../../chunk-F2ENUV3A.js';

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

@@ -0,0 +1,9 @@
+import type { EthersClient } from '../../client';
+import type { ContractsResource } from './types';
+/**
+ * Creates a contracts resource for managing resolved addresses and contract instances.
+ *
+ * @param client - EthersClient instance
+ * @returns ContractsResource instance
+ */
+export declare function createContractsResource(client: EthersClient): ContractsResource;

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

@@ -0,0 +1,2 @@
+export { createContractsResource } from './contracts';
+export type { ContractsResource, ContractInstances } from './types';

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

@@ -0,0 +1,60 @@
+import type { Contract } from 'ethers';
+import type { ResolvedAddresses } from '../../client';
+/**
+ * Collection of typed ethers Contract instances for all bridge contracts.
+ */
+export interface ContractInstances {
+    bridgehub: Contract;
+    l1AssetRouter: Contract;
+    l1Nullifier: Contract;
+    l1NativeTokenVault: Contract;
+    l2AssetRouter: Contract;
+    l2NativeTokenVault: Contract;
+    l2BaseTokenSystem: Contract;
+}
+/**
+ * Contracts resource interface providing access to resolved addresses
+ * and contract instances.
+ */
+export interface ContractsResource {
+    /**
+     * Returns resolved addresses for all bridge contracts.
+     *
+     * @returns Resolved contract addresses
+     */
+    addresses(): Promise<ResolvedAddresses>;
+    /**
+     * Returns typed Contract instances for all bridge contracts (cached).
+     *
+     * @returns Contract instances
+     */
+    instances(): Promise<ContractInstances>;
+    /**
+     * Returns the Bridgehub contract instance.
+     */
+    bridgehub(): Promise<Contract>;
+    /**
+     * Returns the L1 Asset Router contract instance.
+     */
+    l1AssetRouter(): Promise<Contract>;
+    /**
+     * Returns the L1 Native Token Vault contract instance.
+     */
+    l1NativeTokenVault(): Promise<Contract>;
+    /**
+     * Returns the L1 Nullifier contract instance.
+     */
+    l1Nullifier(): Promise<Contract>;
+    /**
+     * Returns the L2 Asset Router contract instance.
+     */
+    l2AssetRouter(): Promise<Contract>;
+    /**
+     * Returns the L2 Native Token Vault contract instance.
+     */
+    l2NativeTokenVault(): Promise<Contract>;
+    /**
+     * Returns the L2 Base Token System contract instance.
+     */
+    l2BaseTokenSystem(): Promise<Contract>;
+}

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

@@ -1,26 +1,40 @@
 import type { EthersClient } from '../../client';
-import type { Address } from '../../../../core/types/primitives';
-import { type ResolvedFeeOverrides } from '../utils';
+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 { ResolvedToken, TokensResource } from '../../../../core/types/flows/token';
+import type { ContractsResource } from '../contracts';
 export interface BuildCtx extends CommonCtx {
     client: EthersClient;
+    tokens: TokensResource;
+    contracts: ContractsResource;
+    resolvedToken: ResolvedToken;
+    baseTokenAssetId: Hex;
+    baseTokenL1: Address;
+    baseIsEth: boolean;
     l1AssetRouter: Address;
-    fee: ResolvedFeeOverrides;
-    l2GasLimit: bigint;
+    gasOverrides?: TxOverrides;
+    l2GasLimit?: bigint;
     gasPerPubdata: bigint;
     operatorTip: bigint;
     refundRecipient: Address;
 }
-export declare function commonCtx(p: DepositParams, client: EthersClient): Promise<{
+export declare function commonCtx(p: DepositParams, client: EthersClient, tokens: TokensResource, contracts: ContractsResource): Promise<{
     client: EthersClient;
+    tokens: TokensResource;
+    contracts: ContractsResource;
+    resolvedToken: ResolvedToken;
+    baseTokenAssetId: `0x${string}`;
+    baseTokenL1: `0x${string}`;
+    baseIsEth: boolean;
     l1AssetRouter: `0x${string}`;
     route: DepositRoute;
     bridgehub: `0x${string}`;
     chainIdL2: bigint;
     sender: `0x${string}`;
-    fee: ResolvedFeeOverrides;
-    l2GasLimit: bigint;
+    gasOverrides: TxOverrides | undefined;
+    l2GasLimit: bigint | undefined;
     gasPerPubdata: bigint;
     operatorTip: bigint;
     refundRecipient: `0x${string}`;

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

@@ -3,6 +3,8 @@ import type { DepositParams, DepositQuote, DepositHandle, DepositWaitable, Depos
 import type { Hex } from '../../../../core/types/primitives.ts';
 import { type TransactionRequest, type TransactionReceipt } from 'ethers';
 import type { DepositRouteStrategy } from './routes/types.ts';
+import type { TokensResource } from '../../../../core/types/flows/token';
+import type { ContractsResource } from '../contracts';
 export declare const ROUTES: Record<DepositRoute, DepositRouteStrategy>;
 export interface DepositsResource {
     quote(p: DepositParams): Promise<DepositQuote>;
@@ -43,4 +45,4 @@ export interface DepositsResource {
         error: unknown;
     }>;
 }
-export declare function createDepositsResource(client: EthersClient): DepositsResource;
+export declare function createDepositsResource(client: EthersClient, tokens?: TokensResource, contracts?: ContractsResource): DepositsResource;

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

@@ -1,10 +1,6 @@
 import type { TransactionRequest } from 'ethers';
 import type { DepositParams } from '../../../../../core/types/flows/deposits';
+import type { DepositFeeBreakdown } from '../../../../../core/types/fees';
 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>;
+export type DepositRouteStrategy = RouteStrategy<DepositParams, TransactionRequest, DepositFeeBreakdown, DepositBuildCtx>;

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

@@ -0,0 +1,6 @@
+import type { BuildCtx } from '../context';
+export type QuoteL2BaseCostInput = {
+    ctx: BuildCtx;
+    l2GasLimit: bigint;
+};
+export declare function quoteL2BaseCost(input: QuoteL2BaseCostInput): Promise<bigint>;

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

@@ -0,0 +1,41 @@
+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 { 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;
+    fallbackGasLimit?: bigint;
+};
+export type QuoteL2GasInput = {
+    ctx: BuildCtx;
+    route: DepositRoute;
+    l2TxForModeling?: TransactionRequest;
+    overrideGasLimit?: bigint;
+    stateOverrides?: Record<string, unknown>;
+};
+export type ResolveErc20L2GasLimitInput = {
+    ctx: BuildCtx;
+    l1Token: Address;
+};
+/**
+ * Quote L1 gas for a deposit transaction.
+ */
+export declare function quoteL1Gas(input: QuoteL1GasInput): Promise<GasQuote | undefined>;
+/**
+ * Quote L2 gas for an L2 transaction.
+ */
+export declare function quoteL2Gas(input: QuoteL2GasInput): Promise<GasQuote | undefined>;
+/**
+ * Resolve a safe L2 gas limit for ERC20 deposits based on whether the
+ * L2 token contract is already deployed.
+ */
+export declare function determineErc20L2Gas(input: {
+    ctx: BuildCtx;
+    l1Token: Address;
+    modelTx?: TransactionRequest;
+}): Promise<GasQuote | undefined>;

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

@@ -0,0 +1 @@
+export { createTokensResource } from './tokens';

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

@@ -0,0 +1,10 @@
+import type { EthersClient } from '../../client';
+import type { TokensResource } from '../../../../core/types/flows/token';
+/**
+ * Creates a tokens resource for managing token identity, L1/L2 mappings,
+ * and bridge assetId primitives.
+ *
+ * @param client - EthersClient instance
+ * @returns TokensResource instance
+ */
+export declare function createTokensResource(client: EthersClient): TokensResource;

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

@@ -1,20 +1,9 @@
-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 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}`;
 export declare function buildDirectRequestStruct(args: {
     chainId: bigint;
     mintValue: bigint;
@@ -34,6 +23,3 @@ export declare function buildDirectRequestStruct(args: {
     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

@@ -1,19 +1,27 @@
 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';
+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 { Hex } from '../../../../core/types/primitives';
+import type { ResolvedToken, TokensResource } from '../../../../core/types/flows/token';
+import type { ContractsResource } from '../contracts';
 export interface BuildCtx extends CommonCtx {
     client: EthersClient;
+    tokens: TokensResource;
+    contracts: ContractsResource;
+    resolvedToken: ResolvedToken;
+    baseTokenAssetId: Hex;
+    baseTokenL1: Address;
+    baseIsEth: boolean;
+    bridgehub: Address;
     l1AssetRouter: Address;
     l1Nullifier: Address;
     l2AssetRouter: Address;
     l2NativeTokenVault: Address;
     l2BaseTokenSystem: Address;
-    baseIsEth: boolean;
-    l2GasLimit: bigint;
-    gasBufferPct: number;
-    fee: ResolvedEip1559Fees;
+    gasOverrides?: TxOverrides;
 }
-export declare function commonCtx(p: WithdrawParams, client: EthersClient): Promise<BuildCtx & {
+export declare function commonCtx(p: WithdrawParams, client: EthersClient, tokens: TokensResource, contracts: ContractsResource): Promise<BuildCtx & {
     route: WithdrawRoute;
 }>;

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

@@ -4,6 +4,8 @@ import type { WithdrawParams, WithdrawQuote, WithdrawPlan, WithdrawHandle, Withd
 import type { Hex } from '../../../../core/types/primitives';
 import type { WithdrawRouteStrategy, TransactionReceiptZKsyncOS } from './routes/types';
 import { createFinalizationServices, type FinalizationServices } from './services/finalization';
+import type { TokensResource } from '../../../../core/types/flows/token';
+import type { ContractsResource } from '../contracts';
 export declare const ROUTES: Record<WithdrawRoute, WithdrawRouteStrategy>;
 export interface WithdrawalsResource {
     quote(p: WithdrawParams): Promise<WithdrawQuote>;
@@ -51,6 +53,6 @@ export interface WithdrawalsResource {
         error: unknown;
     }>;
 }
-export declare function createWithdrawalsResource(client: EthersClient): WithdrawalsResource;
+export declare function createWithdrawalsResource(client: EthersClient, tokens?: TokensResource, contracts?: ContractsResource): WithdrawalsResource;
 export { createFinalizationServices };
 export type { FinalizationServices };

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

@@ -3,8 +3,8 @@ 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>;
+import type { WithdrawalFeeBreakdown } from '../../../../../core/types/fees';
+export type WithdrawRouteStrategy = RouteStrategy<WithdrawParams, TransactionRequest, WithdrawalFeeBreakdown, WithdrawBuildCtx>;
 export interface L2ToL1Log {
     l2ShardId?: number;
     isService?: boolean;

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

@@ -0,0 +1,14 @@
+import type { Address } from '../../../../../core/types/primitives';
+import type { WithdrawalFeeBreakdown } from '../../../../../core/types/fees';
+import type { GasQuote } from './gas';
+export type BuildWithdrawFeeBreakdownInput = {
+    feeToken: Address;
+    l2Gas?: GasQuote;
+};
+/**
+ * Builds FeeBreakdown for withdrawals.
+ *
+ * Withdrawals represent a single L2 transaction:
+ * - fees.l2 = cost of the withdraw tx on L2
+ */
+export declare function buildFeeBreakdown(p: BuildWithdrawFeeBreakdownInput): WithdrawalFeeBreakdown;

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

@@ -0,0 +1,12 @@
+import type { TransactionRequest } from 'ethers';
+import type { BuildCtx } from '../context';
+import { type GasQuote } from '../../../../../core/resources/withdrawals/gas';
+export type { GasQuote };
+export type QuoteWithdrawL2GasInput = {
+    ctx: BuildCtx;
+    tx: TransactionRequest;
+};
+/**
+ * Quotes L2 gas for a withdrawal tx.
+ */
+export declare function quoteL2Gas(input: QuoteWithdrawL2GasInput): Promise<GasQuote | undefined>;