Add contract availability documentation to ERC methods (#7033)

joaquim-verges · web-flow · commit b15c3c074786 · 2025-05-12T17:47:28.000-07:00
diff --git a/packages/thirdweb/src/extensions/erc1155/drops/read/canClaim.ts b/packages/thirdweb/src/extensions/erc1155/drops/read/canClaim.ts
@@ -18,7 +18,7 @@ export type CanClaimResult = {
 
 /**
  * Check if a user can claim a drop.
- *
+ * This method is only available on the `DropERC1155` contract.
  * @param options - The options for the transaction.
  * @returns Whether the user can claim the drop.
  *
diff --git a/packages/thirdweb/src/extensions/erc1155/drops/read/getActiveClaimCondition.ts b/packages/thirdweb/src/extensions/erc1155/drops/read/getActiveClaimCondition.ts
@@ -17,6 +17,7 @@ import {
 export type GetActiveClaimConditionParams = GetActiveClaimConditionIdParams;
 /**
  * Retrieves the active claim condition.
+ * This method is only available on the `DropERC1155` contract.
  * @param options - The transaction options.
  * @returns A promise that resolves to the active claim condition.
  * @throws An error if the claim condition is unsupported.
diff --git a/packages/thirdweb/src/extensions/erc1155/drops/read/getClaimConditions.ts b/packages/thirdweb/src/extensions/erc1155/drops/read/getClaimConditions.ts
@@ -9,6 +9,7 @@ export type GetClaimConditionsParams = {
 };
 /**
  * Retrieves all claim conditions.
+ * This method is only available on the `DropERC1155` contract.
  * @param options - The transaction options.
  * @returns A promise that resolves to all claim conditions.
  * @throws An error if the claim conditions are unsupported by the contract.
diff --git a/packages/thirdweb/src/extensions/erc1155/drops/write/claimTo.ts b/packages/thirdweb/src/extensions/erc1155/drops/write/claimTo.ts
@@ -18,6 +18,7 @@ export type ClaimToParams = {
 
 /**
  * Claim ERC1155 NFTs to a specified address
+ * This method is only available on the `DropERC1155` contract.
  * @param options - The options for the transaction
  * @extension ERC1155
  * @example
diff --git a/packages/thirdweb/src/extensions/erc1155/drops/write/resetClaimEligibility.ts b/packages/thirdweb/src/extensions/erc1155/drops/write/resetClaimEligibility.ts
@@ -23,6 +23,7 @@ export type ResetClaimEligibilityParams = GetClaimConditionsParams;
 
 /**
  * Reset the claim eligibility for all users.
+ * This method is only available on the `DropERC1155` contract.
  * @param options
  * @returns the prepared transaction
  * @extension ERC1155
diff --git a/packages/thirdweb/src/extensions/erc1155/drops/write/setClaimConditions.ts b/packages/thirdweb/src/extensions/erc1155/drops/write/setClaimConditions.ts
@@ -22,6 +22,7 @@ export type SetClaimConditionsParams = {
 
 /**
  * Set the claim conditions for a ERC1155 drop
+ * This method is only available on the `DropERC1155` contract.
  * @param options
  * @returns the prepared transaction
  * @extension ERC1155
diff --git a/packages/thirdweb/src/extensions/erc1155/write/lazyMint.ts b/packages/thirdweb/src/extensions/erc1155/write/lazyMint.ts
@@ -37,6 +37,7 @@ export type LazyMintParams = {
 
 /**
  * Lazily mints ERC1155 tokens.
+ * This method is only available on the `DropERC1155` contract.
  * @param options - The options for the lazy minting process.
  * @returns A promise that resolves to the prepared contract call.
  * @extension ERC1155
diff --git a/packages/thirdweb/src/extensions/erc1155/write/mintAdditionalSupplyTo.ts b/packages/thirdweb/src/extensions/erc1155/write/mintAdditionalSupplyTo.ts
@@ -13,6 +13,7 @@ export type MintAdditionalSupplyToParams = {
 
 /**
  * Mints a "supply" number of additional ERC1155 tokens to the specified "to" address.
+ * This method is only available on the `TokenERC1155` contract.
  * @param options - The transaction options.
  * @returns A promise that resolves to the transaction result.
  * @extension ERC1155
diff --git a/packages/thirdweb/src/extensions/erc1155/write/mintAdditionalSupplyToBatch.ts b/packages/thirdweb/src/extensions/erc1155/write/mintAdditionalSupplyToBatch.ts
@@ -16,6 +16,7 @@ export type MintAdditionalSupplyToBatchParams = WithOverrides<{
 
 /**
  * This extension batches multiple `mintAdditionalSupplyToBatch` extensions into one single multicall.
+ * This method is only available on the `TokenERC1155` contract.
  * Keep in mind that there is a limit of how many NFTs you can mint per transaction.
  * This limit varies depends on the network that you are transacting on.
  *
diff --git a/packages/thirdweb/src/extensions/erc1155/write/mintTo.ts b/packages/thirdweb/src/extensions/erc1155/write/mintTo.ts
@@ -19,6 +19,7 @@ export type MintToParams = WithOverrides<{
 
 /**
  * Mints a "supply" number of new ERC1155 tokens to the specified "to" address.
+ * This method is only available on the `TokenERC1155` contract.
  * If the `nft` parameter is a string, it will be used as the token URI.
  * If the `nft` parameter is a file, it will be uploaded to the storage server and the resulting URI will be used as the token URI.
  * @param options - The transaction options.
diff --git a/packages/thirdweb/src/extensions/erc1155/write/mintToBatch.ts b/packages/thirdweb/src/extensions/erc1155/write/mintToBatch.ts
@@ -40,6 +40,7 @@ export type MintToBatchParams = WithOverrides<{
 
 /**
  * This extension batches multiple `mintTo` extensions into one single multicall.
+ * This method is only available on the `TokenERC1155` contract.
  * Keep in mind that there is a limit of how many NFTs you can mint per transaction.
  * This limit varies depends on the network that you are transacting on.
  *
diff --git a/packages/thirdweb/src/extensions/erc1155/write/sigMint.ts b/packages/thirdweb/src/extensions/erc1155/write/sigMint.ts
@@ -19,6 +19,7 @@ import {
 
 /**
  * Mints a new ERC1155 token with the given minter signature
+ * This method is only available on the `TokenERC1155` contract.
  * @param options - The transaction options.
  * @example
  * ```ts
diff --git a/packages/thirdweb/src/extensions/erc1155/write/updateTokenURI.ts b/packages/thirdweb/src/extensions/erc1155/write/updateTokenURI.ts
@@ -20,6 +20,7 @@ export type UpdateTokenURIParams = {
  * which means it uses `setTokenURI` under the hood.
  * While the `setTokenURI` method only takes in a uri string, this extension takes in a user-friendly [`NFTInput`](https://portal.thirdweb.com/references/typescript/v5/NFTInput),
  * upload that content to IPFS and pass the IPFS URI (of said `NFTInput`) to the underlying `setTokenURI` method.
+ * This method is only available on the `TokenERC1155` contract.
  *
  * This extension does not validate the NFTInput so make sure you are passing the proper content that you want to update.
  *
diff --git a/packages/thirdweb/src/extensions/erc20/drops/read/canClaim.ts b/packages/thirdweb/src/extensions/erc20/drops/read/canClaim.ts
@@ -17,7 +17,7 @@ export type CanClaimResult = {
 
 /**
  * Check if a user can claim a drop.
- *
+ * This method is only available on the `DropERC20` contract.
  * @param options - The options for the transaction.
  * @returns Whether the user can claim the drop.
  *
diff --git a/packages/thirdweb/src/extensions/erc20/drops/read/getActiveClaimCondition.ts b/packages/thirdweb/src/extensions/erc20/drops/read/getActiveClaimCondition.ts
@@ -5,6 +5,7 @@ import * as MultiById from "../../__generated__/IDropERC20/read/getClaimConditio
 
 /**
  * Retrieves the active claim condition.
+ * This method is only available on the `DropERC20` contract.
  * @param options - The transaction options.
  * @returns A promise that resolves to the active claim condition.
  * @throws An error if the claim condition is unsupported.
diff --git a/packages/thirdweb/src/extensions/erc20/drops/read/getClaimConditions.ts b/packages/thirdweb/src/extensions/erc20/drops/read/getClaimConditions.ts
@@ -5,6 +5,7 @@ import * as MultiById from "../../__generated__/IDropERC20/read/getClaimConditio
 
 /**
  * Retrieves all claim conditions.
+ * This method is only available on the `DropERC20` contract.
  * @param options - The transaction options.
  * @returns A promise that resolves to all claim conditions.
  * @throws An error if the claim conditions are unsupported by the contract.
diff --git a/packages/thirdweb/src/extensions/erc20/drops/write/claimTo.ts b/packages/thirdweb/src/extensions/erc20/drops/write/claimTo.ts
@@ -18,6 +18,8 @@ export type ClaimToParams = {
 
 /**
  * Claim ERC20 NFTs to a specified address
+ * This method is only available on the `DropERC20` contract.
+ *
  * @param options - The options for the transaction
  * @extension ERC20
  * @example
diff --git a/packages/thirdweb/src/extensions/erc20/drops/write/resetClaimEligibility.ts b/packages/thirdweb/src/extensions/erc20/drops/write/resetClaimEligibility.ts
@@ -12,6 +12,7 @@ import {
 
 /**
  * Reset the claim eligibility for all users.
+ * This method is only available on the `DropERC20` contract.
  * @param options
  * @returns the prepared transaction
  * @extension ERC20
diff --git a/packages/thirdweb/src/extensions/erc20/drops/write/setClaimConditions.ts b/packages/thirdweb/src/extensions/erc20/drops/write/setClaimConditions.ts
@@ -21,6 +21,7 @@ export type SetClaimConditionsParams = {
 
 /**
  * Set the claim conditions for a ERC20 drop
+ * This method is only available on the `DropERC20` contract.
  * @param options
  * @returns the prepared transaction
  * @extension ERC20
diff --git a/packages/thirdweb/src/extensions/erc20/write/mintTo.ts b/packages/thirdweb/src/extensions/erc20/write/mintTo.ts
@@ -27,6 +27,7 @@ export type MintToParams = Prettify<
 
 /**
  * Mints a specified amount of tokens to a given address.
+ * This method is only available on the `TokenERC20` contract.
  * @param options - The options for minting tokens.
  * @returns A prepared transaction object.
  * @extension ERC20
diff --git a/packages/thirdweb/src/extensions/erc20/write/sigMint.ts b/packages/thirdweb/src/extensions/erc20/write/sigMint.ts
@@ -17,6 +17,7 @@ import {
 
 /**
  * Mints a new ERC20 token with the given minter signature
+ * This method is only available on the `TokenERC20` contract.
  * @param options - The transaction options.
  * @extension ERC20
  * @example
diff --git a/packages/thirdweb/src/extensions/erc721/drops/read/canClaim.ts b/packages/thirdweb/src/extensions/erc721/drops/read/canClaim.ts
@@ -18,6 +18,8 @@ export type CanClaimResult = {
 /**
  * Check if a user can claim a drop.
  *
+ * This method is only available on the `DropERC721` contract.
+ *
  * @param options - The options for the transaction.
  * @returns Whether the user can claim the drop.
  *
diff --git a/packages/thirdweb/src/extensions/erc721/drops/read/getActiveClaimCondition.ts b/packages/thirdweb/src/extensions/erc721/drops/read/getActiveClaimCondition.ts
@@ -5,6 +5,8 @@ import * as ById from "../../__generated__/IDrop/read/getClaimConditionById.js";
 
 /**
  * Retrieves the active claim condition.
+ * This method is only available on the `DropERC721` contract.
+ *
  * @param options - The transaction options.
  * @returns A promise that resolves to the active claim condition.
  * @throws An error if the claim condition is unsupported.
@@ -28,6 +30,8 @@ export async function getActiveClaimCondition(
 
 /**
  * Checks if the `getActiveClaimCondition` method is supported by the given contract.
+ * This method is only available on the `DropERC721` contract.
+ *
  * @param availableSelectors An array of 4byte function selectors of the contract. You can get this in various ways, such as using "whatsabi" or if you have the ABI of the contract available you can use it to generate the selectors.
  * @returns A boolean indicating if the `getActiveClaimCondition` method is supported.
  * @extension ERC721
diff --git a/packages/thirdweb/src/extensions/erc721/drops/read/getClaimConditions.ts b/packages/thirdweb/src/extensions/erc721/drops/read/getClaimConditions.ts
@@ -5,6 +5,9 @@ import * as MultiById from "../../__generated__/IDrop/read/getClaimConditionById
 
 /**
  * Retrieves all claim conditions.
+ *
+ * This method is only available on the `DropERC721` contract.
+ *
  * @param options - The transaction options.
  * @returns A promise that resolves to all claim conditions.
  * @throws An error if the claim conditions are unsupported by the contract.
diff --git a/packages/thirdweb/src/extensions/erc721/drops/write/claimTo.ts b/packages/thirdweb/src/extensions/erc721/drops/write/claimTo.ts
@@ -22,6 +22,7 @@ export type ClaimToParams = {
 
 /**
  * Claim ERC721 NFTs to a specified address
+ * This method is only available on the `DropERC721` contract.
  * @param options - The options for the transaction
  * @extension ERC721
  * @example
diff --git a/packages/thirdweb/src/extensions/erc721/drops/write/claimToBatch.ts b/packages/thirdweb/src/extensions/erc721/drops/write/claimToBatch.ts
@@ -22,6 +22,7 @@ export type ClaimToBatchParams = WithOverrides<{
  * This extension batches multiple `claimTo` extensions into one single multicall.
  * Keep in mind that there is a limit of how many NFTs you can claim per transaction.
  * This limit varies depends on the network that you are transacting on.
+ * This method is only available on the `DropERC721` contract.
  *
  * You are recommended to experiment with the number to figure out the best number for your chain of choice.
  * @extension ERC721
diff --git a/packages/thirdweb/src/extensions/erc721/drops/write/resetClaimEligibility.ts b/packages/thirdweb/src/extensions/erc721/drops/write/resetClaimEligibility.ts
@@ -12,6 +12,7 @@ import {
 
 /**
  * Reset the claim eligibility for all users.
+ * This method is only available on the `DropERC721` contract.
  * @param options
  * @returns the prepared transaction
  * @extension ERC721
diff --git a/packages/thirdweb/src/extensions/erc721/drops/write/setClaimConditions.ts b/packages/thirdweb/src/extensions/erc721/drops/write/setClaimConditions.ts
@@ -21,6 +21,7 @@ export type SetClaimConditionsParams = {
 
 /**
  * Set the claim conditions for a ERC721 drop
+ * This method is only available on the `DropERC721` contract.
  * @param options
  * @returns the prepared transaction
  * @extension ERC721
diff --git a/packages/thirdweb/src/extensions/erc721/lazyMinting/write/createDelayedRevealBatch.ts b/packages/thirdweb/src/extensions/erc721/lazyMinting/write/createDelayedRevealBatch.ts
@@ -32,6 +32,7 @@ export type CreateDelayedRevealBatchParams = {
 
 /**
  * Creates a batch of encrypted NFTs that can be revealed at a later time.
+ * This method is only available on the `DropERC721` contract.
  *
  * @param options {CreateDelayedRevealBatchParams} - The delayed reveal options.
  * @param options.placeholderMetadata {@link NFTInput} - The placeholder metadata for the batch.
diff --git a/packages/thirdweb/src/extensions/erc721/lazyMinting/write/reveal.ts b/packages/thirdweb/src/extensions/erc721/lazyMinting/write/reveal.ts
@@ -14,7 +14,7 @@ export type RevealParams = {
 
 /**
  * Reveals a previously lazy minted batch of NFTs.
- *
+ * This method is only available on the `DropERC721` contract.
  * @param options {RevealParams} - The reveal parameters.
  * @param options.batchId {number} - The ID of the batch to reveal. Get this by calling `getBatchesToReveal`. {@see getBatchesToReveal}
  * @param options.password {string} - The password for the reveal, set when the batch was created. {@see createDelayedRevealBatch}
diff --git a/packages/thirdweb/src/extensions/erc721/write/lazyMint.ts b/packages/thirdweb/src/extensions/erc721/write/lazyMint.ts
@@ -19,6 +19,8 @@ export type LazyMintParams = {
 
 /**
  * Lazily mints ERC721 tokens.
+ * This method is only available on the `DropERC721` contract.
+ *
  * @param options - The options for the lazy minting process.
  * @returns A promise that resolves to the prepared contract call.
  * @extension ERC721
diff --git a/packages/thirdweb/src/extensions/erc721/write/mintTo.ts b/packages/thirdweb/src/extensions/erc721/write/mintTo.ts
@@ -17,6 +17,8 @@ export type MintToParams = WithOverrides<{
 
 /**
  * Mints a new ERC721 token and assigns it to the specified address.
+ * This method is only available on the `TokenERC721` contract.
+ *
  * If the `nft` parameter is a string, it will be used as the token URI.
  * If the `nft` parameter is a file, it will be uploaded to the storage server and the resulting URI will be used as the token URI.
  * @param options - The transaction options.
diff --git a/packages/thirdweb/src/extensions/erc721/write/sigMint.ts b/packages/thirdweb/src/extensions/erc721/write/sigMint.ts
@@ -22,6 +22,8 @@ import {
 
 /**
  * Mints a new ERC721 token with the given minter signature
+ * This method is only available on the `TokenERC721` contract.
+ *
  * @param options - The transaction options.
  * @example
  * ```ts
diff --git a/packages/thirdweb/src/extensions/erc721/write/updateTokenURI.ts b/packages/thirdweb/src/extensions/erc721/write/updateTokenURI.ts
@@ -23,6 +23,7 @@ export type UpdateTokenURIParams = {
  * upload that content to IPFS and pass the IPFS URI (of said `NFTInput`) to the underlying `setTokenURI` method.
  *
  * This extension does not validate the NFTInput so make sure you are passing the proper content that you want to update.
+ * This method is only available on the `TokenERC721` contract.
  *
  * @extension ERC721
  * @returns the prepared transaction from `setTokenURI`

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ export type CanClaimResult = {`
`18`	`18`
`19`	`19`	`/**`
`20`	`20`	`* Check if a user can claim a drop.`
`21`		`- *`
	`21`	+ * This method is only available on the `DropERC1155` contract.
`22`	`22`	`* @param options - The options for the transaction.`
`23`	`23`	`* @returns Whether the user can claim the drop.`
`24`	`24`	`*`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@ export type MintAdditionalSupplyToBatchParams = WithOverrides<{`
`16`	`16`
`17`	`17`	`/**`
`18`	`18`	* This extension batches multiple `mintAdditionalSupplyToBatch` extensions into one single multicall.
	`19`	+ * This method is only available on the `TokenERC1155` contract.
`19`	`20`	`* Keep in mind that there is a limit of how many NFTs you can mint per transaction.`
`20`	`21`	`* This limit varies depends on the network that you are transacting on.`
`21`	`22`	`*`