UNPKG

viem

Version:

TypeScript Interface for Ethereum

50 lines 3.13 kB
import type { Address } from 'abitype'; import { type EstimateContractGasErrorType } from '../../actions/public/estimateContractGas.js'; import type { Client } from '../../clients/createClient.js'; import type { Transport } from '../../clients/transports/createTransport.js'; import type { ErrorType } from '../../errors/utils.js'; import type { Account, GetAccountParameter } from '../../types/account.js'; import type { Chain, DeriveChain, GetChainParameter } from '../../types/chain.js'; import type { UnionEvaluate, UnionOmit } from '../../types/utils.js'; import type { FormattedTransactionRequest } from '../../utils/formatters/transactionRequest.js'; import type { GetContractAddressParameter } from '../types/contract.js'; import type { DepositRequest } from '../types/deposit.js'; export type EstimateDepositTransactionGasParameters<chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined, chainOverride extends Chain | undefined = Chain | undefined, derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>> = UnionEvaluate<UnionOmit<FormattedTransactionRequest<derivedChain>, 'accessList' | 'data' | 'from' | 'gas' | 'gasPrice' | 'to' | 'type' | 'value'>> & GetAccountParameter<account, Account | Address> & GetChainParameter<chain, chainOverride> & GetContractAddressParameter<derivedChain, 'portal'> & { /** L2 transaction request. */ request: DepositRequest; /** Gas limit for transaction execution on the L1. */ gas?: bigint | undefined; }; export type EstimateDepositTransactionGasReturnType = bigint; export type EstimateDepositTransactionGasErrorType = EstimateContractGasErrorType | ErrorType; /** * Estimates gas required to initiate a [deposit transaction](https://github.com/ethereum-optimism/optimism/blob/develop/specs/deposits.md) on an L1, which executes a transaction on L2. * * - Docs: https://viem.sh/op-stack/actions/estimateDepositTransactionGas * * @param client - Client to use * @param parameters - {@link EstimateDepositTransactionGasParameters} * @returns The L1 transaction hash. {@link EstimateDepositTransactionGasReturnType} * * @example * import { createPublicClient, custom, parseEther } from 'viem' * import { base, mainnet } from 'viem/chains' * import { estimateDepositTransactionGas } from 'viem/op-stack' * * const client = createPublicClient({ * chain: mainnet, * transport: custom(window.ethereum), * }) * * const gas = await estimateDepositTransactionGas(client, { * account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', * args: { * gas: 21_000n, * to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', * value: parseEther('1'), * }, * targetChain: base, * }) */ export declare function estimateDepositTransactionGas<chain extends Chain | undefined, account extends Account | undefined, chainOverride extends Chain | undefined = undefined>(client: Client<Transport, chain, account>, parameters: EstimateDepositTransactionGasParameters<chain, account, chainOverride>): Promise<bigint>; //# sourceMappingURL=estimateDepositTransactionGas.d.ts.map