@zoralabs/coins-sdk 0.0.2-sdkalpha.2 → 0.0.2-sdkalpha.4

package/src/actions/{getCoinDetails.ts → getOnchainCoinDetails.ts}

@@ -1,8 +1,17 @@
 import { coinABI, iUniswapV3PoolABI } from "@zoralabs/coins";
-import { SUPERCHAIN_WETH_ADDRESS, USDC_WETH_POOLS_BY_CHAIN } from "src/constants";
+import {
+  SUPERCHAIN_WETH_ADDRESS,
+  USDC_WETH_POOLS_BY_CHAIN,
+} from "src/constants";
+import { GenericPublicClient } from "src/utils/genericPublicClient";
 import { validateClientNetwork } from "src/utils/validateClientNetwork";
-import { Address, erc20Abi, formatEther, isAddressEqual, PublicClient, zeroAddress } from "viem";
-
+import {
+  Address,
+  erc20Abi,
+  formatEther,
+  isAddressEqual,
+  zeroAddress,
+} from "viem";
 
 type Slot0Result = {
   sqrtPriceX96: bigint;
@@ -15,15 +24,15 @@ type Slot0Result = {
 };
 
 type PricingResult = {
-  eth: bigint,
-  usdc: bigint | null,
-  usdcDecimal: number | null,
-  ethDecimal: number,
-}
+  eth: bigint;
+  usdc: bigint | null;
+  usdcDecimal: number | null;
+  ethDecimal: number;
+};
 
 /**
  * Represents the current state of a coin
- * @typedef {Object} CoinDetails
+ * @typedef {Object} OnchainCoinDetails
  * @property {bigint} balance - The user's balance of the coin
  * @property {PricingResult} marketCap - The market cap of the coin
  * @property {PricingResult} liquidity - The liquidity of the coin
@@ -32,14 +41,14 @@ type PricingResult = {
  * @property {Address[]} owners - List of owners for the coin
  * @property {Address} payoutRecipient - The payout recipient address
  */
-export type CoinDetails = {
+export type OnchainCoinDetails = {
   balance: bigint;
   marketCap: PricingResult;
   liquidity: PricingResult;
   pool: Address;
   poolState: Slot0Result;
-  owners: readonly Address[],
-  payoutRecipient: Address,
+  owners: readonly Address[];
+  payoutRecipient: Address;
 };
 
 /**
@@ -48,101 +57,118 @@ export type CoinDetails = {
  * @param {Address} params.coin - The coin contract address
  * @param {Address} params.user - The user address to check balance for
  * @param {PublicClient} params.publicClient - The viem public client instance
- * @returns {Promise<CoinDetails>} The coin's current state
+ * @returns {Promise<OnchainCoinDetails>} The coin's current state
  */
-export async function getCoinDetails({
+export async function getOnchainCoinDetails({
   coin,
   user = zeroAddress,
   publicClient,
 }: {
   coin: Address;
   user?: Address;
-  publicClient: PublicClient;
-}): Promise<CoinDetails> {
+  publicClient: GenericPublicClient;
+}): Promise<OnchainCoinDetails> {
   validateClientNetwork(publicClient);
-  const [balance, pool, owners, payoutRecipient] = await publicClient.multicall({
+  const [balance, pool, owners, payoutRecipient] = await publicClient.multicall(
+    {
+      contracts: [
+        {
+          address: coin,
+          abi: coinABI,
+          functionName: "balanceOf",
+          args: [user],
+        },
+        {
+          address: coin,
+          abi: coinABI,
+          functionName: "poolAddress",
+        },
+        {
+          address: coin,
+          abi: coinABI,
+          functionName: "owners",
+        },
+        {
+          address: coin,
+          abi: coinABI,
+          functionName: "payoutRecipient",
+        },
+      ],
+      allowFailure: false,
+    },
+  );
+
+  const USDC_WETH_POOL = USDC_WETH_POOLS_BY_CHAIN[publicClient.chain?.id || 0];
+
+  const [
+    coinWethPoolSlot0,
+    coinWethPoolToken0,
+    coinReservesRaw,
+    coinTotalSupply,
+    wethReservesRaw,
+    usdcWethSlot0,
+  ] = await publicClient.multicall({
     contracts: [
+      {
+        address: pool,
+        abi: iUniswapV3PoolABI,
+        functionName: "slot0",
+      },
+      {
+        address: pool,
+        abi: iUniswapV3PoolABI,
+        functionName: "token0",
+      },
       {
         address: coin,
-        abi: coinABI,
+        abi: erc20Abi,
         functionName: "balanceOf",
-        args: [user],
+        args: [pool],
       },
       {
         address: coin,
         abi: coinABI,
-        functionName: "poolAddress",
+        functionName: "totalSupply",
       },
       {
-        address: coin,
-        abi: coinABI,
-        functionName: 'owners',
+        address: SUPERCHAIN_WETH_ADDRESS,
+        abi: erc20Abi,
+        functionName: "balanceOf",
+        args: [pool],
       },
       {
-        address: coin,
-        abi: coinABI,
-        functionName: 'payoutRecipient',
-      }
+        address: USDC_WETH_POOL ?? coin,
+        abi: iUniswapV3PoolABI,
+        functionName: "slot0",
+      },
     ],
     allowFailure: false,
   });
 
-  const USDC_WETH_POOL = USDC_WETH_POOLS_BY_CHAIN[publicClient.chain?.id || 0];
-
-  const [coinWethPoolSlot0, coinWethPoolToken0, coinReservesRaw, coinTotalSupply, wethReservesRaw, usdcWethSlot0] = await publicClient.multicall({
-    contracts: [{
-      address: pool,
-      abi: iUniswapV3PoolABI,
-      functionName: "slot0",
-    },
-    {
-      address: pool,
-      abi: iUniswapV3PoolABI,
-      functionName: 'token0'
-    }, {
-      address: coin,
-      abi: erc20Abi,
-      functionName: 'balanceOf',
-      args: [pool],
-    },
-    {
-      address: coin,
-      abi: coinABI,
-      functionName: 'totalSupply',
-    }, {
-      address: SUPERCHAIN_WETH_ADDRESS,
-      abi: erc20Abi,
-      functionName: 'balanceOf',
-      args: [pool],
-    }, {
-      address: USDC_WETH_POOL ?? coin,
-      abi: iUniswapV3PoolABI,
-      functionName: 'slot0',
-    }], allowFailure: false
-  });
-
-  const wethPriceInUsdc = USDC_WETH_POOL ? uniswapV3SqrtPriceToBigIntScaled(
-    usdcWethSlot0.sqrtPriceX96,
-    18,
-    6,
-    true,
-    18
-  ) : null;
+  const wethPriceInUsdc = USDC_WETH_POOL
+    ? uniswapV3SqrtPriceToBigIntScaled(
+        usdcWethSlot0.sqrtPriceX96,
+        18,
+        6,
+        true,
+        18,
+      )
+    : null;
 
   const coinPriceInWeth = uniswapV3SqrtPriceToBigIntScaled(
     coinWethPoolSlot0.sqrtPriceX96,
     18,
     18,
     isAddressEqual(coinWethPoolToken0, coin),
-    18
+    18,
   );
 
   // Divide by 10^18 to remove percision from `coinPriceInWeth` after math since bigint is decimal.
-  const marketCap = coinPriceInWeth * coinTotalSupply / 10n ** 18n;
+  const marketCap = (coinPriceInWeth * coinTotalSupply) / 10n ** 18n;
 
   const wethLiquidity = wethReservesRaw;
   // Divide by 10^18 to remove percision from `coinPriceInWeth` after math since bigint is decimal.
-  const tokenLiquidity = coinReservesRaw * coinPriceInWeth / 10n ** 18n;
+  const tokenLiquidity = (coinReservesRaw * coinPriceInWeth) / 10n ** 18n;
 
   return {
     balance,
@@ -150,14 +176,23 @@ export async function getCoinDetails({
     owners,
     payoutRecipient,
     marketCap: convertEthOutput(marketCap, wethPriceInUsdc),
-    liquidity: convertEthOutput(wethLiquidity + tokenLiquidity, wethPriceInUsdc),
+    liquidity: convertEthOutput(
+      wethLiquidity + tokenLiquidity,
+      wethPriceInUsdc,
+    ),
     poolState: coinWethPoolSlot0,
   };
 }
 
-
 function convertEthOutput(amountETH: bigint, wethToUsdc: bigint | null) {
-  return { eth: amountETH, ethDecimal: parseFloat(formatEther(amountETH)), usdc: wethToUsdc ? amountETH * wethToUsdc : null, usdcDecimal: wethToUsdc ? parseFloat(formatEther(amountETH * wethToUsdc / 10n ** 18n)) : null }
+  return {
+    eth: amountETH,
+    ethDecimal: parseFloat(formatEther(amountETH)),
+    usdc: wethToUsdc ? amountETH * wethToUsdc : null,
+    usdcDecimal: wethToUsdc
+      ? parseFloat(formatEther((amountETH * wethToUsdc) / 10n ** 18n))
+      : null,
+  };
 }
 
 function uniswapV3SqrtPriceToBigIntScaled(
@@ -165,7 +200,7 @@ function uniswapV3SqrtPriceToBigIntScaled(
   token0Decimals: number,
   token1Decimals: number,
   isToken0Coin: boolean,
-  scaleDecimals: number = 18
+  scaleDecimals: number = 18,
 ): bigint {
   // (sqrtPrice^2 / 2^192) => ratio
   // We'll do: ratioScaled = (sqrtPrice^2 * 10^scaleDecimals) / 2^192
@@ -182,7 +217,7 @@ function uniswapV3SqrtPriceToBigIntScaled(
   if (decimalsDiff > 0n) {
     ratioScaled *= 10n ** decimalsDiff;
   } else if (decimalsDiff < 0n) {
-    ratioScaled /= 10n ** (-decimalsDiff);
+    ratioScaled /= 10n ** -decimalsDiff;
   }
 
   if (!isToken0Coin) {

package/src/api/api-key.ts

@@ -0,0 +1,15 @@
+let apiKey: string | undefined;
+export function setApiKey(key: string) {
+  apiKey = key;
+}
+
+export function getApiKeyMeta() {
+  if (!apiKey) {
+    return {};
+  }
+  return {
+    headers: {
+      "api-key": apiKey,
+    },
+  };
+}

package/src/api/explore.ts

@@ -0,0 +1,55 @@
+import { getExplore as getExploreSDK } from "../client/sdk.gen";
+import type { GetExploreData } from "../client/types.gen";
+import { Options } from "@hey-api/client-fetch";
+import { getApiKeyMeta } from "./api-key";
+
+/**
+ * The inner type for the explore queries that omits listType.
+ * This is used to create the query object for the explore queries.
+ */
+type QueryInnerType = {
+  query: Omit<GetExploreData["query"], "listType">;
+} & Omit<GetExploreData, "query">;
+
+/**
+ * Creates an explore query with the specified list type
+ */
+const createExploreQuery = <T extends boolean = false>(
+  listType: GetExploreData["query"]["listType"],
+  options?: Options<QueryInnerType, T>,
+) =>
+  getExploreSDK({
+    ...options,
+    query: { ...options?.query, listType },
+    meta: getApiKeyMeta(),
+  });
+
+/** Get top gaining coins */
+export const getExploreTopGainers = <T extends boolean = false>(
+  options?: Options<QueryInnerType, T>,
+) => createExploreQuery("TOP_GAINERS", options);
+
+/** Get coins with highest 24h volume */
+export const getExploreTopVolume24h = <T extends boolean = false>(
+  options?: Options<QueryInnerType, T>,
+) => createExploreQuery("TOP_VOLUME_24H", options);
+
+/** Get most valuable coins */
+export const getExploreMostValuable = <T extends boolean = false>(
+  options?: Options<QueryInnerType, T>,
+) => createExploreQuery("MOST_VALUABLE", options);
+
+/** Get newly created coins */
+export const getExploreNew = <T extends boolean = false>(
+  options?: Options<QueryInnerType, T>,
+) => createExploreQuery("NEW", options);
+
+/** Get recently traded coins */
+export const getExploreLastTraded = <T extends boolean = false>(
+  options?: Options<QueryInnerType, T>,
+) => createExploreQuery("LAST_TRADED", options);
+
+/** Get recently traded unique coins */
+export const getExploreLastTradedUnique = <T extends boolean = false>(
+  options?: Options<QueryInnerType, T>,
+) => createExploreQuery("LAST_TRADED_UNIQUE", options);

package/src/api/index.ts

@@ -0,0 +1,8 @@
+// Export all of the explore queries
+export * from "./explore";
+// Export all of the queries
+export * from "./queries";
+
+// Only export the set function for external use.
+// All other exports are for internal use.
+export { setApiKey } from "./api-key";

package/src/api/queries.ts

@@ -0,0 +1,60 @@
+import {
+  GetCoinCommentsData,
+  GetCoinData,
+  GetProfileData,
+  GetProfileOwnedData,
+} from "src/client";
+import {
+  getCoin as getCoinSDK,
+  getCoins as getCoinsSDK,
+  getCoinComments as getCoinCommentsSDK,
+  getProfile as getProfileSDK,
+  getProfileOwned as getProfileOwnedSDK,
+} from "../client/sdk.gen";
+import { getApiKeyMeta } from "./api-key";
+
+export const getCoin = async (query: GetCoinData["query"]) => {
+  return await getCoinSDK({
+    query,
+    meta: getApiKeyMeta(),
+  });
+};
+
+export const getCoins = async ({
+  coinAddresses,
+  chainId,
+}: {
+  coinAddresses: string[];
+  chainId?: number;
+}) => {
+  return await getCoinsSDK({
+    query: {
+      coins: coinAddresses.map((collectionAddress) => ({
+        chainId,
+        collectionAddress,
+      })),
+    },
+    meta: getApiKeyMeta(),
+  });
+};
+
+export const getCoinComments = async (query: GetCoinCommentsData["query"]) => {
+  return await getCoinCommentsSDK({
+    query,
+    meta: getApiKeyMeta(),
+  });
+};
+
+export const getProfile = async (query: GetProfileData["query"]) => {
+  return await getProfileSDK({
+    query,
+    meta: getApiKeyMeta(),
+  });
+};
+
+export const getProfileOwned = async (query: GetProfileOwnedData["query"]) => {
+  return await getProfileOwnedSDK({
+    query,
+    meta: getApiKeyMeta(),
+  });
+};

package/src/client/client.gen.ts

@@ -0,0 +1,18 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type { ClientOptions } from './types.gen';
+import { type Config, type ClientOptions as DefaultClientOptions, createClient, createConfig } from '@hey-api/client-fetch';
+
+/**
+ * The `createClientConfig()` function will be called on client initialization
+ * and the returned object will become the client's initial configuration.
+ *
+ * You may want to initialize your client this way instead of calling
+ * `setConfig()`. This is useful for example if you're using Next.js
+ * to ensure your client always has the correct values.
+ */
+export type CreateClientConfig<T extends DefaultClientOptions = ClientOptions> = (override?: Config<DefaultClientOptions & T>) => Config<Required<DefaultClientOptions> & T>;
+
+export const client = createClient(createConfig<ClientOptions>({
+    baseUrl: 'https://api-sdk.zora.engineering/'
+}));

package/src/client/index.ts

@@ -0,0 +1,3 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';
+export * from './sdk.gen';

package/src/client/sdk.gen.ts

@@ -0,0 +1,117 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type {
+  Options as ClientOptions,
+  TDataShape,
+  Client,
+} from "@hey-api/client-fetch";
+import type {
+  GetCoinData,
+  GetCoinResponse,
+  GetCoinCommentsData,
+  GetCoinCommentsResponse,
+  GetCoinsData,
+  GetCoinsResponse,
+  GetExploreData,
+  GetExploreResponse,
+  GetProfileData,
+  GetProfileResponse,
+  GetProfileOwnedData,
+  GetProfileOwnedResponse,
+} from "./types.gen";
+import { client as _heyApiClient } from "./client.gen";
+
+export type Options<
+  TData extends TDataShape = TDataShape,
+  ThrowOnError extends boolean = boolean,
+> = ClientOptions<TData, ThrowOnError> & {
+  /**
+   * You can provide a client instance returned by `createClient()` instead of
+   * individual options. This might be also useful if you want to implement a
+   * custom client.
+   */
+  client?: Client;
+  /**
+   * You can pass arbitrary values through the `meta` object. This can be
+   * used to access values that aren't defined as part of the SDK function.
+   */
+  meta?: Record<string, unknown>;
+};
+
+export const getCoin = <ThrowOnError extends boolean = false>(
+  options: Options<GetCoinData, ThrowOnError>,
+) => {
+  return (options.client ?? _heyApiClient).get<
+    GetCoinResponse,
+    unknown,
+    ThrowOnError
+  >({
+    url: "/coin",
+    ...options,
+  });
+};
+
+export const getCoinComments = <ThrowOnError extends boolean = false>(
+  options: Options<GetCoinCommentsData, ThrowOnError>,
+) => {
+  return (options.client ?? _heyApiClient).get<
+    GetCoinCommentsResponse,
+    unknown,
+    ThrowOnError
+  >({
+    url: "/coinComments",
+    ...options,
+  });
+};
+
+export const getCoins = <ThrowOnError extends boolean = false>(
+  options: Options<GetCoinsData, ThrowOnError>,
+) => {
+  return (options.client ?? _heyApiClient).get<
+    GetCoinsResponse,
+    unknown,
+    ThrowOnError
+  >({
+    url: "/coins",
+    ...options,
+  });
+};
+
+export const getExplore = <ThrowOnError extends boolean = false>(
+  options: Options<GetExploreData, ThrowOnError>,
+) => {
+  return (options.client ?? _heyApiClient).get<
+    GetExploreResponse,
+    unknown,
+    ThrowOnError
+  >({
+    url: "/explore",
+    ...options,
+  });
+};
+
+export const getProfile = <ThrowOnError extends boolean = false>(
+  options: Options<GetProfileData, ThrowOnError>,
+) => {
+  return (options.client ?? _heyApiClient).get<
+    GetProfileResponse,
+    unknown,
+    ThrowOnError
+  >({
+    url: "/profile",
+    ...options,
+  });
+};
+
+export const getProfileOwned = <ThrowOnError extends boolean = false>(
+  options: Options<GetProfileOwnedData, ThrowOnError>,
+) => {
+  return (options.client ?? _heyApiClient).get<
+    GetProfileOwnedResponse,
+    unknown,
+    ThrowOnError
+  >({
+    url: "/profileOwned",
+    ...options,
+  });
+};