`createDisableGuardTx`

Returns a Safe transaction to disable the Safe Guard.

Usage

import { SafeTransactionOptionalProps } from '@safe-global/protocol-kit'
import { protocolKit } from './setup.ts'

const guardAddress = '0x...'

const options: SafeTransactionOptionalProps = {
  safeTxGas: '123', // Optional
  baseGas: '123', // Optional
  gasPrice: '123', // Optional
  gasToken: '0x...', // Optional
  refundReceiver: '0x...', // Optional
  nonce: 123 // Optional
}

const safeTransaction = await protocolKit.createDisableGuardTx(
  guardAddress,
  options // Optional
)

Parameters

`guardAddress`

Type: string

The Safe Guard contract address to disable.

const safeTransaction = await protocolKit.createDisableGuardTx(
  '0x...'
)

`options.safeTxGas` (Optional)

Type: string

The gas that should be used for the Safe transaction.

const safeTransaction = await protocolKit.createDisableGuardTx(
  '0x...',
  options: {
    safeTxGas: '123'
  }
)

`options.baseGas` (Optional)

Type: string

The gas costs for the data used to trigger the Safe transaction.

const safeTransaction = await protocolKit.createDisableGuardTx(
  '0x...',
  options: {
    baseGas: '123'
  }
)

`options.gasPrice` (Optional)

Type: string

The price in wei that the sender is willing to pay for each unit of gas.

const safeTransaction = await protocolKit.createDisableGuardTx(
  '0x...',
  options: {
    gasPrice: '123'
  }
)

`options.gasToken` (Optional)

Type: string

The token address that is used for the gas payment, or 0x0000000000000000000000000000000000000000 if there is no payment.

const safeTransaction = await protocolKit.createDisableGuardTx(
  '0x...',
  options: {
    gasToken: '0x...'
  }
)

`options.refundReceiver` (Optional)

Type: string

The address of the gas payment receiver or 0x0000000000000000000000000000000000000000 if there is no payment.

const safeTransaction = await protocolKit.createDisableGuardTx(
  '0x...',
  options: {
    refundReceiver: '0x...'
  }
)

`options.nonce` (Optional)

Type: number

The transaction nonce.

const safeTransaction = await protocolKit.createDisableGuardTx(
  '0x...',
  options: {
    nonce: 123
  }
)

Returns

Promise<SafeTransaction>

The Safe transaction to disable the Safe Guard.

Last updated on February 28, 2025

isModuleEnabled createEnableGuardTx

Was this page helpful?

createDisableGuardTx

Usage

Parameters

guardAddress

options.safeTxGas (Optional)

options.baseGas (Optional)

options.gasPrice (Optional)

options.gasToken (Optional)

options.refundReceiver (Optional)

options.nonce (Optional)