|
| 1 | +import type { Address } from "abitype"; |
| 2 | +import type { Chain } from "../../chains/types.js"; |
| 3 | +import type { ThirdwebClient } from "../../client/client.js"; |
| 4 | +import { NATIVE_TOKEN_ADDRESS } from "../../constants/addresses.js"; |
| 5 | +import { getBytecode } from "../../contract/actions/get-bytecode.js"; |
| 6 | +import { getContract } from "../../contract/contract.js"; |
| 7 | +import { isAddress } from "../../utils/address.js"; |
| 8 | +import { getClientFetch } from "../../utils/fetch.js"; |
| 9 | +import { getPayConvertCryptoToFiatEndpoint } from "../utils/definitions.js"; |
| 10 | + |
| 11 | +/** |
| 12 | + * Props for the `convertCryptoToFiat` function |
| 13 | + * @buyCrypto |
| 14 | + */ |
| 15 | +export type ConvertCryptoToFiatParams = { |
| 16 | + client: ThirdwebClient; |
| 17 | + /** |
| 18 | + * The contract address of the token |
| 19 | + * For native token, use NATIVE_TOKEN_ADDRESS |
| 20 | + */ |
| 21 | + fromTokenAddress: Address; |
| 22 | + /** |
| 23 | + * The amount of token to convert to fiat value |
| 24 | + */ |
| 25 | + fromAmount: number; |
| 26 | + /** |
| 27 | + * The chain that the token is deployed to |
| 28 | + */ |
| 29 | + chain: Chain; |
| 30 | + /** |
| 31 | + * The fiat symbol. e.g "usd" |
| 32 | + * Only USD is supported at the moment. |
| 33 | + */ |
| 34 | + to: "usd"; |
| 35 | +}; |
| 36 | + |
| 37 | +/** |
| 38 | + * Get a price of a token (using tokenAddress + chainId) in fiat. |
| 39 | + * Only USD is supported at the moment. |
| 40 | + * @example |
| 41 | + * ### Basic usage |
| 42 | + * For native token (non-ERC20), you should use NATIVE_TOKEN_ADDRESS as the value for `tokenAddress` |
| 43 | + * ```ts |
| 44 | + * import { convertCryptoToFiat } from "thirdweb/pay"; |
| 45 | + * |
| 46 | + * // Get Ethereum price |
| 47 | + * const result = convertCryptoToFiat({ |
| 48 | + * fromTokenAddress: NATIVE_TOKEN_ADDRESS, |
| 49 | + * // This is not case sensitive, so either "USD" or "usd" is fine |
| 50 | + * to: "USD", |
| 51 | + * chain: ethereum, |
| 52 | + * fromAmount: 1, |
| 53 | + * }); |
| 54 | + * |
| 55 | + * // Result: 3404.11 |
| 56 | + * ``` |
| 57 | + * @buyCrypto |
| 58 | + * @returns a number representing the price (in selected fiat) of "x" token, with "x" being the `fromAmount`. |
| 59 | + */ |
| 60 | +export async function convertCryptoToFiat( |
| 61 | + options: ConvertCryptoToFiatParams, |
| 62 | +): Promise<{ result: number }> { |
| 63 | + const { client, fromTokenAddress, to, chain, fromAmount } = options; |
| 64 | + if (Number(fromAmount) === 0) { |
| 65 | + return { result: 0 }; |
| 66 | + } |
| 67 | + try { |
| 68 | + // Testnets just don't work with our current provider(s) |
| 69 | + if (chain.testnet === true) { |
| 70 | + throw new Error( |
| 71 | + `Cannot fetch price for a testnet (chainId: ${chain.id})`, |
| 72 | + ); |
| 73 | + } |
| 74 | + // Some provider that we are using will return `0` for unsupported token |
| 75 | + // so we should do some basic input validations before sending the request |
| 76 | + |
| 77 | + // Make sure it's a valid EVM address |
| 78 | + if (!isAddress(fromTokenAddress)) { |
| 79 | + throw new Error( |
| 80 | + "Invalid fromTokenAddress. Expected a valid EVM contract address", |
| 81 | + ); |
| 82 | + } |
| 83 | + // Make sure it's either a valid contract or a native token address |
| 84 | + if (fromTokenAddress.toLowerCase() !== NATIVE_TOKEN_ADDRESS.toLowerCase()) { |
| 85 | + const bytecode = await getBytecode( |
| 86 | + getContract({ |
| 87 | + address: fromTokenAddress, |
| 88 | + chain, |
| 89 | + client, |
| 90 | + }), |
| 91 | + ).catch(() => undefined); |
| 92 | + if (!bytecode || bytecode === "0x") { |
| 93 | + throw new Error( |
| 94 | + `Error: ${fromTokenAddress} on chainId: ${chain.id} is not a valid contract address.`, |
| 95 | + ); |
| 96 | + } |
| 97 | + } |
| 98 | + const params = { |
| 99 | + fromTokenAddress, |
| 100 | + to, |
| 101 | + chainId: String(chain.id), |
| 102 | + fromAmount: String(fromAmount), |
| 103 | + }; |
| 104 | + const queryString = new URLSearchParams(params).toString(); |
| 105 | + const url = `${getPayConvertCryptoToFiatEndpoint()}?${queryString}`; |
| 106 | + const response = await getClientFetch(client)(url); |
| 107 | + if (!response.ok) { |
| 108 | + throw new Error( |
| 109 | + `Failed to fetch ${to} value for token (${fromTokenAddress}) on chainId: ${chain.id}`, |
| 110 | + ); |
| 111 | + } |
| 112 | + |
| 113 | + const data: { result: number } = await response.json(); |
| 114 | + return data; |
| 115 | + } catch (error) { |
| 116 | + console.error(error); |
| 117 | + throw new Error( |
| 118 | + `Failed to fetch ${to} value for token (${fromTokenAddress}) on chainId: ${chain.id}`, |
| 119 | + ); |
| 120 | + } |
| 121 | +} |
0 commit comments