createChangeThresholdTx
Returns a Safe transaction to change the threshold of the connected Safe.
Usage
_15import { SafeTransactionOptionalProps } from '@safe-global/protocol-kit'_15import { protocolKit } from './setup.ts'_15_15const options: SafeTransactionOptionalProps = {_15 safeTxGas: '123', // Optional_15 baseGas: '123', // Optional_15 gasPrice: '123', // Optional_15 gasToken: '0x...', // Optional_15 refundReceiver: '0x...', // Optional_15 nonce: 123 // Optional_15}_15const safeTransaction = await protocolKit.createChangeThresholdTx(_15 threshold: 3,_15 options // Optional_15)
Parameters
threshold (Optional)
- Type:
number
The new threshold of the Safe.
_10const safeTransaction = await protocolKit.createChangeThresholdTx({_10 threshold: 3_10})
options.safeTxGas (Optional)
- Type:
string
The gas that should be used for the Safe transaction.
_10const safeTransaction = await protocolKit.createChangeThresholdTx(_10 threshold: 3,_10 {_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.createChangeThresholdTx(_10 threshold: 3,_10 {_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.createChangeThresholdTx(_10 threshold: 3,_10 {_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.createChangeThresholdTx(_10 threshold: 3,_10 {_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.createChangeThresholdTx(_10 threshold: 3,_10 {_10 refundReceiver: '0x...'_10 }_10)
options.nonce (Optional)
- Type:
number
The transaction nonce.
_10const safeTransaction = await protocolKit.createChangeThresholdTx(_10 threshold: 3,_10 {_10 nonce: 123_10 }_10)
Returns
Promise<SafeTransaction>
The Safe transaction to update the threshold.