NFT Drop Code Examples

Easy copy and paste snippets to use thirdweb NFT Drop module

Copy codeconst drop = sdk.getDropModule("<MODULE_ADDRESS>");

const lazyMintNft = async () => {
  try {
    await drop.createBatch([{
      name: "thirdweb",
      description: "Smart contracts you control. Tools that accelerate your workflow. Intuitive SDKs and widgets for developers.",
      image: "ipfs//:<YOUR_IPFS_FOLDER_CID>/1.png",
      properties: {},
    }]);
  } catch (err) {
    console.log(err);
  }
};

lazyMintNft();

When creating a lazy minted batch, we recommend that you upload all token image assets to IPFS ahead of time in an IPFS folder.

That means you're required to bring along the CID of the IPFS folder, such that each image for a token can be mapped deterministically by its token ID.

You also have the option of uploading the image as you mint the batch, which will upload each of the images outside of a folder, but will take a bit longer to complete because each of the images will be uploaded to IPFS and the speed is subject to your internet speed.

To take advantage of this "just in time upload" you simply set the image property of each token to the loaded image file, which will signal to the SDK that the image should be uploaded.

Copy codeconst drop = sdk.getDropModule("<MODULE_ADDRESS>");

const lazyMintBatchNft = async () => {
  try {
    await drop.mintBatch([
      {
        name: "Token 1",
        description: "Token 1 maps to 1.png",
        image: "ipfs/<YOUR_IPFS_FOLDER_CID>/1.png",
        properties: {},
      },
      {
        name: "Token 2",
        description: "Token 2 maps to 2.png",
        image: "ipfs/<YOUR_IPFS_FOLDER_CID>/2.png",
        properties: {},
      },
    ]);
  } catch (err) {
    console.log(err);
  }
};

lazyMintBatchNft();

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const getBalance = async () => {
  const bal = await drop.balance();

  console.log(bal.toString());  // Since bal is a BigNumber object.
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const getBalance = async () => {
  const bal = await drop.balanceOf("<TARGET_ADDRESS>");

  console.log(bal.toString());  // Since bal is a BigNumber object.
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const burnToken = async() => {
    // Token ID to be burned, which is created in the NFT drop module on the dashboard.
    const tokenId = 0;

    await drop.burn(tokenId)
    .then((data) => console.log(data))
    .catch((err) => console.log(err));
}

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const canClaim = async () => {
    const quantity = 1;
    const addressToCheck = "<MODULE_ADDRESS>";

    // Check if claimable.
    const isClaimable = await drop.canClaim(quantity, addressToCheck)

    console.log(isClaimable);
}

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const claim = async () => {
  const quantity = 1;

  await drop
    .claim(quantity)
    .then((data) => console.log(data))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const claim = async () => {
  const quantity = 1;
  const receiverAddress = "<TARGET_ADDRESS>";

  await drop
    .claimTo(quantity, receiverAddress)
    .then((data) => console.log(data))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const getTokenInfo = async (tokenId) => {
  await drop
    .get(tokenId)
    .then((data) => console.log(data))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const getActiveClaimCondition = async () => {
  await drop
    .getActiveClaimCondition()
    .then((data) => console.log(data))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const getActiveMintCondition = async () => {
  await drop
    .getActiveMintCondition()
    .then((data) => console.log(data))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const getAllTokenInfo = async () => {
  await drop
    .getAll()
    .then((data) => console.log(data))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const getAllClaimConditions = async () => {
  await drop
    .getAllClaimConditions()
    .then((data) => console.log(data))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const getAllClaimedTokens = async () => {
  await drop
    .getAllClaimed()
    .then((data) => console.log(data))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const getAllUnclaimed = async () => {
  await drop
    .getAllUnclaimed()
    .then((data) => console.log(data))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const createClaimConditionsFactory = async () => {
  const claimConditionsFactory = await drop.getClaimConditionsFactory();

  console.log(claimConditionsFactory);
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const getClaimIneligibilityReasons = async () => {
  const quantity = 1;
  const addressToCheck = "<TARGET_ADDRESS>";

  // Check if claimable.
  const claimIneligibilityReasons = await drop.getClaimIneligibilityReasons(quantity, addressToCheck);

  console.log(claimIneligibilityReasons);
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const getDefaultSaleRecipient = async () => {
  await drop
    .getDefaultSaleRecipient()
    .then((data) => console.log(data))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const getOwnedByAddress = async (address) => {
  await drop.getOwned(address)
  .then(data => console.log(data))
  .catch(err => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const getRoyaltyBps = async () => {
  await drop.getRoyaltyBps()
  .then(data => console.log(data.toNumber()))
  .catch(err => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const getRoyaltyRecipientAddress = async () => {
  await drop.getRoyaltyRecipientAddress()
  .then(data => console.log(data))
  .catch(err => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const isContractApproved = async () => {
  const address = "<TARGET_ADDRESS>";
  // The ID for the deployed contract that will spend on your behalf.
  const operatorContractId = "<OPERATOR_CONTRACT_ID>";

  await drop
    .isApproved(address, operatorContractId)
    .then((data) => console.log(data))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const isTransferRestricted = async () => {
  await drop.isTransferRestricted()
  .then(data => console.log(data))
  .catch(err => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const isContractV1 = async () => {
  await drop.isV1()
  .then(data => console.log(data))
  .catch(err => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const getTokenOwner = async (tokenId) => {
  await drop.ownerOf(tokenId)
  .then(data => console.log(data))
  .catch(err => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const setTokenApproval = async () => {
  // The ID for the deployed contract that will spend on your behalf.
  const operatorContractId = "<OPERATOR_CONTRACT_ID>";

  await drop
    .setApproval(operatorContractId, true)
    .then((data) => console.log(data))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const setTokenClaimConditions = async () => {
  const factory = await drop.getClaimConditionsFactory();

  // Define claim phase.
  const claimPhase = await factory.newClaimPhase({
    startTime: new Date(),
    maxQuantity: 10,
    maxQuantityPerTransaction: 1,
  });

  // Set price.
  claimPhase.setPrice(1);

  // Set wait time between claims.
  claimPhase.setWaitTimeBetweenClaims(24 * 60 * 60);

  // Allow snapshot for the specified list.
  const allowList = [
    "[ALLOWED_ADDRESS_1]",
    "[ALLOWED_ADDRESS_2]",
    "[ALLOWED_ADDRESS_3]",
    "[ALLOWED_ADDRESS_4]",
  ];

  claimPhase.setSnapshot(allowList);

  // Set claim conditions.
  await drop.setClaimConditions(factory);
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const setDefaultSaleRecipient = async () => {
  const address = "<TARGET_ADDRESS>";

  await drop
    .setDefaultSaleRecipient(address)
    .then((data) => console.log(data))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const setModuleMetadata = async () => {
  await drop
    .setModuleMetadata({
      name: "NFT Drop mod",
      description: "My cool drop module!",
      image: "[IMAGE_BUFFER_OR_LINK]" // Replace this with image buffer, or IPFS link.
    })
    .then((data) => console.log(data))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const setTransferRestriction = async () => {
  await drop
    .setRestrictedTransfer(true) // true or false
    .then((data) => console.log(data))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const setRoyaltyBp = async () => {
  const basisPoints = 10;

  await drop
    .setRoyaltyBps(basisPoints)
    .then((data) => console.log(data))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const getTotalClaimedSupply = async () => {
  await drop
    .totalClaimedSupply()
    .then((data) => console.log(data.toNumber()))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const getTotalSupply = async () => {
  await drop
    .totalSupply()
    .then((data) => console.log(data.toNumber()))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const getTotalUnclaimedSupply = async () => {
  await drop
    .totalUnclaimedSupply()
    .then((data) => console.log(data.toNumber()))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const transferTokenToAddress = async () => {
  const address = "<TARGET_ADDRESS>";
  const tokenId = "0";

  await drop
    .transfer(address, tokenId)
    .then((data) => console.log(data.toNumber()))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const transferTokenFromAddress = async (fromAddress, toAddress, tokenId) => {
  await drop
    .transferFrom(fromAddress, toAddress, tokenId)
    .then((data) => console.log(data.toNumber()))
    .catch((err) => console.log(err));
};

Copy code// The drop module address received after initializing the NFT drop module on the dashboard.
const dropAddress = "<MODULE_ADDRESS>";

// Initialize the NFT drop module with the contract address.
const drop = sdk.getDropModule(dropAddress);

const updateTokenClaimConditions = async () => {
  const factory = drop.getClaimConditionsFactory();

  // Define claim phase.
  const claimPhase = await factory.newClaimPhase({
    startTime: new Date(),
    maxQuantity: 10,
    maxQuantityPerTransaction: 1,
  });

  // Set price.
  claimPhase.setPrice(1);

  // Set wait time between claims.
  claimPhase.setWaitTimeBetweenClaims(24 * 60 * 60);

  // Allow snapshot for the specified list.
  const allowList = [];

  claimPhase.setSnapshot(allowList);

  // Set claim conditions.
  await drop.updateClaimConditions(factory);
};

NFT Drops differ from Bundle Drops in that each token is a ERC-721 token. So that means that when setting our claim conditions, we do it only once for the entire drop.

Copy codeconst factory = dropModule.getClaimConditionsFactory();
const phase = factory.newClaimPhase({
  startTime: new Date(),
});
await phase.setSnapshot(["<ALLOWED_ADDRESS_1>", "<ALLOWED_ADDRESS_2>", ...]);
await dropModule.setClaimCondition("0", factory);