UNPKG

viem

Version:

TypeScript Interface for Ethereum

34 lines 1.37 kB
import type { Address } from '../../accounts/index.js'; import type { Client } from '../../clients/createClient.js'; import type { Transport } from '../../clients/transports/createTransport.js'; import type { Account } from '../../types/account.js'; import type { Chain } from '../../types/chain.js'; export type GetL1TokenAddressParameters = { /** The address of the token on L2. */ token: Address; }; export type GetL1TokenAddressReturnType = Address; /** * Returns the L1 token address equivalent for a L2 token address as they are not equal. * ETH address is set to zero address. * * @remarks Only works for tokens bridged on default ZKsync Era bridges. * * @param client - Client to use * @param parameters - {@link GetL1TokenAddressParameters} * @returns The L1 token address equivalent for a L2 token address. * * * @example * import { createPublicClient, http } from 'viem' * import { zksync } from 'viem/chains' * * const client = createPublicClient({ * chain: zksync, * transport: http(), * }) * * const address = await getL1TokenAddress(client, {token: '0x...'}); */ export declare function getL1TokenAddress<chain extends Chain | undefined, account extends Account | undefined>(client: Client<Transport, chain, account>, parameters: GetL1TokenAddressParameters): Promise<Address>; //# sourceMappingURL=getL1TokenAddress.d.ts.map