@zoralabs/coins-sdk 0.2.2 → 0.2.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zoralabs/coins-sdk",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "repository": "https://github.com/ourzora/zora-protocol",
   "license": "MIT",
   "type": "module",
@@ -23,7 +23,7 @@
   },
   "dependencies": {
     "@hey-api/client-fetch": "^0.8.3",
-    "@zoralabs/protocol-deployments": "^0.6.0"
+    "@zoralabs/protocol-deployments": "^0.6.1"
   },
   "peerDependencies": {
     "abitype": "^1.0.8",

package/src/actions/createCoin.ts

@@ -12,16 +12,17 @@ import {
   Hex,
   Account,
 } from "viem";
+import { base, baseSepolia } from "viem/chains";
 import { COIN_FACTORY_ADDRESS } from "../constants";
 import { validateClientNetwork } from "../utils/validateClientNetwork";
-import { GenericPublicClient } from "src/utils/genericPublicClient";
-import { validateMetadataURIContent, ValidMetadataURI } from "src/metadata";
+import { GenericPublicClient } from "../utils/genericPublicClient";
+import { validateMetadataURIContent, ValidMetadataURI } from "../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";
+} from "../utils/poolConfigUtils";
+import { getPrepurchaseHook } from "../utils/getPrepurchaseHook";
 
 export type CoinDeploymentLogArgs = ContractEventArgsFromTopics<
   typeof zoraFactoryImplABI,
@@ -33,15 +34,24 @@ export enum DeployCurrency {
   ETH = 2,
 }
 
+export enum InitialPurchaseCurrency {
+  ETH = 1,
+  // TODO: Add USDC and ZORA support with signature approvals
+}
+
 export type CreateCoinArgs = {
   name: string;
   symbol: string;
   uri: ValidMetadataURI;
-  chainId: number;
+  chainId?: number;
   owners?: Address[];
   payoutRecipient: Address;
   platformReferrer?: Address;
   currency?: DeployCurrency;
+  initialPurchase?: {
+    currency: InitialPurchaseCurrency;
+    amount: bigint;
+  };
 };
 
 function getPoolConfig(currency: DeployCurrency, chainId: number) {
@@ -72,6 +82,7 @@ export async function createCoinCall({
   currency,
   chainId = base.id,
   platformReferrer = "0x0000000000000000000000000000000000000000",
+  initialPurchase,
 }: CreateCoinArgs): Promise<
   SimulateContractParameters<typeof zoraFactoryImplABI, "deploy">
 > {
@@ -88,6 +99,19 @@ export async function createCoinCall({
   // This will throw an error if the metadata is not valid
   await validateMetadataURIContent(uri);
 
+  let deployHook = {
+    hook: zeroAddress as Address,
+    hookData: "0x" as Hex,
+    value: 0n,
+  };
+  if (initialPurchase) {
+    deployHook = await getPrepurchaseHook({
+      initialPurchase,
+      payoutRecipient,
+      chainId,
+    });
+  }
+
   return {
     abi: zoraFactoryImplABI,
     functionName: "deploy",
@@ -100,10 +124,11 @@ export async function createCoinCall({
       symbol,
       poolConfig,
       platformReferrer,
-      zeroAddress, // hookAddress
-      "0x" as Hex, // hookData
+      deployHook.hook,
+      deployHook.hookData,
       keccak256(toBytes(Math.random().toString())), // coinSalt
     ],
+    value: deployHook.value,
     dataSuffix: getAttribution(),
   } as const;
 }

package/src/actions/updateCoinURI.ts

@@ -6,7 +6,7 @@ import {
   SimulateContractParameters,
   WalletClient,
 } from "viem";
-import { GenericPublicClient } from "src/utils/genericPublicClient";
+import { GenericPublicClient } from "../utils/genericPublicClient";
 import { getAttribution } from "../utils/attribution";
 
 export type UpdateCoinURIArgs = {

package/src/actions/updatePayoutRecipient.ts

@@ -6,7 +6,7 @@ import {
   SimulateContractParameters,
   WalletClient,
 } from "viem";
-import { GenericPublicClient } from "src/utils/genericPublicClient";
+import { GenericPublicClient } from "../utils/genericPublicClient";
 import { getAttribution } from "../utils/attribution";
 
 export type UpdatePayoutRecipientArgs = {

package/src/api/index.ts

@@ -1,6 +1,7 @@
 // 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";

package/src/index.ts

@@ -3,16 +3,12 @@ export {
   createCoinCall,
   getCoinCreateFromLogs,
   DeployCurrency,
+  InitialPurchaseCurrency,
+} from "./actions/createCoin";
+export type {
+  CreateCoinArgs,
+  CoinDeploymentLogArgs,
 } from "./actions/createCoin";
-export type { CreateCoinArgs } from "./actions/createCoin";
-
-export {
-  simulateBuy,
-  tradeCoin,
-  tradeCoinCall,
-  getTradeFromLogs,
-} from "./actions/tradeCoin";
-export type { TradeParams } from "./actions/tradeCoin";
 
 export {
   getOnchainCoinDetails,
@@ -31,6 +27,7 @@ export type { UpdatePayoutRecipientArgs } from "./actions/updatePayoutRecipient"
 export * from "./api/queries";
 export type * from "./api/queries";
 
+// API Explore Actions
 export * from "./api/explore";
 export type * from "./api/explore";
 

package/src/utils/getPrepurchaseHook.ts

@@ -0,0 +1,59 @@
+import {
+  encodeBuySupplyWithMultiHopSwapRouterHookCall,
+  wethAddress,
+} from "@zoralabs/protocol-deployments";
+import { InitialPurchaseCurrency } from "../actions/createCoin";
+import { Address, concat, Hex, pad, toHex } from "viem";
+import { ZORA_ADDRESS } from "./poolConfigUtils";
+import { base } from "viem/chains";
+
+const BASE_UDSC_ADDRESS = "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913";
+
+const USDC_ZORA_FEE = 3000;
+const WETH_BASE_FEE = 3000;
+
+const encodeFee = (fee: number) => pad(toHex(fee), { size: 3 });
+
+export const getPrepurchaseHook = async ({
+  payoutRecipient,
+  initialPurchase,
+  chainId,
+}: {
+  initialPurchase: {
+    currency: InitialPurchaseCurrency;
+    amount: bigint;
+    amountOutMinimum?: bigint;
+  };
+  payoutRecipient: Address;
+  chainId: number;
+}) => {
+  if (
+    initialPurchase.currency !== InitialPurchaseCurrency.ETH &&
+    chainId !== base.id
+  ) {
+    throw new Error("Initial purchase currency and/or chain not supported");
+  }
+
+  const path = concat([
+    wethAddress[base.id],
+    encodeFee(WETH_BASE_FEE),
+    BASE_UDSC_ADDRESS,
+    encodeFee(USDC_ZORA_FEE),
+    ZORA_ADDRESS,
+  ]);
+
+  return encodeBuySupplyWithMultiHopSwapRouterHookCall({
+    ethValue: initialPurchase.amount,
+    buyRecipient: payoutRecipient,
+    exactInputParams: {
+      path,
+      amountIn: initialPurchase.amount,
+      amountOutMinimum: initialPurchase.amountOutMinimum || 0n,
+    },
+    chainId: base.id,
+  }) as {
+    hook: Address;
+    hookData: Hex;
+    value: bigint;
+  };
+};

package/dist/actions/tradeCoin.d.ts

@@ -1,75 +0,0 @@
-import { coinABI } from "@zoralabs/protocol-deployments";
-import { Address, TransactionReceipt, WalletClient, SimulateContractParameters, ContractEventArgsFromTopics } from "viem";
-import { GenericPublicClient } from "src/utils/genericPublicClient";
-export type SellEventArgs = ContractEventArgsFromTopics<typeof coinABI, "CoinSell">;
-export type BuyEventArgs = ContractEventArgsFromTopics<typeof coinABI, "CoinBuy">;
-export type TradeEventArgs = SellEventArgs | BuyEventArgs;
-/**
- * Simulates a buy order to get the expected output amount
- * @param {Object} params - The simulation parameters
- * @param {Address} params.target - The target coin contract address
- * @param {bigint} params.requestedOrderSize - The desired input amount for the buy
- * @param {PublicClient} params.publicClient - The viem public client instance
- * @returns {Promise<{orderSize: bigint, amountOut: bigint}>} The simulated order size and output amount
- */
-export declare function simulateBuy({ target, requestedOrderSize, publicClient, }: {
-    target: Address;
-    requestedOrderSize: bigint;
-    publicClient: GenericPublicClient;
-}): Promise<{
-    orderSize: bigint;
-    amountOut: bigint;
-}>;
-/**
- * Parameters for creating a trade call
- * @typedef {Object} TradeParams
- * @property {'sell' | 'buy'} direction - The trade direction
- * @property {Address} target - The target coin contract address
- * @property {Object} args - The trade arguments
- * @property {Address} args.recipient - The recipient of the trade output
- * @property {bigint} args.orderSize - The size of the order
- * @property {bigint} [args.minAmountOut] - The minimum amount to receive
- * @property {bigint} [args.sqrtPriceLimitX96] - The price limit for the trade
- * @property {Address} [args.tradeReferrer] - The referrer address for the trade
- */
-export type TradeParams = {
-    direction: "sell" | "buy";
-    target: Address;
-    args: {
-        recipient: Address;
-        orderSize: bigint;
-        minAmountOut?: bigint;
-        sqrtPriceLimitX96?: bigint;
-        tradeReferrer?: Address;
-    };
-};
-/**
- * Creates a trade call parameters object for buy or sell
- * @param {TradeParams} params - The trade parameters
- * @returns {SimulateContractParameters} The contract call parameters
- */
-export declare function tradeCoinCall({ target, direction, args: { recipient, orderSize, minAmountOut, sqrtPriceLimitX96, tradeReferrer, }, }: TradeParams): SimulateContractParameters;
-/**
- * Gets the trade event from transaction receipt logs
- * @param {TransactionReceipt} receipt - The transaction receipt containing the logs
- * @param {'buy' | 'sell'} direction - The direction of the trade
- * @returns {TradeEventArgs | undefined} The decoded trade event args if found
- */
-export declare function getTradeFromLogs(receipt: TransactionReceipt, direction: "buy" | "sell"): TradeEventArgs | undefined;
-/**
- * Executes a trade transaction
- * @param {TradeParams} params - The trade parameters
- * @param {PublicClient} publicClient - The viem public client instance
- * @param {WalletClient} walletClient - The viem wallet client instance
- * @returns {Promise<{
- *   hash: `0x${string}`,
- *   receipt: TransactionReceipt,
- *   trade: TradeEventArgs | undefined
- * }>} The transaction result with trade details
- */
-export declare function tradeCoin(params: TradeParams, walletClient: WalletClient, publicClient: GenericPublicClient): Promise<{
-    hash: `0x${string}`;
-    receipt: any;
-    trade: TradeEventArgs | undefined;
-}>;
-//# sourceMappingURL=tradeCoin.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"tradeCoin.d.ts","sourceRoot":"","sources":["../../src/actions/tradeCoin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAEzD,OAAO,EACL,OAAO,EACP,kBAAkB,EAClB,YAAY,EACZ,0BAA0B,EAG1B,2BAA2B,EAE5B,MAAM,MAAM,CAAC;AAEd,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAIpE,MAAM,MAAM,aAAa,GAAG,2BAA2B,CACrD,OAAO,OAAO,EACd,UAAU,CACX,CAAC;AACF,MAAM,MAAM,YAAY,GAAG,2BAA2B,CACpD,OAAO,OAAO,EACd,SAAS,CACV,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,YAAY,CAAC;AAO1D;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAAC,EAChC,MAAM,EACN,kBAAkB,EAClB,YAAY,GACb,EAAE;IACD,MAAM,EAAE,OAAO,CAAC;IAChB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,YAAY,EAAE,mBAAmB,CAAC;CACnC,GAAG,OAAO,CAAC;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC,CAwBpD;AAED;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,SAAS,EAAE,MAAM,GAAG,KAAK,CAAC;IAC1B,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE;QACJ,SAAS,EAAE,OAAO,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,aAAa,CAAC,EAAE,OAAO,CAAC;KACzB,CAAC;CACH,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,EAC5B,MAAM,EACN,SAAS,EACT,IAAI,EAAE,EACJ,SAAS,EACT,SAAS,EACT,YAAiB,EACjB,iBAAsB,EACtB,aAA2B,GAC5B,GACF,EAAE,WAAW,GAAG,0BAA0B,CAc1C;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,kBAAkB,EAC3B,SAAS,EAAE,KAAK,GAAG,MAAM,GACxB,cAAc,GAAG,SAAS,CAU5B;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,SAAS,CAC7B,MAAM,EAAE,WAAW,EACnB,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,mBAAmB;;;;GAgBlC"}

package/src/actions/tradeCoin.ts

@@ -1,182 +0,0 @@
-import { coinABI } from "@zoralabs/protocol-deployments";
-import { validateClientNetwork } from "../utils/validateClientNetwork";
-import {
-  Address,
-  TransactionReceipt,
-  WalletClient,
-  SimulateContractParameters,
-  parseEther,
-  zeroAddress,
-  ContractEventArgsFromTopics,
-  parseEventLogs,
-} from "viem";
-import { baseSepolia } from "viem/chains";
-import { GenericPublicClient } from "src/utils/genericPublicClient";
-import { getAttribution } from "../utils/attribution";
-// Define trade event args type
-
-export type SellEventArgs = ContractEventArgsFromTopics<
-  typeof coinABI,
-  "CoinSell"
->;
-export type BuyEventArgs = ContractEventArgsFromTopics<
-  typeof coinABI,
-  "CoinBuy"
->;
-
-export type TradeEventArgs = SellEventArgs | BuyEventArgs;
-
-// We'll use this address to ensure it will have funds to simulate an eth trade.
-// @dev: This only works on OP chains and is a fix for a bug. Another approach should be taken long term.
-const OP_BRIDGE_ADDRESS =
-  "0x4200000000000000000000000000000000000016" as Address;
-
-/**
- * Simulates a buy order to get the expected output amount
- * @param {Object} params - The simulation parameters
- * @param {Address} params.target - The target coin contract address
- * @param {bigint} params.requestedOrderSize - The desired input amount for the buy
- * @param {PublicClient} params.publicClient - The viem public client instance
- * @returns {Promise<{orderSize: bigint, amountOut: bigint}>} The simulated order size and output amount
- */
-export async function simulateBuy({
-  target,
-  requestedOrderSize,
-  publicClient,
-}: {
-  target: Address;
-  requestedOrderSize: bigint;
-  publicClient: GenericPublicClient;
-}): Promise<{ orderSize: bigint; amountOut: bigint }> {
-  const numberResult = await publicClient.simulateContract({
-    address: target,
-    abi: coinABI,
-    functionName: "buy",
-    dataSuffix: getAttribution(),
-    args: [
-      OP_BRIDGE_ADDRESS,
-      requestedOrderSize,
-      0n, // minAmountOut
-      0n, // sqrtPriceLimitX96
-      zeroAddress, // tradeReferrer
-    ],
-    // We want to ensure that the multicall3 contract has enough ETH to buy in the simulation
-    stateOverride: [
-      {
-        address: baseSepolia.contracts.multicall3.address,
-        balance: parseEther("10000000"),
-      },
-    ],
-  });
-  const orderSize = numberResult.result[0];
-  const amountOut = numberResult.result[1];
-  return { orderSize, amountOut };
-}
-
-/**
- * Parameters for creating a trade call
- * @typedef {Object} TradeParams
- * @property {'sell' | 'buy'} direction - The trade direction
- * @property {Address} target - The target coin contract address
- * @property {Object} args - The trade arguments
- * @property {Address} args.recipient - The recipient of the trade output
- * @property {bigint} args.orderSize - The size of the order
- * @property {bigint} [args.minAmountOut] - The minimum amount to receive
- * @property {bigint} [args.sqrtPriceLimitX96] - The price limit for the trade
- * @property {Address} [args.tradeReferrer] - The referrer address for the trade
- */
-export type TradeParams = {
-  direction: "sell" | "buy";
-  target: Address;
-  args: {
-    recipient: Address;
-    orderSize: bigint;
-    minAmountOut?: bigint;
-    sqrtPriceLimitX96?: bigint;
-    tradeReferrer?: Address;
-  };
-};
-
-/**
- * Creates a trade call parameters object for buy or sell
- * @param {TradeParams} params - The trade parameters
- * @returns {SimulateContractParameters} The contract call parameters
- */
-export function tradeCoinCall({
-  target,
-  direction,
-  args: {
-    recipient,
-    orderSize,
-    minAmountOut = 0n,
-    sqrtPriceLimitX96 = 0n,
-    tradeReferrer = zeroAddress,
-  },
-}: TradeParams): SimulateContractParameters {
-  return {
-    abi: coinABI,
-    functionName: direction,
-    address: target,
-    args: [
-      recipient,
-      orderSize,
-      minAmountOut,
-      sqrtPriceLimitX96,
-      tradeReferrer,
-    ],
-    value: direction === "buy" ? orderSize : 0n,
-  } as const;
-}
-
-/**
- * Gets the trade event from transaction receipt logs
- * @param {TransactionReceipt} receipt - The transaction receipt containing the logs
- * @param {'buy' | 'sell'} direction - The direction of the trade
- * @returns {TradeEventArgs | undefined} The decoded trade event args if found
- */
-export function getTradeFromLogs(
-  receipt: TransactionReceipt,
-  direction: "buy" | "sell",
-): TradeEventArgs | undefined {
-  const eventLogs = parseEventLogs({
-    abi: coinABI,
-    logs: receipt.logs,
-  });
-
-  if (direction === "buy") {
-    return eventLogs.find((log) => log.eventName === "CoinBuy")?.args;
-  }
-  return eventLogs.find((log) => log.eventName === "CoinSell")?.args;
-}
-
-/**
- * Executes a trade transaction
- * @param {TradeParams} params - The trade parameters
- * @param {PublicClient} publicClient - The viem public client instance
- * @param {WalletClient} walletClient - The viem wallet client instance
- * @returns {Promise<{
- *   hash: `0x${string}`,
- *   receipt: TransactionReceipt,
- *   trade: TradeEventArgs | undefined
- * }>} The transaction result with trade details
- */
-export async function tradeCoin(
-  params: TradeParams,
-  walletClient: WalletClient,
-  publicClient: GenericPublicClient,
-) {
-  validateClientNetwork(publicClient);
-  const { request } = await publicClient.simulateContract({
-    ...tradeCoinCall(params),
-    account: walletClient.account,
-  });
-  const hash = await walletClient.writeContract(request);
-  const receipt = await publicClient.waitForTransactionReceipt({ hash });
-  const trade = getTradeFromLogs(receipt, params.direction);
-
-  return {
-    hash,
-    receipt,
-    trade,
-  };
-}