useConfirmTransaction
Confirms a pending multi-signature transaction shared via the Safe Transaction Service.
Usage
- If the number of signatures collected in the Safe Transaction Service for a given Safe transaction hash hasn't met the
threshold, it adds the signature from the connected signer. - If the number of collected signatures reaches the
threshold, it executes the Safe transaction.
This function is only relevant for Safes with their threshold greater than 1.
_24import { useConfirmTransaction, ConfirmTransactionVariables } from '@safe-global/safe-react-hooks'_24_24function App() {_24 const {_24 confirmTransaction,_24 data,_24 // ..._24 } = useConfirmTransaction()_24_24 const confirmTransactionParams: ConfirmTransactionVariables = {_24 safeTxHash: '0x...'_24 }_24_24 return (_24 <>_24 <button onClick={() => confirmTransaction(confirmTransactionParams)}>_24 Confirm Transaction_24 </button>_24 {data && JSON.stringify(data)}_24 </>_24 )_24}_24_24export default App
Parameters
UseConfirmTransactionParams
Parameters to customize the hook behavior.
_10import { UseConfirmTransactionParams } from '@safe-global/safe-react-hooks'
config (Optional)
- Type:
SafeConfigWithSigner
The configuration used instead of the one from the nearest SafeProvider.
_10import { config } from './config.ts'_10_10const result = useConfirmTransaction({_10 config_10})
Returns
UseConfirmTransactionReturnType
_10import { UseConfirmTransactionReturnType } from '@safe-global/safe-react-hooks'
TanStack Query mutation documentation (opens in a new tab).
confirmTransaction
- Type:
UseMutateFunction<SafeClientResult, Error, ConfirmTransactionVariables, unknown>
Function to confirm a Safe transaction from the connected Safe.
Parameters
ConfirmTransactionVariables
_10import { ConfirmTransactionVariables } from '@safe-global/safe-react-hooks'
Variables to update the threshold.
Returns
SafeClientResult (opens in a new tab)
The result of the transaction in the data property.
confirmTransactionAsync
- Type:
UseMutateAsyncFunction<SafeClientResult, Error, ConfirmTransactionVariables, unknown>
Asynchronous function to confirm a Safe transaction from the connected Safe.
Parameters
ConfirmTransactionVariables
_10import { ConfirmTransactionVariables } from '@safe-global/safe-react-hooks'
Variables to update the threshold.
Returns
SafeClientResult (opens in a new tab)
The result of the transaction in the data property.
data
- Type:
SafeClientResult(opens in a new tab) - Default:
undefined
The last successfully resolved data for the mutation.
error
- Type:
null | TError - Default:
null
The error object for the mutation, if an error was encountered.
failureCount
- Type:
number
The failure count for the mutation.
Incremented every time the mutation fails.
Reset to 0 when the mutation succeeds.
failureReason
- Type:
null | TError
The failure reason for the mutation retry.
Reset to null when the mutation succeeds.
isError / isIdle / isPending / isSuccess
- Type:
boolean
The boolean variables derived from status.
isPaused
- Type:
boolean
Will be true if the mutation has been paused.
See Network Mode (opens in a new tab) for more information.
reset
- Type:
() => void
A function to clean the mutation internal state (for example, it resets the mutation to its initial state).
status
- Type:
'idle' | 'pending' | 'error' | 'success'
'idle' initial status prior to the mutation function executing.
'pending' if the mutation is currently executing.
'error' if the last mutation attempt resulted in an error.
'success' if the last mutation attempt was successful.
submittedAt
- Type:
number - Default:
0
The timestamp for when the mutation was submitted.
variables
- Type:
ConfirmTransactionVariables - Default:
undefined
The variables object passed to the mutation function.