[SDK] Allow passing overrides to common extension functions (#8041)

Author: joaquim-verges

.changeset/two-steaks-melt.md

@@ -0,0 +1,5 @@
+---
+"thirdweb": patch
+---
+
+Allow passing overrides to common extension functions

apps/playground-web/src/components/account-abstraction/gateway.tsx

@@ -28,7 +28,7 @@ import {
   TableRow,
 } from "../ui/table";
 
-const url = `http://${process.env.NEXT_PUBLIC_API_URL}`;
+const url = `https://${process.env.NEXT_PUBLIC_API_URL}`;
 
 const chain = baseSepolia;
 const editionDropAddress = "0x638263e3eAa3917a53630e61B1fBa685308024fa";

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

@@ -1,4 +1,7 @@
-import type { BaseTransactionOptions } from "../../../../transaction/types.js";
+import type {
+  BaseTransactionOptions,
+  WithOverrides,
+} from "../../../../transaction/types.js";
 import { getClaimParams } from "../../../../utils/extensions/drops/get-claim-params.js";
 import { isGetContractMetadataSupported } from "../../../common/read/getContractMetadata.js";
 import * as GeneratedClaim from "../../__generated__/IDrop1155/write/claim.js";
@@ -51,7 +54,9 @@ export type ClaimToParams = {
  * @throws If no claim condition is set
  * @returns The prepared transaction
  */
-export function claimTo(options: BaseTransactionOptions<ClaimToParams>) {
+export function claimTo(
+  options: BaseTransactionOptions<WithOverrides<ClaimToParams>>,
+) {
   return GeneratedClaim.claim({
     async asyncParams() {
       const params = await getClaimParams({
@@ -70,6 +75,7 @@ export function claimTo(options: BaseTransactionOptions<ClaimToParams>) {
       };
     },
     contract: options.contract,
+    overrides: options.overrides,
   });
 }
 

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

@@ -1,5 +1,8 @@
 import type { Hex } from "viem";
-import type { BaseTransactionOptions } from "../../../../transaction/types.js";
+import type {
+  BaseTransactionOptions,
+  WithOverrides,
+} from "../../../../transaction/types.js";
 import type { ClaimCondition } from "../../../../utils/extensions/drops/types.js";
 import {
   isSetClaimConditionsSupported,
@@ -40,7 +43,9 @@ export type ResetClaimEligibilityParams = GetClaimConditionsParams;
  * ```
  */
 export function resetClaimEligibility(
-  options: BaseTransactionOptions<ResetClaimEligibilityParams> & {
+  options: BaseTransactionOptions<
+    WithOverrides<ResetClaimEligibilityParams>
+  > & {
     singlePhaseDrop?: boolean;
   },
 ) {
@@ -79,6 +84,7 @@ export function resetClaimEligibility(
         };
       },
       contract: options.contract,
+      overrides: options.overrides,
     });
   }
   // download existing conditions
@@ -101,6 +107,7 @@ export function resetClaimEligibility(
       };
     },
     contract: options.contract,
+    overrides: options.overrides,
   });
 }
 

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

@@ -1,4 +1,7 @@
-import type { BaseTransactionOptions } from "../../../../transaction/types.js";
+import type {
+  BaseTransactionOptions,
+  WithOverrides,
+} from "../../../../transaction/types.js";
 import { getMulticallSetClaimConditionTransactions } from "../../../../utils/extensions/drops/get-multicall-set-claim-claim-conditon-transactions.js";
 import type { ClaimConditionsInput } from "../../../../utils/extensions/drops/types.js";
 import { isSetContractURISupported } from "../../../common/__generated__/IContractMetadata/write/setContractURI.js";
@@ -49,7 +52,7 @@ export type SetClaimConditionsParams = {
  * ```
  */
 export function setClaimConditions(
-  options: BaseTransactionOptions<SetClaimConditionsParams>,
+  options: BaseTransactionOptions<WithOverrides<SetClaimConditionsParams>>,
 ) {
   return multicall({
     asyncParams: async () => {
@@ -65,6 +68,7 @@ export function setClaimConditions(
       };
     },
     contract: options.contract,
+    overrides: options.overrides,
   });
 }
 

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

@@ -1,4 +1,7 @@
-import type { BaseTransactionOptions } from "../../../../transaction/types.js";
+import type {
+  BaseTransactionOptions,
+  WithOverrides,
+} from "../../../../transaction/types.js";
 import type { NFT, NFTInput } from "../../../../utils/nft/parseNft.js";
 import * as BaseURICount from "../../../erc721/__generated__/IBatchMintMetadata/read/getBaseURICount.js";
 import * as BatchAtIndex from "../../__generated__/BatchMintMetadata/read/getBatchIdAtIndex.js";
@@ -116,12 +119,13 @@ async function getUpdateMetadataParams(
  * ```
  */
 export function updateMetadata(
-  options: BaseTransactionOptions<UpdateMetadataParams>,
+  options: BaseTransactionOptions<WithOverrides<UpdateMetadataParams>>,
 ) {
   const { contract } = options;
   return BatchBaseURI.updateBatchBaseURI({
     asyncParams: async () => getUpdateMetadataParams(options),
     contract,
+    overrides: options.overrides,
   });
 }
 

packages/thirdweb/src/extensions/erc1155/write/lazyMint.ts

@@ -1,5 +1,8 @@
 import type { FileOrBufferOrString } from "../../../storage/upload/types.js";
-import type { BaseTransactionOptions } from "../../../transaction/types.js";
+import type {
+  BaseTransactionOptions,
+  WithOverrides,
+} from "../../../transaction/types.js";
 import {
   getBaseUriFromBatch,
   uploadOrExtractURIs,
@@ -31,9 +34,9 @@ type NFTInput = Prettify<
 /**
  * @extension ERC1155
  */
-export type LazyMintParams = {
+export type LazyMintParams = WithOverrides<{
   nfts: (NFTInput | string)[];
-};
+}>;
 
 /**
  * Lazily mints ERC1155 tokens.
@@ -83,6 +86,7 @@ export function lazyMint(options: BaseTransactionOptions<LazyMintParams>) {
       } as const;
     },
     contract: options.contract,
+    overrides: options.overrides,
   });
 }
 

packages/thirdweb/src/extensions/erc1155/write/mintAdditionalSupplyTo.ts

@@ -1,15 +1,18 @@
-import type { BaseTransactionOptions } from "../../../transaction/types.js";
+import type {
+  BaseTransactionOptions,
+  WithOverrides,
+} from "../../../transaction/types.js";
 import * as URI from "../__generated__/IERC1155/read/uri.js";
 import * as MintTo from "../__generated__/IMintableERC1155/write/mintTo.js";
 
 /**
  * @extension ERC1155
  */
-export type MintAdditionalSupplyToParams = {
+export type MintAdditionalSupplyToParams = WithOverrides<{
   to: string;
   tokenId: bigint;
   supply: bigint;
-};
+}>;
 
 /**
  * Mints a "supply" number of additional ERC1155 tokens to the specified "to" address.
@@ -46,6 +49,7 @@ export function mintAdditionalSupplyTo(
       };
     },
     contract: options.contract,
+    overrides: options.overrides,
   });
 }
 

packages/thirdweb/src/extensions/erc1155/write/updateTokenURI.ts

@@ -1,5 +1,8 @@
 import { upload } from "../../../storage/upload.js";
-import type { BaseTransactionOptions } from "../../../transaction/types.js";
+import type {
+  BaseTransactionOptions,
+  WithOverrides,
+} from "../../../transaction/types.js";
 import type { NFTInput } from "../../../utils/nft/parseNft.js";
 import {
   type SetTokenURIParams,
@@ -10,10 +13,10 @@ export { isSetTokenURISupported as isUpdateTokenURISupported } from "../../erc11
 /**
  * @extension ERC1155
  */
-export type UpdateTokenURIParams = {
+export type UpdateTokenURIParams = WithOverrides<{
   tokenId: bigint;
   newMetadata: NFTInput;
-};
+}>;
 
 /**
  * This function is an abstracted layer of the [`setTokenURI` extension](https://portal.thirdweb.com/references/typescript/v5/erc1155/setTokenURI),
@@ -47,6 +50,7 @@ export function updateTokenURI(
   return setTokenURI({
     asyncParams: async () => getUpdateTokenParams(options),
     contract,
+    overrides: options.overrides,
   });
 }
 

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

@@ -1,5 +1,8 @@
 import type { Address } from "abitype";
-import type { BaseTransactionOptions } from "../../../../transaction/types.js";
+import type {
+  BaseTransactionOptions,
+  WithOverrides,
+} from "../../../../transaction/types.js";
 import { getClaimParams } from "../../../../utils/extensions/drops/get-claim-params.js";
 import { isGetContractMetadataSupported } from "../../../common/read/getContractMetadata.js";
 import * as GeneratedClaim from "../../__generated__/IDropERC20/write/claim.js";
@@ -51,7 +54,9 @@ export type ClaimToParams = {
  * @throws If no claim condition is set
  * @returns A promise that resolves with the submitted transaction hash.
  */
-export function claimTo(options: BaseTransactionOptions<ClaimToParams>) {
+export function claimTo(
+  options: BaseTransactionOptions<WithOverrides<ClaimToParams>>,
+) {
   return GeneratedClaim.claim({
     asyncParams: async () => {
       const quantity = await (async () => {
@@ -77,6 +82,7 @@ export function claimTo(options: BaseTransactionOptions<ClaimToParams>) {
       });
     },
     contract: options.contract,
+    overrides: options.overrides,
   });
 }