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

package/src/client/types.gen.ts

@@ -0,0 +1,580 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type GetCoinData = {
+  body?: never;
+  path?: never;
+  query: {
+    address: string;
+    chain?: number;
+  };
+  url: "/coin";
+};
+
+export type GetCoinResponses = {
+  /**
+   * response
+   */
+  200: {
+    zora20Token?: {
+      /**
+       * The Globally Unique ID of this object
+       */
+      id?: string;
+      name?: string;
+      description?: string;
+      address?: string;
+      symbol?: string;
+      totalSupply?: string;
+      totalVolume?: string;
+      volume24h?: string;
+      createdAt?: string;
+      creatorAddress?: string;
+      creatorEarnings?: Array<{
+        amount?: {
+          currency?: {
+            address?: string;
+          };
+          amountRaw?: string;
+          amountDecimal?: number;
+        };
+        amountUsd?: string;
+      }>;
+      marketCap?: string;
+      marketCapDelta24h?: string;
+      chainId?: number;
+      creatorProfile?: string;
+      handle?: string;
+      avatar?: {
+        previewImage?: string;
+        blurhash?: string;
+        small?: string;
+      };
+      media?: {
+        mimeType?: string;
+        originalUri?: string;
+        format?: string;
+        previewImage?: string;
+        medium?: string;
+        blurhash?: string;
+      };
+      transfers?: {
+        count?: number;
+      };
+      uniqueHolders?: number;
+      zoraComments?: {
+        /**
+         * Information to aid in pagination.
+         */
+        pageInfo?: {
+          /**
+           * When paginating forwards, the cursor to continue.
+           */
+          endCursor?: string;
+          /**
+           * When paginating forwards, are there more items?
+           */
+          hasNextPage?: boolean;
+        };
+        count?: number;
+        edges?: Array<{
+          node?: string;
+          txHash?: string;
+          comment?: string;
+          userAddress?: string;
+          timestamp?: number;
+          userProfile?: string;
+          /**
+           * The Globally Unique ID of this object
+           */
+          id?: string;
+          handle?: string;
+          avatar?: {
+            previewImage?: string;
+            blurhash?: string;
+            small?: string;
+          };
+        }>;
+      };
+    };
+  };
+};
+
+export type GetCoinResponse = GetCoinResponses[keyof GetCoinResponses];
+
+export type GetCoinCommentsData = {
+  body?: never;
+  path?: never;
+  query: {
+    address: string;
+    chain?: number;
+    after?: string;
+    count?: number;
+  };
+  url: "/coinComments";
+};
+
+export type GetCoinCommentsResponses = {
+  /**
+   * response
+   */
+  200: {
+    zora20Token?: {
+      zoraComments?: {
+        /**
+         * Information to aid in pagination.
+         */
+        pageInfo?: {
+          /**
+           * When paginating forwards, the cursor to continue.
+           */
+          endCursor?: string;
+          /**
+           * When paginating forwards, are there more items?
+           */
+          hasNextPage?: boolean;
+        };
+        count?: number;
+        edges?: Array<{
+          node?: string;
+          txHash?: string;
+          comment?: string;
+          userAddress?: string;
+          timestamp?: number;
+          userProfile?: string;
+          /**
+           * The Globally Unique ID of this object
+           */
+          id?: string;
+          handle?: string;
+          avatar?: {
+            previewImage?: string;
+            blurhash?: string;
+            small?: string;
+          };
+          replies?: {
+            count?: number;
+            edges?: Array<{
+              node?: {
+                txHash?: string;
+                comment?: string;
+                userAddress?: string;
+                timestamp?: number;
+                userProfile?: string;
+                /**
+                 * The Globally Unique ID of this object
+                 */
+                id?: string;
+                handle?: string;
+                avatar?: {
+                  previewImage?: string;
+                  blurhash?: string;
+                  small?: string;
+                };
+              };
+            }>;
+          };
+        }>;
+      };
+    };
+  };
+};
+
+export type GetCoinCommentsResponse =
+  GetCoinCommentsResponses[keyof GetCoinCommentsResponses];
+
+export type GetCoinsData = {
+  body?: never;
+  path?: never;
+  query: {
+    coins: Array<{
+      chainId?: number;
+      collectionAddress?: string;
+    }>;
+  };
+  url: "/coins";
+};
+
+export type GetCoinsResponses = {
+  /**
+   * response
+   */
+  200: {
+    zora20Tokens?: Array<{
+      /**
+       * The Globally Unique ID of this object
+       */
+      id?: string;
+      name?: string;
+      description?: string;
+      address?: string;
+      symbol?: string;
+      totalSupply?: string;
+      totalVolume?: string;
+      volume24h?: string;
+      createdAt?: string;
+      creatorAddress?: string;
+      creatorEarnings?: Array<{
+        amount?: {
+          currency?: {
+            address?: string;
+          };
+          amountRaw?: string;
+          amountDecimal?: number;
+        };
+        amountUsd?: string;
+      }>;
+      marketCap?: string;
+      marketCapDelta24h?: string;
+      chainId?: number;
+      creatorProfile?: string;
+      handle?: string;
+      avatar?: {
+        previewImage?: string;
+        blurhash?: string;
+        small?: string;
+      };
+      media?: {
+        mimeType?: string;
+        originalUri?: string;
+        format?: string;
+        previewImage?: string;
+        medium?: string;
+        blurhash?: string;
+      };
+      transfers?: {
+        count?: number;
+      };
+      uniqueHolders?: number;
+      zoraComments?: {
+        /**
+         * Information to aid in pagination.
+         */
+        pageInfo?: {
+          /**
+           * When paginating forwards, the cursor to continue.
+           */
+          endCursor?: string;
+          /**
+           * When paginating forwards, are there more items?
+           */
+          hasNextPage?: boolean;
+        };
+        count?: number;
+        edges?: Array<{
+          node?: string;
+          txHash?: string;
+          comment?: string;
+          userAddress?: string;
+          timestamp?: number;
+          userProfile?: string;
+          /**
+           * The Globally Unique ID of this object
+           */
+          id?: string;
+          handle?: string;
+          avatar?: {
+            previewImage?: string;
+            blurhash?: string;
+            small?: string;
+          };
+        }>;
+      };
+    }>;
+  };
+};
+
+export type GetCoinsResponse = GetCoinsResponses[keyof GetCoinsResponses];
+
+export type GetExploreData = {
+  body?: never;
+  path?: never;
+  query: {
+    listType:
+      | "TOP_GAINERS"
+      | "TOP_VOLUME_24H"
+      | "MOST_VALUABLE"
+      | "NEW"
+      | "LAST_TRADED"
+      | "LAST_TRADED_UNIQUE";
+    count?: number;
+    after?: string;
+  };
+  url: "/explore";
+};
+
+export type GetExploreResponses = {
+  /**
+   * response
+   */
+  200: {
+    exploreList?: {
+      edges?: Array<{
+        node?: {
+          /**
+           * The Globally Unique ID of this object
+           */
+          id?: string;
+          name?: string;
+          description?: string;
+          address?: string;
+          symbol?: string;
+          totalSupply?: string;
+          totalVolume?: string;
+          volume24h?: string;
+          createdAt?: string;
+          creatorAddress?: string;
+          creatorEarnings?: Array<{
+            amount?: {
+              currency?: {
+                address?: string;
+              };
+              amountRaw?: string;
+              amountDecimal?: number;
+            };
+            amountUsd?: string;
+          }>;
+          marketCap?: string;
+          marketCapDelta24h?: string;
+          chainId?: number;
+          creatorProfile?: string;
+          handle?: string;
+          avatar?: {
+            previewImage?: string;
+            blurhash?: string;
+            small?: string;
+          };
+          media?: {
+            mimeType?: string;
+            originalUri?: string;
+            format?: string;
+            previewImage?: string;
+            medium?: string;
+            blurhash?: string;
+          };
+          transfers?: {
+            count?: number;
+          };
+          uniqueHolders?: number;
+        };
+        cursor?: string;
+      }>;
+      /**
+       * Information to aid in pagination.
+       */
+      pageInfo?: {
+        /**
+         * When paginating forwards, the cursor to continue.
+         */
+        endCursor?: string;
+        /**
+         * When paginating forwards, are there more items?
+         */
+        hasNextPage?: boolean;
+      };
+    };
+  };
+};
+
+export type GetExploreResponse = GetExploreResponses[keyof GetExploreResponses];
+
+export type GetProfileData = {
+  body?: never;
+  path?: never;
+  query: {
+    identifier: string;
+  };
+  url: "/profile";
+};
+
+export type GetProfileResponses = {
+  /**
+   * response
+   */
+  200: {
+    profile?: string;
+    /**
+     * The Globally Unique ID of this object
+     */
+    id?: string;
+    handle?: string;
+    avatar?: {
+      small?: string;
+      medium?: string;
+      blurhash?: string;
+    };
+    username?: string;
+    displayName?: string;
+    bio?: string;
+    website?: string;
+    publicWallet?: {
+      walletAddress?: string;
+    };
+    linkedWallets?: {
+      edges?: Array<{
+        node?: {
+          walletType?: "PRIVY" | "EXTERNAL" | "SMART_WALLET";
+          walletAddress?: string;
+        };
+      }>;
+    };
+  };
+};
+
+export type GetProfileResponse = GetProfileResponses[keyof GetProfileResponses];
+
+export type GetProfileOwnedData = {
+  body?: never;
+  path?: never;
+  query: {
+    /**
+     * The identifier of the profile to get. This can be a username, handle, or address.
+     */
+    identifier: string;
+    /**
+     * The number of items to return.
+     */
+    count?: number;
+    /**
+     * The cursor to continue.
+     */
+    after?: string;
+    chainIds?: Array<number>;
+  };
+  url: "/profileOwned";
+};
+
+export type GetProfileOwnedResponses = {
+  /**
+   * response
+   */
+  200: {
+    profile?: string;
+    /**
+     * The Globally Unique ID of this object
+     */
+    id?: string;
+    handle?: string;
+    avatar?: {
+      previewImage?: string;
+      blurhash?: string;
+      small?: string;
+    };
+    coinBalances?: {
+      count?: number;
+      edges?: Array<{
+        node?: {
+          balance?: string;
+          /**
+           * The Globally Unique ID of this object
+           */
+          id?: string;
+          coin?: {
+            /**
+             * The Globally Unique ID of this object
+             */
+            id?: string;
+            name?: string;
+            description?: string;
+            address?: string;
+            symbol?: string;
+            totalSupply?: string;
+            totalVolume?: string;
+            volume24h?: string;
+            createdAt?: string;
+            creatorAddress?: string;
+            creatorEarnings?: Array<{
+              amount?: {
+                currency?: {
+                  address?: string;
+                };
+                amountRaw?: string;
+                amountDecimal?: number;
+              };
+              amountUsd?: string;
+            }>;
+            marketCap?: string;
+            marketCapDelta24h?: string;
+            chainId?: number;
+            creatorProfile?: string;
+            handle?: string;
+            avatar?: {
+              previewImage?: string;
+              blurhash?: string;
+              small?: string;
+            };
+            media?: {
+              mimeType?: string;
+              originalUri?: string;
+              format?: string;
+              previewImage?: string;
+              medium?: string;
+              blurhash?: string;
+            };
+            transfers?: {
+              count?: number;
+            };
+            uniqueHolders?: number;
+            zoraComments?: {
+              /**
+               * Information to aid in pagination.
+               */
+              pageInfo?: {
+                /**
+                 * When paginating forwards, the cursor to continue.
+                 */
+                endCursor?: string;
+                /**
+                 * When paginating forwards, are there more items?
+                 */
+                hasNextPage?: boolean;
+              };
+              count?: number;
+              edges?: Array<{
+                node?: string;
+                txHash?: string;
+                comment?: string;
+                userAddress?: string;
+                timestamp?: number;
+                userProfile?: string;
+                /**
+                 * The Globally Unique ID of this object
+                 */
+                id?: string;
+                handle?: string;
+                avatar?: {
+                  previewImage?: string;
+                  blurhash?: string;
+                  small?: string;
+                };
+              }>;
+            };
+          };
+        };
+      }>;
+      /**
+       * Information to aid in pagination.
+       */
+      pageInfo?: {
+        /**
+         * When paginating forwards, are there more items?
+         */
+        hasNextPage?: boolean;
+        /**
+         * When paginating forwards, the cursor to continue.
+         */
+        endCursor?: string;
+      };
+    };
+  };
+};
+
+export type GetProfileOwnedResponse =
+  GetProfileOwnedResponses[keyof GetProfileOwnedResponses];
+
+export type ClientOptions = {
+  baseUrl:
+    | "https://api-sdk.zora.engineering/"
+    | "https://api-sdk-staging.zora.engineering/"
+    | "http://localhost:8787/"
+    | (string & {});
+};

package/src/index.ts

@@ -1,5 +1,19 @@
-
-export { createCoin, createCoinCall, getCoinCreateFromLogs } from "./actions/createCoin";
-export { tradeCoin, tradeCoinCall, getTradeFromLogs } from "./actions/tradeCoin";
-export { getCoinDetails, type CoinDetails } from "./actions/getCoinDetails";
+export {
+  createCoin,
+  createCoinCall,
+  getCoinCreateFromLogs,
+} from "./actions/createCoin";
+export {
+  tradeCoin,
+  tradeCoinCall,
+  getTradeFromLogs,
+} from "./actions/tradeCoin";
+export {
+  getOnchainCoinDetails,
+  type OnchainCoinDetails,
+} from "./actions/getOnchainCoinDetails";
 export { updateCoinURI, updateCoinURICall } from "./actions/updateCoinURI";
+
+// API Read Actions
+export * from "./api/queries";
+export * from "./api/explore";

package/src/utils/genericPublicClient.ts

@@ -0,0 +1,5 @@
+import { PublicClient as VanillaPublicClient } from "viem";
+
+// A bit messy for now but it works with peerdeps.
+// TODO: Make this a more clear type.
+export type GenericPublicClient = VanillaPublicClient<any, any, any, any>;

package/src/utils/validateClientNetwork.ts

@@ -1,14 +1,18 @@
-import { PublicClient } from "viem"
-import { base, baseSepolia } from "viem/chains"
+import { PublicClient } from "viem";
+import { base, baseSepolia } from "viem/chains";
 
-export const validateClientNetwork = (publicClient: PublicClient) => {
-    const clientChainId = publicClient?.chain?.id;
-    if (clientChainId === base.id) {
-        return;
-    }
-    if (clientChainId === baseSepolia.id) {
-        return;
-    }
+export const validateClientNetwork = (
+  publicClient: PublicClient<any, any, any, any>,
+) => {
+  const clientChainId = publicClient?.chain?.id;
+  if (clientChainId === base.id) {
+    return;
+  }
+  if (clientChainId === baseSepolia.id) {
+    return;
+  }
 
-    throw new Error('Client network needs to be base or baseSepolia for current coin deployments.');
-}
+  throw new Error(
+    "Client network needs to be base or baseSepolia for current coin deployments.",
+  );
+};

package/dist/actions/getCoinDetails.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getCoinDetails.d.ts","sourceRoot":"","sources":["../../src/actions/getCoinDetails.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAyC,YAAY,EAAe,MAAM,MAAM,CAAC;AAGjG,KAAK,WAAW,GAAG;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,EAAE,MAAM,CAAC;IACzB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,0BAA0B,EAAE,MAAM,CAAC;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,KAAK,aAAa,GAAG;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;CACpB,CAAA;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,aAAa,CAAC;IACzB,SAAS,EAAE,aAAa,CAAC;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,EAAE,WAAW,CAAC;IACvB,MAAM,EAAE,SAAS,OAAO,EAAE,CAAC;IAC3B,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAsB,cAAc,CAAC,EACnC,IAAI,EACJ,IAAkB,EAClB,YAAY,GACb,EAAE;IACD,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,YAAY,EAAE,YAAY,CAAC;CAC5B,GAAG,OAAO,CAAC,WAAW,CAAC,CA+FvB"}