@matterlabs/zksync-js 0.0.1 → 0.0.3

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

@@ -7,5 +7,8 @@ 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 { createContractsResource } from './resources/contracts';
+export type { ContractsResource, ContractInstances } from './resources/contracts';
 export * from './errors/error-ops';
 export * from './errors/revert';

package/dist/adapters/viem/index.js

@@ -1,8 +1,8 @@
-export { buildDirectRequestStruct, buildViemFeeOverrides, checkBaseCost, classifyReadinessFromRevert, createDepositsResource, createErrorHandlers, createFinalizationServices, createViemSdk, createWithdrawalsResource, decodeRevert, encodeNTVAssetId, encodeNTVTransferData, encodeNativeTokenVaultAssetId, encodeNativeTokenVaultTransferData, encodeSecondBridgeArgs, encodeSecondBridgeDataV1, encodeSecondBridgeErc20Args, encodeSecondBridgeEthArgs, getFeeOverrides, getGasPriceWei, getL2FeeOverrides, registerErrorAbi, scaleGasLimit, toZKsyncError } from '../../chunk-7M4V3FMT.js';
-import '../../chunk-263G6636.js';
-import '../../chunk-DI2CJDPZ.js';
-export { createViemClient as createClient, createViemClient } from '../../chunk-BD2LUO5T.js';
-import '../../chunk-4HLJJKIY.js';
-import '../../chunk-Y75OMFK6.js';
-import '../../chunk-B77GWPO5.js';
-import '../../chunk-6GCT6TLS.js';
+export { createViemClient as createClient, createViemClient } from '../../chunk-YUK547UF.js';
+export { buildDirectRequestStruct, classifyReadinessFromRevert, createContractsResource, createDepositsResource, createErrorHandlers, createFinalizationServices, createTokensResource, createViemSdk, createWithdrawalsResource, decodeRevert, encodeNativeTokenVaultTransferData, encodeSecondBridgeArgs, encodeSecondBridgeDataV1, encodeSecondBridgeErc20Args, encodeSecondBridgeEthArgs, registerErrorAbi, toZKsyncError } from '../../chunk-JXUFGIJG.js';
+import '../../chunk-LL3WKCFJ.js';
+import '../../chunk-NEC2ZKHI.js';
+import '../../chunk-6K6VJQAL.js';
+import '../../chunk-NCAIVYBR.js';
+import '../../chunk-M5J2MM2U.js';
+import '../../chunk-F2ENUV3A.js';

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

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

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

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

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

@@ -0,0 +1,61 @@
+import type { GetContractReturnType, PublicClient } from 'viem';
+import type { ResolvedAddresses } from '../../client';
+import type { IBridgehubABI, IL1AssetRouterABI, IL1NullifierABI, IL2AssetRouterABI, L2NativeTokenVaultABI, L1NativeTokenVaultABI, IBaseTokenABI } from '../../../../core/abi';
+/**
+ * Collection of typed viem contract instances for all bridge contracts.
+ */
+export interface ContractInstances {
+    bridgehub: GetContractReturnType<typeof IBridgehubABI, PublicClient>;
+    l1AssetRouter: GetContractReturnType<typeof IL1AssetRouterABI, PublicClient>;
+    l1Nullifier: GetContractReturnType<typeof IL1NullifierABI, PublicClient>;
+    l1NativeTokenVault: GetContractReturnType<typeof L1NativeTokenVaultABI, PublicClient>;
+    l2AssetRouter: GetContractReturnType<typeof IL2AssetRouterABI, PublicClient>;
+    l2NativeTokenVault: GetContractReturnType<typeof L2NativeTokenVaultABI, PublicClient>;
+    l2BaseTokenSystem: GetContractReturnType<typeof IBaseTokenABI, PublicClient>;
+}
+/**
+ * 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<ContractInstances['bridgehub']>;
+    /**
+     * Returns the L1 Asset Router contract instance.
+     */
+    l1AssetRouter(): Promise<ContractInstances['l1AssetRouter']>;
+    /**
+     * Returns the L1 Native Token Vault contract instance.
+     */
+    l1NativeTokenVault(): Promise<ContractInstances['l1NativeTokenVault']>;
+    /**
+     * Returns the L1 Nullifier contract instance.
+     */
+    l1Nullifier(): Promise<ContractInstances['l1Nullifier']>;
+    /**
+     * Returns the L2 Asset Router contract instance.
+     */
+    l2AssetRouter(): Promise<ContractInstances['l2AssetRouter']>;
+    /**
+     * Returns the L2 Native Token Vault contract instance.
+     */
+    l2NativeTokenVault(): Promise<ContractInstances['l2NativeTokenVault']>;
+    /**
+     * Returns the L2 Base Token System contract instance.
+     */
+    l2BaseTokenSystem(): Promise<ContractInstances['l2BaseTokenSystem']>;
+}

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

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

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

@@ -3,6 +3,8 @@ import type { DepositParams, DepositQuote, DepositHandle, DepositWaitable, Depos
 import type { Hex } from '../../../../core/types/primitives';
 import type { TransactionReceipt } from 'viem';
 import type { DepositRouteStrategy, ViemPlanWriteRequest } from './routes/types';
+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: ViemClient): DepositsResource;
+export declare function createDepositsResource(client: ViemClient, tokens?: TokensResource, contracts?: ContractsResource): DepositsResource;

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

@@ -2,6 +2,7 @@ import type { WalletClient, Transport, Chain, Account } from 'viem';
 import type { DepositParams } from '../../../../../core/types/flows/deposits';
 import type { RouteStrategy } from '../../../../../core/types/flows/route';
 import type { BuildCtx as DepositBuildCtx } from '../context';
+import type { DepositFeeBreakdown } from '../../../../../core/types/fees';
 type WriteParams = Parameters<WalletClient<Transport, Chain, Account>['writeContract']>[0];
 /**
  * viem specific
@@ -11,10 +12,5 @@ type WriteParams = Parameters<WalletClient<Transport, Chain, Account>['writeCont
 export type ViemPlanWriteRequest = Omit<WriteParams, 'value'> & {
     value?: bigint;
 };
-export type DepositQuoteExtras = {
-    baseCost: bigint;
-    mintValue: bigint;
-    l1GasLimit?: bigint;
-};
-export type DepositRouteStrategy = RouteStrategy<DepositParams, ViemPlanWriteRequest, DepositQuoteExtras, DepositBuildCtx>;
+export type DepositRouteStrategy = RouteStrategy<DepositParams, ViemPlanWriteRequest, DepositFeeBreakdown, DepositBuildCtx>;
 export {};

package/dist/adapters/viem/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/viem/resources/deposits/services/gas.d.ts

@@ -0,0 +1,37 @@
+import { type TransactionRequest } from 'viem';
+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>;
+};
+/**
+ * Quote L1 gas for a deposit transaction.
+ */
+export declare function quoteL1Gas(input: QuoteL1GasInput): Promise<GasQuote | undefined>;
+/**
+ * Quote L2 gas for an L2 execution.
+ */
+export declare function quoteL2Gas(input: QuoteL2GasInput): Promise<GasQuote | undefined>;
+/**
+ * ERC20 deposits have an extra edge case:
+ * if the token is not deployed on L2, the deposit includes deployment cost.
+ */
+export declare function determineErc20L2Gas(input: {
+    ctx: BuildCtx;
+    l1Token: Address;
+    modelTx?: TransactionRequest;
+}): Promise<GasQuote | undefined>;

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

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

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

@@ -0,0 +1,3 @@
+import type { ViemClient } from '../../client';
+import type { TokensResource } from '../../../../core/types/flows/token';
+export declare function createTokensResource(client: ViemClient): TokensResource;

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

@@ -1,23 +1,10 @@
 import { type Hex } from 'viem';
 import type { Address } from '../../../core/types';
-import type { ViemClient } from '../client';
-import type { Eip1559GasOverrides, ResolvedEip1559Fees } from '../../../core/types/flows/base';
-export declare function encodeNativeTokenVaultAssetId(chainId: bigint, address: string): Hex;
 export declare function encodeNativeTokenVaultTransferData(amount: bigint, receiver: Address, token: Address): Hex;
 export declare function encodeSecondBridgeDataV1(assetId: Hex, transferData: Hex): Hex;
-export declare const encodeNTVAssetId: typeof encodeNativeTokenVaultAssetId;
-export declare const encodeNTVTransferData: typeof encodeNativeTokenVaultTransferData;
-export declare function scaleGasLimit(gasLimit: bigint): bigint;
-/** Throws if baseCost > value */
-export declare function checkBaseCost(baseCost: bigint, value: bigint | Promise<bigint>): Promise<void>;
-export type FeeOverrides = ResolvedEip1559Fees & {
-    gasPriceForBaseCost: bigint;
-};
-export declare function getFeeOverrides(client: ViemClient, overrides?: Eip1559GasOverrides): Promise<FeeOverrides>;
-export declare function getL2FeeOverrides(client: ViemClient, overrides?: Eip1559GasOverrides): Promise<ResolvedEip1559Fees>;
-export declare function buildViemFeeOverrides(fees: ResolvedEip1559Fees): Record<string, unknown>;
-/** Fetches the gas price in wei (legacy) or falls back to maxFeePerGas. */
-export declare function getGasPriceWei(client: ViemClient): Promise<bigint>;
+export declare function encodeSecondBridgeArgs(token: Address, amount: bigint, l2Receiver: Address): Hex;
+export declare function encodeSecondBridgeErc20Args(token: Address, amount: bigint, l2Receiver: Address): Hex;
+export declare function encodeSecondBridgeEthArgs(amount: bigint, l2Receiver: Address, ethToken?: Address): Hex;
 export declare function buildDirectRequestStruct(args: {
     chainId: bigint;
     mintValue: bigint;
@@ -37,6 +24,3 @@ export declare function buildDirectRequestStruct(args: {
     factoryDeps: Hex[];
     refundRecipient: `0x${string}`;
 };
-export declare function encodeSecondBridgeArgs(token: Address, amount: bigint, l2Receiver: Address): Hex;
-export declare function encodeSecondBridgeErc20Args(token: Address, amount: bigint, l2Receiver: Address): Hex;
-export declare function encodeSecondBridgeEthArgs(amount: bigint, l2Receiver: Address, ethToken?: Address): Hex;

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

@@ -1,22 +1,27 @@
 import type { ViemClient } 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: ViemClient;
+    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;
-    chainIdL2: bigint;
-    sender: Address;
-    l2GasLimit: bigint;
-    gasBufferPct: number;
-    fee: ResolvedEip1559Fees;
+    gasOverrides?: TxOverrides;
 }
-export declare function commonCtx(p: WithdrawParams, client: ViemClient): Promise<BuildCtx & {
+export declare function commonCtx(p: WithdrawParams, client: ViemClient, tokens: TokensResource, contracts: ContractsResource): Promise<BuildCtx & {
     route: WithdrawRoute;
 }>;

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

@@ -4,6 +4,8 @@ import type { Hex } from '../../../../core/types/primitives';
 import type { TransactionReceipt } from 'viem';
 import type { WithdrawRouteStrategy, TransactionReceiptZKsyncOS, ViemPlanWriteRequest } 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: ViemClient): WithdrawalsResource;
+export declare function createWithdrawalsResource(client: ViemClient, tokens?: TokensResource, contracts?: ContractsResource): WithdrawalsResource;
 export { createFinalizationServices };
 export type { FinalizationServices };

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

@@ -3,9 +3,18 @@ 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 ViemPlanWriteRequest = Parameters<WalletClient<Transport, Chain, Account>['writeContract']>[0];
+import type { WithdrawalFeeBreakdown } from '../../../../../core/types/fees';
+type ViemWriteParams = Parameters<WalletClient<Transport, Chain, Account>['writeContract']>[0];
+/**
+ * viem specific
+ * Plan-time write request: relax 'value' so a single type can hold both
+ * non-payable (no value) and payable (value: bigint) requests.
+ */
+export type ViemPlanWriteRequest = Omit<ViemWriteParams, 'value'> & {
+    value?: bigint;
+};
 export type WithdrawQuoteExtras = Record<string, never>;
-export type WithdrawRouteStrategy = RouteStrategy<WithdrawParams, ViemPlanWriteRequest, WithdrawQuoteExtras, WithdrawBuildCtx>;
+export type WithdrawRouteStrategy = RouteStrategy<WithdrawParams, ViemPlanWriteRequest, WithdrawalFeeBreakdown, WithdrawBuildCtx>;
 export interface L2ToL1Log {
     l2ShardId?: number;
     isService?: boolean;
@@ -17,3 +26,4 @@ export interface L2ToL1Log {
 export type TransactionReceiptZKsyncOS = TransactionReceipt & {
     l2ToL1Logs?: L2ToL1Log[];
 };
+export {};

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

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

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

@@ -0,0 +1,12 @@
+import type { TransactionRequest } from 'viem';
+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>;