@zoralabs/protocol-sdk 0.11.12 → 0.12.0

package/src/secondary/secondary-client.ts

@@ -58,7 +58,6 @@ async function makeBuy({
   quantity,
   account,
   recipient,
-  chainId,
   slippage,
   publicClient,
   comment,
@@ -71,7 +70,6 @@ async function makeBuy({
   quantity: bigint;
   account: Address | Account;
   recipient?: Address;
-  chainId: number;
   slippage: number;
   comment: string | undefined;
   publicClient: PublicClient;
@@ -95,7 +93,7 @@ async function makeBuy({
     return handleBuyWithComment({
       accountAddress,
       recipient,
-      chainId,
+      chainId: publicClient.chain.id,
       quantity,
       contract,
       tokenId,
@@ -111,7 +109,7 @@ async function makeBuy({
     recipient,
     accountAddress,
     costWithSlippage,
-    chainId,
+    chainId: publicClient.chain.id,
     account,
   });
 }
@@ -242,25 +240,22 @@ type BuyOrSellWithSlippageResult =
       parameters?: undefined;
     };
 
-export async function buyWithSlippage({
+export async function buy1155OnSecondary({
   contract,
   tokenId,
   publicClient,
   quantity,
-  chainId,
   account,
   slippage = UNISWAP_SLIPPAGE,
   recipient,
   comment,
 }: BuyWithSlippageInput & {
-  chainId: number;
   publicClient: PublicClient;
 }): Promise<BuyOrSellWithSlippageResult> {
   const secondaryInfo = await getSecondaryInfo({
     contract,
     tokenId,
     publicClient,
-    chainId,
   });
 
   if (!secondaryInfo) {
@@ -279,7 +274,6 @@ export async function buyWithSlippage({
       quantity,
       poolAddress: pool,
       erc20z,
-      chainId,
     },
     publicClient,
   );
@@ -293,7 +287,6 @@ export async function buyWithSlippage({
     quantity,
     account,
     recipient,
-    chainId,
     slippage,
     comment,
     publicClient,
@@ -313,7 +306,6 @@ async function makeSell({
   quantity,
   account,
   recipient,
-  chainId,
   slippage,
   publicClient,
 }: {
@@ -324,7 +316,6 @@ async function makeSell({
   quantity: bigint;
   account: Address | Account;
   recipient?: Address;
-  chainId: number;
   slippage: number;
   publicClient: PublicClient;
 }): Promise<Call> {
@@ -356,6 +347,8 @@ async function makeSell({
     0n,
   ]);
 
+  const chainId = publicClient.chain.id;
+
   return {
     parameters: makeContractParameters({
       abi: zoraCreator1155ImplABI,
@@ -373,24 +366,21 @@ async function makeSell({
   };
 }
 
-export async function sellWithSlippage({
+export async function sell1155OnSecondary({
   contract,
   tokenId,
   publicClient,
   quantity,
-  chainId,
   account,
   slippage = UNISWAP_SLIPPAGE,
   recipient,
 }: SellWithSlippageInput & {
-  chainId: number;
   publicClient: PublicClient;
 }): Promise<BuyOrSellWithSlippageResult> {
   const secondaryInfo = await getSecondaryInfo({
     contract,
     tokenId,
     publicClient,
-    chainId,
   });
 
   if (!secondaryInfo) {
@@ -404,7 +394,7 @@ export async function sellWithSlippage({
   }
 
   const { poolBalance, amount, price } = await getUniswapQuote(
-    { type: "sell", quantity, poolAddress: pool, chainId, erc20z },
+    { type: "sell", quantity, poolAddress: pool, erc20z },
     publicClient,
   );
 
@@ -416,7 +406,6 @@ export async function sellWithSlippage({
     quantity,
     account,
     recipient,
-    chainId,
     slippage,
     publicClient,
   });
@@ -428,26 +417,21 @@ export async function sellWithSlippage({
 }
 
 /**
- * A client for handling secondary market operations.
+ * @deprecated Please use functions directly without creating a client.
+ * Example: Instead of `new SecondaryClient().buy1155OnSecondary()`, use `buy1155OnSecondary()`
+ * Import the functions you need directly from their respective modules:
+ * import { buy1155OnSecondary, sell1155OnSecondary, getSecondaryInfo } from '@zoralabs/protocol-sdk'
  */
 export class SecondaryClient {
   private publicClient: PublicClient;
-  private chainId: number;
 
   /**
    * Creates a new SecondaryClient instance.
    * @param publicClient - The public client for interacting with the blockchain.
    * @param chainId - The ID of the blockchain network.
    */
-  constructor({
-    publicClient,
-    chainId,
-  }: {
-    publicClient: PublicClient;
-    chainId: number;
-  }) {
+  constructor({ publicClient }: { publicClient: PublicClient }) {
     this.publicClient = publicClient;
-    this.chainId = chainId;
   }
 
   /**
@@ -467,7 +451,6 @@ export class SecondaryClient {
       contract,
       tokenId,
       publicClient: this.publicClient,
-      chainId: this.chainId,
     });
   }
 
@@ -480,10 +463,9 @@ export class SecondaryClient {
     input: BuyWithSlippageInput,
   ): Promise<BuyOrSellWithSlippageResult> {
     // Call the buyWithSlippage function with the provided input and client details
-    return buyWithSlippage({
+    return buy1155OnSecondary({
       ...input,
       publicClient: this.publicClient,
-      chainId: this.chainId,
     });
   }
 
@@ -496,10 +478,9 @@ export class SecondaryClient {
     input: SellWithSlippageInput,
   ): Promise<BuyOrSellWithSlippageResult> {
     // Call the sellWithSlippage function with the provided input and client details
-    return sellWithSlippage({
+    return sell1155OnSecondary({
       ...input,
       publicClient: this.publicClient,
-      chainId: this.chainId,
     });
   }
 }

package/src/secondary/uniswap/uniswapQuote.ts

@@ -66,13 +66,14 @@ type GetQuoteInput = {
   quantity: bigint;
   poolAddress: Address;
   erc20z: Address;
-  chainId: number;
 };
 export async function getUniswapQuote(
   input: GetQuoteInput,
   client: PublicClient,
 ): Promise<GetQuoteOutput> {
-  const { type, quantity, poolAddress, chainId, erc20z } = input;
+  const { type, quantity, poolAddress, erc20z } = input;
+
+  const chainId = client.chain.id;
 
   const WETH = wethAddresses[chainId as keyof typeof wethAddresses];
 

package/src/secondary/utils.ts

@@ -14,15 +14,15 @@ export async function getSecondaryInfo({
   contract,
   tokenId,
   publicClient,
-  chainId,
 }: {
   contract: Address;
   tokenId: bigint;
   publicClient: PublicClient;
-  chainId: number;
 }): Promise<SecondaryInfo | undefined> {
   let result;
 
+  const chainId = publicClient.chain.id;
+
   try {
     result = await publicClient.readContract({
       abi: zoraTimedSaleStrategyABI,

package/src/types.ts

@@ -1,13 +1,24 @@
-import { Account, Address, SimulateContractParameters } from "viem";
-import { PublicClient } from "src/utils";
+import {
+  Account,
+  Address,
+  PublicClient,
+  SimulateContractParameters,
+  Transport,
+  Chain,
+} from "viem";
 
 export type GenericTokenIdTypes = number | bigint | string;
 
 export type IPublicClient = Pick<
-  PublicClient,
-  "readContract" | "getBlock" | "simulateContract" | "getBalance"
+  PublicClient<Transport, Chain>,
+  "readContract" | "getBlock" | "simulateContract" | "getBalance" | "chain"
 >;
 
+export type WithPublicClient<T> = T & {
+  /** Public client used to read data from the blockchain.  Chain id will determine which chain is used. */
+  publicClient: IPublicClient;
+};
+
 export type SimulateContractParametersWithAccount = SimulateContractParameters<
   any,
   any,

package/src/utils.ts

@@ -1,4 +1,10 @@
-import { Account, Address, PublicClient as BasePublicClient } from "viem";
+import {
+  Account,
+  Address,
+  PublicClient as BasePublicClient,
+  Transport,
+  Chain,
+} from "viem";
 import { SimulateContractParametersWithAccount } from "./types";
 
 export const makeContractParameters = (
@@ -6,8 +12,8 @@ export const makeContractParameters = (
 ) => args;
 
 export type PublicClient = Pick<
-  BasePublicClient,
-  "readContract" | "getBlock" | "simulateContract" | "getBalance"
+  BasePublicClient<Transport, Chain>,
+  "readContract" | "getBlock" | "simulateContract" | "getBalance" | "chain"
 >;
 
 export type ClientConfig = {

package/dist/create/1155-create-helper.d.ts

@@ -1,29 +0,0 @@
-import type { Account, Address, Hex, PublicClient, TransactionReceipt } from "viem";
-import { CreateNew1155ContractAndTokenReturn, CreateNew1155ContractParams, CreateNew1155TokenParams, CreateNew1155TokenReturn, NewContractParams } from "./types";
-import { IContractGetter } from "./contract-getter";
-export declare const getTokenIdFromCreateReceipt: (receipt: TransactionReceipt) => bigint;
-export declare const getContractAddressFromReceipt: (receipt: TransactionReceipt) => Address;
-type MakeContractParametersBase = {
-    account: Address | Account;
-    tokenSetupActions: Hex[];
-};
-export declare function makeCreateContractAndTokenCall({ account, contract, royaltyBPS, fundsRecipient, tokenSetupActions, chainId, }: {
-    chainId: number;
-    contract: NewContractParams;
-    royaltyBPS?: number;
-    fundsRecipient?: Address;
-} & MakeContractParametersBase): import("../types").SimulateContractParametersWithAccount;
-export declare class Create1155Client {
-    private readonly chainId;
-    private readonly publicClient;
-    readonly contractGetter: IContractGetter;
-    constructor({ chainId, publicClient, contractGetter, }: {
-        chainId: number;
-        publicClient: Pick<PublicClient, "readContract">;
-        contractGetter: IContractGetter;
-    });
-    createNew1155(props: CreateNew1155ContractParams): Promise<CreateNew1155ContractAndTokenReturn>;
-    createNew1155OnExistingContract({ contractAddress: contract, account, token, getAdditionalSetupActions, }: CreateNew1155TokenParams): Promise<CreateNew1155TokenReturn>;
-}
-export {};
-//# sourceMappingURL=1155-create-helper.d.ts.map

package/dist/create/1155-create-helper.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"1155-create-helper.d.ts","sourceRoot":"","sources":["../../src/create/1155-create-helper.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,OAAO,EACP,OAAO,EACP,GAAG,EACH,YAAY,EACZ,kBAAkB,EACnB,MAAM,MAAM,CAAC;AAQd,OAAO,EACL,mCAAmC,EACnC,2BAA2B,EAE3B,wBAAwB,EACxB,wBAAwB,EACxB,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAGjB,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAKpD,eAAO,MAAM,2BAA2B,YAC7B,kBAAkB,KAC1B,MAiBF,CAAC;AAEF,eAAO,MAAM,6BAA6B,YAC/B,kBAAkB,KAC1B,OAiBF,CAAC;AAEF,KAAK,0BAA0B,GAAG;IAChC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC;IAE3B,iBAAiB,EAAE,GAAG,EAAE,CAAC;CAC1B,CAAC;AAEF,wBAAgB,8BAA8B,CAAC,EAC7C,OAAO,EACP,QAAQ,EACR,UAAU,EACV,cAAc,EACd,iBAAiB,EACjB,OAAO,GACR,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,GAAG,0BAA0B,4DAwB7B;AAkBD,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqC;IAClE,SAAgB,cAAc,EAAE,eAAe,CAAC;gBAEpC,EACV,OAAO,EACP,YAAY,EACZ,cAAc,GACf,EAAE;QACD,OAAO,EAAE,MAAM,CAAC;QAChB,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;QACjD,cAAc,EAAE,eAAe,CAAC;KACjC;IAMK,aAAa,CACjB,KAAK,EAAE,2BAA2B,GACjC,OAAO,CAAC,mCAAmC,CAAC;IAQzC,+BAA+B,CAAC,EACpC,eAAe,EAAE,QAAQ,EACzB,OAAO,EACP,KAAK,EACL,yBAAyB,GAC1B,EAAE,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAWhE"}