# `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`.


<Tabs items={['App.tsx', 'main.tsx']}>
  <Tabs.Tab>
    ```typescript
    import { useConfirmTransaction, ConfirmTransactionVariables } from '@safe-global/safe-react-hooks'
    
    function App() {
      const {
        confirmTransaction,
        data,
        // ...
      } = useConfirmTransaction()

      const confirmTransactionParams: ConfirmTransactionVariables = {
        safeTxHash: '0x...'
      }

      return (
        <>
          <button onClick={() => confirmTransaction(confirmTransactionParams)}>
            Confirm Transaction
          </button>
          {data && JSON.stringify(data)}
        </>
      )
    }

    export default App
    ```
  </Tabs.Tab>
  <Tabs.Tab>
    ```typescript
    import ReactDOM from 'react-dom/client'
    import { createConfig, SafeProvider } from '@safe-global/safe-react-hooks'
    import { sepolia } from 'viem/chains'
    import App from './App.tsx'

    const config = createConfig({
      chain: sepolia,
      provider,
      signer,
      safeAddress: '0x...'
    })

    const root = document.getElementById('root')
    
    ReactDOM.createRoot(root).render(
      <SafeProvider config={config}>
        <App />
      </SafeProvider>
    )
    ```
  </Tabs.Tab>
</Tabs>


## Parameters

`UseConfirmTransactionParams`

Parameters to customize the hook behavior.

```typescript
import { UseConfirmTransactionParams } from '@safe-global/safe-react-hooks'
```

### `config` (Optional)

- **Type**: `SafeConfigWithSigner`

The configuration used instead of the one from the nearest [`SafeProvider`](./safeprovider.mdx).


<Tabs items={['index.tsx', 'config.ts']}>
  <Tabs.Tab>
    ```typescript focus=4
    import { config } from './config.ts'

    const result = useConfirmTransaction({
      config
    })
    ```
  </Tabs.Tab>
  <Tabs.Tab>
    ```typescript
    import { createConfig } from '@safe-global/safe-react-hooks'
    import { sepolia } from 'viem/chains'

    export const config = createConfig({
      chain: sepolia,
      provider,
      signer,
      safeAddress: '0x...'
    })
    ```
  </Tabs.Tab>
</Tabs>


## Returns 

`UseConfirmTransactionReturnType`

```typescript
import { UseConfirmTransactionReturnType } from '@safe-global/safe-react-hooks'
```

[TanStack Query mutation documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation).
### `confirmTransaction`

- **Type**: `UseMutateFunction<SafeClientResult, Error, ConfirmTransactionVariables, unknown>`

Function to confirm a Safe transaction from the connected Safe.

#### Parameters

`ConfirmTransactionVariables`

```typescript
import { ConfirmTransactionVariables } from '@safe-global/safe-react-hooks'
```

Variables to update the threshold.

#### Returns

[`SafeClientResult`](https://github.com/safe-global/safe-core-sdk/blob/main/packages/sdk-starter-kit/src/types.ts#L67-L85)

The result of the transaction in the [`data`](#data) property.

### `confirmTransactionAsync`

- **Type**: `UseMutateAsyncFunction<SafeClientResult, Error, ConfirmTransactionVariables, unknown>`

Asynchronous function to confirm a Safe transaction from the connected Safe.

#### Parameters

`ConfirmTransactionVariables`

```typescript
import { ConfirmTransactionVariables } from '@safe-global/safe-react-hooks'
```

Variables to update the threshold.

#### Returns

[`SafeClientResult`](https://github.com/safe-global/safe-core-sdk/blob/main/packages/sdk-starter-kit/src/types.ts#L67-L85)

The result of the transaction in the [`data`](#data) property.

### `data`

- **Type**: [`SafeClientResult`](https://github.com/safe-global/safe-core-sdk/blob/main/packages/sdk-starter-kit/src/types.ts#L67-L85)
- **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](https://tanstack.com/query/v5/docs/framework/react/guides/network-mode) 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.
