createEnableModuleTx
Returns a Safe transaction to enable a Safe Module.
Usage
_18import { SafeTransactionOptionalProps } from '@safe-global/protocol-kit'_18import { protocolKit } from './setup.ts'_18_18const moduleAddress = '0x...'_18_18const 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_18const safeTransaction = await protocolKit.createEnableModuleTx(_18 moduleAddress,_18 options // Optional_18)
Parameters
moduleAddress
- Type:
string
The Safe Module address to enable.
_10const safeTransaction = await protocolKit.createEnableModuleTx(_10 '0x...'_10)
options.safeTxGas (Optional)
- Type:
string
The gas that should be used for the Safe transaction.
_10const safeTransaction = await protocolKit.createEnableModuleTx(_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.
_10const safeTransaction = await protocolKit.createEnableModuleTx(_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.
_10const safeTransaction = await protocolKit.createEnableModuleTx(_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.
_10const safeTransaction = await protocolKit.createEnableModuleTx(_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.
_10const safeTransaction = await protocolKit.createEnableModuleTx(_10 '0x...',_10 options: {_10 refundReceiver: '0x...'_10 }_10)
options.nonce (Optional)
- Type:
number
The transaction nonce.
_10const safeTransaction = await protocolKit.createEnableModuleTx(_10 '0x...',_10 options: {_10 nonce: 123_10 }_10)
Returns
Promise<SafeTransaction>
The Safe transaction to enable the Safe Module.