Allowance Module SDK Reference

This page documents all methods available on the AllowanceModule class in AbstractionKit. For a step-by-step implementation guide, see How to Enable Spend Permissions.

AbstractionKit provides two types of methods:

1. Recommended methods: Simplified interfaces with clear naming, documented under Methods below.
2. Advanced methods: Prefixed with createBase, these match exact contract method names and parameters. Documented under Advanced Methods.

The recommended methods cover most use cases. Use the advanced methods only when you need direct contract-level control.

Methods

createEnableModuleMetaTransaction

Creates a MetaTransaction to enable the Allowance Module for a Safe account. This only needs to be called once per Safe.

Param Types

key	type	description
accountAddress	string	The target Safe Account address to enable the module for.

Return Types

key	type	description
MetaTransaction	object	MetaTransaction is the type of transaction to construct a Safe operation.
MetaTransaction.to	string	To address, or the the target contract address for the transaction
MetaTransaction.value	BigNumberish	Value transfered if making a native token transfer. (usually 0n for contract interaction with non-native tokens like erc-20 tokens)
MetaTransaction.data	BytesLike	The call data for the transaction
MetaTransaction.operation	Operation: enum	Default to 0 for a Call. 1 for a Delegate Call. (Optional)

createAddDelegateMetaTransaction

Creates a MetaTransaction that adds a delegate to the account. The delegate can then be granted allowances to spend tokens.

Param Types

key	type	description
delegate	string	The delegate address that should be added.

Return Types

key	type	description
MetaTransaction	object	MetaTransaction is the type of transaction to construct a Safe operation.
MetaTransaction.to	string	To address, or the the target contract address for the transaction
MetaTransaction.value	BigNumberish	Value transfered if making a native token transfer. (usually 0n for contract interaction with non-native tokens like erc-20 tokens)
MetaTransaction.data	BytesLike	The call data for the transaction
MetaTransaction.operation	Operation: enum	Default to 0 for a Call. 1 for a Delegate Call. (Optional)

createOneTimeAllowanceMetaTransaction

Creates a MetaTransaction that sets a one-time allowance for a delegate. The allowance does not reset after use and is active as soon as the Safe executes the transaction. The module cannot delay activation of a one-time allowance.

Param Types

key	type	description
delegate	string	The address of the delegate to whom the allowance is given.
token	string	The address of the token for which the allowance is set.
allowanceAmount	bigint	The amount of the token allowed for the delegate.

Return Types

key	type	description
MetaTransaction	object	MetaTransaction is the type of transaction to construct a Safe operation.
MetaTransaction.to	string	To address, or the the target contract address for the transaction
MetaTransaction.value	BigNumberish	Value transfered if making a native token transfer. (usually 0n for contract interaction with non-native tokens like erc-20 tokens)
MetaTransaction.data	BytesLike	The call data for the transaction
MetaTransaction.operation	Operation: enum	Default to 0 for a Call. 1 for a Delegate Call. (Optional)

createRecurringAllowanceMetaTransaction

Creates a MetaTransaction that sets a recurring allowance for a delegate. The allowance automatically resets after the specified validity period and is spendable as soon as the Safe executes the transaction. The optional inThePastPeriodStartBaseTimeStamp (unix seconds, in the past) only aligns when each period resets. It does not delay activation.

Param Types

key	type	description
delegate	string	The address of the delegate to whom the recurring allowance is given.
token	string	The address of the token for which the allowance is set.
allowanceAmount	bigint	The amount of the token allowed for the delegate.
recurringAllowanceValidityPeriodInMinutes	bigint	The time period (in minutes) after which the allowance resets. Must be between 0 and 65535 (the contract's uint16), otherwise a RangeError is thrown.
inThePastPeriodStartBaseTimeStamp	bigint?	Optional unix timestamp in seconds that must be in the past. It only aligns the period boundaries (for example, any previous Saturday 10am to reset every Saturday 10am) and does not delay activation: the allowance is spendable as soon as the Safe executes the transaction. Converted to minutes internally. A millisecond timestamp throws a RangeError. Defaults to 0n, which starts the period accounting when the transaction executes for a new allowance, and keeps the current anchor when updating an existing one.

Return Types

key	type	description
MetaTransaction	object	MetaTransaction is the type of transaction to construct a Safe operation.
MetaTransaction.to	string	To address, or the the target contract address for the transaction
MetaTransaction.value	BigNumberish	Value transfered if making a native token transfer. (usually 0n for contract interaction with non-native tokens like erc-20 tokens)
MetaTransaction.data	BytesLike	The call data for the transaction
MetaTransaction.operation	Operation: enum	Default to 0 for a Call. 1 for a Delegate Call. (Optional)

createAllowanceTransferMetaTransaction

Creates a MetaTransaction that executes a token transfer using the delegate's allowance. The delegate calls this to move tokens from the source Safe to a recipient.

Param Types

key	type	description
allowanceSourceSafeAddress	string	The safe address from which the allowance is being transferred.
token	string	The token address being transferred.
to	string	The recipient address of the allowance transfer.
amount	bigint	The amount of tokens to be transferred.
delegate	string	The delegate address managing the transfer.
overrides	object	Optional overrides including delegate signature, payment token, and payment amount.
overrides.delegateSignature	string	The signature of the delegate. Optional.
overrides.paymentToken	string	An optional payment token address. Defaults to the zero address.
overrides.paymentAmount	bigint	The amount of the payment token to be transferred. Required if paymentToken is specified.

Return Types

key	type	description
MetaTransaction	object	MetaTransaction is the type of transaction to construct a Safe operation.
MetaTransaction.to	string	To address, or the the target contract address for the transaction
MetaTransaction.value	BigNumberish	Value transfered if making a native token transfer. (usually 0n for contract interaction with non-native tokens like erc-20 tokens)
MetaTransaction.data	BytesLike	The call data for the transaction
MetaTransaction.operation	Operation: enum	Default to 0 for a Call. 1 for a Delegate Call. (Optional)

createRenewAllowanceMetaTransaction

Creates a MetaTransaction that resets (renews) the allowance for a specific delegate and token. This lets the account owner extend the delegate's allowance without deleting and recreating it.

Param Types

key	type	description
delegate	string	The address of the delegate whose allowance should be reset.
token	string	The address of the token for which the allowance is set.

Return Types

key	type	description
MetaTransaction	object	MetaTransaction is the type of transaction to construct a Safe operation.
MetaTransaction.to	string	To address, or the the target contract address for the transaction
MetaTransaction.value	BigNumberish	Value transfered if making a native token transfer. (usually 0n for contract interaction with non-native tokens like erc-20 tokens)
MetaTransaction.data	BytesLike	The call data for the transaction
MetaTransaction.operation	Operation: enum	Default to 0 for a Call. 1 for a Delegate Call. (Optional)

createDeleteAllowanceMetaTransaction

Creates a MetaTransaction that removes the allowance for a specific delegate and token. This sets all values except the nonce to 0, revoking the delegate's permission.

Param Types

key	type	description
delegate	string	The address of the delegate whose allowance should be removed.
token	string	The address of the token for which the allowance is set.

Return Types

key	type	description
MetaTransaction	object	MetaTransaction is the type of transaction to construct a Safe operation.
MetaTransaction.to	string	To address, or the the target contract address for the transaction
MetaTransaction.value	BigNumberish	Value transfered if making a native token transfer. (usually 0n for contract interaction with non-native tokens like erc-20 tokens)
MetaTransaction.data	BytesLike	The call data for the transaction
MetaTransaction.operation	Operation: enum	Default to 0 for a Call. 1 for a Delegate Call. (Optional)

Helpers

getDelegates

Retrieves a list of delegates associated with a Safe account. Supports pagination for large sets of delegates.

Param Types

key	type	description
nodeRpcUrl	string	The JSON-RPC API URL for the target chain.
safeAddress	string	The target account address.
overrides	object	Optional parameters for pagination.
overrides.start	bigint	The starting point for fetching delegates. Defaults to 0.
overrides.maxNumberOfResults	bigint	The maximum number of results to return, between 0 and 255 (the module's page size is a uint8). If specified, disables automatic pagination. Omit it to fetch all delegates.

Return Types

key	type	description
Delegate Addresses	string[]	A promise that resolves to a list of delegate addresses.

getTokensAllowance

Retrieves the allowance details for a specific delegate and token. Returns the amount, spent, reset time, last reset time, and nonce.

Param Types

key	type	description
nodeRpcUrl	string	The JSON-RPC API URL for the target chain.
safeAddress	string	The target account address.
delegate	string	The address of the target delegate.
token	string	The address of the token for which the allowance is being queried.

Return Types

key	type	description
Allowance	object	A promise that resolves to the allowance details for the specified token.
Allowance.amount	bigint	The total allowance amount.
Allowance.spent	bigint	The amount spent from the allowance.
Allowance.resetTimeMin	bigint	The time in minutes after which the allowance resets.
Allowance.lastResetMin	bigint	The time in minutes when the allowance was last reset.
Allowance.nonce	bigint	The nonce for the allowance.

getTokens

Retrieves the list of delegated token addresses for a specific delegate on a Safe account.

Param Types

key	type	description
nodeRpcUrl	string	The JSON-RPC API URL for the target chain.
safeAddress	string	The target account address.
delegate	string	The address of the target delegate.

Return Types

type	description	key
string[]	A promise that resolves to a list of delegated token addresses.

IsModuleEnabled

Checks if a specified module is enabled for a given Safe account. Returns a boolean.

See the method IsModuleEnabled in the Safe Account reference.

createRemoveDelegateMetaTransaction

Creates a MetaTransaction that removes a delegate from the Safe account. Can also remove all associated allowances if specified.

Param Types

key	type	description
delegate	string	The delegate address that should be removed.
removeAllowances	boolean	Indicator if allowances should also be removed. Set to true unless this causes an out of gas.

Return Types

key	type	description
MetaTransaction	object	MetaTransaction is the type of transaction to construct a Safe operation.
MetaTransaction.to	string	To address, or the the target contract address for the transaction
MetaTransaction.value	BigNumberish	Value transfered if making a native token transfer. (usually 0n for contract interaction with non-native tokens like erc-20 tokens)
MetaTransaction.data	BytesLike	The call data for the transaction
MetaTransaction.operation	Operation: enum	Default to 0 for a Call. 1 for a Delegate Call. (Optional)

Advanced Methods

createBaseSetAllowanceMetaTransaction

Creates a MetaTransaction to update the allowance for a specified token. This can only be executed via a Safe transaction. Use this when you need direct control over the resetTimeMin and resetBaseMin parameters.

Param Types

key	type	description
delegate	string	The address of the delegate whose allowance should be updated.
token	string	The address of the token for which the allowance is set.
allowanceAmount	bigint	The amount of the token allowed for the delegate.
resetTimeMin	bigint	Time in minutes after which the allowance resets.
resetBaseMin	bigint	Time interval to increase the reset time.

Return Types

key	type	description
MetaTransaction	object	MetaTransaction is the type of transaction to construct a Safe operation.
MetaTransaction.to	string	To address, or the the target contract address for the transaction
MetaTransaction.value	BigNumberish	Value transfered if making a native token transfer. (usually 0n for contract interaction with non-native tokens like erc-20 tokens)
MetaTransaction.data	BytesLike	The call data for the transaction
MetaTransaction.operation	Operation: enum	Default to 0 for a Call. 1 for a Delegate Call. (Optional)

createBaseExecuteAllowanceTransferMetaTransaction

Creates a MetaTransaction that executes a transfer using the allowance. This is the low-level version of createAllowanceTransferMetaTransaction with explicit payment token and delegate signature parameters.

Param Types

key	type	description
safeAddress	string	The Safe address whose funds should be used.
token	string	The token contract address being transferred.
to	string	The recipient address of the token transfer.
amount	bigint	The amount of tokens to be transferred.
paymentToken	string	The token that should be used to pay for the execution of the transfer.
payment	bigint	The amount to be paid for executing the transfer.
delegate	string	The delegate whose allowance should be updated.
delegateSignature	string	Signature generated by the delegate to authorize the transfer.

Return Types

key	type	description
MetaTransaction	object	MetaTransaction is the type of transaction to construct a Safe operation.
MetaTransaction.to	string	To address, or the the target contract address for the transaction
MetaTransaction.value	BigNumberish	Value transfered if making a native token transfer. (usually 0n for contract interaction with non-native tokens like erc-20 tokens)
MetaTransaction.data	BytesLike	The call data for the transaction
MetaTransaction.operation	Operation: enum	Default to 0 for a Call. 1 for a Delegate Call. (Optional)

Advanced Helpers

baseGetDelegates

Retrieves a list of delegates associated with a Safe account. This is the low-level version with explicit pagination parameters (start and pageSize).

Param Types

key	type	description
nodeRpcUrl	string	The JSON-RPC API URL for the target chain.
safeAddress	string	The target account address.
start	bigint	The starting point for fetching delegates.
pageSize	bigint	The number of delegates to return in one call.

Return Types

key	description	type
{ results: string[], next: bigint }	A promise that resolves to an object containing the list of delegate addresses and the next starting point for pagination.	object
{ results: string[], next: bigint }.results	A list of delegate addresses.	string[]
{ results: string[], next: bigint }.next	The next starting point for pagination. Returns 0 if there are no more delegates.	bigint