@zoralabs/protocol-sdk 0.7.1 → 0.7.2-ALLOWLIST.0

package/dist/index.d.ts

@@ -13,4 +13,6 @@ export { type ContractCreationConfigWithOptionalAdditionalAdmins, type ContractC
 export * from "./create/types";
 export * from "./sdk";
 export * from "./ipfs";
+export { createAllowList } from "./allow-list/allow-list-client";
+export * from "./allow-list/types";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AAEzC,cAAc,qBAAqB,CAAC;AAEpC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,8BAA8B,CAAC;AAE7C,cAAc,uBAAuB,CAAC;AAEtC,cAAc,6BAA6B,CAAC;AAE5C,cAAc,oBAAoB,CAAC;AAEnC,cAAc,6BAA6B,CAAC;AAE5C,cAAc,uBAAuB,CAAC;AAEtC,cAAc,yBAAyB,CAAC;AAExC,cAAc,wCAAwC,CAAC;AAEvD,OAAO,EACL,KAAK,kDAAkD,EACvD,KAAK,+BAA+B,EACpC,KAAK,gCAAgC,GACtC,MAAM,0BAA0B,CAAC;AAElC,cAAc,gBAAgB,CAAC;AAE/B,cAAc,OAAO,CAAC;AAEtB,cAAc,QAAQ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AAEzC,cAAc,qBAAqB,CAAC;AAEpC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,8BAA8B,CAAC;AAE7C,cAAc,uBAAuB,CAAC;AAEtC,cAAc,6BAA6B,CAAC;AAE5C,cAAc,oBAAoB,CAAC;AAEnC,cAAc,6BAA6B,CAAC;AAE5C,cAAc,uBAAuB,CAAC;AAEtC,cAAc,yBAAyB,CAAC;AAExC,cAAc,wCAAwC,CAAC;AAEvD,OAAO,EACL,KAAK,kDAAkD,EACvD,KAAK,+BAA+B,EACpC,KAAK,gCAAgC,GACtC,MAAM,0BAA0B,CAAC;AAElC,cAAc,gBAAgB,CAAC;AAE/B,cAAc,OAAO,CAAC;AAEtB,cAAc,QAAQ,CAAC;AAEvB,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAEjE,cAAc,oBAAoB,CAAC"}

package/dist/index.js

@@ -580,14 +580,20 @@ var get = async (url) => {
   return await response.json();
 };
 var post = async (url, data) => {
+  const controller = new AbortController();
+  const { signal } = controller;
+  const timeout = 30 * 60 * 1e3;
+  const timeoutId = setTimeout(() => controller.abort(), timeout);
   const response = await fetch(url, {
     method: "POST",
     headers: {
       "content-type": "application/json",
       accept: "application/json"
     },
-    body: JSON.stringify(data)
+    body: JSON.stringify(data),
+    signal
   });
+  clearTimeout(timeoutId);
   if (response.status !== 200) {
     let json;
     try {
@@ -673,6 +679,12 @@ fragment SaleStrategy on SalesStrategyConfig {
     saleStart
     maxTokensPerAddress
   }
+  presale {
+    address
+    presaleStart
+    presaleEnd
+    merkleRoot
+  }
 }`;
 var TOKEN_FRAGMENT = `
 fragment Token on ZoraCreateToken {
@@ -682,7 +694,7 @@ fragment Token on ZoraCreateToken {
     totalMinted
     maxSupply
     tokenStandard
-    salesStrategies(where: {type_in: ["FIXED_PRICE", "ERC_20_MINTER"]}) {
+    salesStrategies(where: {type_in: ["FIXED_PRICE", "ERC_20_MINTER", "PRESALE"]}) {
       ...SaleStrategy
     }
     contract {
@@ -691,7 +703,7 @@ fragment Token on ZoraCreateToken {
       contractVersion
       contractURI
       name
-      salesStrategies(where: {type_in: ["FIXED_PRICE", "ERC_20_MINTER"]}) {
+      salesStrategies(where: {type_in: ["FIXED_PRICE", "ERC_20_MINTER", "PRESALE"]}) {
         ...SaleStrategy
       }
     }
@@ -788,12 +800,23 @@ function parseSalesConfig(targetStrategy) {
       pricePerToken: BigInt(targetStrategy.erc20Minter.pricePerToken)
     };
   }
+  if (targetStrategy.type === "PRESALE") {
+    return {
+      saleType: "allowlist",
+      address: targetStrategy.presale.address,
+      merkleRoot: targetStrategy.presale.merkleRoot,
+      saleStart: targetStrategy.presale.presaleStart,
+      saleEnd: targetStrategy.presale.presaleEnd
+    };
+  }
   throw new Error("Unknown saleType");
 }
 function getSaleEnd(a) {
-  return BigInt(
-    a.type === "ERC_20_MINTER" ? a.erc20Minter.saleEnd : a.fixedPrice.saleEnd
-  );
+  if (a.type === "FIXED_PRICE")
+    return BigInt(a.fixedPrice.saleEnd);
+  if (a.type === "ERC_20_MINTER")
+    return BigInt(a.erc20Minter.saleEnd);
+  return BigInt(a.presale.presaleEnd);
 }
 function getTargetStrategy({
   tokenId,
@@ -1632,12 +1655,13 @@ function makePrepareMint1155TokenParams({
   mintComment,
   mintReferral,
   mintRecipient,
-  quantityToMint
+  quantityToMint,
+  allowListEntry
 }) {
   const mintQuantity = BigInt(quantityToMint || 1);
   const mintTo = mintRecipientOrAccount({ mintRecipient, minterAccount });
   const saleType = salesConfigAndTokenInfo.salesConfig.saleType;
-  if (saleType === "fixedPrice") {
+  if (saleType === "fixedPrice" || saleType === "allowlist") {
     return makeEthMintCall({
       mintComment,
       minterAccount,
@@ -1646,7 +1670,8 @@ function makePrepareMint1155TokenParams({
       mintTo,
       salesConfigAndTokenInfo,
       tokenContract,
-      tokenId
+      tokenId,
+      allowListEntry
     });
   }
   if (saleType === "erc20") {
@@ -1683,7 +1708,8 @@ function makePrepareMint721TokenParams({
   const mintValue = parseMintCosts({
     mintFeePerQuantity: salesConfigAndTokenInfo.mintFeePerQuantity,
     salesConfig: salesConfigAndTokenInfo.salesConfig,
-    quantityToMint: actualQuantityToMint
+    quantityToMint: actualQuantityToMint,
+    allowListEntry: void 0
   }).totalCostEth;
   return makeContractParameters({
     abi: zora721Abi,
@@ -1699,6 +1725,29 @@ function makePrepareMint721TokenParams({
     ]
   });
 }
+function makeFixedPriceMinterArguments({
+  mintTo,
+  mintComment
+}) {
+  return encodeAbiParameters(parseAbiParameters("address, string"), [
+    mintTo,
+    mintComment || ""
+  ]);
+}
+function makeAllowListMinterArguments({
+  mintTo,
+  allowListEntry
+}) {
+  return encodeAbiParameters(
+    parseAbiParameters("address, uint256, uint256, bytes32[]"),
+    [
+      mintTo,
+      BigInt(allowListEntry.maxCanMint),
+      allowListEntry.price,
+      allowListEntry.proof
+    ]
+  );
+}
 function makeEthMintCall({
   tokenContract,
   tokenId,
@@ -1707,17 +1756,26 @@ function makeEthMintCall({
   mintComment,
   mintReferral,
   mintQuantity,
-  mintTo
+  mintTo,
+  allowListEntry
 }) {
   const mintValue = parseMintCosts({
     mintFeePerQuantity: salesConfigAndTokenInfo.mintFeePerQuantity,
     salesConfig: salesConfigAndTokenInfo.salesConfig,
-    quantityToMint: mintQuantity
+    quantityToMint: mintQuantity,
+    allowListEntry
   }).totalCostEth;
-  const minterArguments = encodeAbiParameters(
-    parseAbiParameters("address, string"),
-    [mintTo, mintComment || ""]
-  );
+  const saleType = salesConfigAndTokenInfo.salesConfig.saleType;
+  let minterArguments;
+  if (saleType === "fixedPrice") {
+    minterArguments = makeFixedPriceMinterArguments({ mintTo, mintComment });
+  } else if (saleType === "allowlist") {
+    if (!allowListEntry)
+      throw new Error("Missing allowListEntry");
+    minterArguments = makeAllowListMinterArguments({ mintTo, allowListEntry });
+  } else {
+    throw new Error("Unsupported sale type");
+  }
   if (contractSupportsNewMintFunction(salesConfigAndTokenInfo.contractVersion)) {
     return makeContractParameters({
       abi: zoraCreator1155ImplABI2,
@@ -1750,13 +1808,22 @@ function makeEthMintCall({
     ]
   });
 }
+function paidMintCost(salesConfig, allowListEntry) {
+  if (salesConfig.saleType === "erc20" || salesConfig.saleType === "fixedPrice") {
+    return salesConfig.pricePerToken;
+  }
+  if (allowListEntry)
+    return allowListEntry.price;
+  return 0n;
+}
 function parseMintCosts({
   salesConfig,
   mintFeePerQuantity,
-  quantityToMint
+  quantityToMint,
+  allowListEntry
 }) {
   const mintFeeForTokens = mintFeePerQuantity * quantityToMint;
-  const tokenPurchaseCost = BigInt(salesConfig.pricePerToken) * quantityToMint;
+  const tokenPurchaseCost = paidMintCost(salesConfig, allowListEntry) * quantityToMint;
   const totalPurchaseCostCurrency = isErc20SaleStrategy(salesConfig) ? salesConfig.currency : void 0;
   const totalPurchaseCostEth = totalPurchaseCostCurrency ? 0n : tokenPurchaseCost;
   return {
@@ -1842,6 +1909,7 @@ async function getMintsOfContract({
 }
 async function getMintCosts({
   params,
+  allowListEntry,
   mintGetter,
   premintGetter,
   publicClient
@@ -1856,7 +1924,8 @@ async function getMintCosts({
     return parseMintCosts({
       mintFeePerQuantity: salesConfigAndTokenInfo.mintFeePerQuantity,
       salesConfig: salesConfigAndTokenInfo.salesConfig,
-      quantityToMint: BigInt(quantityToMint)
+      quantityToMint: BigInt(quantityToMint),
+      allowListEntry
     });
   }
   return getPremintMintCostsWithUnknownTokenPrice({
@@ -1938,7 +2007,8 @@ var makeOnchainPrepareMint = (result) => (params) => ({
   costs: parseMintCosts({
     salesConfig: result.salesConfig,
     quantityToMint: BigInt(params.quantityToMint),
-    mintFeePerQuantity: result.mintFeePerQuantity
+    mintFeePerQuantity: result.mintFeePerQuantity,
+    allowListEntry: params.allowListEntry
   })
 });
 function toMintableReturn(result) {
@@ -1953,7 +2023,8 @@ var makePremintPrepareMint = (mintable, mintFee, premint) => (params) => ({
   costs: parseMintCosts({
     mintFeePerQuantity: mintFee,
     quantityToMint: BigInt(params.quantityToMint),
-    salesConfig: mintable.salesConfig
+    salesConfig: mintable.salesConfig,
+    allowListEntry: params.allowListEntry
   })
 });
 function toPremintMintReturn({
@@ -2163,15 +2234,17 @@ import {
   erc20MinterAddress as erc20MinterAddresses,
   zoraCreator1155ImplABI as zoraCreator1155ImplABI4,
   zoraCreatorFixedPriceSaleStrategyABI,
-  zoraCreatorFixedPriceSaleStrategyAddress as zoraCreatorFixedPriceSaleStrategyAddress2
+  zoraCreatorFixedPriceSaleStrategyAddress as zoraCreatorFixedPriceSaleStrategyAddress2,
+  zoraCreatorMerkleMinterStrategyABI,
+  zoraCreatorMerkleMinterStrategyAddress
 } from "@zoralabs/protocol-deployments";
 import { encodeFunctionData, zeroAddress as zeroAddress5 } from "viem";
 import * as semver2 from "semver";
 var PERMISSION_BITS = {
   MINTER: 2n ** 2n
 };
+var SALE_END_FOREVER = 18446744073709551615n;
 var saleSettingsOrDefault = (saleSettings) => {
-  const SALE_END_FOREVER = 18446744073709551615n;
   const DEFAULT_SALE_SETTINGS = {
     currency: zeroAddress5,
     // Free Mint
@@ -2188,6 +2261,31 @@ var saleSettingsOrDefault = (saleSettings) => {
     ...saleSettings
   };
 };
+var allowListWithDefaults = (allowlist) => {
+  const defaultAllowListSettings = {
+    // Sale start time – defaults to beginning of unix time
+    saleStart: 0n,
+    // This is the end of uint64, plenty of time
+    saleEnd: SALE_END_FOREVER
+  };
+  return {
+    ...defaultAllowListSettings,
+    ...allowlist
+  };
+};
+var getSalesConfigOrAllowListWithDefaults = ({
+  salesConfig,
+  allowlist
+}) => {
+  if (!allowlist) {
+    return {
+      salesConfig: saleSettingsOrDefault(salesConfig)
+    };
+  }
+  return {
+    allowlist: allowListWithDefaults(allowlist)
+  };
+};
 function applyNew1155Defaults(props, ownerAddress) {
   const { payoutRecipient: fundsRecipient } = props;
   const fundsRecipientOrOwner = fundsRecipient && fundsRecipient !== zeroAddress5 ? fundsRecipient : ownerAddress;
@@ -2196,8 +2294,11 @@ function applyNew1155Defaults(props, ownerAddress) {
     createReferral: props.createReferral || zeroAddress5,
     maxSupply: typeof props.maxSupply === "undefined" ? OPEN_EDITION_MINT_SIZE : BigInt(props.maxSupply),
     royaltyBPS: props.royaltyBPS || 1e3,
-    salesConfig: saleSettingsOrDefault(props.salesConfig),
-    tokenMetadataURI: props.tokenMetadataURI
+    tokenMetadataURI: props.tokenMetadataURI,
+    salesConfigOrAllowList: getSalesConfigOrAllowListWithDefaults({
+      salesConfig: props.salesConfig,
+      allowlist: props.allowlist
+    })
   };
 }
 function setupErc20Minter({
@@ -2286,21 +2387,64 @@ function setupFixedPriceMinter({
     setupActions: [fixedPriceApproval, callSale]
   };
 }
-function setupMinters({ salesConfig, ...rest }) {
-  if (!salesConfig)
-    throw new Error("No sales config for token");
-  const { currency: currencyAddress } = salesConfig;
-  if (currencyAddress === zeroAddress5) {
-    return setupFixedPriceMinter({
-      ...salesConfig,
-      ...rest
-    });
-  } else {
-    return setupErc20Minter({
-      ...salesConfig,
-      ...rest
-    });
+function setupAllowListMinter({
+  chainId,
+  tokenId: nextTokenId,
+  allowlist,
+  fundsRecipient
+}) {
+  const merkleSaleStrategyAddress = zoraCreatorMerkleMinterStrategyAddress[chainId];
+  const merkleApproval = encodeFunctionData({
+    abi: zoraCreator1155ImplABI4,
+    functionName: "addPermission",
+    args: [nextTokenId, merkleSaleStrategyAddress, PERMISSION_BITS.MINTER]
+  });
+  const merkleRoot = allowlist.presaleMerkleRoot.startsWith("0x") ? allowlist.presaleMerkleRoot : `0x${allowlist.presaleMerkleRoot}`;
+  const saleData = encodeFunctionData({
+    abi: zoraCreatorMerkleMinterStrategyABI,
+    functionName: "setSale",
+    args: [
+      BigInt(nextTokenId),
+      {
+        presaleStart: allowlist.saleStart,
+        presaleEnd: allowlist.saleEnd,
+        merkleRoot,
+        fundsRecipient
+      }
+    ]
+  });
+  const callSaleMerkle = encodeFunctionData({
+    abi: zoraCreator1155ImplABI4,
+    functionName: "callSale",
+    args: [BigInt(nextTokenId), merkleSaleStrategyAddress, saleData]
+  });
+  return {
+    minter: merkleSaleStrategyAddress,
+    setupActions: [merkleApproval, callSaleMerkle]
+  };
+}
+function setupMinters({
+  salesConfigOrAllowList: { salesConfig, allowlist },
+  ...rest
+}) {
+  if (salesConfig) {
+    const { currency: currencyAddress } = salesConfig;
+    if (currencyAddress === zeroAddress5) {
+      return setupFixedPriceMinter({
+        ...salesConfig,
+        ...rest
+      });
+    } else {
+      return setupErc20Minter({
+        ...salesConfig,
+        ...rest
+      });
+    }
   }
+  return setupAllowListMinter({
+    allowlist,
+    ...rest
+  });
 }
 function buildSetupNewToken({
   tokenURI,
@@ -2393,7 +2537,7 @@ function constructCreate1155TokenCalls(props) {
     tokenId: nextTokenId,
     chainId,
     fundsRecipient: new1155TokenPropsWithDefaults.payoutRecipient,
-    salesConfig: new1155TokenPropsWithDefaults.salesConfig
+    salesConfigOrAllowList: new1155TokenPropsWithDefaults.salesConfigOrAllowList
   });
   const adminMintCall = makeAdminMintCall({
     ownerAddress,
@@ -2444,6 +2588,21 @@ var getTokenIdFromCreateReceipt = (receipt) => {
     }
   }
 };
+var getContractAddressFromCreateReceipt = (receipt) => {
+  for (const data of receipt.logs) {
+    try {
+      const decodedLog = decodeEventLog2({
+        abi: zoraCreator1155FactoryImplABI2,
+        eventName: "SetupNewContract",
+        ...data
+      });
+      if (decodedLog && decodedLog.eventName === "SetupNewContract") {
+        return decodedLog.args.newContract;
+      }
+    } catch (err) {
+    }
+  }
+};
 function makeCreateContractAndTokenCall({
   contractExists,
   contractAddress,
@@ -4069,6 +4228,25 @@ async function generateTextNftMetadataFiles(text) {
     thumbnailFile
   };
 }
+
+// src/allow-list/allow-list-client.ts
+var ALLOW_LIST_API_BASE = "http://allowlist.zora.co/";
+var createAllowList = async ({
+  allowList,
+  httpClient: httpClient2 = httpClient
+}) => {
+  const { post: post2, retries: retries2 } = httpClient2;
+  const data = {
+    entries: allowList.entries.map((entry) => ({
+      user: entry.user,
+      maxCanMint: entry.maxCanMint,
+      price: entry.price.toString()
+    }))
+  };
+  return (await retries2(
+    () => post2(`${ALLOW_LIST_API_BASE}allowlist`, data)
+  )).root;
+};
 export {
   Create1155Client,
   Errors,
@@ -4088,6 +4266,7 @@ export {
   convertGetPremintApiResponse,
   convertGetPremintOfCollectionApiResponse,
   convertPremintFromApi,
+  createAllowList,
   createCollectorClient,
   createCreatorClient,
   decodeCallFailedError,
@@ -4100,6 +4279,7 @@ export {
   encodePremintForAPI,
   generateTextNftMetadataFiles,
   getApiNetworkConfigForChain,
+  getContractAddressFromCreateReceipt,
   getDataFromPremintReceipt,
   getDefaultFixedPriceMinterAddress,
   getMintsAccountBalanceWithPriceQuery,