@zoralabs/protocol-sdk 0.11.11 → 0.12.0

package/src/create/{1155-create-helper.ts → create-client.ts}

@@ -6,8 +6,10 @@ import {
 import type {
   Account,
   Address,
+  Chain,
   Hex,
   PublicClient,
+  Transport,
   TransactionReceipt,
 } from "viem";
 import { decodeEventLog } from "viem";
@@ -23,11 +25,12 @@ import {
   CreateNew1155ParamsBase,
   CreateNew1155TokenParams,
   CreateNew1155TokenReturn,
+  PrepareCreateReturn,
   NewContractParams,
 } from "./types";
 import { constructCreate1155TokenCalls } from "./token-setup";
 import { makeOnchainPrepareMintFromCreate } from "./mint-from-create";
-import { IContractGetter } from "./contract-getter";
+import { IContractGetter, SubgraphContractGetter } from "./contract-getter";
 
 // Default royalty bps
 const ROYALTY_BPS_DEFAULT = 1000;
@@ -118,7 +121,7 @@ export function makeCreateContractAndTokenCall({
   });
 }
 
-function makeCreateTokenCall({
+export function makeCreateTokenCall({
   contractAddress,
   account,
   tokenSetupActions,
@@ -134,21 +137,29 @@ function makeCreateTokenCall({
   });
 }
 
+/**
+ * @deprecated Please use functions directly without creating a client.
+ * Example: Instead of `new Create1155Client().createNew1155()`, use `createNew1155()`
+ * Import the functions you need directly from their respective modules:
+ * import { createNew1155, createNew1155OnExistingContract } from '@zoralabs/protocol-sdk'
+ */
 export class Create1155Client {
-  private readonly chainId: number;
-  private readonly publicClient: Pick<PublicClient, "readContract">;
+  private readonly publicClient: Pick<
+    PublicClient<Transport, Chain>,
+    "readContract" | "chain"
+  >;
   public readonly contractGetter: IContractGetter;
 
   constructor({
-    chainId,
     publicClient,
     contractGetter,
   }: {
-    chainId: number;
-    publicClient: Pick<PublicClient, "readContract">;
+    publicClient: Pick<
+      PublicClient<Transport, Chain>,
+      "readContract" | "chain"
+    >;
     contractGetter: IContractGetter;
   }) {
-    this.chainId = chainId;
     this.publicClient = publicClient;
     this.contractGetter = contractGetter;
   }
@@ -156,10 +167,9 @@ export class Create1155Client {
   async createNew1155(
     props: CreateNew1155ContractParams,
   ): Promise<CreateNew1155ContractAndTokenReturn> {
-    return createNew1155ContractAndToken({
+    return create1155({
       ...props,
       publicClient: this.publicClient,
-      chainId: this.chainId,
     });
   }
 
@@ -174,100 +184,121 @@ export class Create1155Client {
       account,
       token,
       getAdditionalSetupActions,
-      publicClient: this.publicClient,
-      chainId: this.chainId,
       contractGetter: this.contractGetter,
+      chainId: this.publicClient.chain.id,
     });
   }
 }
 
-async function createNew1155ContractAndToken({
+export async function create1155({
   contract,
   account,
-  chainId,
   token,
   publicClient,
   getAdditionalSetupActions,
 }: CreateNew1155ContractParams & {
-  publicClient: Pick<PublicClient, "readContract">;
-  chainId: number;
+  publicClient: Pick<PublicClient<Transport, Chain>, "readContract" | "chain">;
 }): Promise<CreateNew1155ContractAndTokenReturn> {
   const nextTokenId = 1n;
+  const chainId = publicClient.chain.id;
   const contractVersion = new1155ContractVersion(chainId);
 
-  const {
-    minter,
-    newToken,
-    setupActions: tokenSetupActions,
-  } = prepareSetupActions({
-    chainId,
-    account,
-    contractVersion,
-    nextTokenId,
-    token,
-    getAdditionalSetupActions,
-    contractName: contract.name,
-  });
-
-  const request = makeCreateContractAndTokenCall({
+  const result = prepareNew1155ContractAndToken({
     contract,
     account,
     chainId,
-    tokenSetupActions,
-    fundsRecipient: token.payoutRecipient,
-    royaltyBPS: token.royaltyBPS,
+    token,
+    getAdditionalSetupActions,
+    nextTokenId,
+    contractVersion,
   });
 
   const contractAddress = await getDeterministicContractAddress({
     account: typeof account === "string" ? account : account.address,
     publicClient,
-    setupActions: tokenSetupActions,
-    chainId,
+    setupActions: result.setupActions,
     contract,
   });
 
   const prepareMint = makeOnchainPrepareMintFromCreate({
-    contractAddress: contractAddress,
+    contractAddress,
     contractVersion,
-    minter,
-    result: newToken.salesConfig,
+    minter: result.minter,
+    result: result.newToken.salesConfig,
     tokenId: nextTokenId,
+    chainId,
     // to get the contract wide mint fee, we get what it would be for a new contract
     getContractMintFee: async () =>
       getNewContractMintFee({
         publicClient,
         chainId,
       }),
+  });
+
+  return {
+    ...result,
+    prepareMint,
+    contractAddress,
+    contractVersion,
+    newTokenId: nextTokenId,
+  };
+}
+
+function prepareNew1155ContractAndToken({
+  account,
+  chainId,
+  token,
+  getAdditionalSetupActions,
+  nextTokenId,
+  contractVersion,
+  contract,
+}: CreateNew1155ContractParams & {
+  chainId: number;
+  nextTokenId: bigint;
+  contractVersion: string;
+}): PrepareCreateReturn {
+  const { minter, newToken, setupActions } = prepareSetupActions({
     chainId,
+    account,
+    contractVersion: contractVersion,
+    nextTokenId: nextTokenId,
+    token,
+    getAdditionalSetupActions,
+    contractName: contract.name,
+  });
+
+  const request = makeCreateContractAndTokenCall({
+    contract,
+    account,
+    chainId,
+    tokenSetupActions: setupActions,
+    fundsRecipient: token.payoutRecipient,
+    royaltyBPS: token.royaltyBPS,
   });
 
   return {
     parameters: request,
-    tokenSetupActions,
-    newTokenId: nextTokenId,
+    setupActions,
     newToken,
-    contractAddress: contractAddress,
-    contractVersion,
     minter,
-    prepareMint,
   };
 }
 
-async function createNew1155Token({
-  contractAddress: contractAddress,
+function prepareNew1155Token({
+  contractAddress,
   account,
   getAdditionalSetupActions,
   token,
   chainId,
-  contractGetter,
-}: CreateNew1155TokenParams & {
-  publicClient: Pick<PublicClient, "readContract">;
+  nextTokenId,
+  contractVersion,
+  contractName,
+}: Omit<CreateNew1155TokenParams, "contractGetter"> & {
   chainId: number;
-  contractGetter: IContractGetter;
-}): Promise<CreateNew1155TokenReturn> {
-  const { nextTokenId, contractVersion, mintFee, name } =
-    await contractGetter.getContractInfo({ contractAddress, retries: 5 });
-
+  nextTokenId: bigint;
+  contractVersion: string;
+  contractName: string;
+}): PrepareCreateReturn {
   const {
     minter,
     newToken,
@@ -279,7 +310,7 @@ async function createNew1155Token({
     nextTokenId,
     token,
     getAdditionalSetupActions,
-    contractName: name,
+    contractName,
   });
 
   const request = makeCreateTokenCall({
@@ -288,28 +319,63 @@ async function createNew1155Token({
     tokenSetupActions,
   });
 
+  return {
+    parameters: request,
+    setupActions: tokenSetupActions,
+    newToken,
+    minter,
+  };
+}
+
+export async function createNew1155Token({
+  contractAddress,
+  account,
+  getAdditionalSetupActions,
+  token,
+  chainId,
+  contractGetter,
+}: CreateNew1155TokenParams & {
+  chainId: number;
+  contractGetter?: IContractGetter;
+}): Promise<CreateNew1155TokenReturn> {
+  const contractGetterOrDefault =
+    contractGetter ?? new SubgraphContractGetter(chainId);
+  const { nextTokenId, contractVersion, mintFee, name } =
+    await contractGetterOrDefault.getContractInfo({
+      contractAddress,
+      retries: 5,
+    });
+
+  const preparedToken = prepareNew1155Token({
+    contractAddress,
+    account,
+    getAdditionalSetupActions,
+    token,
+    chainId,
+    nextTokenId,
+    contractVersion,
+    contractName: name,
+  });
+
   const prepareMint = makeOnchainPrepareMintFromCreate({
     contractAddress: contractAddress,
     contractVersion,
-    minter,
-    result: newToken.salesConfig,
+    minter: preparedToken.minter,
+    result: preparedToken.newToken.salesConfig,
     tokenId: nextTokenId,
     getContractMintFee: async () => mintFee,
     chainId,
   });
 
   return {
-    parameters: request,
-    tokenSetupActions,
+    ...preparedToken,
+    prepareMint,
     newTokenId: nextTokenId,
-    newToken,
     contractVersion,
-    minter,
-    prepareMint,
   };
 }
 
-function prepareSetupActions({
+export function prepareSetupActions({
   chainId,
   account,
   contractVersion,

package/src/create/types.ts

@@ -114,7 +114,7 @@ export type New1155Token = {
   salesConfig: ConcreteSalesConfig;
 };
 
-export type CreateNew1155TokenReturn = {
+export type PrepareCreateReturn = {
   parameters: SimulateContractParameters<
     any,
     any,
@@ -123,10 +123,13 @@ export type CreateNew1155TokenReturn = {
     any,
     Account | Address
   >;
-  tokenSetupActions: Hex[];
-  newTokenId: bigint;
+  setupActions: Hex[];
   newToken: New1155Token;
   minter: Address;
+};
+
+export type CreateNew1155TokenReturn = PrepareCreateReturn & {
+  newTokenId: bigint;
   contractVersion: string;
   prepareMint: AsyncPrepareMint;
 };
@@ -134,3 +137,10 @@ export type CreateNew1155TokenReturn = {
 export type CreateNew1155ContractAndTokenReturn = {
   contractAddress: Address;
 } & CreateNew1155TokenReturn;
+
+export type ContractInfo = {
+  nextTokenId: bigint;
+  contractVersion: string;
+  mintFee: bigint;
+  name: string;
+};

package/src/fixtures/contract-setup.ts

@@ -1,8 +1,8 @@
-import { Address, Chain, PublicClient, WalletClient } from "viem";
-import { simulateAndWriteContractWithRetries } from "src/test-utils";
+import { Address, Chain, PublicClient, WalletClient, Transport } from "viem";
 import { createCreatorClient } from "src/sdk";
 import { SubgraphMintGetter } from "src/mint/subgraph-mint-getter";
 import { SubgraphRewardsGetter } from "../rewards/subgraph-rewards-getter";
+import { simulateAndWriteContractWithRetries } from "src/test-utils";
 
 export const demoTokenMetadataURI =
   "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u";
@@ -15,7 +15,7 @@ export async function setupContractAndToken({
   walletClient,
 }: {
   chain: Chain;
-  publicClient: PublicClient;
+  publicClient: PublicClient<Transport, Chain>;
   creatorAccount: Address;
   walletClient: WalletClient;
 }) {

package/src/fixtures/rewards-query-results.ts

@@ -4,17 +4,10 @@ import {
   CreatorERC20zQueryResult,
 } from "../rewards/subgraph-queries";
 
-const mockResult = ({
-  erz20z,
-  secondaryActivated,
-}: {
-  erz20z: Address;
-  secondaryActivated: boolean;
-}): RewardsToken => ({
+const mockResult = ({ erz20z }: { erz20z: Address }): RewardsToken => ({
   salesStrategies: [
     {
       zoraTimedMinter: {
-        secondaryActivated,
         erc20Z: {
           id: erz20z,
         },
@@ -26,7 +19,7 @@ const mockResult = ({
 export const mockRewardsQueryResults = ({
   erc20z,
 }: {
-  erc20z: { secondaryActivated: boolean; erz20z: Address }[];
+  erc20z: { erz20z: Address }[];
 }): CreatorERC20zQueryResult => ({
   zoraCreateTokens: erc20z.map(mockResult),
 });

package/src/fixtures/secondary.ts

@@ -1,34 +1,38 @@
-import { Address, Account, PublicClient, TestClient, WalletClient } from "viem";
-import { CollectorClient } from "../sdk";
-import { simulateAndWriteContractWithRetries } from "src/test-utils";
+import {
+  Address,
+  Account,
+  PublicClient,
+  TestClient,
+  WalletClient,
+  Transport,
+  Chain,
+} from "viem";
+import { simulateAndWriteContractWithRetries } from "../test-utils";
 import { makeContractParameters } from "../utils";
 import {
   zoraTimedSaleStrategyABI,
   zoraTimedSaleStrategyAddress,
 } from "@zoralabs/protocol-deployments";
-
+import { getSecondaryInfo } from "src/secondary/utils";
 export async function advanceToSaleAndAndLaunchMarket({
   contractAddress,
   tokenId,
   testClient,
   publicClient,
   walletClient,
-  collectorClient,
-  chainId,
   account,
 }: {
   contractAddress: Address;
   tokenId: bigint;
   testClient: TestClient;
-  publicClient: PublicClient;
+  publicClient: PublicClient<Transport, Chain>;
   walletClient: WalletClient;
-  collectorClient: CollectorClient;
-  chainId: number;
   account: Address | Account;
 }) {
-  const saleInfo = await collectorClient.getSecondaryInfo({
+  const saleInfo = await getSecondaryInfo({
     contract: contractAddress,
     tokenId,
+    publicClient,
   });
 
   if (!saleInfo) {
@@ -50,6 +54,8 @@ export async function advanceToSaleAndAndLaunchMarket({
     blocks: 1,
   });
 
+  const chainId = publicClient.chain.id;
+
   // advance to end of sale
   // launch the market
   await simulateAndWriteContractWithRetries({

package/src/index.ts

@@ -13,11 +13,11 @@ export * from "./mint/subgraph-mint-getter";
 export * from "./mint/mint-client";
 export {
   type MintParameters,
-  type GetMintParameters,
-  type GetMintsOfContractParameters,
+  type GetMintParametersArguments as GetMintParameters,
+  type GetMintsOfContractParametersArguments as GetMintsOfContractParameters,
   type MintTypes,
   type SaleType,
-  type GetMintCostsParameters,
+  type GetMintCostsParameterArguments as GetMintCostsParameters,
   type MakeMintParametersArguments,
   type SaleStrategies,
   type ContractInfo,
@@ -30,9 +30,25 @@ export {
   type MintableReturn,
   type PrepareMint,
   type MintParametersBase,
+  type OnChainMintParameters,
+  type Erc1155MintParameters,
+  type Erc721MintParameters,
+  isOnChainMint,
+  is1155Mint,
 } from "./mint/types";
 
-export * from "./create/1155-create-helper";
+export { getToken, getTokensOfContract } from "./mint/mint-queries";
+
+export { type TokenQueryResult } from "./mint/subgraph-queries";
+
+export * from "./create/create-client";
+
+export * from "./mint/strategies-parsing";
+
+export { toMintableReturn } from "./mint/mint-queries";
+
+export { new1155ContractVersion } from "./create/contract-setup";
+export { makeOnchainPrepareMintFromCreate } from "./create/mint-from-create";
 
 export * from "./sparks/mints-queries";
 
@@ -46,10 +62,24 @@ export {
 
 export * from "./create/types";
 
+export {
+  SubgraphContractGetter,
+  type IContractGetter,
+} from "./create/contract-getter";
+
 export * from "./sdk";
 
 export * from "./ipfs";
 
 export { createAllowList } from "./allow-list/allow-list-client";
 
+export { getRewardsBalances, withdrawRewards } from "./rewards/rewards-queries";
+
 export * from "./allow-list/types";
+
+export {
+  buy1155OnSecondary,
+  sell1155OnSecondary,
+} from "./secondary/secondary-client";
+
+export { getSecondaryInfo } from "./secondary/utils";