Protocol Kit Reference
Safe Configuration
createRemoveOwnerTx

createRemoveOwnerTx

Returns a Safe transaction to remove an owner of the connected Safe and optionally change the threshold.

Usage


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

Parameters

params.ownerAddress

  • Type: string

The address of the owner to remove to the Safe.


_10
const safeTransaction = await protocolKit.createRemoveOwnerTx({
_10
ownerAddress: '0x...'
_10
})

params.passkey

  • Type: PasskeyArgType

The passkey associated with the owner to remove to the Safe.


_10
const safeTransaction = await protocolKit.createRemoveOwnerTx({
_10
passkey
_10
})

params.threshold (Optional)

  • Type: number

The new threshold of the Safe.


_10
const safeTransaction = await protocolKit.createRemoveOwnerTx({
_10
ownerAddress: '0x...',
_10
threshold: 1
_10
})

options.safeTxGas (Optional)

  • Type: string

The gas that should be used for the Safe transaction.


_10
const safeTransaction = await protocolKit.createRemoveOwnerTx(
_10
{
_10
ownerAddress: '0x...'
_10
},
_10
{
_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.createRemoveOwnerTx(
_10
{
_10
ownerAddress: '0x...'
_10
},
_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.


_10
const safeTransaction = await protocolKit.createRemoveOwnerTx(
_10
{
_10
ownerAddress: '0x...'
_10
},
_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.


_10
const safeTransaction = await protocolKit.createRemoveOwnerTx(
_10
{
_10
ownerAddress: '0x...'
_10
},
_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.


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

options.nonce (Optional)

  • Type: number

The transaction nonce.


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

Returns

Promise<SafeTransaction>

The Safe transaction to remove an owner.

createChangeThresholdTxcreateSwapOwnerTx

Was this page helpful?