@zoralabs/protocol-sdk 0.11.5 → 0.11.6-COMMENTS.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @zoralabs/protocol-sdk@0.11.5 build /home/runner/work/zora-protocol-private/zora-protocol-private/packages/protocol-sdk
+> @zoralabs/protocol-sdk@0.11.6-COMMENTS.0 build /home/runner/work/zora-protocol-private/zora-protocol-private/packages/protocol-sdk
 > pnpm tsup
 
 CLI Building entry: src/index.ts
@@ -10,9 +10,9 @@ CLI Target: es2021
 CLI Cleaning output folder
 CJS Build start
 ESM Build start
-ESM dist/index.js     218.89 KB
-ESM dist/index.js.map 454.13 KB
-ESM ⚡️ Build success in 351ms
-CJS dist/index.cjs     225.22 KB
-CJS dist/index.cjs.map 456.13 KB
-CJS ⚡️ Build success in 359ms
+CJS dist/index.cjs     228.29 KB
+CJS dist/index.cjs.map 462.51 KB
+CJS ⚡️ Build success in 392ms
+ESM dist/index.js     222.00 KB
+ESM dist/index.js.map 460.67 KB
+ESM ⚡️ Build success in 399ms

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @zoralabs/protocol-sdk
 
+## 0.11.6-COMMENTS.0
+
+### Patch Changes
+
+- 9d5d1638: When minting + commenting, and using the timed sale strategy, protocol sdk will call the CallerAndCommenter contract
+- 088ec6fb: When buying on secondary, you can now add a comment, which will call the CallerAndCommenter's buyOnSecondaryAndComment
+- Updated dependencies [4928687d]
+- Updated dependencies [c6e1c1bc]
+- Updated dependencies [7e285fb1]
+- Updated dependencies [17cc9821]
+- Updated dependencies [a141e322]
+  - @zoralabs/protocol-deployments@0.3.8-COMMENTS.0
+
 ## 0.11.5
 
 ### Patch Changes

package/dist/create/mint-from-create.d.ts

@@ -1,12 +1,13 @@
 import { Address } from "viem";
 import { ConcreteSalesConfig } from "./types";
 import { AsyncPrepareMint } from "src/mint/types";
-export declare function makeOnchainPrepareMintFromCreate({ contractAddress, tokenId, result, minter, getContractMintFee, contractVersion, }: {
+export declare function makeOnchainPrepareMintFromCreate({ contractAddress, tokenId, result, minter, getContractMintFee, contractVersion, chainId, }: {
     contractAddress: Address;
     tokenId: bigint;
     result: ConcreteSalesConfig;
     minter: Address;
     getContractMintFee: () => Promise<bigint>;
     contractVersion: string;
+    chainId: number;
 }): AsyncPrepareMint;
 //# sourceMappingURL=mint-from-create.d.ts.map

package/dist/create/mint-from-create.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mint-from-create.d.ts","sourceRoot":"","sources":["../../src/create/mint-from-create.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAA2B,MAAM,MAAM,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EACL,gBAAgB,EAIjB,MAAM,gBAAgB,CAAC;AA+DxB,wBAAgB,gCAAgC,CAAC,EAC/C,eAAe,EACf,OAAO,EACP,MAAM,EACN,MAAM,EACN,kBAAkB,EAClB,eAAe,GAChB,EAAE;IACD,eAAe,EAAE,OAAO,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,mBAAmB,CAAC;IAC5B,MAAM,EAAE,OAAO,CAAC;IAChB,kBAAkB,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1C,eAAe,EAAE,MAAM,CAAC;CACzB,GAAG,gBAAgB,CAyBnB"}
+{"version":3,"file":"mint-from-create.d.ts","sourceRoot":"","sources":["../../src/create/mint-from-create.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAA2B,MAAM,MAAM,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EACL,gBAAgB,EAIjB,MAAM,gBAAgB,CAAC;AA+DxB,wBAAgB,gCAAgC,CAAC,EAC/C,eAAe,EACf,OAAO,EACP,MAAM,EACN,MAAM,EACN,kBAAkB,EAClB,eAAe,EACf,OAAO,GACR,EAAE;IACD,eAAe,EAAE,OAAO,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,mBAAmB,CAAC;IAC5B,MAAM,EAAE,OAAO,CAAC;IAChB,kBAAkB,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1C,eAAe,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;CACjB,GAAG,gBAAgB,CA0BnB"}

package/dist/index.cjs

@@ -3773,7 +3773,8 @@ var contractSupportsNewMintFunction = (contractVersion) => {
 // src/mint/mint-transactions.ts
 function makeOnchainMintCall({
   token,
-  mintParams
+  mintParams,
+  chainId
 }) {
   if (token.mintType === "721") {
     return makePrepareMint721TokenParams({
@@ -3786,9 +3787,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: import_protocol_deployments6.callerAndCommenterABI,
+      address: import_protocol_deployments6.callerAndCommenterAddress[chainId],
+      functionName: "timedSaleMintAndComment",
+      account: minterAccount,
+      value: salesConfigAndTokenInfo.salesConfig.mintFeePerQuantity * mintQuantity,
+      args: [
+        mintTo,
+        mintQuantity,
+        tokenContract,
+        tokenId,
+        mintReferral || import_viem5.zeroAddress,
+        mintComment
+      ]
+    });
+  }
+  return makeContractParameters({
+    abi: import_protocol_deployments6.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 || import_viem5.zeroAddress,
+      ""
+    ]
+  });
+}
 function makePrepareMint1155TokenParams({
   tokenContract,
   tokenId,
@@ -3798,7 +3845,8 @@ function makePrepareMint1155TokenParams({
   mintReferral,
   mintRecipient,
   quantityToMint,
-  allowListEntry
+  allowListEntry,
+  chainId
 }) {
   const mintQuantity = BigInt(quantityToMint || 1);
   const mintTo = mintRecipientOrAccount({ mintRecipient, minterAccount });
@@ -3817,21 +3865,16 @@ function makePrepareMint1155TokenParams({
     });
   }
   if (saleType === "timed") {
-    return makeContractParameters({
-      abi: import_protocol_deployments6.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 || import_viem5.zeroAddress,
-        mintComment || ""
-      ]
+    return makeZoraTimedSaleStrategyMintCall({
+      minterAccount,
+      salesConfigAndTokenInfo,
+      mintQuantity,
+      mintTo,
+      tokenContract,
+      tokenId,
+      mintReferral,
+      mintComment,
+      chainId
     });
   }
   if (saleType === "erc20") {
@@ -3996,7 +4039,8 @@ async function getMint({
   params,
   mintGetter,
   premintGetter,
-  publicClient
+  publicClient,
+  chainId
 }) {
   const { tokenContract } = params;
   if (isOnChainMint(params)) {
@@ -4008,7 +4052,7 @@ async function getMint({
       preferredSaleType: params.preferredSaleType,
       blockTime
     });
-    return toMintableReturn(result);
+    return toMintableReturn(result, chainId);
   }
   const premint = await premintGetter.get({
     collectionAddress: tokenContract,
@@ -4046,11 +4090,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,
@@ -4167,14 +4212,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({
@@ -4184,7 +4230,7 @@ var makeOnchainPrepareMint = (result) => (params) => {
     })
   };
 };
-function toMintableReturn(result) {
+function toMintableReturn(result, chainId) {
   const primaryMintActive = result.primaryMintActive;
   if (!primaryMintActive) {
     return {
@@ -4200,7 +4246,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) => {
@@ -4263,11 +4312,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.
@@ -4281,7 +4332,8 @@ var MintClient = class {
       parameters,
       publicClient: this.publicClient,
       mintGetter: this.mintGetter,
-      premintGetter: this.premintGetter
+      premintGetter: this.premintGetter,
+      chainId: this.chainId
     });
   }
   /**
@@ -4295,7 +4347,8 @@ var MintClient = class {
       params: parameters,
       mintGetter: this.mintGetter,
       premintGetter: this.premintGetter,
-      publicClient: this.publicClient
+      publicClient: this.publicClient,
+      chainId: this.chainId
     });
   }
   /**
@@ -4309,7 +4362,8 @@ var MintClient = class {
       params,
       mintGetter: this.mintGetter,
       premintGetter: this.premintGetter,
-      publicClient: this.publicClient
+      publicClient: this.publicClient,
+      chainId: this.chainId
     });
   }
   /**
@@ -4330,13 +4384,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");
@@ -4879,7 +4935,8 @@ function makeOnchainPrepareMintFromCreate({
   result,
   minter,
   getContractMintFee,
-  contractVersion
+  contractVersion,
+  chainId
 }) {
   return async (params) => {
     const subgraphSalesConfig = await toSalesStrategyFromSubgraph({
@@ -4895,7 +4952,8 @@ function makeOnchainPrepareMintFromCreate({
         },
         ...params,
         tokenContract: contractAddress,
-        tokenId
+        tokenId,
+        chainId
       }),
       costs: parseMintCosts({
         allowListEntry: params.allowListEntry,
@@ -5068,7 +5126,8 @@ async function createNew1155ContractAndToken({
     getContractMintFee: async () => getNewContractMintFee({
       publicClient,
       chainId
-    })
+    }),
+    chainId
   });
   return {
     parameters: request,
@@ -5114,7 +5173,8 @@ async function createNew1155Token({
     minter,
     result: newToken.salesConfig,
     tokenId: nextTokenId,
-    getContractMintFee: async () => mintFee
+    getContractMintFee: async () => mintFee,
+    chainId
   });
   return {
     parameters: request,
@@ -6017,10 +6077,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,
@@ -6029,20 +6092,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: import_protocol_deployments15.callerAndCommenterABI,
+      address: import_protocol_deployments15.callerAndCommenterAddress[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: import_protocol_deployments15.secondarySwapABI,
@@ -6069,7 +6218,8 @@ async function buyWithSlippage({
   chainId,
   account,
   slippage = UNISWAP_SLIPPAGE,
-  recipient
+  recipient,
+  comment
 }) {
   const secondaryInfo = await getSecondaryInfo({
     contract,
@@ -6096,6 +6246,8 @@ async function buyWithSlippage({
   );
   const call = await makeBuy({
     erc20z,
+    contract,
+    tokenId,
     poolBalance,
     amount,
     quantity,
@@ -6103,6 +6255,7 @@ async function buyWithSlippage({
     recipient,
     chainId,
     slippage,
+    comment,
     publicClient
   });
   return {
@@ -6292,7 +6445,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,