viem
Version:
49 lines • 3.01 kB
TypeScript
import type { Address } from 'abitype';
import { type WriteContractErrorType } from '../../../actions/wallet/writeContract.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 { Hash } from '../../../types/misc.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 { Withdrawal } from '../types/withdrawal.js';
import { type EstimateFinalizeWithdrawalGasErrorType } from './estimateFinalizeWithdrawalGas.js';
export type FinalizeWithdrawalParameters<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'> & {
/**
* Gas limit for transaction execution on the L1.
* `null` to skip gas estimation & defer calculation to signer.
*/
gas?: bigint | null;
withdrawal: Withdrawal;
};
export type FinalizeWithdrawalReturnType = Hash;
export type FinalizeWithdrawalErrorType = EstimateFinalizeWithdrawalGasErrorType | WriteContractErrorType | ErrorType;
/**
* Finalizes a withdrawal that occurred on an L2. Used in the Withdrawal flow.
*
* - Docs: https://viem.sh/op-stack/actions/finalizeWithdrawal.html
*
* @param client - Client to use
* @param parameters - {@link FinalizeWithdrawalParameters}
* @returns The finalize transaction hash. {@link FinalizeWithdrawalReturnType}
*
* @example
* import { createWalletClient, http } from 'viem'
* import { mainnet, optimism } from 'viem/chains'
* import { finalizeWithdrawal } from 'viem/op-stack'
*
* const walletClientL1 = createWalletClient({
* chain: mainnet,
* transport: http(),
* })
*
* const request = await finalizeWithdrawal(walletClientL1, {
* targetChain: optimism,
* withdrawal: { ... },
* })
*/
export declare function finalizeWithdrawal<chain extends Chain | undefined, account extends Account | undefined, chainOverride extends Chain | undefined = undefined>(client: Client<Transport, chain, account>, parameters: FinalizeWithdrawalParameters<chain, account, chainOverride>): Promise<FinalizeWithdrawalReturnType>;
//# sourceMappingURL=finalizeWithdrawal.d.ts.map