@zoralabs/protocol-sdk 0.4.0 → 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,20 +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,
-});
-
 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();
@@ -87,7 +82,7 @@ describe("ZoraCreator1155Premint - v1 signatures", () => {
     20 * 1000,
   );
 
-  zoraMainnetForkAnvilTest(
+  anvilTest(
     "can validate premint on network",
     async ({ viemClients: { publicClient } }) => {
       const premintClient = createPremintClient({
@@ -133,7 +128,7 @@ describe("ZoraCreator1155Premint - v1 signatures", () => {
     },
   );
 
-  zoraMainnetForkAnvilTest(
+  anvilTest(
     "can execute premint on network",
     async ({ viemClients: { walletClient, publicClient } }) => {
       const [deployerAccount] = await walletClient.getAddresses();
@@ -206,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,
       });
@@ -237,10 +213,7 @@ describe("ZoraCreator1155Premint - v1 signatures", () => {
 });
 
 describe("ZoraCreator1155Premint - v2 signatures", () => {
-  makeAnvilTest({
-    forkUrl: forkUrls.zoraSepolia,
-    forkBlockNumber: 1865004,
-  })(
+  anvilTest(
     "can sign on the forked premint contract",
     async ({ viemClients: { walletClient, publicClient } }) => {
       const [creatorAccount, createReferralAccount] =

package/src/premint/premint-client.ts

@@ -23,6 +23,8 @@ import {
   markPremintDeleted,
   makeNewPremint,
   supportsPremintVersion,
+  getPremintMintCosts,
+  makeMintRewardsRecipient,
 } from "./preminter";
 import {
   PremintConfigV2,
@@ -34,18 +36,18 @@ 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";
-import { REWARD_PER_TOKEN } from "src/apis/chain-constants";
 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 = {
@@ -58,7 +60,6 @@ type SignedPremintResponse = {
   urls: URLSReturnType;
   uid: number;
   verifyingContract: Address;
-  premint: PremintSignatureResponse;
 };
 
 export const defaultTokenConfigV1MintArguments = (): Omit<
@@ -126,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) {}
@@ -284,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,
@@ -298,7 +299,6 @@ class PremintClient {
       urls: this.makeUrls({ address: verifyingContract, uid }),
       uid,
       verifyingContract,
-      premint,
     };
   }
 
@@ -461,6 +461,23 @@ class PremintClient {
     });
   }
 
+  async getMintCosts({
+    tokenContract,
+    quantityToMint,
+    tokenCreationConfig,
+  }: {
+    quantityToMint: bigint;
+    tokenContract: Address;
+    tokenCreationConfig: TokenCreationConfig;
+  }): Promise<MintCosts> {
+    return await getPremintMintCosts({
+      publicClient: this.publicClient,
+      quantityToMint,
+      tokenContract,
+      tokenPrice: tokenCreationConfig.pricePerToken,
+    });
+  }
+
   /**
    * Execute premint on-chain
    *
@@ -486,6 +503,7 @@ class PremintClient {
       quantityToMint: number;
       mintComment?: string;
       mintReferral?: Address;
+      platformReferral?: Address;
       mintRecipient?: Address;
     };
   }): Promise<SimulateContractParameters> {
@@ -505,13 +523,31 @@ class PremintClient {
 
     const numberToMint = BigInt(mintArguments?.quantityToMint || 1);
 
-    const value = numberToMint * REWARD_PER_TOKEN;
+    const value = (
+      await getPremintMintCosts({
+        tokenContract,
+        quantityToMint: numberToMint,
+        publicClient: this.publicClient,
+        tokenPrice: premintConfig.tokenConfig.pricePerToken,
+      })
+    ).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: [
@@ -519,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,
@@ -542,11 +576,7 @@ class PremintClient {
           toPost,
           signature,
           numberToMint,
-          {
-            mintComment: mintArguments?.mintComment || "",
-            mintRecipient: mintArguments?.mintRecipient || accountAddress,
-            mintReferral: mintArguments?.mintReferral || zeroAddress,
-          },
+          mintArgumentsContract,
         ],
       } satisfies SimulateContractParameters<
         typeof zoraCreator1155PremintExecutorImplABI,

package/src/premint/preminter.test.ts

@@ -14,6 +14,7 @@ import {
   isValidSignature,
   recoverCreatorFromCreatorAttribution,
   getPremintExecutorAddress,
+  getPremintMintCosts,
 } from "./preminter";
 import {
   ContractCreationConfig,
@@ -102,8 +103,6 @@ const defaultPremintConfigV2 = ({
   version: 0,
 });
 
-const ZORA_MINT_FEE = parseEther("0.000777");
-
 const PREMINTER_ADDRESS = getPremintExecutorAddress();
 
 const anvilTest = makeAnvilTest({
@@ -140,6 +139,11 @@ async function setupContracts({
   };
 }
 
+const zoraSepoliaAnvilTest = makeAnvilTest({
+  forkUrl: forkUrls.zoraSepolia,
+  forkBlockNumber: 1905837,
+});
+
 describe("ZoraCreator1155Preminter", () => {
   // skip for now - we need to make this work on zora testnet chain too
   anvilTest(
@@ -186,7 +190,7 @@ describe("ZoraCreator1155Preminter", () => {
     },
     20 * 1000,
   );
-  anvilTest(
+  zoraSepoliaAnvilTest(
     "can sign and recover a v1 premint config signature",
     async ({ viemClients }) => {
       const {
@@ -239,10 +243,7 @@ describe("ZoraCreator1155Preminter", () => {
 
     20 * 1000,
   );
-  makeAnvilTest({
-    forkUrl: forkUrls.zoraSepolia,
-    forkBlockNumber: 1262991,
-  })(
+  zoraSepoliaAnvilTest(
     "can sign and recover a v2 premint config signature",
     async ({ viemClients }) => {
       const {
@@ -296,7 +297,7 @@ describe("ZoraCreator1155Preminter", () => {
 
     20 * 1000,
   );
-  anvilTest(
+  zoraSepoliaAnvilTest(
     "can sign and mint multiple tokens",
     async ({ viemClients }) => {
       const {
@@ -337,9 +338,14 @@ describe("ZoraCreator1155Preminter", () => {
 
       const quantityToMint = 2n;
 
-      const valueToSend =
-        (ZORA_MINT_FEE + premintConfig1.tokenConfig.pricePerToken) *
-        quantityToMint;
+      const valueToSend = (
+        await getPremintMintCosts({
+          publicClient: viemClients.publicClient,
+          quantityToMint,
+          tokenContract: contractAddress,
+          tokenPrice: premintConfig1.tokenConfig.pricePerToken,
+        })
+      ).totalCost;
 
       await viemClients.testClient.setBalance({
         address: collectorAccount,
@@ -361,7 +367,7 @@ describe("ZoraCreator1155Preminter", () => {
       const mintArguments: MintArguments = {
         mintComment: "",
         mintRecipient: collectorAccount,
-        mintReferral: collectorAccount,
+        mintRewardsRecipients: [],
       };
 
       // now have the collector execute the first signed message;
@@ -433,9 +439,14 @@ describe("ZoraCreator1155Preminter", () => {
 
       const quantityToMint2 = 4n;
 
-      const valueToSend2 =
-        (ZORA_MINT_FEE + premintConfig2.tokenConfig.pricePerToken) *
-        quantityToMint2;
+      const valueToSend2 = (
+        await getPremintMintCosts({
+          publicClient: viemClients.publicClient,
+          quantityToMint: quantityToMint2,
+          tokenContract: contractAddress,
+          tokenPrice: premintConfig2.tokenConfig.pricePerToken,
+        })
+      ).totalCost;
 
       const simulationResult = await viemClients.publicClient.simulateContract({
         abi: preminterAbi,
@@ -490,7 +501,7 @@ describe("ZoraCreator1155Preminter", () => {
     40 * 1000,
   );
 
-  anvilTest(
+  zoraSepoliaAnvilTest(
     "can decode the CreatorAttribution event",
     async ({ viemClients }) => {
       const {
@@ -532,9 +543,14 @@ describe("ZoraCreator1155Preminter", () => {
 
       const quantityToMint = 2n;
 
-      const valueToSend =
-        (ZORA_MINT_FEE + premintConfig.tokenConfig.pricePerToken) *
-        quantityToMint;
+      const valueToSend = (
+        await getPremintMintCosts({
+          publicClient: viemClients.publicClient,
+          quantityToMint,
+          tokenContract: contractAddress,
+          tokenPrice: premintConfig.tokenConfig.pricePerToken,
+        })
+      ).totalCost;
 
       await viemClients.testClient.setBalance({
         address: collectorAccount,
@@ -560,7 +576,7 @@ describe("ZoraCreator1155Preminter", () => {
           {
             mintComment: "",
             mintRecipient: collectorAccount,
-            mintReferral: zeroAddress,
+            mintRewardsRecipients: [],
           },
         ],
         value: valueToSend,

package/src/premint/preminter.ts

@@ -16,6 +16,7 @@ import {
   concat,
   recoverAddress,
   GetEventArgs,
+  parseEther,
 } from "viem";
 import {
   ContractCreationConfig,
@@ -30,6 +31,7 @@ import {
   v1Types,
   v2Types,
 } from "./contract-types";
+import { MintCosts } from "src/mint/mint-client";
 
 export const getPremintExecutorAddress = () =>
   zoraCreator1155PremintExecutorImplAddress[999];
@@ -300,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.
@@ -393,3 +389,56 @@ export function makeNewPremint<T extends TokenCreationConfig>({
     tokenConfig,
   } as PremintConfigForTokenCreationConfig<T>;
 }
+
+export async function getPremintMintFee({
+  tokenContract,
+  publicClient,
+}: {
+  tokenContract: Address;
+  publicClient: PublicClient;
+}) {
+  // try reading mint fee function from premint executor.  this will revert
+  // if the abi is not up to date yet
+  try {
+    return await publicClient.readContract({
+      address: getPremintExecutorAddress(),
+      abi: zoraCreator1155PremintExecutorImplABI,
+      functionName: "mintFee",
+      args: [tokenContract],
+    });
+  } catch (e) {
+    console.error(e);
+
+    return parseEther("0.000777");
+  }
+}
+
+export async function getPremintMintCosts({
+  publicClient,
+  tokenContract,
+  tokenPrice,
+  quantityToMint,
+}: {
+  tokenContract: Address;
+  tokenPrice: bigint;
+  quantityToMint: bigint;
+  publicClient: PublicClient;
+}): Promise<MintCosts> {
+  const mintFee = await getPremintMintFee({ tokenContract, publicClient });
+
+  return {
+    mintFee: mintFee * quantityToMint,
+    tokenPurchaseCost: tokenPrice * quantityToMint,
+    totalCost: (mintFee + tokenPrice) * quantityToMint,
+  };
+}
+
+export function makeMintRewardsRecipient({
+  mintReferral = zeroAddress,
+  platformReferral = zeroAddress,
+}: {
+  mintReferral?: Address;
+  platformReferral?: Address;
+}): Address[] {
+  return [mintReferral, platformReferral];
+}