@zoralabs/coins-sdk 0.1.3 → 0.2.1

package/src/actions/createCoin.ts

@@ -6,40 +6,71 @@ import {
   SimulateContractParameters,
   ContractEventArgsFromTopics,
   parseEventLogs,
+  zeroAddress,
+  keccak256,
+  toBytes,
   Hex,
+  Account,
 } from "viem";
 import { COIN_FACTORY_ADDRESS } from "../constants";
 import { validateClientNetwork } from "../utils/validateClientNetwork";
 import { GenericPublicClient } from "src/utils/genericPublicClient";
 import { validateMetadataURIContent, ValidMetadataURI } from "src/metadata";
 import { getAttribution } from "../utils/attribution";
+import { base, baseSepolia } from "viem/chains";
+import {
+  COIN_ETH_PAIR_POOL_CONFIG,
+  COIN_ZORA_PAIR_POOL_CONFIG,
+} from "src/utils/poolConfigUtils";
 
 export type CoinDeploymentLogArgs = ContractEventArgsFromTopics<
   typeof zoraFactoryImplABI,
-  "CoinCreated"
+  "CoinCreatedV4"
 >;
 
-// This is the default pool config matching zora.co front-end. TODO: Allow users to customize further parameters within safe contract limits.
-const POOL_CONFIG =
-  "0x00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffc2f70fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffcf2c0000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000b1a2bc2ec50000" as Hex;
+export enum DeployCurrency {
+  ZORA = 1,
+  ETH = 2,
+}
 
 export type CreateCoinArgs = {
   name: string;
   symbol: string;
   uri: ValidMetadataURI;
+  chainId: number;
   owners?: Address[];
   payoutRecipient: Address;
   platformReferrer?: Address;
-  initialPurchaseWei?: bigint;
+  currency?: DeployCurrency;
 };
 
+function getPoolConfig(currency: DeployCurrency, chainId: number) {
+  if (currency === DeployCurrency.ZORA && chainId == baseSepolia.id) {
+    throw new Error("ZORA is not supported on Base Sepolia");
+  }
+
+  switch (currency) {
+    case DeployCurrency.ZORA:
+      return COIN_ZORA_PAIR_POOL_CONFIG[
+        chainId as keyof typeof COIN_ZORA_PAIR_POOL_CONFIG
+      ];
+    case DeployCurrency.ETH:
+      return COIN_ETH_PAIR_POOL_CONFIG[
+        chainId as keyof typeof COIN_ETH_PAIR_POOL_CONFIG
+      ];
+    default:
+      throw new Error("Invalid currency");
+  }
+}
+
 export async function createCoinCall({
   name,
   symbol,
   uri,
   owners,
   payoutRecipient,
-  initialPurchaseWei = 0n,
+  currency,
+  chainId = base.id,
   platformReferrer = "0x0000000000000000000000000000000000000000",
 }: CreateCoinArgs): Promise<
   SimulateContractParameters<typeof zoraFactoryImplABI, "deploy">
@@ -48,9 +79,11 @@ export async function createCoinCall({
     owners = [payoutRecipient];
   }
 
-  const orderSize: bigint = initialPurchaseWei;
-  // The default pool config for
-  const poolConfig = POOL_CONFIG;
+  if (!currency) {
+    currency = chainId !== base.id ? DeployCurrency.ETH : DeployCurrency.ZORA;
+  }
+
+  const poolConfig = getPoolConfig(currency, chainId);
 
   // This will throw an error if the metadata is not valid
   await validateMetadataURIContent(uri);
@@ -67,9 +100,10 @@ export async function createCoinCall({
       symbol,
       poolConfig,
       platformReferrer,
-      orderSize,
+      zeroAddress, // hookAddress
+      "0x" as Hex, // hookData
+      keccak256(toBytes(Math.random().toString())), // coinSalt
     ],
-    value: initialPurchaseWei,
     dataSuffix: getAttribution(),
   } as const;
 }
@@ -86,7 +120,8 @@ export function getCoinCreateFromLogs(
     abi: zoraFactoryImplABI,
     logs: receipt.logs,
   });
-  return eventLogs.find((log) => log.eventName === "CoinCreated")?.args;
+
+  return eventLogs.find((log) => log.eventName === "CoinCreatedV4")?.args;
 }
 
 // Update createCoin to return both receipt and coin address
@@ -96,6 +131,7 @@ export async function createCoin(
   publicClient: GenericPublicClient,
   options?: {
     gasMultiplier?: number;
+    account?: Account | Address;
   },
 ) {
   validateClientNetwork(publicClient);
@@ -103,7 +139,7 @@ export async function createCoin(
   const createCoinRequest = await createCoinCall(call);
   const { request } = await publicClient.simulateContract({
     ...createCoinRequest,
-    account: walletClient.account,
+    account: options?.account ?? walletClient.account,
   });
 
   // Add a 2/5th buffer on gas.

package/src/api/internal.ts

@@ -0,0 +1,23 @@
+import {
+  SetCreateUploadJwtData,
+  SetCreateUploadJwtResponse,
+} from "../client/types.gen";
+import { setCreateUploadJwt as setCreateUploadJwtSDK } from "../client/sdk.gen";
+import { getApiKeyMeta } from "./api-key";
+import { RequestOptionsType } from "./query-types";
+import { RequestResult } from "@hey-api/client-fetch";
+
+type SetCreateUploadJwtQuery = SetCreateUploadJwtData["query"];
+export type { SetCreateUploadJwtQuery, SetCreateUploadJwtData };
+export type { SetCreateUploadJwtResponse } from "../client/types.gen";
+
+export const setCreateUploadJwt = async (
+  query: SetCreateUploadJwtQuery,
+  options?: RequestOptionsType<SetCreateUploadJwtData>,
+): Promise<RequestResult<SetCreateUploadJwtResponse>> => {
+  return await setCreateUploadJwtSDK({
+    query,
+    meta: getApiKeyMeta(),
+    ...options,
+  });
+};

package/src/api/queries.ts

@@ -7,6 +7,8 @@ import {
   GetCoinsResponse,
   GetProfileBalancesData,
   GetProfileBalancesResponse,
+  GetProfileCoinsData,
+  GetProfileCoinsResponse,
   GetProfileData,
   GetProfileResponse,
 } from "../client/types.gen";
@@ -16,6 +18,7 @@ import {
   getCoinComments as getCoinCommentsSDK,
   getProfile as getProfileSDK,
   getProfileBalances as getProfileBalancesSDK,
+  getProfileCoins as getProfileCoinsSDK,
 } from "../client/sdk.gen";
 import { getApiKeyMeta } from "./api-key";
 import { RequestOptionsType } from "./query-types";
@@ -87,6 +90,21 @@ export const getProfile = async (
   });
 };
 
+type GetProfileCoinsQuery = GetProfileCoinsData["query"];
+export type { GetProfileCoinsQuery, GetProfileCoinsData };
+export type { GetProfileCoinsResponse } from "../client/types.gen";
+
+export const getProfileCoins = async (
+  query: GetProfileCoinsQuery,
+  options?: RequestOptionsType<GetProfileCoinsData>,
+): Promise<RequestResult<GetProfileCoinsResponse>> => {
+  return await getProfileCoinsSDK({
+    query,
+    meta: getApiKeyMeta(),
+    ...options,
+  });
+};
+
 type GetProfileBalancesQuery = GetProfileBalancesData["query"];
 export type { GetProfileBalancesQuery, GetProfileBalancesData };
 export type { GetProfileBalancesResponse } from "../client/types.gen";

package/src/client/sdk.gen.ts

@@ -6,18 +6,24 @@ import type {
   Client,
 } from "@hey-api/client-fetch";
 import type {
+  GetApiKeyData,
+  GetApiKeyResponse,
   GetCoinData,
   GetCoinResponse,
   GetCoinCommentsData,
   GetCoinCommentsResponse,
   GetCoinsData,
   GetCoinsResponse,
+  SetCreateUploadJwtData,
+  SetCreateUploadJwtResponse,
   GetExploreData,
   GetExploreResponse,
   GetProfileData,
   GetProfileResponse,
   GetProfileBalancesData,
   GetProfileBalancesResponse,
+  GetProfileCoinsData,
+  GetProfileCoinsResponse,
 } from "./types.gen";
 import { client as _heyApiClient } from "./client.gen";
 
@@ -38,6 +44,28 @@ export type Options<
   meta?: Record<string, unknown>;
 };
 
+/**
+ * zoraSDK_apiKey query
+ */
+export const getApiKey = <ThrowOnError extends boolean = false>(
+  options: Options<GetApiKeyData, ThrowOnError>,
+) => {
+  return (options.client ?? _heyApiClient).get<
+    GetApiKeyResponse,
+    unknown,
+    ThrowOnError
+  >({
+    security: [
+      {
+        name: "api-key",
+        type: "apiKey",
+      },
+    ],
+    url: "/apiKey",
+    ...options,
+  });
+};
+
 /**
  * zoraSDK_coin query
  */
@@ -49,6 +77,12 @@ export const getCoin = <ThrowOnError extends boolean = false>(
     unknown,
     ThrowOnError
   >({
+    security: [
+      {
+        name: "api-key",
+        type: "apiKey",
+      },
+    ],
     url: "/coin",
     ...options,
   });
@@ -65,6 +99,12 @@ export const getCoinComments = <ThrowOnError extends boolean = false>(
     unknown,
     ThrowOnError
   >({
+    security: [
+      {
+        name: "api-key",
+        type: "apiKey",
+      },
+    ],
     url: "/coinComments",
     ...options,
   });
@@ -81,11 +121,43 @@ export const getCoins = <ThrowOnError extends boolean = false>(
     unknown,
     ThrowOnError
   >({
+    security: [
+      {
+        name: "api-key",
+        type: "apiKey",
+      },
+    ],
     url: "/coins",
     ...options,
   });
 };
 
+/**
+ * zoraSDK_createUploadJWT mutation
+ */
+export const setCreateUploadJwt = <ThrowOnError extends boolean = false>(
+  options?: Options<SetCreateUploadJwtData, ThrowOnError>,
+) => {
+  return (options?.client ?? _heyApiClient).post<
+    SetCreateUploadJwtResponse,
+    unknown,
+    ThrowOnError
+  >({
+    security: [
+      {
+        name: "api-key",
+        type: "apiKey",
+      },
+    ],
+    url: "/createUploadJWT",
+    ...options,
+    headers: {
+      "Content-Type": "application/json",
+      ...options?.headers,
+    },
+  });
+};
+
 /**
  * zoraSDK_explore query
  */
@@ -97,6 +169,12 @@ export const getExplore = <ThrowOnError extends boolean = false>(
     unknown,
     ThrowOnError
   >({
+    security: [
+      {
+        name: "api-key",
+        type: "apiKey",
+      },
+    ],
     url: "/explore",
     ...options,
   });
@@ -113,6 +191,12 @@ export const getProfile = <ThrowOnError extends boolean = false>(
     unknown,
     ThrowOnError
   >({
+    security: [
+      {
+        name: "api-key",
+        type: "apiKey",
+      },
+    ],
     url: "/profile",
     ...options,
   });
@@ -129,7 +213,35 @@ export const getProfileBalances = <ThrowOnError extends boolean = false>(
     unknown,
     ThrowOnError
   >({
+    security: [
+      {
+        name: "api-key",
+        type: "apiKey",
+      },
+    ],
     url: "/profileBalances",
     ...options,
   });
 };
+
+/**
+ * zoraSDK_profileCoins query
+ */
+export const getProfileCoins = <ThrowOnError extends boolean = false>(
+  options: Options<GetProfileCoinsData, ThrowOnError>,
+) => {
+  return (options.client ?? _heyApiClient).get<
+    GetProfileCoinsResponse,
+    unknown,
+    ThrowOnError
+  >({
+    security: [
+      {
+        name: "api-key",
+        type: "apiKey",
+      },
+    ],
+    url: "/profileCoins",
+    ...options,
+  });
+};