API Reference
Standard configuration
TokenboundClient
TokenboundClient
The TokenboundClient class provides an interface for interacting with tokenbound accounts, enabling operations like account creation, transaction execution, token transfers (including ERC-721, ERC-1155, and ERC-20 tokens), and message signing.
Deploy Tokenbound Account
Get Tokenbound Account
Now you can use the TokenboundClient to interact with the Tokenbound contracts:
TokenboundClient SDK Methods
The TokenboundClient enables the creation of and interaction with Tokenbound accounts:
createAccount
createAccount
Creates a tokenbound account for an NFT. The deterministic address is calculated using the deploy_syscall
with listed parameters alongside the implementation address. createAccount
adds the account to the registry and initializes it for use.
tokenContract
The address of the token contract.
string
tokenId
The token ID.
string
salt
The salt used to create a unique account address (optional)
number
getAccount
getAccount
Gets the tokenbound account address for an NFT.
Returns the tokenbound account address for a given token contract and token ID.
tokenContract
The address of the token contract.
string
tokenId
The token ID.
string
salt
The salt used when the account was created (optional)
string
checkAccountDeployment
checkAccountDeployment
Check if the tokenbound account address has been activated using createAccount.
Returns a boolean
indicating if a tokenbound account has been deployed (created) at the accountAddress and classHash
of the contract.
tokenContract
The address of the token contract.
string
tokenId
The token ID
string
salt
The salt used when the account was created (optional)
number
getOwner
getOwner
Returns the address of the tokenbound owner.
tbaAddress
The tokenbound address
string
getOwnerNFT
getOwnerNFT
Extracts information about the original NFT that is paired with the tokenbound account.
Returns a Promise that resolves to a TokenboundAccountNFT object. The TokenboundAccountNFT object contains the following properties:
tokenContract: The token contract address
tokenId: The token ID
tbaAddress
The Tokenbound account address
string
transferNFT
transferNFT
Transfer an NFT to a recipient from a Tokenbound account.
Returns a Promise that resolves to the transaction hash of the transfer
tbaAddress
The Tokenbound account
string
tokenID
The tokenId fo the NFT
string
contractAddress
The address of the token contract.
string
sender
The TBA sending the NFT
string
recipient
The recipient address
string
transferERC20
transferERC20
Transfer ERC-20 tokens to a recipient from a Tokenbound account.
Returns a Promise that resolves to the transaction hash of the transfer
tbaAddress
The Tokenbound account address.
string
amount
Amount (eg. 0.1 USDC).
string
recipient
The recipient address
string
contractAddress
The ERC-20 token address.
string
execute
execute
Execute a contract call on any arbitrary contract and engage in multi-contract interaction within a single transaction (multicall).
account
The Tokenbound account address.
string
[call]
array of payload
Call
lock
lock
Locks a tokenbound account.
tbaAddress
The Tokenbound account address
string
lockUntill
amount of time to lock tokenbound account
number
isLocked
isLocked
Returns an array of bool and uint256 which references the lock status of the tokenbound and time left until unlock.
tbaAddress
The Tokenbound account address
string
upgrade
upgrade
This is used to upgrade a Tokenbound account by updating the class hash of the contract.
newClassHash
The class hash to be upgraded to.
string
tbaAddress
The Tokenbound account address
string
setPermission
setPermission
This allows you to assign or revoke specific permissions for different addresses on a Tokenbound account.
Last updated