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

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/explore.ts

@@ -0,0 +1,55 @@
+import { getExplore } from "./sdk.gen";
+import type { GetExploreData } from "./types.gen";
+import { Options } from "@hey-api/client-fetch";
+
+type QueryInnerType = {
+  query: Omit<GetExploreData["query"], "listType">;
+} & Omit<GetExploreData, "query">;
+
+export const getTopGainers = <ThrowOnError extends boolean = false>(
+  options?: Options<QueryInnerType, ThrowOnError>,
+) =>
+  getExplore({
+    ...options,
+    query: { ...options?.query, listType: "TOP_GAINERS" },
+  });
+
+export const getTopVolume24h = <ThrowOnError extends boolean = false>(
+  options?: Options<QueryInnerType, ThrowOnError>,
+) =>
+  getExplore({
+    ...options,
+    query: { ...options?.query, listType: "TOP_VOLUME_24H" },
+  });
+
+export const getMostValuable = <ThrowOnError extends boolean = false>(
+  options?: Options<QueryInnerType, ThrowOnError>,
+) =>
+  getExplore({
+    ...options,
+    query: { ...options?.query, listType: "MOST_VALUABLE" },
+  });
+
+export const getNew = <ThrowOnError extends boolean = false>(
+  options?: Options<QueryInnerType, ThrowOnError>,
+) =>
+  getExplore({
+    ...options,
+    query: { ...options?.query, listType: "NEW" },
+  });
+
+export const getLastTraded = <ThrowOnError extends boolean = false>(
+  options?: Options<QueryInnerType, ThrowOnError>,
+) =>
+  getExplore({
+    ...options,
+    query: { ...options?.query, listType: "LAST_TRADED" },
+  });
+
+export const getLastTradedUnique = <ThrowOnError extends boolean = false>(
+  options?: Options<QueryInnerType, ThrowOnError>,
+) =>
+  getExplore({
+    ...options,
+    query: { ...options?.query, listType: "LAST_TRADED_UNIQUE" },
+  });

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,40 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
+import type { GetCoinDetailsData, GetCoinDetailsResponse, GetCoinCommentsData, GetCoinCommentsResponse, GetExploreData, GetExploreResponse } 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 getCoinDetails = <ThrowOnError extends boolean = false>(options: Options<GetCoinDetailsData, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).get<GetCoinDetailsResponse, unknown, ThrowOnError>({
+        url: '/coinDetails',
+        ...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 getExplore = <ThrowOnError extends boolean = false>(options: Options<GetExploreData, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).get<GetExploreResponse, unknown, ThrowOnError>({
+        url: '/explore',
+        ...options
+    });
+};

package/src/client/types.gen.ts

@@ -0,0 +1,229 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type GetCoinDetailsData = {
+    body?: never;
+    path?: never;
+    query: {
+        address: string;
+        chain?: number;
+    };
+    url: '/coinDetails';
+};
+
+export type GetCoinDetailsResponses = {
+    /**
+     * 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;
+            chainName?: 'EthereumMainnet' | 'EthereumRopsten' | 'EthereumRinkeby' | 'EthereumGoerli' | 'EthereumSepolia' | 'OptimismMainnet' | 'OptimismGoerli' | 'ZoraGoerli' | 'ZoraSepolia' | 'ZoraMainnet' | 'BaseMainnet' | 'BaseGoerli' | 'BaseSepolia' | 'BaseAnvil' | 'PGNMainnet' | 'ArbitrumMainnet' | 'BlastMainnet';
+            creatorProfile?: string;
+            handle?: string;
+            avatar?: {
+                small?: string;
+                medium?: string;
+                blurhash?: string;
+            };
+            bio?: string;
+            media?: {
+                mimeType?: string;
+                originalUri?: string;
+                format?: string;
+                previewImage?: string;
+                medium?: string;
+                blurhash?: string;
+            };
+            transfers?: {
+                count?: number;
+            };
+            uniqueHolders?: number;
+        };
+    };
+};
+
+export type GetCoinDetailsResponse = GetCoinDetailsResponses[keyof GetCoinDetailsResponses];
+
+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 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;
+                    address?: string;
+                    chainId?: number;
+                    creatorProfile?: string;
+                    profileId?: string;
+                    handle?: string;
+                    avatar?: {
+                        mimeType?: string;
+                        downloadableUri?: string;
+                        height?: number;
+                        width?: number;
+                        blurhash?: string;
+                    };
+                    name?: string;
+                    symbol?: string;
+                    volume24h?: string;
+                    uniqueHolders?: number;
+                    createdAt?: string;
+                    zoraComments?: {
+                        count?: number;
+                    };
+                    mediaContent?: string;
+                    mimeType?: string;
+                    originalUri?: string;
+                    downloadableUri?: string;
+                    previewImage?: string;
+                    height?: number;
+                    width?: number;
+                    blurhash?: string;
+                    marketCap?: string;
+                    marketCapDelta24h?: string;
+                };
+                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 ClientOptions = {
+    baseUrl: 'https://api-sdk.zora.engineering/' | 'https://api-sdk-staging.zora.engineering/' | (string & {});
+};

package/src/index.ts

@@ -1,5 +1,9 @@
 
 export { createCoin, createCoinCall, getCoinCreateFromLogs } from "./actions/createCoin";
 export { tradeCoin, tradeCoinCall, getTradeFromLogs } from "./actions/tradeCoin";
-export { getCoinDetails, type CoinDetails } from "./actions/getCoinDetails";
+export { getOnchainCoinDetails, type OnchainCoinDetails } from "./actions/getOnchainCoinDetails";
 export { updateCoinURI, updateCoinURICall } from "./actions/updateCoinURI";
+
+// API Read Actions
+export * from './client/sdk.gen';
+export * as explore from './client/explore';

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"}