NFT Drop

Learn how to interact with your NFT Drop contract in the SDK.

Create an NFT Drop Contract

React

const sdk = useSDK();

const contractAddress = await sdk.deployer.deployNFTDrop({
  name: "My Drop",
  primary_sale_recipient: "your-address",
});

View in React SDK Documentation

Javascript

const contractAddress = await sdk.deployer.deployNFTDrop({
  name: "My Drop",
  primary_sale_recipient: "your-address",
});

View in Javascript SDK Documentation

Python

This feature is missing a code snippet or might not be supported yet.
Check the Python SDK Reference for more information.
Reach out on Discord for further assistance!

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

await sdk
    .deployer
    .DeployNFTDrop(new NFTContractDeployMetadata()
    { name = "My Collection", primary_sale_recipient = "0x..." });

---

Getting the contract in your application

To start using your NFT Drop contract inside your application, you need to use its contract address. You can get the contract address from the dashboard.

React

This feature is missing a code snippet or might not be supported yet.
Check the React SDK Reference for more information.
Reach out on Discord for further assistance!

Javascript

import { ThirdwebSDK } from "@thirdweb-dev/sdk";

const sdk = new ThirdwebSDK("{{chainName}}");
const contract = await sdk.getContract("{{contract_address}}", "nft-drop");

Python

from thirdweb import ThirdwebSDK

# You can customize this to a supported network or your own RPC URL
network = "mumbai"

# Now we can create a new instance of the SDK
sdk = ThirdwebSDK(network)

# If you want to send transactions, you can instantiate the SDK with a private key instead:
#   sdk = ThirdwebSDK.from_private_key(PRIVATE_KEY, network)

contract = sdk.get_nft_drop("{{contract_address}}")

View in Python SDK Documentation

Go

import (
	"github.com/thirdweb-dev/go-sdk/v2/thirdweb"
)

privateKey = "..."

sdk, err := thirdweb.NewThirdwebSDK("mumbai", &thirdweb.SDKOptions{
	PrivateKey: privateKey,
})

contract, err := sdk.GetNFTDrop("{{contract_address}}")

View in Go SDK Documentation

Unity

Contract contract = sdk.GetContract("{{contract_address}}");

---

Lazy Minting Your NFTs

Create a batch of unique NFTs to be claimed in the future

React

// Custom metadata of the NFTs to create
const metadatas = [{
  name: "Cool NFT",
  description: "This is a cool NFT",
  image: fs.readFileSync("path/to/image.png"), // This can be an image url or file
}, {
  name: "Cool NFT",
  description: "This is a cool NFT",
  image: fs.readFileSync("path/to/image.png"),
}];

const results = await contract.createBatch(metadatas); // uploads and creates the NFTs on chain
const firstTokenId = results[0].id; // token id of the first created NFT
const firstNFT = await results[0].data(); // (optional) fetch details of the first created NFT

View in React SDK Documentation

Javascript

// Custom metadata of the NFTs to create
const metadatas = [{
  name: "Cool NFT",
  description: "This is a cool NFT",
  image: fs.readFileSync("path/to/image.png"), // This can be an image url or file
}, {
  name: "Cool NFT",
  description: "This is a cool NFT",
  image: fs.readFileSync("path/to/image.png"),
}];

const results = await contract.createBatch(metadatas); // uploads and creates the NFTs on chain
const firstTokenId = results[0].id; // token id of the first created NFT
const firstNFT = await results[0].data(); // (optional) fetch details of the first created NFT

View in Javascript SDK Documentation

Python

from thirdweb.types.nft import NFTMetadataInput

# You can customize this metadata however you like
metadatas = [
    NFTMetadataInput.from_json({
        "name": "Cool NFT",
        "description": "This is a cool NFT",
        "image": open("path/to/file.jpg", "rb"),
    }),
    NFTMetadataInput.from_json({
        "name": "Cooler NFT",
        "description": "This is a cooler NFT",
        "image": open("path/to/file.jpg", "rb"),
    }),
]

txs = contract.create_batch(metadatas)
first_token_id = txs[0].id
first_nft = txs[0].data()

View in Python SDK Documentation

Go

image0, err := os.Open("path/to/image/0.jpg")
defer image0.Close()

image1, err := os.Open("path/to/image/1.jpg")
defer image1.Close()

metadatas := []*thirdweb.NFTMetadataInput{
	&thirdweb.NFTMetadataInput{
		Name: "Cool NFT",
		Description: "This is a cool NFT",
		Image: image1
	}
	&thirdweb.NFTMetadataInput{
		Name: "Cool NFT 2",
		Description: "This is also a cool NFT",
		Image: image2
	}
}

tx, err := contract.CreateBatch(context.Background(), metadatas)

View in Go SDK Documentation

Unity

This feature is missing a code snippet or might not be supported yet.
Check the Unity SDK Reference for more information.
Reach out on Discord for further assistance!

---

Setting Claim Phases

Configure claim conditions

React

const presaleStartTime = new Date();
const publicSaleStartTime = new Date(Date.now() + 60 * 60 * 24 * 1000);
const claimConditions = [
  {
    startTime: presaleStartTime, // start the presale now
    maxQuantity: 2, // limit how many mints for this presale
    price: 0.01, // presale price
    snapshot: ['0x...', '0x...'], // limit minting to only certain addresses
  },
  {
    startTime: publicSaleStartTime, // 24h after presale, start public sale
    price: 0.08, // public sale price
  }
]);
await contract.claimConditions.set(claimConditions);

View in React SDK Documentation

Javascript

const presaleStartTime = new Date();
const publicSaleStartTime = new Date(Date.now() + 60 * 60 * 24 * 1000);
const claimConditions = [
  {
    startTime: presaleStartTime, // start the presale now
    maxQuantity: 2, // limit how many mints for this presale
    price: 0.01, // presale price
    snapshot: ['0x...', '0x...'], // limit minting to only certain addresses
  },
  {
    startTime: publicSaleStartTime, // 24h after presale, start public sale
    price: 0.08, // public sale price
  }
]);
await contract.claimConditions.set(claimConditions);

View in Javascript SDK Documentation

Python

This feature is missing a code snippet or might not be supported yet.
Check the Python SDK Reference for more information.
Reach out on Discord for further assistance!

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

This feature is missing a code snippet or might not be supported yet.
Check the Unity SDK Reference for more information.
Reach out on Discord for further assistance!

---

Delayed Reveals

Delayed reveal

React

// the real NFTs, these will be encrypted until you reveal them
const realNFTs = [{
  name: "Common NFT #1",
  description: "Common NFT, one of many.",
  image: fs.readFileSync("path/to/image.png"),
}, {
  name: "Super Rare NFT #2",
  description: "You got a Super Rare NFT!",
  image: fs.readFileSync("path/to/image.png"),
}];
// A placeholder NFT that people will get immediately in their wallet, and will be converted to the real NFT at reveal time
const placeholderNFT = {
  name: "Hidden NFT",
  description: "Will be revealed next week!"
};
// Create and encrypt the NFTs
await contract.revealer.createDelayedRevealBatch(
  placeholderNFT,
  realNFTs,
  "my secret password",
);
// Whenever you're ready, reveal your NFTs at any time
const batchId = 0; // the batch to reveal
await contract.revealer.reveal(batchId, "my secret password");

View in React SDK Documentation

Javascript

// the real NFTs, these will be encrypted until you reveal them
const realNFTs = [{
  name: "Common NFT #1",
  description: "Common NFT, one of many.",
  image: fs.readFileSync("path/to/image.png"),
}, {
  name: "Super Rare NFT #2",
  description: "You got a Super Rare NFT!",
  image: fs.readFileSync("path/to/image.png"),
}];
// A placeholder NFT that people will get immediately in their wallet, and will be converted to the real NFT at reveal time
const placeholderNFT = {
  name: "Hidden NFT",
  description: "Will be revealed next week!"
};
// Create and encrypt the NFTs
await contract.revealer.createDelayedRevealBatch(
  placeholderNFT,
  realNFTs,
  "my secret password",
);
// Whenever you're ready, reveal your NFTs at any time
const batchId = 0; // the batch to reveal
await contract.revealer.reveal(batchId, "my secret password");

View in Javascript SDK Documentation

Python

This feature is missing a code snippet or might not be supported yet.
Check the Python SDK Reference for more information.
Reach out on Discord for further assistance!

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

This feature is missing a code snippet or might not be supported yet.
Check the Unity SDK Reference for more information.
Reach out on Discord for further assistance!

---

Setting Royalty Fees

Configure royalties

React

// royalties on the whole contract
contract.royalties.setDefaultRoyaltyInfo({
  seller_fee_basis_points: 100, // 1%
  fee_recipient: "0x..."
});
// override royalty for a particular token
contract.royalties.setTokenRoyaltyInfo(tokenId, {
  seller_fee_basis_points: 500, // 5%
  fee_recipient: "0x..."
});

View in React SDK Documentation

Javascript

// royalties on the whole contract
contract.royalties.setDefaultRoyaltyInfo({
  seller_fee_basis_points: 100, // 1%
  fee_recipient: "0x..."
});
// override royalty for a particular token
contract.royalties.setTokenRoyaltyInfo(tokenId, {
  seller_fee_basis_points: 500, // 5%
  fee_recipient: "0x..."
});

View in Javascript SDK Documentation

Python

This feature is missing a code snippet or might not be supported yet.
Check the Python SDK Reference for more information.
Reach out on Discord for further assistance!

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

This feature is missing a code snippet or might not be supported yet.
Check the Unity SDK Reference for more information.
Reach out on Discord for further assistance!

---

Minting / Claiming NFTs

Claim unique NFTs to a specific Wallet

React

const address = "{{wallet_address}}"; // address of the wallet you want to claim the NFTs
const quantity = 1; // how many unique NFTs you want to claim

const tx = await contract.claimTo(address, quantity);
const receipt = tx[0].receipt; // the transaction receipt
const claimedTokenId = tx[0].id; // the id of the NFT claimed
const claimedNFT = await tx[0].data(); // (optional) get the claimed NFT metadata

View in React SDK Documentation

Javascript

const address = "{{wallet_address}}"; // address of the wallet you want to claim the NFTs
const quantity = 1; // how many unique NFTs you want to claim

const tx = await contract.claimTo(address, quantity);
const receipt = tx[0].receipt; // the transaction receipt
const claimedTokenId = tx[0].id; // the id of the NFT claimed
const claimedNFT = await tx[0].data(); // (optional) get the claimed NFT metadata

View in Javascript SDK Documentation

Python

address = {{wallet_address}}
quantity = 1

tx = contract.claim_to(address, quantity)
receipt = tx.receipt
claimed_token_id = tx.id
claimed_nft = tx.data()

View in Python SDK Documentation

Go

address := "{{wallet_address}}"
quantity = 1

tx, err := contract.ClaimTo(context.Background(), address, quantity)

View in Go SDK Documentation

Unity

var address = "{{wallet_address}}"; // address of the wallet you want to claim the NFTs
var quantity = 1; // how many unique NFTs you want to claim

var tx = await contract.ERC721.ClaimTo(address, quantity);

---

Viewing NFTs

One NFT

Get a single NFT Metadata

React

const tokenId = 0;
const nft = await contract.get(tokenId);

View in React SDK Documentation

Javascript

const tokenId = 0;
const nft = await contract.get(tokenId);

View in Javascript SDK Documentation

Python

nft = contract.get(0)
print(nft)

View in Python SDK Documentation

Go

nft, err := contract.Get(context.Background(), 0)
 owner := nft.Owner
	name := nft.Metadata.Name

View in Go SDK Documentation

Unity

var tokenId = "0";
var nft = await contract.ERC721.Get(tokenId);

---

All NFTs

Get All Minted NFTs

React

const nfts = await contract.getAll();
console.log(nfts);

View in React SDK Documentation

Javascript

const nfts = await contract.getAll();
console.log(nfts);

View in Javascript SDK Documentation

Python

nfts = contract.get_all()
print(nfts)

View in Python SDK Documentation

Go

nfts, err := contract.GetAll(context.Background())
ownerOne := nfts[0].Owner
nameOne := nfts[0].Metadata.Name

View in Go SDK Documentation

Unity

var nfts = await contract.ERC721.GetAll();
Debug.Log(nfts);

---

Claimed NFTs

Get All Claimed NFTs

React

const claimedNFTs = await contract.getAllClaimed();
const firstOwner = claimedNFTs[0].owner;

View in React SDK Documentation

Javascript

const claimedNFTs = await contract.getAllClaimed();
const firstOwner = claimedNFTs[0].owner;

View in Javascript SDK Documentation

Python

claimed_nfts = contract.get_all_claimed()
first_owner = claimed_nfts[0].owner

View in Python SDK Documentation

Go

claimedNfts, err := contract.GetAllClaimed(context.Background())
firstOwner := claimedNfts[0].Owner

View in Go SDK Documentation

Unity

This feature is missing a code snippet or might not be supported yet.
Check the Unity SDK Reference for more information.
Reach out on Discord for further assistance!

---

Unclaimed NFTs

Get All Unclaimed NFTs

React

const unclaimedNFTs = await contract.getAllUnclaimed();
const firstUnclaimedNFT = unclaimedNFTs[0].name;

View in React SDK Documentation

Javascript

const unclaimedNFTs = await contract.getAllUnclaimed();
const firstUnclaimedNFT = unclaimedNFTs[0].name;

View in Javascript SDK Documentation

Python

unclaimed_nfts = contract.get_all_unclaimed()
first_nft_name = unclaimed_nfts[0].name

View in Python SDK Documentation

Go

unclaimedNfts, err := contract.GetAllUnclaimed(context.Background())
firstNftName := unclaimedNfts[0].Name

View in Go SDK Documentation

Unity

This feature is missing a code snippet or might not be supported yet.
Check the Unity SDK Reference for more information.
Reach out on Discord for further assistance!

---

NFTs owned by a specific wallet

Get Owned NFTs

React

// Address of the wallet to get the NFTs of
const address = "{{wallet_address}}";
const nfts = await contract.getOwned(address);
console.log(nfts);

View in React SDK Documentation

Javascript

// Address of the wallet to get the NFTs of
const address = "{{wallet_address}}";
const nfts = await contract.getOwned(address);
console.log(nfts);

View in Javascript SDK Documentation

Python

nfts = contract.get_owned("{{wallet_address}}")
print(nfts)

View in Python SDK Documentation

Go

owner := "{{wallet_address}}"
nfts, err := contract.GetOwned(context.Background(), owner)
name := nfts[0].Metadata.Name

View in Go SDK Documentation

Unity

// Address of the Wallet to get the NFTs of
var address = "{{wallet_address}}";
var nfts = await contract.ERC721.GetOwned(address);
Debug.Log(nfts);

---

Viewing Supply

Claimed supply

Get the claimed supply

React

const claimedNFTCount = await contract.totalClaimedSupply();
console.log(`NFTs claimed so far: ${claimedNFTCount}`);

View in React SDK Documentation

Javascript

const claimedNFTCount = await contract.totalClaimedSupply();
console.log(`NFTs claimed so far: ${claimedNFTCount}`);

View in Javascript SDK Documentation

Python

total_claimed = contract.total_claimed_supply()

View in Python SDK Documentation

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

var claimedNFTCount = await contract.ERC721.TotalClaimedSupply();

---

Unclaimed supply

Get the unclaimed supply

React

const unclaimedNFTCount = await contract.totalUnclaimedSupply();
console.log(`NFTs left to claim: ${unclaimedNFTCount}`);

View in React SDK Documentation

Javascript

const unclaimedNFTCount = await contract.totalUnclaimedSupply();
console.log(`NFTs left to claim: ${unclaimedNFTCount}`);

View in Javascript SDK Documentation

Python

total_unclaimed = contract.total_unclaimed_supply()

View in Python SDK Documentation

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

var unclaimedNFTCount = await contract.ERC721.TotalUnclaimedSupply();

---

Transferring NFTs

Transfer a single NFT

React

const walletAddress = "{{wallet_address}}";
const tokenId = 0;
await contract.transfer(walletAddress, tokenId);

View in React SDK Documentation

Javascript

const walletAddress = "{{wallet_address}}";
const tokenId = 0;
await contract.transfer(walletAddress, tokenId);

View in Javascript SDK Documentation

Python

to = "{{wallet_address}}"
token_id = 0

receipt = contract.transfer(to, token_id)

View in Python SDK Documentation

Go

to := "0x..."
tokenId := 0

tx, err := contract.Transfer(context.Background(), to, tokenId)

View in Go SDK Documentation

Unity

var walletAddress = "{{wallet_address}}";
var tokenId = "0";
await contract.ERC721.Transfer(walletAddress, tokenId);

---

Burning NFTs

Burn a single NFT

React

const result = await contract.burnToken(tokenId);

View in React SDK Documentation

Javascript

const result = await contract.burnToken(tokenId);

View in Javascript SDK Documentation

Python

This feature is missing a code snippet or might not be supported yet.
Check the Python SDK Reference for more information.
Reach out on Discord for further assistance!

Go

tokenId := 0
tx, err := contract.Burn(context.Background(), tokenId)

View in Go SDK Documentation

Unity

var tokenId = "0";
var result = await contract.ERC721.Burn(tokenId);