@zoralabs/coins-sdk 0.0.2-sdkalpha.7 → 0.0.2

package/src/actions/createCoin.ts

@@ -1,7 +1,6 @@
 import { zoraFactoryImplABI } from "@zoralabs/coins";
 import {
   Address,
-  PublicClient,
   TransactionReceipt,
   WalletClient,
   SimulateContractParameters,
@@ -10,6 +9,7 @@ import {
 } from "viem";
 import { COIN_FACTORY_ADDRESS } from "../constants";
 import { validateClientNetwork } from "../utils/validateClientNetwork";
+import { GenericPublicClient } from "src/utils/genericPublicClient";
 
 export type CoinDeploymentLogArgs = ContractEventArgsFromTopics<
   typeof zoraFactoryImplABI,
@@ -83,7 +83,7 @@ export function getCoinCreateFromLogs(
 export async function createCoin(
   call: CreateCoinArgs,
   walletClient: WalletClient,
-  publicClient: PublicClient,
+  publicClient: GenericPublicClient,
   options?: {
     gasMultiplier?: number;
   },

package/src/actions/tradeCoin.ts

@@ -2,7 +2,6 @@ import { coinABI } from "@zoralabs/coins";
 import { validateClientNetwork } from "../utils/validateClientNetwork";
 import {
   Address,
-  PublicClient,
   TransactionReceipt,
   WalletClient,
   SimulateContractParameters,
@@ -12,7 +11,7 @@ import {
   parseEventLogs,
 } from "viem";
 import { baseSepolia } from "viem/chains";
-
+import { GenericPublicClient } from "src/utils/genericPublicClient";
 // Define trade event args type
 
 export type SellEventArgs = ContractEventArgsFromTopics<
@@ -41,7 +40,7 @@ export async function simulateBuy({
 }: {
   target: Address;
   requestedOrderSize: bigint;
-  publicClient: PublicClient;
+  publicClient: GenericPublicClient;
 }): Promise<{ orderSize: bigint; amountOut: bigint }> {
   const numberResult = await publicClient.simulateContract({
     address: target,
@@ -157,7 +156,7 @@ export function getTradeFromLogs(
 export async function tradeCoin(
   params: TradeParams,
   walletClient: WalletClient,
-  publicClient: PublicClient,
+  publicClient: GenericPublicClient,
 ) {
   validateClientNetwork(publicClient);
   const { request } = await publicClient.simulateContract({

package/src/actions/updateCoinURI.ts

@@ -3,10 +3,10 @@ import { validateClientNetwork } from "../utils/validateClientNetwork";
 import {
   Address,
   parseEventLogs,
-  PublicClient,
   SimulateContractParameters,
   WalletClient,
 } from "viem";
+import { GenericPublicClient } from "src/utils/genericPublicClient";
 
 export type UpdateCoinURIArgs = {
   coin: Address;
@@ -32,7 +32,7 @@ export function updateCoinURICall({
 export async function updateCoinURI(
   args: UpdateCoinURIArgs,
   walletClient: WalletClient,
-  publicClient: PublicClient,
+  publicClient: GenericPublicClient,
 ) {
   validateClientNetwork(publicClient);
   const call = updateCoinURICall(args);

package/src/actions/updatePayoutRecipient.ts

@@ -3,10 +3,10 @@ import { validateClientNetwork } from "../utils/validateClientNetwork";
 import {
   Address,
   parseEventLogs,
-  PublicClient,
   SimulateContractParameters,
   WalletClient,
 } from "viem";
+import { GenericPublicClient } from "src/utils/genericPublicClient";
 
 export type UpdatePayoutRecipientArgs = {
   coin: Address;
@@ -28,7 +28,7 @@ export function updatePayoutRecipientCall({
 export async function updatePayoutRecipient(
   args: UpdatePayoutRecipientArgs,
   walletClient: WalletClient,
-  publicClient: PublicClient,
+  publicClient: GenericPublicClient,
 ) {
   validateClientNetwork(publicClient);
   const call = updatePayoutRecipientCall(args);

package/src/api/explore.ts

@@ -1,55 +1,73 @@
 import { getExplore as getExploreSDK } from "../client/sdk.gen";
-import type { GetExploreData } from "../client/types.gen";
-import { Options } from "@hey-api/client-fetch";
+import type { GetExploreData, GetExploreResponse } from "../client/types.gen";
 import { getApiKeyMeta } from "./api-key";
+import { RequestOptionsType } from "./query-types";
 
 /**
  * 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">;
+export type QueryRequestType = Omit<GetExploreData["query"], "listType">;
+
+type ExploreResponse = { data?: GetExploreResponse };
+
+export type ListType = GetExploreData["query"]["listType"];
+
+export type { ExploreResponse };
+
+export type { GetExploreData };
 
 /**
  * Creates an explore query with the specified list type
  */
-const createExploreQuery = <T extends boolean = false>(
-  listType: GetExploreData["query"]["listType"],
-  options?: Options<QueryInnerType, T>,
-) =>
+const createExploreQuery = (
+  query: QueryRequestType,
+  listType: ListType,
+  options?: RequestOptionsType<GetExploreData>,
+): Promise<ExploreResponse> =>
   getExploreSDK({
     ...options,
-    query: { ...options?.query, listType },
+    query: { ...query, listType },
     meta: getApiKeyMeta(),
   });
 
 /** Get top gaining coins */
-export const getCoinsTopGainers = <T extends boolean = false>(
-  options?: Options<QueryInnerType, T>,
-) => createExploreQuery("TOP_GAINERS", options);
+export const getCoinsTopGainers = (
+  query: QueryRequestType = {},
+  options?: RequestOptionsType<GetExploreData>,
+): Promise<ExploreResponse> =>
+  createExploreQuery(query, "TOP_GAINERS", options);
 
 /** Get coins with highest 24h volume */
-export const getCoinsTopVolume24h = <T extends boolean = false>(
-  options?: Options<QueryInnerType, T>,
-) => createExploreQuery("TOP_VOLUME_24H", options);
+export const getCoinsTopVolume24h = (
+  query: QueryRequestType = {},
+  options?: RequestOptionsType<GetExploreData>,
+): Promise<ExploreResponse> =>
+  createExploreQuery(query, "TOP_VOLUME_24H", options);
 
 /** Get most valuable coins */
-export const getCoinsMostValuable = <T extends boolean = false>(
-  options?: Options<QueryInnerType, T>,
-) => createExploreQuery("MOST_VALUABLE", options);
+export const getCoinsMostValuable = (
+  query: QueryRequestType = {},
+  options?: RequestOptionsType<GetExploreData>,
+): Promise<ExploreResponse> =>
+  createExploreQuery(query, "MOST_VALUABLE", options);
 
 /** Get newly created coins */
-export const getCoinsNew = <T extends boolean = false>(
-  options?: Options<QueryInnerType, T>,
-) => createExploreQuery("NEW", options);
+export const getCoinsNew = (
+  query: QueryRequestType = {},
+  options?: RequestOptionsType<GetExploreData>,
+): Promise<ExploreResponse> => createExploreQuery(query, "NEW", options);
 
 /** Get recently traded coins */
-export const getCoinsLastTraded = <T extends boolean = false>(
-  options?: Options<QueryInnerType, T>,
-) => createExploreQuery("LAST_TRADED", options);
+export const getCoinsLastTraded = (
+  query: QueryRequestType = {},
+  options?: RequestOptionsType<GetExploreData>,
+): Promise<ExploreResponse> =>
+  createExploreQuery(query, "LAST_TRADED", options);
 
 /** Get recently traded unique coins */
-export const getCoinsLastTradedUnique = <T extends boolean = false>(
-  options?: Options<QueryInnerType, T>,
-) => createExploreQuery("LAST_TRADED_UNIQUE", options);
+export const getCoinsLastTradedUnique = (
+  query: QueryRequestType = {},
+  options?: RequestOptionsType<GetExploreData>,
+): Promise<ExploreResponse> =>
+  createExploreQuery(query, "LAST_TRADED_UNIQUE", options);

package/src/api/index.ts

@@ -1,7 +1,9 @@
 // Export all of the explore queries
 export * from "./explore";
+export type * from "./explore";
 // Export all of the queries
 export * from "./queries";
+export type * from "./queries";
 
 // Only export the set function for external use.
 // All other exports are for internal use.

package/src/api/queries.ts

@@ -1,8 +1,13 @@
 import {
   GetCoinCommentsData,
+  GetCoinCommentsResponse,
   GetCoinData,
+  GetCoinResponse,
+  GetCoinsData,
+  GetCoinsResponse,
   GetProfileBalancesData,
   GetProfileData,
+  GetProfileResponse,
 } from "../client/types.gen";
 import {
   getCoin as getCoinSDK,
@@ -12,21 +17,40 @@ import {
   getProfileBalances as getProfileBalancesSDK,
 } from "../client/sdk.gen";
 import { getApiKeyMeta } from "./api-key";
+import { RequestOptionsType } from "./query-types";
 
-export const getCoin = async (query: GetCoinData["query"]) => {
+type APIQueryDataResponse<T> = Promise<{ data?: T }>;
+
+export type { APIQueryDataResponse };
+
+type GetCoinQuery = GetCoinData["query"];
+export type { GetCoinQuery, GetCoinData };
+export type { GetCoinResponse } from "../client/types.gen";
+
+export type CoinData = NonNullable<GetCoinResponse["zora20Token"]>;
+
+export const getCoin = async (
+  query: GetCoinQuery,
+  options?: RequestOptionsType<GetCoinData>,
+): Promise<{ data?: GetCoinResponse }> => {
   return await getCoinSDK({
+    ...options,
     query,
     meta: getApiKeyMeta(),
   });
 };
 
-export const getCoins = async ({
-  coinAddresses,
-  chainId,
-}: {
+type GetCoinsQuery = {
   coinAddresses: string[];
   chainId?: number;
-}) => {
+};
+export type { GetCoinsQuery, GetCoinsData };
+export type { GetCoinsResponse } from "../client/types.gen";
+
+export const getCoins = async (
+  { coinAddresses, chainId }: GetCoinsQuery,
+  options?: RequestOptionsType<GetCoinsData>,
+): APIQueryDataResponse<GetCoinsResponse> => {
   return await getCoinsSDK({
     query: {
       coins: coinAddresses.map((collectionAddress) => ({
@@ -35,28 +59,51 @@ export const getCoins = async ({
       })),
     },
     meta: getApiKeyMeta(),
+    ...options,
   });
 };
 
-export const getCoinComments = async (query: GetCoinCommentsData["query"]) => {
+type GetCoinCommentsQuery = GetCoinCommentsData["query"];
+export type { GetCoinCommentsQuery, GetCoinCommentsData };
+export type { GetCoinCommentsResponse } from "../client/types.gen";
+
+export const getCoinComments = async (
+  query: GetCoinCommentsQuery,
+  options?: RequestOptionsType<GetCoinCommentsData>,
+): APIQueryDataResponse<GetCoinCommentsResponse> => {
   return await getCoinCommentsSDK({
     query,
     meta: getApiKeyMeta(),
+    ...options,
   });
 };
 
-export const getProfile = async (query: GetProfileData["query"]) => {
+type GetProfileQuery = GetProfileData["query"];
+export type { GetProfileQuery, GetProfileData };
+export type { GetProfileResponse } from "../client/types.gen";
+
+export const getProfile = async (
+  query: GetProfileQuery,
+  options?: RequestOptionsType<GetProfileData>,
+): APIQueryDataResponse<GetProfileResponse> => {
   return await getProfileSDK({
     query,
     meta: getApiKeyMeta(),
+    ...options,
   });
 };
 
+type GetProfileBalancesQuery = GetProfileBalancesData["query"];
+export type { GetProfileBalancesQuery, GetProfileBalancesData };
+export type { GetProfileBalancesResponse } from "../client/types.gen";
+
 export const getProfileBalances = async (
   query: GetProfileBalancesData["query"],
+  options?: RequestOptionsType<GetProfileBalancesData>,
 ) => {
   return await getProfileBalancesSDK({
     query,
     meta: getApiKeyMeta(),
+    ...options,
   });
 };

package/src/api/query-types.ts

@@ -0,0 +1,8 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type {
+  Options as ClientOptions,
+  TDataShape,
+} from "@hey-api/client-fetch";
+
+export type RequestOptionsType<TData extends TDataShape> = ClientOptions<TData>;

package/src/index.ts

@@ -6,6 +6,7 @@ export {
 export type { CreateCoinArgs } from "./actions/createCoin";
 
 export {
+  simulateBuy,
   tradeCoin,
   tradeCoinCall,
   getTradeFromLogs,
@@ -27,13 +28,13 @@ export type { UpdatePayoutRecipientArgs } from "./actions/updatePayoutRecipient"
 
 // API Read Actions
 export * from "./api/queries";
+export type * from "./api/queries";
+
 export * from "./api/explore";
+export type * from "./api/explore";
 
 // API Key Setter
 export { setApiKey } from "./api/api-key";
 
 // Metadata Validation Utils
 export * from "./metadata";
-
-// API Types
-export type * from "./client/types.gen";

package/dist/utils/retries.d.ts

@@ -1,7 +0,0 @@
-export declare const retriesGeneric: <T>(params: {
-    tryFn: () => T;
-    maxTries?: number;
-    linearBackoffMS?: number;
-    shouldRetryOnError?: (err: any) => boolean;
-}) => Promise<T>;
-//# sourceMappingURL=retries.d.ts.map

package/dist/utils/retries.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"retries.d.ts","sourceRoot":"","sources":["../../src/utils/retries.ts"],"names":[],"mappings":"AAsCA,eAAO,MAAM,cAAc,GAAU,CAAC,UAAU;IAC9C,KAAK,EAAE,MAAM,CAAC,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,kBAAkB,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC;CAC5C,eAKA,CAAC"}

package/src/utils/retries.ts

@@ -1,49 +0,0 @@
-async function wait(delayMs: number) {
-  return new Promise((resolve) => {
-    setTimeout(resolve, delayMs);
-  });
-}
-
-const retryInternal = async <T>({
-  tryFn,
-  maxTries = 3,
-  atTry,
-  linearBackoffMS = 200,
-  shouldRetryOnError = () => true,
-}: {
-  tryFn: () => T;
-  maxTries?: number;
-  atTry: number;
-  linearBackoffMS?: number;
-  shouldRetryOnError?: (err: any) => boolean;
-}): Promise<T> => {
-  try {
-    return await tryFn();
-  } catch (err: any) {
-    if (shouldRetryOnError(err)) {
-      if (atTry <= maxTries) {
-        await wait(atTry * linearBackoffMS);
-        return await retryInternal({
-          tryFn,
-          maxTries,
-          atTry: atTry + 1,
-          linearBackoffMS,
-          shouldRetryOnError,
-        });
-      }
-    }
-    throw err;
-  }
-};
-
-export const retriesGeneric = async <T>(params: {
-  tryFn: () => T;
-  maxTries?: number;
-  linearBackoffMS?: number;
-  shouldRetryOnError?: (err: any) => boolean;
-}) => {
-  return retryInternal({
-    ...params,
-    atTry: 1,
-  });
-};