@zoralabs/protocol-sdk 0.4.1 → 0.4.2

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

@@ -9,19 +9,16 @@ 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 =
-  SignaturePostType["requestBody"]["content"]["application/json"];
-export type PremintSignatureResponse =
-  SignaturePostType["responses"][200]["content"]["application/json"];
+import {
+  PremintSignatureRequestBody,
+  PremintSignatureResponse,
+  convertGetPremintApiResponse,
+  encodePostSignatureInput,
+} from "./conversions";
 
 type PremintNextUIDGetType =
   paths["/signature/{chain_name}/{collection_address}/next_uid"]["get"];
@@ -82,83 +79,7 @@ const getSignature = async ({
     ),
   );
 
-  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}`);
+  return result;
 };
 
 class PremintAPIClient {
@@ -171,31 +92,22 @@ class PremintAPIClient {
   }
   postSignature = async <T extends PremintConfigVersion>({
     collection,
-    premintConfigVersion,
-    premintConfig,
     signature,
+    ...premintConfigAndVersion
   }: {
     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");
-    }
+    const data = encodePostSignatureInput({
+      collection,
+      ...premintConfigAndVersion,
+      chainId: this.networkConfig.chainId,
+      signature,
+    });
+    return postSignature({
+      ...data,
+      httpClient: this.httpClient,
+    });
   };
 
   getNextUID = async (collectionAddress: Address): Promise<number> =>
@@ -226,25 +138,7 @@ class PremintAPIClient {
       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,
-    };
+    return convertGetPremintApiResponse(response);
   };
 }
 

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

@@ -3,25 +3,15 @@ import { describe, expect, vi } from "vitest";
 
 import { Address, Hex } from "viem";
 import { createPremintClient } from "./premint-client";
-import { forkUrls, makeAnvilTest } from "src/anvil";
+import { anvilTest } from "src/anvil";
 import {
   ContractCreationConfig,
   PremintConfigV1,
   PremintConfigVersion,
 } from "./contract-types";
 
-const zoraMainnetForkAnvilTest = makeAnvilTest({
-  forkUrl: forkUrls.zoraMainnet,
-  forkBlockNumber: 7550118,
-});
-
-const zoraSepoliaAnvilTest = makeAnvilTest({
-  forkUrl: forkUrls.zoraSepolia,
-  forkBlockNumber: 1904731,
-});
-
 describe("ZoraCreator1155Premint - v1 signatures", () => {
-  zoraMainnetForkAnvilTest(
+  anvilTest(
     "can sign by default v1 on the forked premint contract",
     async ({ viemClients: { walletClient, publicClient } }) => {
       const [deployerAccount] = await walletClient.getAddresses();
@@ -92,7 +82,7 @@ describe("ZoraCreator1155Premint - v1 signatures", () => {
     20 * 1000,
   );
 
-  zoraMainnetForkAnvilTest(
+  anvilTest(
     "can validate premint on network",
     async ({ viemClients: { publicClient } }) => {
       const premintClient = createPremintClient({
@@ -138,7 +128,7 @@ describe("ZoraCreator1155Premint - v1 signatures", () => {
     },
   );
 
-  zoraMainnetForkAnvilTest(
+  anvilTest(
     "can execute premint on network",
     async ({ viemClients: { walletClient, publicClient } }) => {
       const [deployerAccount] = await walletClient.getAddresses();
@@ -211,28 +201,9 @@ describe("ZoraCreator1155Premint - v1 signatures", () => {
 
       expect(premintedLog).toEqual({
         contractAddress: "0xf8dA7f53c283d898818af7FB9d98103F559bDac2",
-        contractConfig: {
-          contractAdmin: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
-          contractName: "Testing Contract",
-          contractURI:
-            "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
-        },
         createdNewContract: expect.any(Boolean),
         minter: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
         quantityMinted: 1n,
-        tokenConfig: {
-          fixedPriceMinter: "0x04E2516A2c207E84a1839755675dfd8eF6302F0a",
-          maxSupply: 18446744073709551615n,
-          maxTokensPerAddress: 0n,
-          mintDuration: 604800n,
-          mintStart: 0n,
-          pricePerToken: 0n,
-          royaltyBPS: 1000,
-          royaltyMintSchedule: 0,
-          royaltyRecipient: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
-          tokenURI:
-            "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
-        },
         tokenId: 1n,
         uid: 3,
       });
@@ -242,7 +213,7 @@ describe("ZoraCreator1155Premint - v1 signatures", () => {
 });
 
 describe("ZoraCreator1155Premint - v2 signatures", () => {
-  zoraSepoliaAnvilTest(
+  anvilTest(
     "can sign on the forked premint contract",
     async ({ viemClients: { walletClient, publicClient } }) => {
       const [creatorAccount, createReferralAccount] =

package/src/premint/premint-client.ts

@@ -36,8 +36,8 @@ import {
   TokenCreationConfigV2,
   TokenCreationConfig,
   PremintConfigForVersion,
+  MintArguments,
 } from "./contract-types";
-import type { PremintSignatureResponse } from "./premint-api-client";
 import { PremintAPIClient } from "./premint-api-client";
 import type { DecodeEventLogReturnType } from "viem";
 import { OPEN_EDITION_MINT_SIZE } from "../constants";
@@ -45,9 +45,9 @@ import { IHttpClient } from "src/apis/http-api-base";
 import { getApiNetworkConfigForChain } from "src/mint/mint-api-client";
 import { MintCosts } from "src/mint/mint-client";
 
-type PremintedLogType = DecodeEventLogReturnType<
+type PremintedV2LogType = DecodeEventLogReturnType<
   typeof zoraCreator1155PremintExecutorImplABI,
-  "Preminted"
+  "PremintedV2"
 >["args"];
 
 type URLSReturnType = {
@@ -60,7 +60,6 @@ type SignedPremintResponse = {
   urls: URLSReturnType;
   uid: number;
   verifyingContract: Address;
-  premint: PremintSignatureResponse;
 };
 
 export const defaultTokenConfigV1MintArguments = (): Omit<
@@ -128,15 +127,15 @@ const makeTokenConfigWithDefaults = <T extends PremintConfigVersion>({
  */
 export function getPremintedLogFromReceipt(
   receipt: TransactionReceipt,
-): PremintedLogType | undefined {
+): PremintedV2LogType | undefined {
   for (const data of receipt.logs) {
     try {
       const decodedLog = decodeEventLog({
         abi: zoraCreator1155PremintExecutorImplABI,
-        eventName: "Preminted",
+        eventName: "PremintedV2",
         ...data,
       });
-      if (decodedLog.eventName === "Preminted") {
+      if (decodedLog.eventName === "PremintedV2") {
         return decodedLog.args;
       }
     } catch (err: any) {}
@@ -286,8 +285,8 @@ class PremintClient {
    */
   private async signAndSubmitPremint<T extends PremintConfigVersion>(
     params: SignAndSubmitPremintParams<T>,
-  ) {
-    const { premint, verifyingContract } = await signAndSubmitPremint({
+  ): Promise<SignedPremintResponse> {
+    const { verifyingContract } = await signAndSubmitPremint({
       ...params,
       chainId: this.chain.id,
       apiClient: this.apiClient,
@@ -300,7 +299,6 @@ class PremintClient {
       urls: this.makeUrls({ address: verifyingContract, uid }),
       uid,
       verifyingContract,
-      premint,
     };
   }
 
@@ -534,11 +532,22 @@ class PremintClient {
       })
     ).totalCost;
 
+    const mintArgumentsContract: MintArguments = {
+      mintComment: mintArguments?.mintComment || "",
+      mintRecipient:
+        mintArguments?.mintRecipient ||
+        (typeof account === "string" ? account : account.address),
+      mintRewardsRecipients: makeMintRewardsRecipient({
+        mintReferral: mintArguments?.mintReferral,
+        platformReferral: mintArguments?.platformReferral,
+      }),
+    };
+
     if (premintConfigVersion === PremintConfigVersion.V1) {
       return {
         account,
         abi: zoraCreator1155PremintExecutorImplABI,
-        functionName: "premint",
+        functionName: "premintV1",
         value,
         address: getPremintExecutorAddress(),
         args: [
@@ -546,16 +555,14 @@ class PremintClient {
           premintConfig,
           signature,
           numberToMint,
-          mintArguments?.mintComment || "",
+          mintArgumentsContract,
         ],
       } satisfies SimulateContractParameters<
         typeof zoraCreator1155PremintExecutorImplABI,
-        "premint"
+        "premintV1"
       >;
     } else if (premintConfigVersion === PremintConfigVersion.V2) {
       const toPost = premintConfig as PremintConfigV2;
-      const accountAddress =
-        typeof account === "string" ? account : account.address;
 
       return {
         account,
@@ -569,14 +576,7 @@ class PremintClient {
           toPost,
           signature,
           numberToMint,
-          {
-            mintComment: mintArguments?.mintComment || "",
-            mintRecipient: mintArguments?.mintRecipient || accountAddress,
-            mintRewardsRecipients: makeMintRewardsRecipient({
-              mintReferral: mintArguments?.mintReferral,
-              platformReferral: mintArguments?.platformReferral,
-            }),
-          },
+          mintArgumentsContract,
         ],
       } satisfies SimulateContractParameters<
         typeof zoraCreator1155PremintExecutorImplABI,

package/src/premint/preminter.ts

@@ -302,18 +302,12 @@ export const supportedPremintVersions = async ({
   tokenContract: Address;
   publicClient: PublicClient;
 }): Promise<readonly string[]> => {
-  try {
-    return await publicClient.readContract({
-      abi: preminterAbi,
-      address: getPremintExecutorAddress(),
-      functionName: "supportedPremintSignatureVersions",
-      args: [tokenContract],
-    });
-  } catch (e) {
-    console.error(e);
-    // if the premint executor contract doesn't support the function, it must be v1
-    return ["1"];
-  }
+  return await publicClient.readContract({
+    abi: preminterAbi,
+    address: getPremintExecutorAddress(),
+    functionName: "supportedPremintSignatureVersions",
+    args: [tokenContract],
+  });
 };
 /**
  * Checks if the 1155 contract at that address supports the given version of the premint config.