Skip to content

Overview

The Tokenbound SDK currently supports projects using Ethers or Viem to interact with Ethereum. The SDK makes it easy to query ERC-6551 account addresses for any NFT and execute transactions against accounts.

Installation

npm install @tokenbound/sdk

The Tokenbound SDK is compatible with both viem and Ethers. viem is a core SDK dependency, so we recommend using viem except for legacy Ethers projects.

Note: If making use of one of the many Web3 starter kits, please make sure that you're using a recent release of viem (>1.0), Ethers 5.7+, or 6 to avoid issues.

Example apps

To help you get started more quickly, we've assembled bare-bones example apps using the Tokenbound SDK using viem, Ethers 5.7, and Ethers 6 respectively. These examples are using Goerli testnet (chainId: 5).