Properly type purchaseData as Record<string, unknown>

.changeset/orange-files-admire.md

@@ -0,0 +1,5 @@
+---
+"thirdweb": patch
+---
+
+properly type purchaseData

packages/thirdweb/src/bridge/Buy.ts

@@ -1,6 +1,7 @@
 import type { Address as ox__Address } from "ox";
 import { defineChain } from "../chains/utils.js";
 import type { ThirdwebClient } from "../client/client.js";
+import type { PurchaseData } from "../pay/types.js";
 import { getThirdwebBaseUrl } from "../utils/domains.js";
 import { getClientFetch } from "../utils/fetch.js";
 import { stringify } from "../utils/json.js";
@@ -413,7 +414,7 @@ export declare namespace prepare {
     receiver: ox__Address.Address;
     amount: bigint;
     client: ThirdwebClient;
-    purchaseData?: unknown;
+    purchaseData?: PurchaseData;
     maxSteps?: number;
     /**
      * @hidden
@@ -430,7 +431,7 @@ export declare namespace prepare {
       amount: bigint;
       sender: ox__Address.Address;
       receiver: ox__Address.Address;
-      purchaseData?: unknown;
+      purchaseData?: PurchaseData;
     };
   };
 }

packages/thirdweb/src/bridge/Onramp.ts

@@ -1,6 +1,7 @@
 import type { Address as ox__Address } from "ox";
 import { defineChain } from "../chains/utils.js";
 import type { ThirdwebClient } from "../client/client.js";
+import type { PurchaseData } from "../pay/types.js";
 import { getThirdwebBaseUrl } from "../utils/domains.js";
 import { getClientFetch } from "../utils/fetch.js";
 import { stringify } from "../utils/json.js";
@@ -17,7 +18,7 @@ type OnrampIntent = {
   tokenAddress: ox__Address.Address;
   receiver: ox__Address.Address;
   amount?: string; // Corresponds to buyAmountWei in some other contexts
-  purchaseData?: unknown;
+  purchaseData?: PurchaseData;
   sender?: ox__Address.Address;
   onrampTokenAddress?: ox__Address.Address;
   onrampChainId?: number;
@@ -46,7 +47,7 @@ interface OnrampApiRequestBody {
   tokenAddress: ox__Address.Address;
   receiver: ox__Address.Address;
   amount?: string;
-  purchaseData?: unknown;
+  purchaseData?: PurchaseData;
   sender?: ox__Address.Address;
   onrampTokenAddress?: ox__Address.Address;
   onrampChainId?: number;
@@ -265,7 +266,7 @@ export declare namespace prepare {
     tokenAddress: ox__Address.Address;
     receiver: ox__Address.Address;
     amount?: bigint;
-    purchaseData?: unknown;
+    purchaseData?: PurchaseData;
     sender?: ox__Address.Address;
     onrampTokenAddress?: ox__Address.Address;
     onrampChainId?: number;

packages/thirdweb/src/bridge/OnrampStatus.ts

@@ -1,5 +1,6 @@
 import type { Hex as ox__Hex } from "ox";
 import type { ThirdwebClient } from "../client/client.js";
+import type { PurchaseData } from "../pay/types.js";
 import { getThirdwebBaseUrl } from "../utils/domains.js";
 import { getClientFetch } from "../utils/fetch.js";
 import { ApiError } from "./types/Errors.js";
@@ -108,30 +109,30 @@ export declare namespace status {
           chainId: number;
           transactionHash: ox__Hex.Hex;
         }>;
-        purchaseData?: unknown;
+        purchaseData?: PurchaseData;
       }
     | {
         status: "PENDING";
         transactions: Array<{
           chainId: number;
           transactionHash: ox__Hex.Hex;
         }>;
-        purchaseData?: unknown;
+        purchaseData?: PurchaseData;
       }
     | {
         status: "CREATED";
         transactions: Array<{
           chainId: number;
           transactionHash: ox__Hex.Hex;
         }>;
-        purchaseData?: unknown;
+        purchaseData?: PurchaseData;
       }
     | {
         status: "FAILED";
         transactions: Array<{
           chainId: number;
           transactionHash: ox__Hex.Hex;
         }>;
-        purchaseData?: unknown;
+        purchaseData?: PurchaseData;
       };
 }

packages/thirdweb/src/bridge/Sell.ts

@@ -1,6 +1,7 @@
 import type { Address as ox__Address } from "ox";
 import { defineChain } from "../chains/utils.js";
 import type { ThirdwebClient } from "../client/client.js";
+import type { PurchaseData } from "../pay/types.js";
 import { getThirdwebBaseUrl } from "../utils/domains.js";
 import { getClientFetch } from "../utils/fetch.js";
 import { stringify } from "../utils/json.js";
@@ -402,7 +403,7 @@ export declare namespace prepare {
     sender: ox__Address.Address;
     receiver: ox__Address.Address;
     client: ThirdwebClient;
-    purchaseData?: unknown;
+    purchaseData?: PurchaseData;
     maxSteps?: number;
     /**
      * @hidden
@@ -419,7 +420,7 @@ export declare namespace prepare {
       amount: bigint;
       sender: ox__Address.Address;
       receiver: ox__Address.Address;
-      purchaseData?: unknown;
+      purchaseData?: PurchaseData;
     };
   };
 }

packages/thirdweb/src/bridge/Transfer.ts

@@ -1,6 +1,7 @@
 import type { Address as ox__Address } from "ox";
 import { defineChain } from "../chains/utils.js";
 import type { ThirdwebClient } from "../client/client.js";
+import type { PurchaseData } from "../pay/types.js";
 import { getThirdwebBaseUrl } from "../utils/domains.js";
 import { getClientFetch } from "../utils/fetch.js";
 import { stringify } from "../utils/json.js";
@@ -258,7 +259,7 @@ export declare namespace prepare {
     receiver: ox__Address.Address;
     amount: bigint;
     client: ThirdwebClient;
-    purchaseData?: unknown;
+    purchaseData?: PurchaseData;
     feePayer?: "sender" | "receiver";
     /**
      * @hidden
@@ -273,7 +274,7 @@ export declare namespace prepare {
       amount: bigint;
       sender: ox__Address.Address;
       receiver: ox__Address.Address;
-      purchaseData?: unknown;
+      purchaseData?: PurchaseData;
       feePayer?: "sender" | "receiver";
     };
   };

packages/thirdweb/src/bridge/types/Status.ts

@@ -1,4 +1,5 @@
 import type { Address as ox__Address, Hex as ox__Hex } from "ox";
+import type { PurchaseData } from "../../pay/types.js";
 import type { Token } from "./Token.js";
 export type Status =
   | {
@@ -18,7 +19,7 @@ export type Status =
         chainId: number;
         transactionHash: ox__Hex.Hex;
       }>;
-      purchaseData?: unknown;
+      purchaseData?: PurchaseData;
     }
   | {
       status: "PENDING";
@@ -36,7 +37,7 @@ export type Status =
         chainId: number;
         transactionHash: ox__Hex.Hex;
       }>;
-      purchaseData?: unknown;
+      purchaseData?: PurchaseData;
     }
   | {
       status: "FAILED";
@@ -45,7 +46,7 @@ export type Status =
         chainId: number;
         transactionHash: ox__Hex.Hex;
       }>;
-      purchaseData?: unknown;
+      purchaseData?: PurchaseData;
     }
   | {
       status: "NOT_FOUND";

packages/thirdweb/src/pay/buyWithCrypto/getQuote.ts

@@ -7,6 +7,7 @@ import { NATIVE_TOKEN_ADDRESS } from "../../constants/addresses.js";
 import { getContract } from "../../contract/contract.js";
 import { decimals } from "../../extensions/erc20/read/decimals.js";
 import type { PrepareTransactionOptions } from "../../transaction/prepare-transaction.js";
+import type { PurchaseData } from "../types.js";
 import type {
   QuoteApprovalInfo,
   QuotePaymentToken,
@@ -76,7 +77,7 @@ export type GetBuyWithCryptoQuoteParams = {
    *
    * This details will be stored with the purchase and can be retrieved later via the status API or Webhook
    */
-  purchaseData?: object;
+  purchaseData?: PurchaseData;
 
   /**
    * The maximum slippage in basis points (bps) allowed for the swap.

packages/thirdweb/src/pay/buyWithCrypto/getStatus.ts

@@ -3,6 +3,7 @@
 import type { ThirdwebClient } from "../../client/client.js";
 import type { Hex } from "../../utils/encoding/hex.js";
 import { toTokens } from "../../utils/units.js";
+import type { PurchaseData } from "../types.js";
 import type {
   PayOnChainTransactionDetails,
   PayTokenInfo,
@@ -80,7 +81,7 @@
       toAddress: string;
       failureMessage?: string;
       bridge?: string;
-      purchaseData?: object;
+      purchaseData?: PurchaseData;
     };
 
 export type ValidBuyWithCryptoStatus = Exclude<
@@ -162,7 +163,7 @@
           originTokenAddress: result.originTokenAddress,
           originTransaction,
           paymentId: result.paymentId,
-          purchaseData: result.purchaseData as object | undefined,
+          purchaseData: result.purchaseData,
           receiver: result.receiver,
           sender: result.sender,
           status: result.status,
@@ -178,7 +179,7 @@
           originToken: result.originToken,
           originTokenAddress: result.originTokenAddress,
           paymentId: result.paymentId,
-          purchaseData: result.purchaseData as object | undefined,
+          purchaseData: result.purchaseData,
           receiver: result.receiver,
           sender: result.sender,
           status: result.status,
@@ -202,7 +203,7 @@
           originTokenAddress: "",
           originTransaction,
           paymentId: "",
-          purchaseData: result.purchaseData as object | undefined,
+          purchaseData: result.purchaseData,
           receiver: "",
           sender: "",
           status: result.status,
@@ -230,7 +231,7 @@
   originChainId: number;
   destinationChainId: number;
   status: Status["status"];
-  purchaseData?: object;
+  purchaseData?: PurchaseData;
   sender: string;
   receiver: string;
   paymentId: string;
@@ -277,7 +278,7 @@
       transactionHash: destinationTransaction?.transactionHash ?? "",
     },
     fromAddress: sender,
-    purchaseData: purchaseData as object | undefined, // TODO transfer type?
+    purchaseData: purchaseData,
     quote: {
       createdAt: new Date().toISOString(),
       estimated: {

packages/thirdweb/src/pay/buyWithCrypto/getTransfer.ts

@@ -7,6 +7,7 @@ import { NATIVE_TOKEN_ADDRESS } from "../../constants/addresses.js";
 import { getContract } from "../../contract/contract.js";
 import { decimals } from "../../extensions/erc20/read/decimals.js";
 import type { PrepareTransactionOptions } from "../../transaction/prepare-transaction.js";
+import type { PurchaseData } from "../types.js";
 import type { QuoteApprovalInfo, QuotePaymentToken } from "./commonTypes.js";
 
 /**
@@ -54,7 +55,7 @@ export type GetBuyWithCryptoTransferParams = {
    *
    * This details will be stored with the purchase and can be retrieved later via the status API or Webhook
    */
-  purchaseData?: object;
+  purchaseData?: PurchaseData;
 
   /**
    * For direct transfers, specify who will pay for the transfer fee. Can be "sender" or "receiver".

packages/thirdweb/src/pay/buyWithFiat/getQuote.ts

@@ -6,6 +6,7 @@ import { getContract } from "../../contract/contract.js";
 import { decimals } from "../../extensions/erc20/read/decimals.js";
 import type { CurrencyMeta } from "../../react/web/ui/ConnectWallet/screens/Buy/fiat/currencies.js";
 import { toTokens, toUnits } from "../../utils/units.js";
+import type { PurchaseData } from "../types.js";
 import type { FiatProvider, PayTokenInfo } from "../utils/commonTypes.js";
 /**
  * Parameters for [`getBuyWithFiatQuote`](https://portal.thirdweb.com/references/typescript/v5/getBuyWithFiatQuote) function
@@ -80,7 +81,7 @@ export type GetBuyWithFiatQuoteParams = {
    *
    * This details will be stored with the purchase and can be retrieved later via the status API or Webhook
    */
-  purchaseData?: object;
+  purchaseData?: PurchaseData;
 
   /**
    * Optional parameter to onramp gas with the purchase

packages/thirdweb/src/pay/buyWithFiat/getStatus.ts

@@ -1,5 +1,6 @@
 import { status as onrampStatus } from "../../bridge/OnrampStatus.js";
 import type { ThirdwebClient } from "../../client/client.js";
+import type { PurchaseData } from "../types.js";
 import type {
   PayOnChainTransactionDetails,
   PayTokenInfo,
@@ -109,7 +110,7 @@
       /**
        * Arbitrary data sent at the time of fetching the quote
        */
-      purchaseData?: object;
+      purchaseData?: PurchaseData;
     };
 
 /**
@@ -202,7 +203,7 @@
     | "PENDING_PAYMENT"
     | "PAYMENT_FAILED"
     | "ON_RAMP_TRANSFER_COMPLETED";
-  purchaseData?: unknown;
+  purchaseData?: PurchaseData;
 }): BuyWithFiatStatus {
   const { intentId, status, purchaseData } = args;
 
@@ -253,7 +254,7 @@
   const base: Exclude<BuyWithFiatStatus, { status: "NOT_FOUND" }> = {
     fromAddress: "",
     intentId,
-    purchaseData: purchaseData as object | undefined,
+    purchaseData,
     quote,
     status,
     toAddress: "",

packages/thirdweb/src/pay/types.ts

@@ -0,0 +1 @@
+export type PurchaseData = Record<string, unknown>;

packages/thirdweb/src/react/core/hooks/connection/ConnectButtonProps.ts

@@ -4,6 +4,7 @@ import type { ThirdwebClient } from "../../../../client/client.js";
 import type { BuyWithCryptoStatus } from "../../../../pay/buyWithCrypto/getStatus.js";
 import type { BuyWithFiatStatus } from "../../../../pay/buyWithFiat/getStatus.js";
 import type { SupportedFiatCurrency } from "../../../../pay/convert/type.js";
+import type { PurchaseData } from "../../../../pay/types.js";
 import type { FiatProvider } from "../../../../pay/utils/commonTypes.js";
 import type { AssetTabs } from "../../../../react/web/ui/ConnectWallet/screens/ViewAssets.js";
 import type { PreparedTransaction } from "../../../../transaction/prepare-transaction.js";
@@ -117,7 +118,7 @@ export type PayUIOptions = Prettify<
      *
      * This details will be stored with the purchase and can be retrieved later via the status API or Webhook
      */
-    purchaseData?: object;
+    purchaseData?: PurchaseData;
 
     /**
      * Callback to be called when the user successfully completes the purchase.

packages/thirdweb/src/react/core/hooks/transaction/useSendTransaction.ts

@@ -6,6 +6,7 @@ import * as Bridge from "../../../../bridge/index.js";
 import type { Chain } from "../../../../chains/types.js";
 import type { BuyWithCryptoStatus } from "../../../../pay/buyWithCrypto/getStatus.js";
 import type { BuyWithFiatStatus } from "../../../../pay/buyWithFiat/getStatus.js";
+import type { PurchaseData } from "../../../../pay/types.js";
 import type { FiatProvider } from "../../../../pay/utils/commonTypes.js";
 import type { GaslessOptions } from "../../../../transaction/actions/gasless/types.js";
 import { sendTransaction } from "../../../../transaction/actions/send-transaction.js";
@@ -65,7 +66,7 @@ export type SendTransactionPayModalConfig =
             testMode?: boolean;
             preferredProvider?: FiatProvider;
           };
-      purchaseData?: object;
+      purchaseData?: PurchaseData;
       /**
        * Callback to be called when the user successfully completes the purchase.
        */

packages/thirdweb/src/react/web/ui/Bridge/BridgeOrchestrator.tsx

@@ -2,6 +2,7 @@
 import { useCallback, useMemo } from "react";
 import type { Token } from "../../../../bridge/types/Token.js";
 import type { ThirdwebClient } from "../../../../client/client.js";
+import type { PurchaseData } from "../../../../pay/types.js";
 import type { PreparedTransaction } from "../../../../transaction/prepare-transaction.js";
 import type { Address } from "../../../../utils/address.js";
 import { webLocalStorage } from "../../../../utils/storage/webStorage.js";
@@ -102,7 +103,7 @@ export interface BridgeOrchestratorProps {
   /**
    * Optional purchase data for the payment
    */
-  purchaseData: object | undefined;
+  purchaseData?: PurchaseData;
 
   /**
    * Optional payment link ID for the payment