@zoralabs/protocol-sdk 0.4.0 → 0.4.1

package/src/premint/premint-client.ts

@@ -23,6 +23,8 @@ import {
   markPremintDeleted,
   makeNewPremint,
   supportsPremintVersion,
+  getPremintMintCosts,
+  makeMintRewardsRecipient,
 } from "./preminter";
 import {
   PremintConfigV2,
@@ -39,9 +41,9 @@ 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<
   typeof zoraCreator1155PremintExecutorImplABI,
@@ -461,6 +463,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 +505,7 @@ class PremintClient {
       quantityToMint: number;
       mintComment?: string;
       mintReferral?: Address;
+      platformReferral?: Address;
       mintRecipient?: Address;
     };
   }): Promise<SimulateContractParameters> {
@@ -505,7 +525,14 @@ 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;
 
     if (premintConfigVersion === PremintConfigVersion.V1) {
       return {
@@ -545,7 +572,10 @@ class PremintClient {
           {
             mintComment: mintArguments?.mintComment || "",
             mintRecipient: mintArguments?.mintRecipient || accountAddress,
-            mintReferral: mintArguments?.mintReferral || zeroAddress,
+            mintRewardsRecipients: makeMintRewardsRecipient({
+              mintReferral: mintArguments?.mintReferral,
+              platformReferral: mintArguments?.platformReferral,
+            }),
           },
         ],
       } satisfies SimulateContractParameters<

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];
@@ -393,3 +395,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];
+}