[SDK] Add 2 new Pay functions: convertFiatToCrypto and convertCryptoToFiat (#5457)

kien-ngo · kien-ngo · commit 57fa96b26867 · 2024-12-02T10:21:57.000Z
CNCT-2369 ## Problem solved Short description of the bug fixed or feature added  --- ## PR-Codex overview This PR introduces two new functions for converting between fiat and crypto currencies in the `thirdweb` package, along with corresponding tests and endpoints. ### Detailed summary - Added `convertFiatToCrypto` and `convertCryptoToFiat` functions. - Created endpoints for fiat to crypto and crypto to fiat conversions. - Implemented tests for both conversion functions, covering various scenarios and error handling. - Updated documentation with examples for the new functions. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`
diff --git a/.changeset/stupid-buses-wink.md b/.changeset/stupid-buses-wink.md
@@ -0,0 +1,41 @@
+---
+"thirdweb": minor
+---
+
+Add 2 new Pay functions: convertFiatToCrypto and convertCryptoToFiat
+
+Examples:
+
+### Convert fiat (USD) to crypto
+```ts
+import { convertFiatToCrypto } from "thirdweb/pay";
+import { ethereum } from "thirdweb/chains";
+
+// Convert 2 cents to ETH
+const result = await convertFiatToCrypto({
+  from: "USD",
+  // the token address. For native token, use NATIVE_TOKEN_ADDRESS
+  to: "0x...",
+  // the chain (of the chain where the token belong to)
+  chain: ethereum,
+  // 2 cents
+  fromAmount: 0.02,
+});
+// Result: 0.0000057 (a number)
+```
+
+### Convert crypto to fiat (USD)
+
+```ts
+import { convertCryptoToFiat } from "thirdweb/pay";
+
+// Get Ethereum price
+const result = convertCryptoToFiat({
+  fromTokenAddress: NATIVE_TOKEN_ADDRESS,
+  to: "USD",
+  chain: ethereum,
+  fromAmount: 1,
+});
+
+// Result: 3404.11 (number)
+```
diff --git a/packages/thirdweb/src/exports/pay.ts b/packages/thirdweb/src/exports/pay.ts
@@ -66,3 +66,13 @@ export type {
   PayTokenInfo,
   PayOnChainTransactionDetails,
 } from "../pay/utils/commonTypes.js";
+
+export {
+  convertFiatToCrypto,
+  type ConvertFiatToCryptoParams,
+} from "../pay/convert/fiatToCrypto.js";
+
+export {
+  convertCryptoToFiat,
+  type ConvertCryptoToFiatParams,
+} from "../pay/convert/cryptoToFiat.js";
diff --git a/packages/thirdweb/src/pay/convert/cryptoToFiat.test.ts b/packages/thirdweb/src/pay/convert/cryptoToFiat.test.ts
@@ -0,0 +1,95 @@
+import { describe, expect, it } from "vitest";
+import { TEST_CLIENT } from "~test/test-clients.js";
+import { TEST_ACCOUNT_A } from "~test/test-wallets.js";
+import { base } from "../../chains/chain-definitions/base.js";
+import { ethereum } from "../../chains/chain-definitions/ethereum.js";
+import { sepolia } from "../../chains/chain-definitions/sepolia.js";
+import { NATIVE_TOKEN_ADDRESS } from "../../constants/addresses.js";
+import { convertCryptoToFiat } from "./cryptoToFiat.js";
+
+describe.runIf(process.env.TW_SECRET_KEY)("Pay: crypto-to-fiat", () => {
+  it("should convert ETH price to USD on Ethereum mainnet", async () => {
+    const data = await convertCryptoToFiat({
+      chain: ethereum,
+      fromTokenAddress: NATIVE_TOKEN_ADDRESS,
+      fromAmount: 1,
+      to: "USD",
+      client: TEST_CLIENT,
+    });
+    expect(data.result).toBeDefined();
+    // Should be a number
+    expect(!Number.isNaN(data.result)).toBe(true);
+    // Since eth is around US$3000, we can add a test to check if the price is greater than $1500 (as a safe margin)
+    // let's hope that scenario does not happen :(
+    expect(Number(data.result) > 1500).toBe(true);
+  });
+
+  it("should convert ETH price to USD on Base mainnet", async () => {
+    const data = await convertCryptoToFiat({
+      chain: base,
+      fromTokenAddress: NATIVE_TOKEN_ADDRESS,
+      fromAmount: 1,
+      to: "USD",
+      client: TEST_CLIENT,
+    });
+    expect(data.result).toBeDefined();
+    // Should be a number
+    expect(!Number.isNaN(data.result)).toBe(true);
+    // Since eth is around US$3000, we can add a test to check if the price is greater than $1500 (as a safe margin)
+    // let's hope that scenario does not happen :(
+    expect(data.result > 1500).toBe(true);
+  });
+
+  it("should return zero if fromAmount is zero", async () => {
+    const data = await convertCryptoToFiat({
+      chain: base,
+      fromTokenAddress: NATIVE_TOKEN_ADDRESS,
+      fromAmount: 0,
+      to: "USD",
+      client: TEST_CLIENT,
+    });
+    expect(data.result).toBe(0);
+  });
+
+  it("should throw error for testnet chain (because testnets are not supported", async () => {
+    await expect(() =>
+      convertCryptoToFiat({
+        chain: sepolia,
+        fromTokenAddress: NATIVE_TOKEN_ADDRESS,
+        fromAmount: 1,
+        to: "USD",
+        client: TEST_CLIENT,
+      }),
+    ).rejects.toThrowError(
+      `Cannot fetch price for a testnet (chainId: ${sepolia.id})`,
+    );
+  });
+
+  it("should throw error if fromTokenAddress is set to an invalid EVM address", async () => {
+    await expect(() =>
+      convertCryptoToFiat({
+        chain: ethereum,
+        fromTokenAddress: "haha",
+        fromAmount: 1,
+        to: "USD",
+        client: TEST_CLIENT,
+      }),
+    ).rejects.toThrowError(
+      "Invalid fromTokenAddress. Expected a valid EVM contract address",
+    );
+  });
+
+  it("should throw error if fromTokenAddress is set to a wallet address", async () => {
+    await expect(() =>
+      convertCryptoToFiat({
+        chain: base,
+        fromTokenAddress: TEST_ACCOUNT_A.address,
+        fromAmount: 1,
+        to: "USD",
+        client: TEST_CLIENT,
+      }),
+    ).rejects.toThrowError(
+      `Error: ${TEST_ACCOUNT_A.address} on chainId: ${base.id} is not a valid contract address.`,
+    );
+  });
+});
diff --git a/packages/thirdweb/src/pay/convert/cryptoToFiat.ts b/packages/thirdweb/src/pay/convert/cryptoToFiat.ts
@@ -0,0 +1,111 @@
+import type { Address } from "abitype";
+import type { Chain } from "../../chains/types.js";
+import type { ThirdwebClient } from "../../client/client.js";
+import { NATIVE_TOKEN_ADDRESS } from "../../constants/addresses.js";
+import { getBytecode } from "../../contract/actions/get-bytecode.js";
+import { getContract } from "../../contract/contract.js";
+import { isAddress } from "../../utils/address.js";
+import { getClientFetch } from "../../utils/fetch.js";
+import { getPayConvertCryptoToFiatEndpoint } from "../utils/definitions.js";
+
+/**
+ * Props for the `convertCryptoToFiat` function
+ * @buyCrypto
+ */
+export type ConvertCryptoToFiatParams = {
+  client: ThirdwebClient;
+  /**
+   * The contract address of the token
+   * For native token, use NATIVE_TOKEN_ADDRESS
+   */
+  fromTokenAddress: Address;
+  /**
+   * The amount of token to convert to fiat value
+   */
+  fromAmount: number;
+  /**
+   * The chain that the token is deployed to
+   */
+  chain: Chain;
+  /**
+   * The fiat symbol. e.g "USD"
+   * Only USD is supported at the moment.
+   */
+  to: "USD";
+};
+
+/**
+ * Get a price of a token (using tokenAddress + chainId) in fiat.
+ * Only USD is supported at the moment.
+ * @example
+ * ### Basic usage
+ * For native token (non-ERC20), you should use NATIVE_TOKEN_ADDRESS as the value for `tokenAddress`
+ * ```ts
+ * import { convertCryptoToFiat } from "thirdweb/pay";
+ *
+ * // Get Ethereum price
+ * const result = convertCryptoToFiat({
+ *   fromTokenAddress: NATIVE_TOKEN_ADDRESS,
+ *   to: "USD",
+ *   chain: ethereum,
+ *   fromAmount: 1,
+ * });
+ *
+ * // Result: 3404.11
+ * ```
+ * @buyCrypto
+ * @returns a number representing the price (in selected fiat) of "x" token, with "x" being the `fromAmount`.
+ */
+export async function convertCryptoToFiat(
+  options: ConvertCryptoToFiatParams,
+): Promise<{ result: number }> {
+  const { client, fromTokenAddress, to, chain, fromAmount } = options;
+  if (Number(fromAmount) === 0) {
+    return { result: 0 };
+  }
+  // Testnets just don't work with our current provider(s)
+  if (chain.testnet === true) {
+    throw new Error(`Cannot fetch price for a testnet (chainId: ${chain.id})`);
+  }
+  // Some provider that we are using will return `0` for unsupported token
+  // so we should do some basic input validations before sending the request
+
+  // Make sure it's a valid EVM address
+  if (!isAddress(fromTokenAddress)) {
+    throw new Error(
+      "Invalid fromTokenAddress. Expected a valid EVM contract address",
+    );
+  }
+  // Make sure it's either a valid contract or a native token address
+  if (fromTokenAddress.toLowerCase() !== NATIVE_TOKEN_ADDRESS.toLowerCase()) {
+    const bytecode = await getBytecode(
+      getContract({
+        address: fromTokenAddress,
+        chain,
+        client,
+      }),
+    ).catch(() => undefined);
+    if (!bytecode || bytecode === "0x") {
+      throw new Error(
+        `Error: ${fromTokenAddress} on chainId: ${chain.id} is not a valid contract address.`,
+      );
+    }
+  }
+  const params = {
+    fromTokenAddress,
+    to,
+    chainId: String(chain.id),
+    fromAmount: String(fromAmount),
+  };
+  const queryString = new URLSearchParams(params).toString();
+  const url = `${getPayConvertCryptoToFiatEndpoint()}?${queryString}`;
+  const response = await getClientFetch(client)(url);
+  if (!response.ok) {
+    throw new Error(
+      `Failed to fetch ${to} value for token (${fromTokenAddress}) on chainId: ${chain.id}`,
+    );
+  }
+
+  const data: { result: number } = await response.json();
+  return data;
+}
diff --git a/packages/thirdweb/src/pay/convert/fiatToCrypto.test.ts b/packages/thirdweb/src/pay/convert/fiatToCrypto.test.ts
@@ -0,0 +1,96 @@
+import { describe, expect, it } from "vitest";
+import { TEST_CLIENT } from "~test/test-clients.js";
+import { TEST_ACCOUNT_A } from "~test/test-wallets.js";
+import { base } from "../../chains/chain-definitions/base.js";
+import { ethereum } from "../../chains/chain-definitions/ethereum.js";
+import { sepolia } from "../../chains/chain-definitions/sepolia.js";
+import { NATIVE_TOKEN_ADDRESS } from "../../constants/addresses.js";
+import { convertFiatToCrypto } from "./fiatToCrypto.js";
+
+describe.runIf(process.env.TW_SECRET_KEY)("Pay: fiatToCrypto", () => {
+  it("should convert fiat price to token on Ethereum mainnet", async () => {
+    const data = await convertFiatToCrypto({
+      chain: ethereum,
+      from: "USD",
+      fromAmount: 1,
+      to: NATIVE_TOKEN_ADDRESS,
+      client: TEST_CLIENT,
+    });
+    expect(data.result).toBeDefined();
+    // Should be a number
+    expect(!Number.isNaN(data.result)).toBe(true);
+    // Since eth is around US$3000, 1 USD should be around 0.0003
+    // we give it some safe margin so the test won't be flaky
+    expect(data.result < 0.001).toBe(true);
+  });
+
+  it("should convert fiat price to token on Base mainnet", async () => {
+    const data = await convertFiatToCrypto({
+      chain: base,
+      from: "USD",
+      fromAmount: 1,
+      to: NATIVE_TOKEN_ADDRESS,
+      client: TEST_CLIENT,
+    });
+
+    expect(data.result).toBeDefined();
+    // Should be a number
+    expect(!Number.isNaN(data.result)).toBe(true);
+    // Since eth is around US$3000, 1 USD should be around 0.0003
+    // we give it some safe margin so the test won't be flaky
+    expect(data.result < 0.001).toBe(true);
+  });
+
+  it("should return zero if the fromAmount is zero", async () => {
+    const data = await convertFiatToCrypto({
+      chain: base,
+      from: "USD",
+      fromAmount: 0,
+      to: NATIVE_TOKEN_ADDRESS,
+      client: TEST_CLIENT,
+    });
+    expect(data.result).toBe(0);
+  });
+
+  it("should throw error for testnet chain (because testnets are not supported", async () => {
+    await expect(() =>
+      convertFiatToCrypto({
+        chain: sepolia,
+        to: NATIVE_TOKEN_ADDRESS,
+        fromAmount: 1,
+        from: "USD",
+        client: TEST_CLIENT,
+      }),
+    ).rejects.toThrowError(
+      `Cannot fetch price for a testnet (chainId: ${sepolia.id})`,
+    );
+  });
+
+  it("should throw error if `to` is set to an invalid EVM address", async () => {
+    await expect(() =>
+      convertFiatToCrypto({
+        chain: ethereum,
+        to: "haha",
+        fromAmount: 1,
+        from: "USD",
+        client: TEST_CLIENT,
+      }),
+    ).rejects.toThrowError(
+      "Invalid `to`. Expected a valid EVM contract address",
+    );
+  });
+
+  it("should throw error if `to` is set to a wallet address", async () => {
+    await expect(() =>
+      convertFiatToCrypto({
+        chain: base,
+        to: TEST_ACCOUNT_A.address,
+        fromAmount: 1,
+        from: "USD",
+        client: TEST_CLIENT,
+      }),
+    ).rejects.toThrowError(
+      `Error: ${TEST_ACCOUNT_A.address} on chainId: ${base.id} is not a valid contract address.`,
+    );
+  });
+});
diff --git a/packages/thirdweb/src/pay/convert/fiatToCrypto.ts b/packages/thirdweb/src/pay/convert/fiatToCrypto.ts
diff --git a/packages/thirdweb/src/pay/utils/definitions.ts b/packages/thirdweb/src/pay/utils/definitions.ts
