update

Author: kien-ngo

packages/thirdweb/src/extensions/erc1155/drops/write/claimTo.ts

@@ -19,6 +19,7 @@ export type ClaimToParams = {
  * @param options - The options for the transaction
  * @extension ERC1155
  * @example
+ * ### Basic usage
  * ```ts
  * import { claimTo } from "thirdweb/extensions/erc1155";
  * import { sendTransaction } from "thirdweb";
@@ -32,9 +33,20 @@ export type ClaimToParams = {
  *
  * await sendTransaction({ transaction, account });
  * ```
+ *
+ * ### For Drops with allowlists
+ * You need to specify the claimer address as the `from` param to avoid any issue with the allowlist
+ * ```ts
+ * const transaction = claimTo({
+ *   contract,
+ *   to: "0x...",
+ *   tokenId: 0n,
+ *   quantity: 1n,
+ *   from: "0x...", // address of the one claiming
+ * });
+ * ```
  * @throws If no claim condition is set
  * @returns The prepared transaction
- * @note If the claiming address is not the same as the receiving address, you need to specify the claimer address as the `from` param to avoid any issue with the allowlist (if one exists)
  */
 export function claimTo(options: BaseTransactionOptions<ClaimToParams>) {
   return GeneratedClaim.claim({

packages/thirdweb/src/extensions/erc20/drops/write/claimTo.ts

@@ -20,6 +20,8 @@ export type ClaimToParams = {
  * @param options - The options for the transaction
  * @extension ERC20
  * @example
+ *
+ * ### Basic usage
  * ```ts
  * import { claimTo } from "thirdweb/extensions/erc20";
  * import { sendTransaction } from "thirdweb";
@@ -32,9 +34,19 @@ export type ClaimToParams = {
  *
  * await sendTransaction({ transaction, account });
  * ```
+ *
+ * ### For Drops with allowlists
+ * You need to specify the claimer address as the `from` param to avoid any issue with the allowlist
+ * ```ts
+ * const transaction = claimTo({
+ *   contract,
+ *   to: "0x...",
+ *   quantity: 100n,
+ *   from: "0x...", // address of the one claiming
+ * });
+ * ```
  * @throws If no claim condition is set
  * @returns A promise that resolves with the submitted transaction hash.
- * @note If the claiming address is not the same as the receiving address, you need to specify the claimer address as the `from` param to avoid any issue with the allowlist (if one exists)
  */
 export function claimTo(options: BaseTransactionOptions<ClaimToParams>) {
   return GeneratedClaim.claim({

packages/thirdweb/src/extensions/erc721/drops/write/claimTo.ts

@@ -23,6 +23,8 @@ export type ClaimToParams = {
  * @param options - The options for the transaction
  * @extension ERC721
  * @example
+ *
+ * ### Basic usage
  * ```ts
  * import { claimTo } from "thirdweb/extensions/erc721";
  * import { sendTransaction } from "thirdweb";
@@ -35,9 +37,19 @@ export type ClaimToParams = {
  *
  * await sendTransaction({ transaction, account });
  * ```
+ *
+ * ### For Drops with allowlists
+ * You need to specify the claimer address as the `from` param to avoid any issue with the allowlist
+ * ```ts
+ * const transaction = claimTo({
+ *   contract,
+ *   to: "0x...",
+ *   quantity: 1n,
+ *   from: "0x...", // address of the one claiming
+ * });
+ * ```
  * @throws If no claim condition is set
  * @returns A promise that resolves with the submitted transaction hash.
- * @note If the claiming address is not the same as the receiving address, you need to specify the claimer address as the `from` param to avoid any issue with the allowlist (if one exists)
  */
 export function claimTo(options: BaseTransactionOptions<ClaimToParams>) {
   return claim({