thirdweb 5.38.0 → 5.38.1-nightly-c82c524e139d7960794e08bca838a1a1b78a3532-20240725000333

package/src/extensions/prebuilts/deploy-erc20.ts

@@ -11,6 +11,9 @@ import { initialize as initTokenERC20 } from "./__generated__/TokenERC20/write/i
 
 export type ERC20ContractType = "DropERC20" | "TokenERC20";
 
+/**
+ * @extension DEPLOY
+ */
 export type ERC20ContractParams = {
   name: string;
   description?: string;
@@ -26,6 +29,9 @@ export type ERC20ContractParams = {
   trustedForwarders?: string[];
 };
 
+/**
+ * @extension DEPLOY
+ */
 export type DeployERC20ContractOptions = Prettify<
   ClientAndChainAndAccount & {
     type: ERC20ContractType;

package/src/extensions/prebuilts/deploy-erc721.ts

@@ -10,11 +10,17 @@ import { initialize as initDropERC721 } from "./__generated__/DropERC721/write/i
 import { initialize as initOpenEditionERC721 } from "./__generated__/OpenEditionERC721/write/initialize.js";
 import { initialize as initTokenERC721 } from "./__generated__/TokenERC721/write/initialize.js";
 
+/**
+ * @extension DEPLOY
+ */
 export type ERC721ContractType =
   | "DropERC721"
   | "TokenERC721"
   | "OpenEditionERC721";
 
+/**
+ * @extension DEPLOY
+ */
 export type ERC721ContractParams = {
   name: string;
   description?: string;
@@ -32,6 +38,9 @@ export type ERC721ContractParams = {
   trustedForwarders?: string[];
 };
 
+/**
+ * @extension DEPLOY
+ */
 export type DeployERC721ContractOptions = Prettify<
   ClientAndChainAndAccount & {
     type: ERC721ContractType;

package/src/extensions/prebuilts/deploy-published.ts

@@ -9,6 +9,9 @@ import { prepareContractCall } from "../../transaction/prepare-contract-call.js"
 import { resolveMethod } from "../../transaction/resolve-method.js";
 import type { Account } from "../../wallets/interfaces/wallet.js";
 
+/**
+ * @extension DEPLOY
+ */
 export type DeployPublishedContractOptions = {
   client: ThirdwebClient;
   chain: Chain;

package/src/extensions/uniswap/read/getUniswapV3Pools.ts

@@ -5,12 +5,16 @@ import { UniswapFee } from "../types.js";
 
 /**
  * Represents the parameters for the `findUniswapV3Pool` function.
+ * @extension UNISWAP
  */
 export type GetUniswapV3PoolParams = {
   tokenA: Address;
   tokenB: Address;
 };
 
+/**
+ * @extension UNISWAP
+ */
 export type GetUniswapV3PoolResult = {
   poolFee: UniswapFee;
   poolAddress: Address;

package/src/gas/fee-data.ts

@@ -150,7 +150,7 @@ async function getDynamicFeeData(
     return { maxFeePerGas: null, maxPriorityFeePerGas: null };
     // mumbai & polygon
   }
-  if (chainId === 80001 || chainId === 137) {
+  if (chainId === 80002 || chainId === 137) {
     // for polygon, get fee data from gas station
     maxPriorityFeePerGas_ = await getPolygonGasPriorityFee(chainId);
   } else if (maxPriorityFeePerGas) {
@@ -200,37 +200,23 @@ function getPreferredPriorityFee(
 /**
  * @internal
  */
-function getGasStationUrl(chainId: 137 | 80001): string {
+function getGasStationUrl(chainId: 137 | 80002): string {
   switch (chainId) {
     case 137:
       return "https://gasstation.polygon.technology/v2";
-    case 80001:
+    case 80002:
       return "https://gasstation-testnet.polygon.technology/v2";
   }
 }
 
 const MIN_POLYGON_GAS_PRICE = 31n; // 31 gwei
 
-const MIN_MUMBAI_GAS_PRICE = 1n; // 1 gwei
-
-/**
- * @internal
- */
-function getDefaultGasFee(chainId: 137 | 80001): bigint {
-  switch (chainId) {
-    case 137:
-      return MIN_POLYGON_GAS_PRICE;
-    case 80001:
-      return MIN_MUMBAI_GAS_PRICE;
-  }
-}
-
 /**
  *
  * @returns The gas price
  * @internal
  */
-async function getPolygonGasPriorityFee(chainId: 137 | 80001): Promise<bigint> {
+async function getPolygonGasPriorityFee(chainId: 137 | 80002): Promise<bigint> {
   const gasStationUrl = getGasStationUrl(chainId);
   try {
     const data = await (await fetch(gasStationUrl)).json();
@@ -243,5 +229,5 @@ async function getPolygonGasPriorityFee(chainId: 137 | 80001): Promise<bigint> {
   } catch (e) {
     console.error("failed to fetch gas", e);
   }
-  return getDefaultGasFee(chainId);
+  return MIN_POLYGON_GAS_PRICE;
 }

package/src/pay/buyWithCrypto/getQuote.ts

@@ -14,6 +14,7 @@ import { getPayBuyWithCryptoQuoteEndpoint } from "../utils/definitions.js";
 /**
  * The parameters for [`getBuyWithCryptoQuote`](https://portal.thirdweb.com/references/typescript/v5/getBuyWithCryptoQuote) function
  * It includes information about which tokens to swap, the amount of tokens to swap, slippage, etc.
+ * @buyCrypto
  */
 export type GetBuyWithCryptoQuoteParams = {
   /**
@@ -103,6 +104,9 @@ export type GetBuyWithCryptoQuoteParams = {
     }
 );
 
+/**
+ * @buyCrypto
+ */
 export type QuoteTokenInfo = {
   chainId: number;
   tokenAddress: string;
@@ -169,8 +173,14 @@ type BuyWithCryptoQuoteRouteResponse = {
   bridge?: string;
 };
 
+/**
+ * @buyCrypto
+ */
 export type QuoteApprovalParams = BaseTransactionOptions<ApproveParams>;
 
+/**
+ * @buyCrypto
+ */
 export type BuyWithCryptoQuote = {
   transactionRequest: PrepareTransactionOptions;
   approval?: PrepareTransactionOptions;

package/src/pay/buyWithCrypto/getStatus.ts

@@ -8,6 +8,9 @@ import { getPayBuyWithCryptoStatusUrl } from "../utils/definitions.js";
 
 // TODO: add JSDoc description for all properties
 
+/**
+ * @buyCrypto
+ */
 export type BuyWithCryptoQuoteSummary = {
   fromToken: PayTokenInfo;
   toToken: PayTokenInfo;
@@ -34,6 +37,9 @@ export type BuyWithCryptoQuoteSummary = {
   createdAt: string; // ISO DATE
 };
 
+/**
+ * @buyCrypto
+ */
 export type BuyWithCryptoTransaction = {
   client: ThirdwebClient;
   transactionHash: string;

package/src/pay/buyWithFiat/getPostOnRampQuote.ts

@@ -7,6 +7,7 @@ import type { BuyWithFiatStatus } from "./getStatus.js";
 
 /**
  * The parameters for [`getPostOnRampQuote`](https://portal.thirdweb.com/references/typescript/v5/getPostOnRampQuote) function
+ * @buyCrypto
  */
 export type GetPostOnRampQuoteParams = {
   /**

package/src/pay/buyWithFiat/getQuote.ts

@@ -4,6 +4,7 @@ import { getPayBuyWithFiatQuoteEndpoint } from "../utils/definitions.js";
 
 /**
  * Parameters for [`getBuyWithFiatQuote`](https://portal.thirdweb.com/references/typescript/v5/getBuyWithFiatQuote) function
+ * @buyCrypto
  */
 export type GetBuyWithFiatQuoteParams = {
   /**
@@ -84,6 +85,8 @@ export type GetBuyWithFiatQuoteParams = {
  * - The estimated time for the transaction to complete.
  * - The on-ramp and destination token information.
  * - Processing fees
+ *
+ * @buyCrypto
  */
 export type BuyWithFiatQuote = {
   /**

package/src/pay/buyWithFiat/getStatus.ts

@@ -8,6 +8,7 @@ import { getPayBuyWithFiatStatusEndpoint } from "../utils/definitions.js";
 
 /**
  * Parameters for the [`getBuyWithFiatStatus`](https://portal.thirdweb.com/references/typescript/v5/getBuyWithFiatStatus) function
+ * @buyCrypto
  */
 export type GetBuyWithFiatStatusParams = {
   /**
@@ -32,6 +33,7 @@ export type ValidBuyWithFiatStatus = Exclude<
  * The returned object from [`getBuyWithFiatStatus`](https://portal.thirdweb.com/references/typescript/v5/getBuyWithFiatStatus) function
  *
  * If the in invalid intentId is provided, the object will have a status of "NOT_FOUND" and no other fields.
+ * @buyCrypto
  */
 export type BuyWithFiatStatus =
   | {

package/src/pay/getBuyHistory.ts

@@ -6,6 +6,7 @@ import { getPayBuyHistoryEndpoint } from "./utils/definitions.js";
 
 /**
  * The parameters for [`getBuyHistory`](https://portal.thirdweb.com/references/typescript/v5/getBuyHistory) function
+ * @buyCrypto
  */
 export type BuyHistoryParams = {
   /**
@@ -35,6 +36,8 @@ export type BuyHistoryParams = {
  * The result for [`getBuyHistory`](https://portal.thirdweb.com/references/typescript/v5/getBuyWithCryptoHistory) function
  *
  * It includes both "Buy with Crypto" and "Buy with Fiat" transactions
+ *
+ * @buyCrypto
  */
 export type BuyHistoryData = {
   /**

package/src/react/web/ui/ConnectWallet/NetworkSelector.tsx

@@ -897,6 +897,7 @@ export type UseNetworkSwitcherModalOptions = {
  *   return <button onClick={handleClick}> Switch Network </button>
  * }
  * ```
+ * @wallet
  */
 export function useNetworkSwitcherModal() {
   const activeChain = useActiveWalletChain();

package/src/react/web/ui/ConnectWallet/screens/SendFunds.tsx

@@ -181,7 +181,9 @@ function SendFundsForm(props: {
           color="danger"
         >
           <CrossCircledIcon width={iconSize.xl} height={iconSize.xl} />
-          <Text color="danger">{getErrorMessage(sendTokenMutation.error)}</Text>
+          <Text center multiline color="danger">
+            {getErrorMessage(sendTokenMutation.error)}
+          </Text>
         </Container>
       </Container>
     );
@@ -336,10 +338,10 @@ function SendFundsForm(props: {
             padding: spacing.md,
           }}
         >
-          {sendTokenMutation.isPending ? locale.sending : locale.submitButton}
           {sendTokenMutation.isPending && (
             <Spinner size="sm" color="accentButtonText" />
           )}
+          {sendTokenMutation.isPending ? locale.sending : locale.submitButton}
         </Button>
       </form>
     </Container>

package/src/react/web/ui/PayEmbed.test.tsx

@@ -4,19 +4,16 @@ import { render } from "../../../../test/src/react-render.js";
 import { TEST_CLIENT } from "../../../../test/src/test-clients.js";
 import { PayEmbed } from "./PayEmbed.js";
 
-describe.runIf(process.env.TW_SECRET_KEY)(
+describe.runIf(!!process.env.TW_SECRET_KEY)(
   "PayEmbed - Connected state",
-  async () => {
-    const { findByRole } = render(<PayEmbed client={TEST_CLIENT} />, {
-      setConnectedWallet: true,
-    });
-
-    // continue button is shown
-    const connectWalletButton = await findByRole("button", {
-      name: "Continue",
-    });
-
+  () => {
     it("continue button is disabled if no token amount is set", async () => {
+      const { findByRole } = render(<PayEmbed client={TEST_CLIENT} />, {
+        setConnectedWallet: true,
+      });
+      const connectWalletButton: HTMLElement = await findByRole("button", {
+        name: "Continue",
+      });
       // continue button is disabled when no amount is entered
       expect(connectWalletButton).toBeDisabled();
 

package/src/react/web/ui/prebuilt/thirdweb/ClaimButton/ClaimButton.test.tsx

@@ -0,0 +1,271 @@
+import { describe, expect, it } from "vitest";
+import { ANVIL_CHAIN } from "~test/chains.js";
+import { TEST_CONTRACT_URI } from "~test/ipfs-uris.js";
+import { render, screen } from "~test/react-render.js";
+import { TEST_CLIENT } from "~test/test-clients.js";
+import { DOODLES_CONTRACT, USDT_CONTRACT } from "~test/test-contracts.js";
+import { TEST_ACCOUNT_A } from "~test/test-wallets.js";
+import { getContract } from "../../../../../../contract/contract.js";
+import { deployERC20Contract } from "../../../../../../extensions/prebuilts/deploy-erc20.js";
+import { deployERC721Contract } from "../../../../../../extensions/prebuilts/deploy-erc721.js";
+import { deployERC1155Contract } from "../../../../../../extensions/prebuilts/deploy-erc1155.js";
+import type { Hex } from "../../../../../../utils/encoding/helpers/is-hex.js";
+import {
+  ClaimButton,
+  getERC20ClaimTo,
+  getERC721ClaimTo,
+  getERC1155ClaimTo,
+} from "./index.js";
+
+const account = TEST_ACCOUNT_A;
+const client = TEST_CLIENT;
+const chain = ANVIL_CHAIN;
+
+/**
+ * The ClaimButton uses TransactionButton under the hood
+ * So all we need to test is whether it gives the correct PreparedTransaction to the TransactionButton
+ */
+describe.runIf(process.env.TW_SECRET_KEY)("ClaimButton", () => {
+  // ERC721
+  it("should throw an error if not an ERC721 contract", async () => {
+    const contract = USDT_CONTRACT;
+    await expect(() =>
+      getERC721ClaimTo({
+        contract,
+        account,
+        claimParams: { type: "ERC721", quantity: 1n },
+      }),
+    ).rejects.toThrowError("Not an ERC721 contract");
+  });
+
+  it("should throw an error if is an ERC721 but not an NFT Drop contract", async () => {
+    const contract = DOODLES_CONTRACT;
+    await expect(() =>
+      getERC721ClaimTo({
+        contract,
+        account,
+        claimParams: { type: "ERC721", quantity: 1n },
+      }),
+    ).rejects.toThrowError("Not a valid NFT Drop (ERC721) contract");
+  });
+
+  it("should work for an NFT Drop contract", async () => {
+    const address = await deployERC721Contract({
+      client,
+      chain,
+      account,
+      type: "DropERC721",
+      params: {
+        name: "",
+        contractURI: TEST_CONTRACT_URI,
+      },
+    });
+    const contract = getContract({ address, client, chain });
+    const result = await getERC721ClaimTo({
+      contract,
+      account,
+      claimParams: { type: "ERC721", quantity: 1n },
+    });
+
+    expect(result.to).toBe(address);
+    expect(result.chain.id).toBe(chain.id);
+    expect(result.client.clientId).toBe(client.clientId);
+    expect("data" in result).toBe(true);
+
+    // should also render <ClaimButton />
+    render(
+      <ClaimButton
+        client={client}
+        chain={chain}
+        contractAddress={address as Hex}
+        claimParams={{ quantity: 1n, type: "ERC721" }}
+      >
+        Claim
+      </ClaimButton>,
+    );
+    expect(screen.queryByText("Claim")).toBeInTheDocument();
+    expect(screen.getByRole("button")).toBeInTheDocument();
+  });
+
+  // ERC1155
+  it("should throw an error if not an ERC1155 contract", async () => {
+    const contract = USDT_CONTRACT;
+    await expect(() =>
+      getERC1155ClaimTo({
+        contract,
+        account,
+        claimParams: { type: "ERC1155", quantity: 1n, tokenId: 0n },
+      }),
+    ).rejects.toThrowError("Not a valid ERC1155 contract");
+  });
+
+  it("should throw an error if is an ERC1155 but not an Edition Drop contract", async () => {
+    const address = await deployERC1155Contract({
+      client,
+      chain,
+      account,
+      type: "TokenERC1155",
+      params: {
+        name: "",
+        contractURI: TEST_CONTRACT_URI,
+      },
+    });
+    const contract = getContract({
+      address,
+      client,
+      chain,
+    });
+    await expect(() =>
+      getERC1155ClaimTo({
+        contract,
+        account,
+        claimParams: { type: "ERC1155", quantity: 1n, tokenId: 0n },
+      }),
+    ).rejects.toThrowError("Not a valid thirdweb Edition Drop contract");
+  });
+
+  it("should work for an Edition Drop contract", async () => {
+    const address = await deployERC1155Contract({
+      client,
+      chain,
+      account,
+      type: "DropERC1155",
+      params: {
+        name: "",
+        contractURI: TEST_CONTRACT_URI,
+      },
+    });
+    const contract = getContract({ address, client, chain });
+    const result = await getERC1155ClaimTo({
+      contract,
+      account,
+      claimParams: { type: "ERC1155", quantity: 1n, tokenId: 0n },
+    });
+    expect(result.to).toBe(address);
+    expect(result.chain.id).toBe(chain.id);
+    expect(result.client.clientId).toBe(client.clientId);
+    expect("data" in result).toBe(true);
+
+    // should also render <ClaimButton />
+    render(
+      <ClaimButton
+        client={client}
+        chain={chain}
+        contractAddress={address as Hex}
+        claimParams={{ quantity: 1n, type: "ERC1155", tokenId: 0n }}
+      >
+        Claim
+      </ClaimButton>,
+    );
+    expect(screen.queryByText("Claim")).toBeInTheDocument();
+    expect(screen.getByRole("button")).toBeInTheDocument();
+  });
+
+  // ERC20
+  it("should throw an error if not an DropERC20 contract", async () => {
+    const contract = DOODLES_CONTRACT;
+    await expect(() =>
+      getERC20ClaimTo({
+        contract,
+        account,
+        claimParams: { type: "ERC20", quantity: "1" },
+      }),
+    ).rejects.toThrowError("Not a valid thirdweb Token Drop contract");
+  });
+
+  it("should throw an error if claim quantity / quantityInWei is not passed", async () => {
+    const address = await deployERC20Contract({
+      client,
+      chain,
+      account,
+      type: "DropERC20",
+      params: {
+        name: "",
+        contractURI: TEST_CONTRACT_URI,
+      },
+    });
+    const contract = getContract({ address, chain, client });
+    await expect(() =>
+      getERC20ClaimTo({
+        contract,
+        account,
+        // @ts-ignore Intended for the test
+        claimParams: { type: "ERC20" },
+      }),
+    ).rejects.toThrowError("Missing quantity or quantityInWei");
+  });
+
+  it("should work for an Token Drop contract + quantity", async () => {
+    const address = await deployERC20Contract({
+      client,
+      chain,
+      account,
+      type: "DropERC20",
+      params: {
+        name: "",
+        contractURI: TEST_CONTRACT_URI,
+      },
+    });
+    const contract = getContract({ address, chain, client });
+    const result = await getERC20ClaimTo({
+      contract,
+      account,
+      claimParams: { type: "ERC20", quantity: "1" },
+    });
+    expect(result.to).toBe(address);
+    expect(result.chain.id).toBe(chain.id);
+    expect(result.client.clientId).toBe(client.clientId);
+    expect("data" in result).toBe(true);
+
+    // should also render <ClaimButton />
+    render(
+      <ClaimButton
+        client={client}
+        chain={chain}
+        contractAddress={address as Hex}
+        claimParams={{ quantity: "100", type: "ERC20" }}
+      >
+        Claim
+      </ClaimButton>,
+    );
+    expect(screen.queryByText("Claim")).toBeInTheDocument();
+    expect(screen.getByRole("button")).toBeInTheDocument();
+  });
+
+  it("should work for an Token Drop contract + quantityInWei", async () => {
+    const address = await deployERC20Contract({
+      client,
+      chain,
+      account,
+      type: "DropERC20",
+      params: {
+        name: "",
+        contractURI: TEST_CONTRACT_URI,
+      },
+    });
+    const contract = getContract({ address, chain, client });
+    const result = await getERC20ClaimTo({
+      contract,
+      account,
+      claimParams: { type: "ERC20", quantityInWei: 1000000n },
+    });
+    expect(result.to).toBe(address);
+    expect(result.chain.id).toBe(chain.id);
+    expect(result.client.clientId).toBe(client.clientId);
+    expect("data" in result).toBe(true);
+
+    // should also render <ClaimButton />
+    render(
+      <ClaimButton
+        client={client}
+        chain={chain}
+        contractAddress={address as Hex}
+        claimParams={{ quantityInWei: 1000000n, type: "ERC20" }}
+      >
+        Claim
+      </ClaimButton>,
+    );
+    expect(screen.queryByText("Claim")).toBeInTheDocument();
+    expect(screen.getByRole("button")).toBeInTheDocument();
+  });
+});