\n\n# Tokenbound SDK\n\nThis repo houses the Tokenbound SDK, a front-end library for interacting with ERC-6551 accounts on Starknet. The SDK 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. Any onchain action you can perform with your EOA wallet can be done with your NFT's Tokenbound account.\n\nPackages\n`src` - SDK client for all projects, signing enabled via Starknet.js.\n\n## Examples\n\n- `examples/sdk-starknetjs` - An example app using the tokenbound SDK in a react project with starknetjs\n- `examples/sdk-starknetjs-starknetkit-starknet-react` - An example app using the tokenbound SDK in a react project with starknetjs, starknetkit and starknet-react\n\nDevelopment\nClone repository and install dependencies:\n\n# clone the repo\n\n```\ngit clone \n```\n\n# install dependencies\n\n```\nnpm install\n```\n\n# build packages\n\n```\nnpm run build\n```\n\nNOTE: Any local changes to SDK methods in `TokenboundClient.ts` require a rebuild to be useable in the example apps in /example\n\n## API Reference\n\n### TokenboundClient\n\nThe 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.\n\nThe client is instantiated with an object containing two parameters:\n\n#### Parameter\n\nOne of `account ` or `walletClient ` is mandatory.\n\n### Standard configuration with WalletClient\n\nTo configure tokenbound using walletClient:\n\n```js\nimport { TokenboundClient, WalletClient } from 'starknet-tokenbound-sdk';\n\nconst walletClient: WalletClient = {\n address: \"0x0617D13Db952a2965580ebAc9DF602debFa12d0eAFB7c1a79D9dA03321169286\",\n privateKey: process.env.REACT_APP_PRIVATE_KEY!,\n}\n\nconst options = {\n walletClient: walletClient,\n registryAddress: registryAddress,\n implementationAddress: implementationAddress,\n jsonRPC: `https://starknet-mainnet.g.alchemy.com/v2/${process.env.REACT_APP_ALCHEMY_API_KEY}`\n\n}\n\nconst tokenbound = new TokenboundClient(options)\n```\n\n### Standard configuration with Account signer\n\nRefer to the starknet-react documentation, for notes on configuring your StarknetProvider.\n\n```js\nimport { useAccount, useConnect } from \"@starknet-react/core\";\n\nconst options = {\n account: account,\n registryAddress: registryAddress,\n implementationAddress: implementationAddress,\n jsonRPC: `https://starknet-mainnet.g.alchemy.com/v2/${process.env.REACT_APP_ALCHEMY_API_KEY}`,\n};\n\nconst tokenbound = new TokenboundClient(options);\n```\n\nFor easy reference, we've prepared code examples for a few simple SDK interactions.\n\n## TokenboundClient SDK Methods\n\nThe `TokenboundClient` enables creation of and interaction with Tokenbound accounts:\n\n### createAccount\n\nCreates a tokenbound account for an NFT. createAccount adds the account to the registry and initializes it for use. Prior to account creation, the address can already receive assets. Deploying the account allows the NFT's owner to interact with the account.\n\n```js\nconst deployAccount = async () => {\n try {\n await tokenbound.createAccount({\n tokenContract: tokenContract,\n tokenId: tokenId,\n salt: \"3000000000\",\n });\n } catch (error) {\n console.log(error);\n }\n};\n```\n\nParameter Description Type\n\n- tokenContract: The address of the token contract. `string`\n- tokenId: The token ID. `string`\n- salt: The salt used to create a unique account address (optional) `number`\n\n### getAccount\n\nGets the tokenbound account address for an NFT.\n\nReturns the tokenbound account address for a given token contract and token ID.\n\n```js\nconst getAccount = async () => {\n const account = await tokenbound.getAccount({\n tokenContract: tokenContract,\n tokenId: tokenId,\n salt: \"3000000000\",\n });\n};\n```\n\nParameter Description Type\n\n- tokenContract: The address of the token contract. string\n- tokenId: The token ID. string\n- salt: The salt used when the account was created (optional) number\n\n### checkAccountDeployment\n\nCheck if the tokenbound account address has been activated using createAccount.\n\nReturns a boolean and classHash indicating if a tokenbound account has been deployed (created) at the accountAddress\n\n```js\nconst getDeploymentStatus = async () => {\n const status = await tokenbound.checkAccountDeployment({\n tokenContract,\n tokenId,\n salt: \"3000000000\",\n });\n setDeployStatus(status?.deployed);\n setAccountClassHash(status?.classHash);\n};\n```\n\nParameter Description Type\n\n- tokenContract: The token contract address\n- tokenId: The token ID\n- salt\n","readmeFilename":"README.md"}
![](\"./assets/tokenbound.png\")
\n![](\"https://img.shields.io/badge/license-MIT-black\"){kind=icon}