@zoralabs/protocol-sdk 0.2.0 → 0.3.0

package/src/create/1155-create-helper.ts

@@ -8,8 +8,8 @@ import type {
   Address,
   Hex,
   PublicClient,
+  SimulateContractParameters,
   TransactionReceipt,
-  WalletClient,
 } from "viem";
 import { decodeEventLog, encodeFunctionData, zeroAddress } from "viem";
 import { OPEN_EDITION_MINT_SIZE } from "../constants";
@@ -101,11 +101,6 @@ export function create1155TokenSetupArgs({
   };
 
   const setupActions = [
-    encodeFunctionData({
-      abi: zoraCreator1155ImplABI,
-      functionName: "addPermission",
-      args: [0n, fixedPriceMinterAddress, PERMISSION_BIT_MINTER],
-    }),
     encodeFunctionData({
       abi: zoraCreator1155ImplABI,
       functionName: "assumeLastTokenIdMatches",
@@ -122,6 +117,11 @@ export function create1155TokenSetupArgs({
           functionName: "setupNewToken",
           args: [tokenMetadataURI, maxSupply],
         }),
+    encodeFunctionData({
+      abi: zoraCreator1155ImplABI,
+      functionName: "addPermission",
+      args: [0n, fixedPriceMinterAddress, PERMISSION_BIT_MINTER],
+    }),
     encodeFunctionData({
       abi: zoraCreator1155ImplABI,
       functionName: "callSale",
@@ -226,117 +226,134 @@ async function getContractExists(
   };
 }
 
-// Create new 1155 token
-export async function createNew1155Token({
+type CreateNew1155TokenReturn = {
+  request: SimulateContractParameters;
+  tokenSetupActions: Hex[];
+  contractAddress: Address;
+  contractExists: boolean;
+};
+
+export function create1155CreatorClient({
   publicClient,
-  contract,
-  tokenMetadataURI,
-  mintToCreatorCount = 1,
-  salesConfig = {},
-  maxSupply,
-  account,
-  royaltySettings,
-  getAdditionalSetupActions,
 }: {
   publicClient: PublicClient;
-  account: Address;
-  maxSupply?: bigint | number;
-  royaltySettings?: RoyaltySettingsType;
-  royaltyBPS?: number;
-  contract: ContractType;
-  tokenMetadataURI: string;
-  mintToCreatorCount?: bigint | number;
-  salesConfig?: SalesConfigParamsType;
-  getAdditionalSetupActions?: (args: {
-    tokenId: bigint;
-    contractAddress: Address;
-  }) => Hex[];
 }) {
-  // Check if contract exists either from metadata or the static address passed in.
-  // If a static address is passed in, this fails if that contract does not exist.
-  const { contractExists, contractAddress } = await getContractExists(
-    publicClient,
+  async function createNew1155Token({
     contract,
-    account,
-  );
-
-  // Assume the next token id is the first token available for a new contract.
-  let nextTokenId = 1n;
-
-  if (contractExists) {
-    nextTokenId = await publicClient.readContract({
-      abi: zoraCreator1155ImplABI,
-      functionName: "nextTokenId",
-      address: contractAddress,
-    });
-  }
-
-  // Get the fixed price minter to use within the new token to set the sales configuration.
-  const fixedPriceMinterAddress = await publicClient.readContract({
-    abi: zoraCreator1155FactoryImplABI,
-    address: zoraCreator1155FactoryImplAddress[999],
-    functionName: "fixedPriceMinter",
-  });
-
-  let tokenSetupActions = create1155TokenSetupArgs({
     tokenMetadataURI,
-    nextTokenId,
-    salesConfig,
+    mintToCreatorCount = 1,
+    salesConfig = {},
     maxSupply,
-    fixedPriceMinterAddress,
     account,
-    mintToCreatorCount,
     royaltySettings,
-  });
-  if (getAdditionalSetupActions) {
-    tokenSetupActions = [
-      ...getAdditionalSetupActions({ tokenId: nextTokenId, contractAddress }),
-      ...tokenSetupActions,
-    ];
-  }
+    getAdditionalSetupActions,
+  }: {
+    account: Address;
+    maxSupply?: bigint | number;
+    royaltySettings?: RoyaltySettingsType;
+    royaltyBPS?: number;
+    contract: ContractType;
+    tokenMetadataURI: string;
+    mintToCreatorCount?: bigint | number;
+    salesConfig?: SalesConfigParamsType;
+    getAdditionalSetupActions?: (args: {
+      tokenId: bigint;
+      contractAddress: Address;
+    }) => Hex[];
+  }): Promise<CreateNew1155TokenReturn> {
+    // Check if contract exists either from metadata or the static address passed in.
+    // If a static address is passed in, this fails if that contract does not exist.
+    const { contractExists, contractAddress } = await getContractExists(
+      publicClient,
+      contract,
+      account,
+    );
 
-  if (!contractAddress && typeof contract === "string") {
-    throw new Error("Invariant: contract cannot be missing and an address");
-  }
-  if (!contractExists && typeof contract !== "string") {
-    const { request } = await publicClient.simulateContract({
+    // Assume the next token id is the first token available for a new contract.
+    let nextTokenId = 1n;
+
+    if (contractExists) {
+      nextTokenId = await publicClient.readContract({
+        abi: zoraCreator1155ImplABI,
+        functionName: "nextTokenId",
+        address: contractAddress,
+      });
+    }
+
+    // Get the fixed price minter to use within the new token to set the sales configuration.
+    const fixedPriceMinterAddress = await publicClient.readContract({
       abi: zoraCreator1155FactoryImplABI,
-      functionName: "createContractDeterministic",
-      account,
       address: zoraCreator1155FactoryImplAddress[999],
-      args: [
-        contract.uri,
-        contract.name,
-        {
-          // deprecated
-          royaltyMintSchedule: 0,
-          royaltyBPS: royaltySettings?.royaltyBPS || ROYALTY_BPS_DEFAULT,
-          royaltyRecipient: royaltySettings?.royaltyRecipient || account,
-        },
-        contract.defaultAdmin || account,
-        tokenSetupActions,
-      ],
+      functionName: "fixedPriceMinter",
     });
-    return {
-      send: (walletClient: WalletClient) => walletClient.writeContract(request),
-      tokenSetupActions,
-      contractAddress,
-      contractExists,
-    };
-  } else if (contractExists) {
-    const { request } = await publicClient.simulateContract({
-      abi: zoraCreator1155ImplABI,
-      functionName: "multicall",
+
+    let tokenSetupActions = create1155TokenSetupArgs({
+      tokenMetadataURI,
+      nextTokenId,
+      salesConfig,
+      maxSupply,
+      fixedPriceMinterAddress,
       account,
-      address: contractAddress,
-      args: [tokenSetupActions],
+      mintToCreatorCount,
+      royaltySettings,
     });
-    return {
-      send: (walletClient: WalletClient) => walletClient.writeContract(request),
-      tokenSetupActions,
-      contractAddress,
-      contractExists,
-    };
+    if (getAdditionalSetupActions) {
+      tokenSetupActions = [
+        ...getAdditionalSetupActions({ tokenId: nextTokenId, contractAddress }),
+        ...tokenSetupActions,
+      ];
+    }
+
+    if (!contractAddress && typeof contract === "string") {
+      throw new Error("Invariant: contract cannot be missing and an address");
+    }
+    if (!contractExists && typeof contract !== "string") {
+      const request: SimulateContractParameters<
+        typeof zoraCreator1155FactoryImplABI,
+        "createContractDeterministic"
+      > = {
+        abi: zoraCreator1155FactoryImplABI,
+        functionName: "createContractDeterministic",
+        account,
+        address: zoraCreator1155FactoryImplAddress[999],
+        args: [
+          contract.uri,
+          contract.name,
+          {
+            // deprecated
+            royaltyMintSchedule: 0,
+            royaltyBPS: royaltySettings?.royaltyBPS || ROYALTY_BPS_DEFAULT,
+            royaltyRecipient: royaltySettings?.royaltyRecipient || account,
+          },
+          contract.defaultAdmin || account,
+          tokenSetupActions,
+        ],
+      };
+      return {
+        request,
+        tokenSetupActions,
+        contractAddress,
+        contractExists,
+      };
+    } else if (contractExists) {
+      const request: SimulateContractParameters<
+        typeof zoraCreator1155ImplABI,
+        "multicall"
+      > = {
+        abi: zoraCreator1155ImplABI,
+        functionName: "multicall",
+        account,
+        address: contractAddress,
+        args: [tokenSetupActions],
+      };
+      return {
+        request,
+        tokenSetupActions,
+        contractAddress,
+        contractExists,
+      };
+    }
+    throw new Error("Unsupported contract argument type");
   }
-  throw new Error("Unsupported contract argument type");
+  return { createNew1155Token };
 }

package/src/mint/mint-client.test.ts

@@ -1,7 +1,7 @@
 import { parseAbi, parseEther } from "viem";
 import { zora } from "viem/chains";
 import { describe, expect } from "vitest";
-import { MintClient } from "./mint-client";
+import { createMintClient } from "./mint-client";
 import { zoraCreator1155ImplABI } from "@zoralabs/protocol-deployments";
 import { anvilTest } from "src/anvil";
 
@@ -21,7 +21,7 @@ describe("mint-helper", () => {
       });
       const targetContract = "0xa2fea3537915dc6c7c7a97a82d1236041e6feb2e";
       const targetTokenId = 1n;
-      const minter = new MintClient(zora);
+      const minter = createMintClient({ chain: zora });
 
       const { simulateContractParameters: params } =
         await minter.makePrepareMintTokenParams({
@@ -73,7 +73,7 @@ describe("mint-helper", () => {
 
       const targetContract = "0x7aae7e67515A2CbB8585C707Ca6db37BDd3EA839";
       const targetTokenId = undefined;
-      const minter = new MintClient(zora);
+      const minter = createMintClient({ chain: zora });
 
       const { simulateContractParameters: prepared } =
         await minter.makePrepareMintTokenParams({

package/src/mint/mint-client.ts

@@ -42,7 +42,7 @@ const zora721Abi = parseAbi([
   "function zoraFeeForAmount(uint256 amount) public view returns (address, uint256)",
 ] as const);
 
-export class MintClient extends ClientBase {
+class MintClient extends ClientBase {
   apiClient: typeof MintAPIClient;
 
   constructor(chain: Chain, apiClient?: typeof MintAPIClient) {
@@ -80,7 +80,7 @@ export class MintClient extends ClientBase {
     mintable: MintableGetTokenResponse;
     minterAccount: Address;
     mintArguments: MintArguments;
-  }): Promise<{simulateContractParameters: SimulateContractParameters}> {
+  }): Promise<{ simulateContractParameters: SimulateContractParameters }> {
     if (!mintable) {
       throw new MintError("No mintable found");
     }
@@ -216,3 +216,13 @@ export class MintClient extends ClientBase {
     return result;
   }
 }
+
+export function createMintClient({
+  chain,
+  mintAPIClient,
+}: {
+  chain: Chain;
+  mintAPIClient?: typeof MintAPIClient;
+}) {
+  return new MintClient(chain, mintAPIClient);
+}

package/src/premint/premint-client.test.ts

@@ -1,6 +1,6 @@
 import { foundry } from "viem/chains";
 import { describe, expect, vi } from "vitest";
-import { PremintClient } from "./premint-client";
+import { createPremintClient } from "./premint-client";
 import { anvilTest } from "src/anvil";
 import { BackendChainNamesLookup } from "src/apis/chain-constants";
 
@@ -9,7 +9,7 @@ describe("ZoraCreator1155Premint", () => {
     "can sign on the forked premint contract",
     async ({ viemClients: { walletClient, publicClient } }) => {
       const [deployerAccount] = await walletClient.getAddresses();
-      const premintClient = new PremintClient(foundry);
+      const premintClient = createPremintClient({ chain: foundry });
 
       premintClient.apiClient.getNextUID = vi
         .fn()
@@ -71,7 +71,7 @@ describe("ZoraCreator1155Premint", () => {
   anvilTest(
     "can validate premint on network",
     async ({ viemClients: { publicClient } }) => {
-      const premintClient = new PremintClient(foundry);
+      const premintClient = createPremintClient({ chain: foundry });
 
       const premintData = {
         collection: {
@@ -116,7 +116,7 @@ describe("ZoraCreator1155Premint", () => {
     "can execute premint on network",
     async ({ viemClients: { walletClient, publicClient } }) => {
       const [deployerAccount] = await walletClient.getAddresses();
-      const premintClient = new PremintClient(foundry);
+      const premintClient = createPremintClient({ chain: foundry });
 
       premintClient.apiClient.getSignature = vi.fn().mockResolvedValue({
         chain_name: "ZORA-TESTNET",
@@ -149,21 +149,34 @@ describe("ZoraCreator1155Premint", () => {
       });
       premintClient.apiClient.postSignature = vi.fn();
 
-      const premint = await premintClient.executePremintWithWallet({
+      const { request } = await premintClient.executePremint({
+        account: deployerAccount!,
         data: await premintClient.getPremintData({
           address: "0xf8dA7f53c283d898818af7FB9d98103F559bDac2",
           uid: 3,
         }),
-        account: deployerAccount,
-        walletClient,
-        publicClient,
         mintArguments: {
           quantityToMint: 1,
           mintComment: "",
         },
       });
+      const { request: simulateRequest } =
+        await publicClient.simulateContract(request);
+      const hash = await walletClient.writeContract(simulateRequest);
+      const receipt = await publicClient.waitForTransactionReceipt({ hash });
+      const { premintedLog, urls } =
+        premintClient.getDataFromPremintReceipt(receipt);
+
+      expect(urls).toEqual({
+        explorer:
+          "https://undefined/token/0xf8dA7f53c283d898818af7FB9d98103F559bDac2/instance/1",
+        zoraCollect:
+          "https://testnet.zora.co/collect/zgor:0xf8dA7f53c283d898818af7FB9d98103F559bDac2/1",
+        zoraManage:
+          "https://testnet.zora.co/collect/zgor:0xf8dA7f53c283d898818af7FB9d98103F559bDac2/1",
+      });
 
-      expect(premint.premintedLog).toEqual({
+      expect(premintedLog).toEqual({
         contractAddress: "0xf8dA7f53c283d898818af7FB9d98103F559bDac2",
         contractConfig: {
           contractAdmin: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",

package/src/premint/premint-client.ts

@@ -5,6 +5,7 @@ import type {
   Chain,
   Hex,
   PublicClient,
+  SimulateContractParameters,
   TransactionReceipt,
   WalletClient,
 } from "viem";
@@ -55,12 +56,6 @@ type SignedPremintResponse = {
   premint: PremintSignatureResponse;
 };
 
-type ExecutedPremintResponse = {
-  receipt: TransactionReceipt;
-  premintedLog?: PremintedLogType;
-  urls: URLSReturnType;
-};
-
 export const DefaultMintArguments = {
   maxSupply: OPEN_EDITION_MINT_SIZE,
   maxTokensPerAddress: 0n,
@@ -148,7 +143,7 @@ export const encodePremintForAPI = ({
  * Preminter API to access ZORA Premint functionality.
  * Currently only supports V1 premints.
  */
-export class PremintClient extends ClientBase {
+class PremintClient extends ClientBase {
   apiClient: typeof PremintAPIClient;
 
   constructor(chain: Chain, apiClient?: typeof PremintAPIClient) {
@@ -181,6 +176,17 @@ export class PremintClient extends ClientBase {
     return zoraCreatorFixedPriceSaleStrategyAddress[999];
   }
 
+  getDataFromPremintReceipt(receipt: TransactionReceipt) {
+    const premintedLog = getPremintedLogFromReceipt(receipt);
+    return {
+      premintedLog,
+      urls: this.makeUrls({
+        address: premintedLog?.contractAddress,
+        tokenId: premintedLog?.tokenId,
+      }),
+    };
+  }
+
   /**
    * Update existing premint given collection address and UID of existing premint.
    *
@@ -553,24 +559,18 @@ export class PremintClient extends ClientBase {
    * @param settings.publicClient Optional public client for preflight checks.
    * @returns receipt, log, zoraURL
    */
-  async executePremintWithWallet({
+  async executePremint({
     data,
     account,
-    walletClient,
     mintArguments,
-    publicClient,
   }: {
     data: PremintSignatureGetResponse;
-    walletClient: WalletClient;
-    account?: Account | Address;
+    account: Account | Address;
     mintArguments?: {
       quantityToMint: number;
       mintComment?: string;
     };
-    publicClient?: PublicClient;
-  }): Promise<ExecutedPremintResponse> {
-    publicClient = this.getPublicClient(publicClient);
-
+  }): Promise<{request: SimulateContractParameters}> {
     if (mintArguments && mintArguments?.quantityToMint < 1) {
       throw new Error("Quantity to mint cannot be below 1");
     }
@@ -585,35 +585,33 @@ export class PremintClient extends ClientBase {
       mintArguments?.mintComment || "",
     ] as const;
 
-    if (!account) {
-      account = walletClient.account;
-    }
-
     if (!account) {
       throw new Error("Wallet not passed in");
     }
 
     const value = numberToMint * REWARD_PER_TOKEN;
 
-    const { request } = await publicClient.simulateContract({
+    const request = {
       account,
       abi: zoraCreator1155PremintExecutorImplABI,
       functionName: "premint",
       value,
       address: targetAddress,
       args,
-    });
-    const hash = await walletClient.writeContract(request);
-    const receipt = await publicClient.waitForTransactionReceipt({ hash });
-    const premintedLog = getPremintedLogFromReceipt(receipt);
+    };
 
     return {
-      receipt,
-      premintedLog,
-      urls: this.makeUrls({
-        address: premintedLog?.contractAddress,
-        tokenId: premintedLog?.tokenId,
-      }),
+      request,
     };
   }
 }
+
+export function createPremintClient({
+  chain,
+  premintAPIClient,
+}: {
+  chain: Chain;
+  premintAPIClient?: typeof PremintAPIClient;
+}) {
+  return new PremintClient(chain, premintAPIClient);
+}

package/dist/preminter.d.ts

@@ -1,25 +0,0 @@
-import { Address } from "abitype";
-import { ExtractAbiFunction, AbiParametersToPrimitiveTypes } from "abitype";
-import { zoraCreator1155PremintExecutorImplABI as preminterAbi } from "@zoralabs/protocol-deployments";
-import { TypedDataDefinition } from "viem";
-type PremintInputs = ExtractAbiFunction<typeof preminterAbi, "premint">["inputs"];
-type PreminterHashDataTypes = AbiParametersToPrimitiveTypes<PremintInputs>;
-export type ContractCreationConfig = PreminterHashDataTypes[0];
-export type PremintConfig = PreminterHashDataTypes[1];
-export type TokenCreationConfig = PremintConfig["tokenConfig"];
-export declare const preminterTypedDataDefinition: ({ verifyingContract, premintConfig, chainId, }: {
-    verifyingContract: Address;
-    premintConfig: PremintConfig;
-    chainId: number;
-}) => TypedDataDefinition<{
-    CreatorAttribution: {
-        name: string;
-        type: string;
-    }[];
-    TokenCreationConfig: {
-        name: string;
-        type: string;
-    }[];
-}, "CreatorAttribution">;
-export {};
-//# sourceMappingURL=preminter.d.ts.map

package/dist/preminter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"preminter.d.ts","sourceRoot":"","sources":["../src/preminter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAE,6BAA6B,EAAE,MAAM,SAAS,CAAC;AAC5E,OAAO,EAAE,qCAAqC,IAAI,YAAY,EAAE,MAAM,gCAAgC,CAAC;AACvG,OAAO,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAE3C,KAAK,aAAa,GAAG,kBAAkB,CACrC,OAAO,YAAY,EACnB,SAAS,CACV,CAAC,QAAQ,CAAC,CAAC;AAEZ,KAAK,sBAAsB,GAAG,6BAA6B,CAAC,aAAa,CAAC,CAAC;AAE3E,MAAM,MAAM,sBAAsB,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC;AAC/D,MAAM,MAAM,aAAa,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC;AACtD,MAAM,MAAM,mBAAmB,GAAG,aAAa,CAAC,aAAa,CAAC,CAAC;AAI/D,eAAO,MAAM,4BAA4B;uBAKpB,OAAO;mBACX,aAAa;aACnB,MAAM;;;;;;;;;;wBA8ChB,CAAC"}