OP Wagmi

Appearance

useWriteFinalizeWithdrawalTransaction ​

Action for finalizing a withdrawal transaction.

tsx
import { useWriteFinalizeWithdrawalTransaction } from 'op-wagmi'

const { writeFinalizeWithdrawalTransaction } =
  useWriteFinalizeWithdrawalTransaction()

return (
  <button
    onClick={() =>
      writeFinalizeWithdrawalTransaction({
        args: {
          withdrawalTxHash:
            '0x18e70002441d72a82eebcf02786da417074c18cf54ca0eba49886773448151e8',
        },
        l2ChainId: 8453,
      })}
  >
    Finalize Withdrawal
  </button>
)

Parameters ​

Config ​

Config | undefined

Config to use instead of retrieving from the from nearest WagmiProvider.

Return Value ​

writeFinalizeWithdrawalTransaction ​

(variables: WriteFinalizeWithdrawalTransactionParameters, { onSuccess, onSettled, onError }) => void

The mutation function you can call with variables to trigger finalizing the provided withdrawal.

  • variables ​

    • args ​
      • withdrawalTxHash ​

      Hash

      The L2 transaction hash of the withdrawal initiation.

    • l2ChainId ​

      number

      The chain ID of the chain you are withdrawing from.

  • options (optional) ​

    • onSuccess ​

      (data: WriteContractReturnType, variables: WriteFinalizeWithdrawalTransactionParameters, context: TContext) => void

      This function will fire when the mutation is successful and will be passed the mutation's result.

    • onError ​

      (error: WriteContractErrorType, variables: WriteFinalizeWithdrawalTransactionParameters, context: TContext | undefined) => void

      This function will fire if the mutation encounters an error and will be passed the error.

    • onSettled ​

      (data: WriteContractReturnType | undefined, error: WriteContractErrorType | null, variables: WriteFinalizeWithdrawalTransactionParameters, context: TContext | undefined) => void

      • This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
      • If you make multiple requests, onSuccess will fire only after the latest call you've made.

writeFinalizeWithdrawalTransactionAsync ​

(variables: WriteFinalizeWithdrawalTransactionParameters, { onSuccess, onSettled, onError }) => Promise<WriteContractReturnType>

Similar to writeFinalizeWithdrawalTransaction but returns a promise which can be awaited.

  • variables ​

    • args ​
      • withdrawalTxHash ​

      Hash

      The L2 transaction hash of the withdrawal initiation.

    • l2ChainId ​

      number

      The chain ID of the chain you are withdrawing from.

  • options (optional) ​

    • onSuccess ​

      (data: WriteContractReturnType, variables: WriteFinalizeWithdrawalTransactionParameters, context: TContext) => void

      This function will fire when the mutation is successful and will be passed the mutation's result.

    • onError ​

      (error: WriteContractErrorType, variables: WriteFinalizeWithdrawalTransactionParameters, context: TContext | undefined) => void

      This function will fire if the mutation encounters an error and will be passed the error.

    • onSettled ​

      (data: WriteContractReturnType | undefined, error: WriteContractErrorType | null, variables: WriteFinalizeWithdrawalTransactionParameters, context: TContext | undefined) => void

      • This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
      • If you make multiple requests, onSuccess will fire only after the latest call you've made.

The rest of wagmi's useWriteContract return type (except writeContract and writeContractAsync). ​