@zoralabs/protocol-sdk 0.3.5 → 0.4.0

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

@@ -6,6 +6,16 @@ import { components, paths } from "../apis/generated/premint-api-types";
 import { ZORA_API_BASE } from "../constants";
 import { NetworkConfig } from "src/apis/chain-constants";
 import { getApiNetworkConfigForChain } from "src/mint/mint-api-client";
+import {
+  ContractCreationConfig,
+  PremintConfigAndVersion,
+  PremintConfigForVersion,
+  PremintConfigV1,
+  PremintConfigV2,
+  PremintConfigVersion,
+  PremintConfigWithVersion,
+} from "./contract-types";
+import { Address, Hex } from "viem";
 
 type SignaturePostType = paths["/signature"]["post"];
 type PremintSignatureRequestBody =
@@ -61,15 +71,96 @@ const getSignature = async ({
   httpClient: { retries, get } = defaultHttpClient,
 }: PremintSignatureGetPathParameters & {
   httpClient?: Pick<IHttpClient, "retries" | "get">;
-}): Promise<PremintSignatureGetResponse> =>
-  retries(() =>
+}): Promise<
+  PremintSignatureGetResponse & {
+    premint_config_version?: PremintConfigVersion;
+  }
+> => {
+  const result = await retries(() =>
     get<PremintSignatureGetResponse>(
       `${ZORA_API_BASE}premint/signature/${chain_name}/${collection_address}/${uid}`,
     ),
   );
 
+  return {
+    ...result,
+    // for now - we stub the backend api to simulate returning v1
+    premint_config_version: PremintConfigVersion.V1,
+  };
+};
+
 type OmitChainName<T> = Omit<T, "chain_name">;
 
+const convertCollection = (
+  collection: PremintSignatureGetResponse["collection"],
+): ContractCreationConfig => ({
+  ...collection,
+  contractAdmin: collection.contractAdmin as Address,
+});
+
+/**
+ * Convert server to on-chain types for a premint
+ *
+ * @param premint Premint object from the server to convert to one that's compatible with viem
+ * @returns Viem type-compatible premint object
+ */
+const convertPremintV1 = (premint: PremintSignatureGetResponse["premint"]) => ({
+  ...premint,
+  tokenConfig: {
+    ...premint.tokenConfig,
+    fixedPriceMinter: premint.tokenConfig.fixedPriceMinter as Address,
+    royaltyRecipient: premint.tokenConfig.royaltyRecipient as Address,
+    maxSupply: BigInt(premint.tokenConfig.maxSupply),
+    pricePerToken: BigInt(premint.tokenConfig.pricePerToken),
+    mintStart: BigInt(premint.tokenConfig.mintStart),
+    mintDuration: BigInt(premint.tokenConfig.mintDuration),
+    maxTokensPerAddress: BigInt(premint.tokenConfig.maxTokensPerAddress),
+  },
+});
+
+const encodePremintV1ForAPI = ({
+  tokenConfig,
+  ...premint
+}: PremintConfigV1): PremintSignatureGetResponse["premint"] => ({
+  ...premint,
+  tokenConfig: {
+    ...tokenConfig,
+    maxSupply: tokenConfig.maxSupply.toString(),
+    pricePerToken: tokenConfig.pricePerToken.toString(),
+    mintStart: tokenConfig.mintStart.toString(),
+    mintDuration: tokenConfig.mintDuration.toString(),
+    maxTokensPerAddress: tokenConfig.maxTokensPerAddress.toString(),
+  },
+});
+
+const encodePremintV2ForAPI = ({
+  tokenConfig,
+  ...premint
+}: PremintConfigV2) => ({
+  ...premint,
+  tokenConfig: {
+    ...tokenConfig,
+    maxSupply: tokenConfig.maxSupply.toString(),
+    pricePerToken: tokenConfig.pricePerToken.toString(),
+    mintStart: tokenConfig.mintStart.toString(),
+    mintDuration: tokenConfig.mintDuration.toString(),
+    maxTokensPerAddress: tokenConfig.maxTokensPerAddress.toString(),
+  },
+});
+
+const encodePremintForAPI = <T extends PremintConfigVersion>({
+  premintConfig,
+  premintConfigVersion,
+}: PremintConfigWithVersion<T>) => {
+  if (premintConfigVersion === PremintConfigVersion.V1) {
+    return encodePremintV1ForAPI(premintConfig as PremintConfigV1);
+  }
+  if (premintConfigVersion === PremintConfigVersion.V2) {
+    return encodePremintV2ForAPI(premintConfig as PremintConfigV2);
+  }
+  throw new Error(`Invalid premint config version ${premintConfigVersion}`);
+};
+
 class PremintAPIClient {
   httpClient: IHttpClient;
   networkConfig: NetworkConfig;
@@ -78,34 +169,83 @@ class PremintAPIClient {
     this.httpClient = httpClient || defaultHttpClient;
     this.networkConfig = getApiNetworkConfigForChain(chainId);
   }
-  postSignature = async (
-    data: OmitChainName<PremintSignatureRequestBody>,
-  ): Promise<PremintSignatureResponse> =>
-    postSignature({
-      ...data,
-      chain_name: this.networkConfig.zoraBackendChainName,
-      httpClient: this.httpClient,
-    });
+  postSignature = async <T extends PremintConfigVersion>({
+    collection,
+    premintConfigVersion,
+    premintConfig,
+    signature,
+  }: {
+    collection: ContractCreationConfig;
+    signature: Hex;
+  } & PremintConfigWithVersion<T>): Promise<PremintSignatureResponse> => {
+    if (premintConfigVersion === PremintConfigVersion.V1) {
+      const data: OmitChainName<PremintSignatureRequestBody> = {
+        premint: encodePremintForAPI<T>({
+          premintConfig,
+          premintConfigVersion,
+        }) as PremintSignatureRequestBody["premint"],
+        signature,
+        collection,
+      };
+      return postSignature({
+        ...data,
+        chain_name: this.networkConfig.zoraBackendChainName,
+        httpClient: this.httpClient,
+      });
+    } else {
+      // TODO: support posting premint v2 sig when backend is ready
+      throw new Error("Unsupported premint config version");
+    }
+  };
 
-  getNextUID = async (
-    path: OmitChainName<PremintNextUIDGetPathParameters>,
-  ): Promise<PremintNextUIDGetResponse> =>
-    getNextUID({
-      ...path,
-      chain_name: this.networkConfig.zoraBackendChainName,
-      httpClient: this.httpClient,
-    });
+  getNextUID = async (collectionAddress: Address): Promise<number> =>
+    (
+      await getNextUID({
+        collection_address: collectionAddress.toLowerCase(),
+        chain_name: this.networkConfig.zoraBackendChainName,
+        httpClient: this.httpClient,
+      })
+    ).next_uid;
 
   getSignature = async ({
-    collection_address,
+    collectionAddress,
     uid,
-  }: OmitChainName<PremintSignatureGetPathParameters>): Promise<PremintSignatureGetResponse> =>
-    getSignature({
-      collection_address,
+  }: {
+    collectionAddress: Address;
+    uid: number;
+  }): Promise<
+    {
+      signature: Hex;
+      collection: ContractCreationConfig;
+    } & PremintConfigAndVersion
+  > => {
+    const response = await getSignature({
+      collection_address: collectionAddress.toLowerCase(),
       uid,
       chain_name: this.networkConfig.zoraBackendChainName,
       httpClient: this.httpClient,
     });
+
+    const premintConfigVersion =
+      response.premint_config_version || PremintConfigVersion.V1;
+
+    let premintConfig: PremintConfigForVersion<typeof premintConfigVersion>;
+
+    if (premintConfigVersion === PremintConfigVersion.V1) {
+      premintConfig = convertPremintV1(response.premint);
+    } else {
+      throw new Error(
+        `Unsupported premint config version: ${premintConfigVersion}`,
+      );
+    }
+
+    return {
+      signature: response.signature as Hex,
+      collection: convertCollection(response.collection),
+      premintConfig,
+      premintConfigVersion: premintConfigVersion,
+    };
+  };
 }
 
 export { ZORA_API_BASE, PremintAPIClient };

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

@@ -1,15 +1,23 @@
 import { foundry } from "viem/chains";
 import { describe, expect, vi } from "vitest";
+
+import { Address, Hex } from "viem";
 import { createPremintClient } from "./premint-client";
-import { anvilTest, forkUrls, makeAnvilTest } from "src/anvil";
-import { PremintSignatureResponse } from "./premint-api-client";
+import { forkUrls, makeAnvilTest } from "src/anvil";
+import {
+  ContractCreationConfig,
+  PremintConfigV1,
+  PremintConfigVersion,
+} from "./contract-types";
 
-describe("ZoraCreator1155Premint", () => {
-  makeAnvilTest({
-    forkUrl: forkUrls.zoraGoerli,
-    forkBlockNumber: 1763437,
-  })(
-    "can sign on the forked premint contract",
+const zoraMainnetForkAnvilTest = makeAnvilTest({
+  forkUrl: forkUrls.zoraMainnet,
+  forkBlockNumber: 7550118,
+});
+
+describe("ZoraCreator1155Premint - v1 signatures", () => {
+  zoraMainnetForkAnvilTest(
+    "can sign by default v1 on the forked premint contract",
     async ({ viemClients: { walletClient, publicClient } }) => {
       const [deployerAccount] = await walletClient.getAddresses();
       const premintClient = createPremintClient({
@@ -18,15 +26,15 @@ describe("ZoraCreator1155Premint", () => {
       });
 
       premintClient.apiClient.getNextUID = vi
-        .fn()
-        .mockResolvedValue({ next_uid: 3 });
+        .fn<any, ReturnType<typeof premintClient.apiClient.getNextUID>>()
+        .mockResolvedValue(3);
       premintClient.apiClient.postSignature = vi
-        .fn()
+        .fn<Parameters<typeof premintClient.apiClient.postSignature>>()
         .mockResolvedValue({ ok: true });
 
       await premintClient.createPremint({
         walletClient,
-        account: deployerAccount!,
+        creatorAccount: deployerAccount!,
         checkSignature: true,
         collection: {
           contractAdmin: deployerAccount!,
@@ -34,28 +42,30 @@ describe("ZoraCreator1155Premint", () => {
           contractURI:
             "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
         },
-        token: {
+        tokenCreationConfig: {
           tokenURI:
             "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
         },
       });
 
-      expect(premintClient.apiClient.postSignature).toHaveBeenCalledWith({
+      const expectedPostSignatureArgs: Parameters<
+        typeof premintClient.apiClient.postSignature
+      >[0] = {
         collection: {
           contractAdmin: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
           contractName: "Testing Contract",
           contractURI:
             "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
         },
-        premint: {
+        premintConfig: {
           deleted: false,
           tokenConfig: {
             fixedPriceMinter: "0x04E2516A2c207E84a1839755675dfd8eF6302F0a",
-            maxSupply: "18446744073709551615",
-            maxTokensPerAddress: "0",
-            mintDuration: "604800",
-            mintStart: "0",
-            pricePerToken: "0",
+            maxSupply: 18446744073709551615n,
+            maxTokensPerAddress: 0n,
+            mintDuration: 604800n,
+            mintStart: 0n,
+            pricePerToken: 0n,
             royaltyBPS: 1000,
             royaltyMintSchedule: 0,
             royaltyRecipient: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
@@ -63,16 +73,21 @@ describe("ZoraCreator1155Premint", () => {
               "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
           },
           uid: 3,
-          version: 1,
+          version: 0,
         },
+        premintConfigVersion: PremintConfigVersion.V1,
         signature:
-          "0x588d19641de9ba1dade4d2bb5387c8dc96f4a990fef69787534b60caead759e6334975a6be10a796da948cd7d1d4f5580b3f84d49d9fa4e0b41c97759507975a1c",
-      });
+          "0x8c6a9160a0917d98c201b37c9220c17ebaed23a5f905202341c1d0d4e8673c3913880907d6de48c9858fbeb40a9a38d5edda979e4dcb133643ca8ecb4afe0b691b",
+      };
+
+      expect(premintClient.apiClient.postSignature).toHaveBeenCalledWith(
+        expectedPostSignatureArgs,
+      );
     },
     20 * 1000,
   );
 
-  anvilTest(
+  zoraMainnetForkAnvilTest(
     "can validate premint on network",
     async ({ viemClients: { publicClient } }) => {
       const premintClient = createPremintClient({
@@ -80,85 +95,92 @@ describe("ZoraCreator1155Premint", () => {
         publicClient,
       });
 
-      const premintData: PremintSignatureResponse = {
-        collection: {
-          contractAdmin: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
-          contractName: "Testing Contract",
-          contractURI:
-            "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
-        },
-        premint: {
-          uid: 3,
-          version: 1,
-          deleted: false,
-          tokenConfig: {
-            maxSupply: "18446744073709551615",
-            maxTokensPerAddress: "0",
-            pricePerToken: "0",
-            mintDuration: "604800",
-            mintStart: "0",
-            royaltyMintSchedule: 0,
-            royaltyBPS: 1000,
-            fixedPriceMinter: "0x04E2516A2c207E84a1839755675dfd8eF6302F0a",
-            royaltyRecipient: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
-            tokenURI:
-              "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
-          },
+      const collection: ContractCreationConfig = {
+        contractAdmin: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266" as Address,
+        contractName: "Testing Contract",
+        contractURI:
+          "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
+      };
+      const premint: PremintConfigV1 = {
+        uid: 3,
+        version: 1,
+        deleted: false,
+        tokenConfig: {
+          maxSupply: 18446744073709551615n,
+          maxTokensPerAddress: 0n,
+          pricePerToken: 0n,
+          mintDuration: 604800n,
+          mintStart: 0n,
+          royaltyMintSchedule: 0,
+          royaltyBPS: 1000,
+          fixedPriceMinter: "0x04E2516A2c207E84a1839755675dfd8eF6302F0a",
+          royaltyRecipient: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
+          tokenURI:
+            "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
         },
-        chain_name: "ZORA-GOERLI",
-        signature:
-          "0x588d19641de9ba1dade4d2bb5387c8dc96f4a990fef69787534b60caead759e6334975a6be10a796da948cd7d1d4f5580b3f84d49d9fa4e0b41c97759507975a1c",
-      } as const;
+      };
+
+      const signature =
+        "0x588d19641de9ba1dade4d2bb5387c8dc96f4a990fef69787534b60caead759e6334975a6be10a796da948cd7d1d4f5580b3f84d49d9fa4e0b41c97759507975a1c" as Hex;
 
-      const signatureValid = await premintClient.isValidSignature(premintData);
+      const signatureValid = await premintClient.isValidSignature({
+        collection: collection,
+        premintConfig: premint,
+        signature,
+        // default to premint config v1 version (we dont need to specify it here)
+      });
       expect(signatureValid.isValid).toBe(true);
     },
   );
 
-  anvilTest(
+  zoraMainnetForkAnvilTest(
     "can execute premint on network",
     async ({ viemClients: { walletClient, publicClient } }) => {
       const [deployerAccount] = await walletClient.getAddresses();
-      const premintClient = createPremintClient({ chain: foundry });
+      const premintClient = createPremintClient({
+        chain: foundry,
+        publicClient,
+      });
 
-      premintClient.apiClient.getSignature = vi.fn().mockResolvedValue({
-        chain_name: "ZORA-TESTNET",
-        collection: {
-          contractAdmin: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
-          contractName: "Testing Contract",
-          contractURI:
-            "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
-        },
-        premint: {
-          deleted: false,
-          tokenConfig: {
-            fixedPriceMinter: "0x04E2516A2c207E84a1839755675dfd8eF6302F0a",
-            maxSupply: "18446744073709551615",
-            maxTokensPerAddress: "0",
-            mintDuration: "604800",
-            mintStart: "0",
-            pricePerToken: "0",
-            royaltyBPS: 1000,
-            royaltyMintSchedule: 0,
-            royaltyRecipient: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
-            tokenURI:
-              "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
+      premintClient.apiClient.getSignature = vi
+        .fn<any, ReturnType<typeof premintClient.apiClient.getSignature>>()
+        .mockResolvedValue({
+          collection: {
+            contractAdmin: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
+            contractName: "Testing Contract",
+            contractURI:
+              "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
           },
-          uid: 3,
-          version: 1,
-        },
-        signature:
-          "0x588d19641de9ba1dade4d2bb5387c8dc96f4a990fef69787534b60caead759e6334975a6be10a796da948cd7d1d4f5580b3f84d49d9fa4e0b41c97759507975a1c",
-      });
+          premintConfig: {
+            deleted: false,
+            tokenConfig: {
+              fixedPriceMinter: "0x04E2516A2c207E84a1839755675dfd8eF6302F0a",
+              maxSupply: 18446744073709551615n,
+              maxTokensPerAddress: 0n,
+              mintDuration: 604800n,
+              mintStart: 0n,
+              pricePerToken: 0n,
+              royaltyBPS: 1000,
+              royaltyMintSchedule: 0,
+              royaltyRecipient: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
+              tokenURI:
+                "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
+            },
+            uid: 3,
+            version: 1,
+          },
+          premintConfigVersion: PremintConfigVersion.V1,
+          signature:
+            "0x588d19641de9ba1dade4d2bb5387c8dc96f4a990fef69787534b60caead759e6334975a6be10a796da948cd7d1d4f5580b3f84d49d9fa4e0b41c97759507975a1c",
+        });
+
       premintClient.apiClient.postSignature = vi.fn();
 
       const simulateContractParameters = await premintClient.makeMintParameters(
         {
           account: deployerAccount!,
-          data: await premintClient.getPremintData({
-            address: "0xf8dA7f53c283d898818af7FB9d98103F559bDac2",
-            uid: 3,
-          }),
+          tokenContract: "0xf8dA7f53c283d898818af7FB9d98103F559bDac2",
+          uid: 3,
           mintArguments: {
             quantityToMint: 1,
             mintComment: "",
@@ -213,3 +235,82 @@ describe("ZoraCreator1155Premint", () => {
     20 * 1000,
   );
 });
+
+describe("ZoraCreator1155Premint - v2 signatures", () => {
+  makeAnvilTest({
+    forkUrl: forkUrls.zoraSepolia,
+    forkBlockNumber: 1865004,
+  })(
+    "can sign on the forked premint contract",
+    async ({ viemClients: { walletClient, publicClient } }) => {
+      const [creatorAccount, createReferralAccount] =
+        await walletClient.getAddresses();
+      const premintClient = createPremintClient({
+        chain: foundry,
+        publicClient,
+      });
+
+      premintClient.apiClient.getNextUID = vi
+        .fn<any, ReturnType<typeof premintClient.apiClient.getNextUID>>()
+        .mockResolvedValue(3);
+      premintClient.apiClient.postSignature = vi
+        .fn<Parameters<typeof premintClient.apiClient.postSignature>>()
+        .mockResolvedValue({ ok: true });
+
+      await premintClient.createPremint({
+        walletClient,
+        creatorAccount: creatorAccount!,
+        checkSignature: true,
+        collection: {
+          contractAdmin: creatorAccount!,
+          contractName: "Testing Contract Premint V2",
+          contractURI:
+            "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
+        },
+        premintConfigVersion: PremintConfigVersion.V2,
+        tokenCreationConfig: {
+          tokenURI:
+            "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
+          createReferral: createReferralAccount,
+        },
+      });
+
+      const expectedPostSignatureArgs: Parameters<
+        typeof premintClient.apiClient.postSignature
+      >[0] = {
+        collection: {
+          contractAdmin: creatorAccount!,
+          contractName: "Testing Contract Premint V2",
+          contractURI:
+            "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
+        },
+        premintConfig: {
+          deleted: false,
+          tokenConfig: {
+            fixedPriceMinter: "0x04E2516A2c207E84a1839755675dfd8eF6302F0a",
+            maxSupply: 18446744073709551615n,
+            maxTokensPerAddress: 0n,
+            mintDuration: 604800n,
+            mintStart: 0n,
+            pricePerToken: 0n,
+            royaltyBPS: 1000,
+            payoutRecipient: creatorAccount!,
+            createReferral: createReferralAccount!,
+            tokenURI:
+              "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
+          },
+          uid: 3,
+          version: 0,
+        },
+        premintConfigVersion: PremintConfigVersion.V2,
+        signature:
+          "0xd0a9d8164911237430fe2c76ccfd4f53925a9e14e29da19b98ed5ed59e262b0d6ef24efe8b828b79e7b2fe5a60b81c3ce0f40b58d88619dcca131c87703d9f1f1c",
+      };
+
+      expect(premintClient.apiClient.postSignature).toHaveBeenCalledWith(
+        expectedPostSignatureArgs,
+      );
+    },
+    20 * 1000,
+  );
+});