Thirdweb SDK
Looking for version 1 (legacy)? Click here.
Installation
Install the latest version of the SDK with npm
:
npm install @thirdweb-dev/sdk ethers
or with yarn
:
yarn add @thirdweb-dev/sdk ethers
Quick start
1. Deploy & customize your contracts
- Using your thirdweb dashboard (recommended)
- Using the SDK directly (for advanced use cases)
2. Reading data from your contracts
Quickest way to get started is to use the SDK as read only (no transactions).
This will allow you to query data from any contract with no additional setup.
import { ThirdwebSDK } from "@thirdweb-dev/sdk";
const rpcUrl = "https://polygon-rpc.com/";
const sdk = new ThirdwebSDK(rpcUrl);
const nftDrop = sdk.getNFTDrop("0x...");
const marketplace = sdk.getMarketplace("0x...");
const claimedNFTs = await nftDrop.getAllClaimed();
const listings = await marketplace.getActiveListings();
You can execute this code as a node script by executing:
npx ts-node my_script.ts
3. Executing transactions on your contracts
In order to execute transactions on your contract, the SDK needs to know which wallet is executing those transactions.
This can be done two ways:
- Using your own private key (typically used in the backend or scripts)
- By connecting to a user wallet (typically used in the frontend)
Backend / Scripting usage
Here's how to provide your own private key to the SDK to perform transactions with your account from scripts or from a node.js backend:
import "dotenv/config";
import { ThirdwebSDK } from "@thirdweb-dev/sdk";
const rpcUrl = "https://polygon-rpc.com/";
const privateKey = process.env.PRIVATE_KEY as string;
const sdk = new ThirdwebSDK(
new Wallet(
privateKey,
ethers.getDefaultProvider(rpcUrl)
)
);
const nftCollection = sdk.getNFTCollection("0x...");
await nftCollection.mint({
name: "Cool NFT",
description: "Minted NFT from code!",
image: fs.readFileSync("path/to/image.png"),
});
In this example we use dotenv to store the PRIVATE_KEY in an .env
file, like the following:
PRIVATE_KEY=your-private-key-here
You could also store your private key in a shell environment variable, or load it from a secure service.
⚠️ Never commit private keys to file tracking history, or share it publicly. If you're using an env file, make sure to add .env
to your .gitignore
file.
Frontend usage
For frontend applications, head over to our React Github repo which shows you how to connect to a user's wallet like Metamask, and automatically instantiate the thirdweb SDK for you.
Easiest way to get started on the frontend is using one of our templates in the thirdweb examples repo.
API Reference & code examples
Get in touch