Protocol Kit Reference
Safe Modules
createDisableModuleTx

createDisableModuleTx

Returns a Safe transaction to disable a Safe Module.

Usage


_18
import { SafeTransactionOptionalProps } from '@safe-global/protocol-kit'
_18
import { protocolKit } from './setup.ts'
_18
_18
const moduleAddress = '0x...'
_18
_18
const options: SafeTransactionOptionalProps = {
_18
safeTxGas: '123', // Optional
_18
baseGas: '123', // Optional
_18
gasPrice: '123', // Optional
_18
gasToken: '0x...', // Optional
_18
refundReceiver: '0x...', // Optional
_18
nonce: 123 // Optional
_18
}
_18
_18
const safeTransaction = await protocolKit.createDisableModuleTx(
_18
moduleAddress,
_18
options // Optional
_18
)

Parameters

moduleAddress

  • Type: string

The Safe Module address to disable.


_10
const safeTransaction = await protocolKit.createDisableModuleTx(
_10
'0x...'
_10
)

options.safeTxGas (Optional)

  • Type: string

The gas that should be used for the Safe transaction.


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

options.baseGas (Optional)

  • Type: string

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


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

options.gasPrice (Optional)

  • Type: string

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


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

options.gasToken (Optional)

  • Type: string

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


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

options.refundReceiver (Optional)

  • Type: string

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


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

options.nonce (Optional)

  • Type: number

The transaction nonce.


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

Returns

Promise<SafeTransaction>

The Safe transaction to disable the Safe Module.

signMessagecreateEnableModuleTx

Was this page helpful?