@zoralabs/coins-sdk 0.2.11 → 0.3.0

package/src/index.ts

@@ -2,18 +2,16 @@ export {
   createCoin,
   createCoinCall,
   getCoinCreateFromLogs,
-  DeployCurrency,
-  InitialPurchaseCurrency,
+  CreateConstants,
 } from "./actions/createCoin";
 export type {
   CreateCoinArgs,
   CoinDeploymentLogArgs,
+  RawUriMetadata,
+  StartingMarketCap,
+  ContentCoinCurrency,
 } from "./actions/createCoin";
 
-export {
-  getOnchainCoinDetails,
-  type OnchainCoinDetails,
-} from "./actions/getOnchainCoinDetails";
 export { updateCoinURI, updateCoinURICall } from "./actions/updateCoinURI";
 export type { UpdateCoinURIArgs } from "./actions/updateCoinURI";
 

package/src/uploader/metadata.ts

@@ -202,7 +202,10 @@ export class CoinMetadataBuilder {
       createMetadataParameters: {
         name: this.name!,
         symbol: this.symbol!,
-        uri: uploadResult.url as `ipfs://${string}`,
+        metadata: {
+          type: "RAW_URI",
+          uri: uploadResult.url,
+        },
       },
       metadata,
     };

package/src/uploader/types.ts

@@ -23,5 +23,8 @@ export interface Uploader {
 export type CreateMetadataParameters = {
   name: string;
   symbol: string;
-  uri: `ipfs://${string}`;
+  metadata: {
+    type: "RAW_URI";
+    uri: ValidMetadataURI;
+  };
 };

package/src/utils/rethrowDecodedRevert.ts

@@ -0,0 +1,50 @@
+import {
+  Abi,
+  BaseError,
+  ContractFunctionRevertedError,
+  decodeErrorResult,
+  Hex,
+} from "viem";
+
+export function rethrowDecodedRevert(err: unknown, abi: Abi): never {
+  if (err instanceof BaseError) {
+    const revertError = err.walk(
+      (e) => e instanceof ContractFunctionRevertedError,
+    );
+    if (revertError instanceof ContractFunctionRevertedError) {
+      // Try to decode using factory ABI
+      try {
+        const revertData =
+          typeof (revertError as any).data === "object" &&
+          (revertError as any).data !== null &&
+          "data" in (revertError as any).data
+            ? (revertError as any).data.data
+            : (revertError as any).data;
+        const decoded = decodeErrorResult({
+          abi,
+          data: revertData as Hex,
+        });
+        const name = decoded.errorName;
+        const args = decoded.args as ReadonlyArray<unknown> | undefined;
+        const message =
+          Array.isArray(args) && args.length > 0
+            ? `${name}(${args.map((a) => String(a)).join(", ")})`
+            : name;
+        throw new Error(`Create coin transaction reverted: ${message}`);
+      } catch {
+        const errorName = (revertError as any).data?.errorName as
+          | string
+          | undefined;
+        if (errorName) {
+          const args = (revertError as any).data?.args as unknown[] | undefined;
+          const message =
+            Array.isArray(args) && args.length > 0
+              ? `${errorName}(${args.map((a) => String(a)).join(", ")})`
+              : errorName;
+          throw new Error(`Create coin transaction reverted: ${message}`);
+        }
+      }
+    }
+  }
+  throw err;
+}

package/dist/actions/getOnchainCoinDetails.d.ts

@@ -1,32 +0,0 @@
-import { GenericPublicClient } from "../utils/genericPublicClient";
-import { Address } from "viem";
-/**
- * Represents the current state of a coin
- * @typedef {Object} OnchainCoinDetails
- * @property {bigint} balance - The user's balance of the coin
- * @property {PricingResult} marketCap - The market cap of the coin
- * @property {PricingResult} liquidity - The liquidity of the coin
- * @property {Address} pool - Pool address
- * @property {Slot0Result} poolState - Current state of the UniswapV3 pool
- * @property {Address[]} owners - List of owners for the coin
- * @property {Address} payoutRecipient - The payout recipient address
- */
-export type OnchainCoinDetails = {
-    balance: bigint;
-    owners: readonly Address[];
-    payoutRecipient: Address;
-};
-/**
- * Gets the current state of a coin for a user
- * @param {Object} params - The query parameters
- * @param {Address} params.coin - The coin contract address
- * @param {Address} params.user - The user address to check balance for
- * @param {PublicClient} params.publicClient - The viem public client instance
- * @returns {Promise<OnchainCoinDetails>} The coin's current state
- */
-export declare function getOnchainCoinDetails({ coin, user, publicClient, }: {
-    coin: Address;
-    user?: Address;
-    publicClient: GenericPublicClient;
-}): Promise<OnchainCoinDetails>;
-//# sourceMappingURL=getOnchainCoinDetails.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"getOnchainCoinDetails.d.ts","sourceRoot":"","sources":["../../src/actions/getOnchainCoinDetails.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAEnE,OAAO,EAAE,OAAO,EAAe,MAAM,MAAM,CAAC;AAE5C;;;;;;;;;;GAUG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,SAAS,OAAO,EAAE,CAAC;IAC3B,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAsB,qBAAqB,CAAC,EAC1C,IAAI,EACJ,IAAkB,EAClB,YAAY,GACb,EAAE;IACD,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,YAAY,EAAE,mBAAmB,CAAC;CACnC,GAAG,OAAO,CAAC,kBAAkB,CAAC,CA6B9B"}

package/dist/utils/getPrepurchaseHook.d.ts

@@ -1,16 +0,0 @@
-import { InitialPurchaseCurrency } from "../actions/createCoin";
-import { Address, Hex } from "viem";
-export declare const getPrepurchaseHook: ({ payoutRecipient, initialPurchase, chainId, }: {
-    initialPurchase: {
-        currency: InitialPurchaseCurrency;
-        amount: bigint;
-        amountOutMinimum?: bigint;
-    };
-    payoutRecipient: Address;
-    chainId: number;
-}) => Promise<{
-    hook: Address;
-    hookData: Hex;
-    value: bigint;
-}>;
-//# sourceMappingURL=getPrepurchaseHook.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"getPrepurchaseHook.d.ts","sourceRoot":"","sources":["../../src/utils/getPrepurchaseHook.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,OAAO,EAAU,GAAG,EAAc,MAAM,MAAM,CAAC;AAWxD,eAAO,MAAM,kBAAkB,GAAU,gDAItC;IACD,eAAe,EAAE;QACf,QAAQ,EAAE,uBAAuB,CAAC;QAClC,MAAM,EAAE,MAAM,CAAC;QACf,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;IACF,eAAe,EAAE,OAAO,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;CACjB;UA0BS,OAAO;cACH,GAAG;WACN,MAAM;EAEhB,CAAC"}

package/src/actions/getOnchainCoinDetails.ts

@@ -1,68 +0,0 @@
-import { coinABI } from "@zoralabs/protocol-deployments";
-import { GenericPublicClient } from "../utils/genericPublicClient";
-import { validateClientNetwork } from "../utils/validateClientNetwork";
-import { Address, zeroAddress } from "viem";
-
-/**
- * Represents the current state of a coin
- * @typedef {Object} OnchainCoinDetails
- * @property {bigint} balance - The user's balance of the coin
- * @property {PricingResult} marketCap - The market cap of the coin
- * @property {PricingResult} liquidity - The liquidity of the coin
- * @property {Address} pool - Pool address
- * @property {Slot0Result} poolState - Current state of the UniswapV3 pool
- * @property {Address[]} owners - List of owners for the coin
- * @property {Address} payoutRecipient - The payout recipient address
- */
-export type OnchainCoinDetails = {
-  balance: bigint;
-  owners: readonly Address[];
-  payoutRecipient: Address;
-};
-
-/**
- * Gets the current state of a coin for a user
- * @param {Object} params - The query parameters
- * @param {Address} params.coin - The coin contract address
- * @param {Address} params.user - The user address to check balance for
- * @param {PublicClient} params.publicClient - The viem public client instance
- * @returns {Promise<OnchainCoinDetails>} The coin's current state
- */
-export async function getOnchainCoinDetails({
-  coin,
-  user = zeroAddress,
-  publicClient,
-}: {
-  coin: Address;
-  user?: Address;
-  publicClient: GenericPublicClient;
-}): Promise<OnchainCoinDetails> {
-  validateClientNetwork(publicClient);
-  const [balance, owners, payoutRecipient] = await publicClient.multicall({
-    contracts: [
-      {
-        address: coin,
-        abi: coinABI,
-        functionName: "balanceOf",
-        args: [user],
-      },
-      {
-        address: coin,
-        abi: coinABI,
-        functionName: "owners",
-      },
-      {
-        address: coin,
-        abi: coinABI,
-        functionName: "payoutRecipient",
-      },
-    ],
-    allowFailure: false,
-  });
-
-  return {
-    balance,
-    owners,
-    payoutRecipient,
-  };
-}

package/src/utils/getPrepurchaseHook.ts

@@ -1,59 +0,0 @@
-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;
-  };
-};