@zoralabs/protocol-sdk 0.11.7 → 0.11.9

package/dist/index.js

@@ -3717,7 +3717,9 @@ import {
 import {
   erc20MinterABI,
   zoraCreator1155ImplABI as zoraCreator1155ImplABI2,
-  zoraTimedSaleStrategyABI
+  zoraTimedSaleStrategyABI,
+  callerAndCommenterABI,
+  callerAndCommenterAddress
 } from "@zoralabs/protocol-deployments";
 
 // src/mint/utils.ts
@@ -3735,7 +3737,8 @@ var contractSupportsNewMintFunction = (contractVersion) => {
 // src/mint/mint-transactions.ts
 function makeOnchainMintCall({
   token,
-  mintParams
+  mintParams,
+  chainId
 }) {
   if (token.mintType === "721") {
     return makePrepareMint721TokenParams({
@@ -3748,9 +3751,55 @@ function makeOnchainMintCall({
     salesConfigAndTokenInfo: token,
     tokenContract: token.contract.address,
     tokenId: token.tokenId,
+    chainId,
     ...mintParams
   });
 }
+function makeZoraTimedSaleStrategyMintCall({
+  minterAccount,
+  salesConfigAndTokenInfo,
+  mintQuantity,
+  mintTo,
+  tokenContract,
+  tokenId,
+  mintReferral,
+  mintComment,
+  chainId
+}) {
+  if (mintComment && mintComment !== "") {
+    return makeContractParameters({
+      abi: callerAndCommenterABI,
+      address: callerAndCommenterAddress[chainId],
+      functionName: "timedSaleMintAndComment",
+      account: minterAccount,
+      value: salesConfigAndTokenInfo.salesConfig.mintFeePerQuantity * mintQuantity,
+      args: [
+        mintTo,
+        mintQuantity,
+        tokenContract,
+        tokenId,
+        mintReferral || zeroAddress3,
+        mintComment
+      ]
+    });
+  }
+  return makeContractParameters({
+    abi: zoraTimedSaleStrategyABI,
+    functionName: "mint",
+    account: minterAccount,
+    address: salesConfigAndTokenInfo.salesConfig.address,
+    value: salesConfigAndTokenInfo.salesConfig.mintFeePerQuantity * mintQuantity,
+    /* args: mintTo, quantity, collection, tokenId, mintReferral, comment */
+    args: [
+      mintTo,
+      mintQuantity,
+      tokenContract,
+      BigInt(tokenId),
+      mintReferral || zeroAddress3,
+      ""
+    ]
+  });
+}
 function makePrepareMint1155TokenParams({
   tokenContract,
   tokenId,
@@ -3760,7 +3809,8 @@ function makePrepareMint1155TokenParams({
   mintReferral,
   mintRecipient,
   quantityToMint,
-  allowListEntry
+  allowListEntry,
+  chainId
 }) {
   const mintQuantity = BigInt(quantityToMint || 1);
   const mintTo = mintRecipientOrAccount({ mintRecipient, minterAccount });
@@ -3779,21 +3829,16 @@ function makePrepareMint1155TokenParams({
     });
   }
   if (saleType === "timed") {
-    return makeContractParameters({
-      abi: zoraTimedSaleStrategyABI,
-      functionName: "mint",
-      account: minterAccount,
-      address: salesConfigAndTokenInfo.salesConfig.address,
-      value: salesConfigAndTokenInfo.salesConfig.mintFeePerQuantity * mintQuantity,
-      /* args: mintTo, quantity, collection, tokenId, mintReferral, comment */
-      args: [
-        mintTo,
-        mintQuantity,
-        tokenContract,
-        BigInt(tokenId),
-        mintReferral || zeroAddress3,
-        mintComment || ""
-      ]
+    return makeZoraTimedSaleStrategyMintCall({
+      minterAccount,
+      salesConfigAndTokenInfo,
+      mintQuantity,
+      mintTo,
+      tokenContract,
+      tokenId,
+      mintReferral,
+      mintComment,
+      chainId
     });
   }
   if (saleType === "erc20") {
@@ -3958,7 +4003,8 @@ async function getMint({
   params,
   mintGetter,
   premintGetter,
-  publicClient
+  publicClient,
+  chainId
 }) {
   const { tokenContract } = params;
   if (isOnChainMint(params)) {
@@ -3970,7 +4016,7 @@ async function getMint({
       preferredSaleType: params.preferredSaleType,
       blockTime
     });
-    return toMintableReturn(result);
+    return toMintableReturn(result, chainId);
   }
   const premint = await premintGetter.get({
     collectionAddress: tokenContract,
@@ -4008,11 +4054,12 @@ async function getMintsOfContract({
   params,
   mintGetter,
   premintGetter,
-  publicClient
+  publicClient,
+  chainId
 }) {
   const onchainMints = (await mintGetter.getContractMintable({
     tokenAddress: params.tokenContract
-  })).map(toMintableReturn);
+  })).map((result) => toMintableReturn(result, chainId));
   const offchainMints = await getPremintsOfContractMintable({
     mintGetter,
     premintGetter,
@@ -4129,14 +4176,15 @@ function parsePremint({
   }
   throw new Error("Invalid premint config version");
 }
-var makeOnchainPrepareMint = (result) => (params) => {
+var makeOnchainPrepareMint = (result, chainId) => (params) => {
   if (!result.salesConfig) {
     throw new Error("No valid sales config found for token");
   }
   return {
     parameters: makeOnchainMintCall({
       token: result,
-      mintParams: params
+      mintParams: params,
+      chainId
     }),
     erc20Approval: getRequiredErc20Approvals(params, result.salesConfig),
     costs: parseMintCosts({
@@ -4146,7 +4194,7 @@ var makeOnchainPrepareMint = (result) => (params) => {
     })
   };
 };
-function toMintableReturn(result) {
+function toMintableReturn(result, chainId) {
   const primaryMintActive = result.primaryMintActive;
   if (!primaryMintActive) {
     return {
@@ -4162,7 +4210,10 @@ function toMintableReturn(result) {
     primaryMintActive,
     primaryMintEnd: result.primaryMintEnd,
     secondaryMarketActive: result.secondaryMarketActive,
-    prepareMint: makeOnchainPrepareMint(result.salesConfigAndTokenInfo)
+    prepareMint: makeOnchainPrepareMint(
+      result.salesConfigAndTokenInfo,
+      chainId
+    )
   };
 }
 var makePremintPrepareMint = (mintable, mintFee, premint) => {
@@ -4225,11 +4276,13 @@ var MintClient = class {
   constructor({
     publicClient,
     premintGetter,
-    mintGetter
+    mintGetter,
+    chainId
   }) {
     this.publicClient = publicClient;
     this.mintGetter = mintGetter;
     this.premintGetter = premintGetter;
+    this.chainId = chainId;
   }
   /**
    * Returns the parameters needed to prepare a transaction mint a token.
@@ -4243,7 +4296,8 @@ var MintClient = class {
       parameters,
       publicClient: this.publicClient,
       mintGetter: this.mintGetter,
-      premintGetter: this.premintGetter
+      premintGetter: this.premintGetter,
+      chainId: this.chainId
     });
   }
   /**
@@ -4257,7 +4311,8 @@ var MintClient = class {
       params: parameters,
       mintGetter: this.mintGetter,
       premintGetter: this.premintGetter,
-      publicClient: this.publicClient
+      publicClient: this.publicClient,
+      chainId: this.chainId
     });
   }
   /**
@@ -4271,7 +4326,8 @@ var MintClient = class {
       params,
       mintGetter: this.mintGetter,
       premintGetter: this.premintGetter,
-      publicClient: this.publicClient
+      publicClient: this.publicClient,
+      chainId: this.chainId
     });
   }
   /**
@@ -4292,13 +4348,15 @@ async function mint({
   parameters,
   publicClient,
   mintGetter,
-  premintGetter
+  premintGetter,
+  chainId
 }) {
   const { prepareMint, primaryMintActive } = await getMint({
     params: parameters,
     mintGetter,
     premintGetter,
-    publicClient
+    publicClient,
+    chainId
   });
   if (!primaryMintActive) {
     throw new Error("Primary mint is not active");
@@ -4860,7 +4918,8 @@ function makeOnchainPrepareMintFromCreate({
   result,
   minter,
   getContractMintFee,
-  contractVersion
+  contractVersion,
+  chainId
 }) {
   return async (params) => {
     const subgraphSalesConfig = await toSalesStrategyFromSubgraph({
@@ -4876,7 +4935,8 @@ function makeOnchainPrepareMintFromCreate({
         },
         ...params,
         tokenContract: contractAddress,
-        tokenId
+        tokenId,
+        chainId
       }),
       costs: parseMintCosts({
         allowListEntry: params.allowListEntry,
@@ -5049,7 +5109,8 @@ async function createNew1155ContractAndToken({
     getContractMintFee: async () => getNewContractMintFee({
       publicClient,
       chainId
-    })
+    }),
+    chainId
   });
   return {
     parameters: request,
@@ -5095,7 +5156,8 @@ async function createNew1155Token({
     minter,
     result: newToken.salesConfig,
     tokenId: nextTokenId,
-    getContractMintFee: async () => mintFee
+    getContractMintFee: async () => mintFee,
+    chainId
   });
   return {
     parameters: request,
@@ -5554,7 +5616,10 @@ var getRewardsBalance = async ({
   // Interface for getting ERC20Z tokens for a creator
 }) => {
   const address = typeof account === "string" ? account : account.address;
-  const erc20Zs = await rewardsGetter.getErc20ZzForCreator({ address });
+  const erc20ZsAndSecondaryActivated = await rewardsGetter.getErc20ZzForCreator(
+    { address }
+  );
+  const validErc20Zs = erc20ZsAndSecondaryActivated.filter(({ secondaryActivated }) => secondaryActivated).map(({ erc20z }) => erc20z);
   const result = await publicClient.multicall({
     contracts: [
       {
@@ -5567,7 +5632,7 @@ var getRewardsBalance = async ({
         address: erc20ZRoyaltiesAddress[chainId],
         abi: erc20ZRoyaltiesABI,
         functionName: "getUnclaimedFeesBatch",
-        args: [erc20Zs]
+        args: [validErc20Zs]
       }
     ],
     multicallAddress: multicall3Address,
@@ -5600,9 +5665,10 @@ var makeClaimSecondaryRoyaltiesCalls = async ({
   chainId,
   rewardsGetter
 }) => {
-  const erc20z = await rewardsGetter.getErc20ZzForCreator({
-    address: claimFor
-  });
+  const erc20ZsAndSecondaryActivated = await rewardsGetter.getErc20ZzForCreator(
+    { address: claimFor }
+  );
+  const erc20z = erc20ZsAndSecondaryActivated.filter(({ secondaryActivated }) => secondaryActivated).map(({ erc20z: erc20z2 }) => erc20z2);
   const royaltiesAddress = erc20ZRoyaltiesAddress[chainId];
   if (erc20z.length === 0) {
     return [];
@@ -5709,6 +5775,7 @@ function buildCreatorERC20zs({
         }
         salesStrategies {
           zoraTimedMinter {
+            secondaryActivated
             erc20Z {
               id
             }
@@ -5729,15 +5796,23 @@ var SubgraphRewardsGetter = class extends SubgraphGetter {
   constructor(chainId, subgraphQuerier) {
     super(chainId, subgraphQuerier);
   }
-  async getErc20ZzForCreator({
-    address
-  }) {
+  async getErc20ZzForCreator({ address }) {
     const queryResults = await this.querySubgraphWithRetries(
       buildCreatorERC20zs({ address })
     );
-    return queryResults?.map(
-      (result) => result.salesStrategies[0].zoraTimedMinter.erc20Z.id
-    ) || [];
+    const results = (queryResults?.map((result) => {
+      const timedMinter = result.salesStrategies[0].zoraTimedMinter;
+      if (!timedMinter) {
+        return null;
+      }
+      return {
+        secondaryActivated: timedMinter.secondaryActivated,
+        erc20z: timedMinter.erc20Z.id
+      };
+    }) || []).filter(
+      (idAndActivated) => !!idAndActivated
+    );
+    return results;
   }
 };
 
@@ -5747,7 +5822,9 @@ import {
   secondarySwapAddress,
   zoraCreator1155ImplABI as zoraCreator1155ImplABI7,
   safeTransferSwapAbiParameters,
-  secondarySwapABI
+  secondarySwapABI,
+  callerAndCommenterABI as callerAndCommenterABI2,
+  callerAndCommenterAddress as callerAndCommenterAddress2
 } from "@zoralabs/protocol-deployments";
 
 // src/secondary/uniswap/uniswapQuote.ts
@@ -6035,10 +6112,13 @@ var ERROR_INSUFFICIENT_WALLET_FUNDS = "Insufficient wallet funds";
 var ERROR_INSUFFICIENT_POOL_SUPPLY = "Insufficient pool supply";
 var ERROR_SECONDARY_NOT_CONFIGURED = "Secondary not configured for given contract and token";
 var ERROR_SECONDARY_NOT_STARTED = "Secondary market has not started";
+var ERROR_RECIPIENT_MISMATCH = "Recipient must be the same as the caller if there is a comment";
 function makeError(errorMessage) {
   return { error: errorMessage };
 }
 async function makeBuy({
+  contract,
+  tokenId,
   erc20z,
   poolBalance,
   amount,
@@ -6047,20 +6127,106 @@ async function makeBuy({
   recipient,
   chainId,
   slippage,
-  publicClient
+  publicClient,
+  comment
 }) {
   const costWithSlippage = calculateSlippageUp(amount, slippage);
-  const availableToBuy = poolBalance.erc20z / BigInt(1e18) - 1n;
   const accountAddress = addressOrAccountAddress(account);
+  const validationResult = await validateBuyConditions({
+    poolBalance,
+    quantity,
+    costWithSlippage,
+    accountAddress,
+    publicClient
+  });
+  if (validationResult.error) {
+    return makeError(validationResult.error);
+  }
+  if (comment && comment !== "") {
+    return handleBuyWithComment({
+      accountAddress,
+      recipient,
+      chainId,
+      quantity,
+      contract,
+      tokenId,
+      costWithSlippage,
+      comment,
+      account
+    });
+  }
+  return handleBuyWithoutComment({
+    erc20z,
+    quantity,
+    recipient,
+    accountAddress,
+    costWithSlippage,
+    chainId,
+    account
+  });
+}
+async function validateBuyConditions({
+  poolBalance,
+  quantity,
+  costWithSlippage,
+  accountAddress,
+  publicClient
+}) {
+  const availableToBuy = poolBalance.erc20z / BigInt(1e18) - 1n;
   const availableToSpend = await publicClient.getBalance({
     address: accountAddress
   });
   if (costWithSlippage > availableToSpend) {
-    return makeError(ERROR_INSUFFICIENT_WALLET_FUNDS);
+    return { error: ERROR_INSUFFICIENT_WALLET_FUNDS };
   }
   if (availableToBuy < BigInt(quantity)) {
-    return makeError(ERROR_INSUFFICIENT_POOL_SUPPLY);
+    return { error: ERROR_INSUFFICIENT_POOL_SUPPLY };
+  }
+  return {};
+}
+function handleBuyWithComment({
+  accountAddress,
+  recipient,
+  chainId,
+  quantity,
+  contract,
+  tokenId,
+  costWithSlippage,
+  comment,
+  account
+}) {
+  if (recipient && recipient !== accountAddress) {
+    return makeError(ERROR_RECIPIENT_MISMATCH);
   }
+  return {
+    parameters: makeContractParameters({
+      abi: callerAndCommenterABI2,
+      address: callerAndCommenterAddress2[chainId],
+      functionName: "buyOnSecondaryAndComment",
+      args: [
+        accountAddress,
+        quantity,
+        contract,
+        tokenId,
+        accountAddress,
+        costWithSlippage,
+        0n,
+        comment
+      ],
+      account,
+      value: costWithSlippage
+    })
+  };
+}
+function handleBuyWithoutComment({
+  erc20z,
+  quantity,
+  recipient,
+  accountAddress,
+  costWithSlippage,
+  chainId,
+  account
+}) {
   return {
     parameters: makeContractParameters({
       abi: secondarySwapABI,
@@ -6087,7 +6253,8 @@ async function buyWithSlippage({
   chainId,
   account,
   slippage = UNISWAP_SLIPPAGE,
-  recipient
+  recipient,
+  comment
 }) {
   const secondaryInfo = await getSecondaryInfo({
     contract,
@@ -6114,6 +6281,8 @@ async function buyWithSlippage({
   );
   const call = await makeBuy({
     erc20z,
+    contract,
+    tokenId,
     poolBalance,
     amount,
     quantity,
@@ -6121,6 +6290,7 @@ async function buyWithSlippage({
     recipient,
     chainId,
     slippage,
+    comment,
     publicClient
   });
   return {
@@ -6310,7 +6480,8 @@ function createCollectorClient(params) {
   const mintClient = new MintClient({
     publicClient: params.publicClient,
     premintGetter: premintGetterToUse,
-    mintGetter: mintGetterToUse
+    mintGetter: mintGetterToUse,
+    chainId: params.chainId
   });
   const secondaryClient = new SecondaryClient({
     publicClient: params.publicClient,