@zoralabs/protocol-sdk 0.5.16 → 0.5.17

package/dist/index.d.ts

@@ -9,4 +9,5 @@ export * from "./create/1155-create-helper";
 export * from "./mints/mints-queries";
 export * from "./mints/mints-contracts";
 export * from "./mints/mints-eth-unwrapper-and-caller";
+export { type ContractCreationConfigWithOptionalAdditionalAdmins, type ContractCreationConfigOrAddress, type ContractCreationConfigAndAddress, } from "./premint/contract-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,wBAAwB,CAAC;AAEvC,cAAc,oBAAoB,CAAC;AAEnC,cAAc,6BAA6B,CAAC;AAE5C,cAAc,uBAAuB,CAAC;AAEtC,cAAc,yBAAyB,CAAC;AAExC,cAAc,wCAAwC,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,wBAAwB,CAAC;AAEvC,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"}

package/dist/index.js

@@ -1,6 +1,9 @@
 // src/premint/premint-client.ts
 import { decodeEventLog, zeroAddress as zeroAddress2 } from "viem";
-import { zoraCreator1155PremintExecutorImplABI as zoraCreator1155PremintExecutorImplABI2 } from "@zoralabs/protocol-deployments";
+import {
+  encodePremintConfig,
+  zoraCreator1155PremintExecutorImplABI as zoraCreator1155PremintExecutorImplABI2
+} from "@zoralabs/protocol-deployments";
 
 // src/premint/preminter.ts
 import {
@@ -21,22 +24,21 @@ import {
 } from "viem";
 var getPremintExecutorAddress = () => zoraCreator1155PremintExecutorImplAddress[999];
 async function isAuthorizedToCreatePremint({
-  collection,
+  contractAdmin = zeroAddress,
+  additionalAdmins = [],
   collectionAddress,
   publicClient,
   signer
 }) {
-  if (collection.additionalAdmins.length > 0)
-    throw new Error("additionalAdmins not supported yet.");
   return await publicClient.readContract({
     abi: preminterAbi,
     address: getPremintExecutorAddress(),
     functionName: "isAuthorizedToCreatePremintWithAdditionalAdmins",
     args: [
-      signer,
-      collection.contractAdmin,
+      typeof signer === "string" ? signer : signer.address,
+      contractAdmin,
       collectionAddress,
-      collection.additionalAdmins
+      additionalAdmins
     ]
   });
 }
@@ -61,17 +63,14 @@ async function isValidSignature({
   signature,
   publicClient,
   collection,
+  collectionAddress,
   chainId,
   ...premintConfigAndVersion
 }) {
-  const tokenContract = await getPremintCollectionAddress({
-    collection,
-    publicClient
-  });
   const recoveredAddress = await tryRecoverPremintSigner({
     ...premintConfigAndVersion,
     signature,
-    verifyingContract: tokenContract,
+    verifyingContract: collectionAddress,
     chainId
   });
   if (!recoverAddress) {
@@ -81,8 +80,9 @@ async function isValidSignature({
   }
   const isAuthorized = await isAuthorizedToCreatePremint({
     signer: recoveredAddress,
-    collection,
-    collectionAddress: tokenContract,
+    additionalAdmins: collection?.additionalAdmins,
+    contractAdmin: collection?.contractAdmin,
+    collectionAddress,
     publicClient
   });
   return {
@@ -163,15 +163,24 @@ var supportsPremintVersion = async ({
   return (await supportedPremintVersions({ tokenContract, publicClient })).includes(version);
 };
 async function getPremintCollectionAddress({
+  publicClient,
   collection,
-  publicClient
+  collectionAddress
 }) {
-  return publicClient.readContract({
-    address: getPremintExecutorAddress(),
-    abi: zoraCreator1155PremintExecutorImplABI,
-    functionName: "getContractAddress",
-    args: [collection]
-  });
+  if (typeof collection !== "undefined") {
+    return publicClient.readContract({
+      address: getPremintExecutorAddress(),
+      abi: zoraCreator1155PremintExecutorImplABI,
+      functionName: "getContractWithAdditionalAdminsAddress",
+      args: [
+        {
+          ...collection,
+          additionalAdmins: collection.additionalAdmins || []
+        }
+      ]
+    });
+  }
+  return collectionAddress;
 }
 function applyUpdateToPremint({
   uid,
@@ -240,6 +249,34 @@ function makeMintRewardsRecipient({
 function getDefaultFixedPriceMinterAddress(chainId) {
   return zoraCreatorFixedPriceSaleStrategyAddress[chainId];
 }
+var emptyContractCreationConfig = () => ({
+  contractAdmin: zeroAddress,
+  contractURI: "",
+  contractName: "",
+  additionalAdmins: []
+});
+function defaultAdditionalAdmins(collection) {
+  return {
+    ...collection,
+    additionalAdmins: collection.additionalAdmins || []
+  };
+}
+var toContractCreationConfigOrAddress = ({
+  collection,
+  collectionAddress
+}) => {
+  if (typeof collection !== "undefined") {
+    return {
+      collection
+    };
+  }
+  if (typeof collectionAddress !== "undefined") {
+    return {
+      collectionAddress
+    };
+  }
+  throw new Error("Must provide either a collection or a collection address");
+};
 
 // src/premint/premint-client.ts
 import {
@@ -539,11 +576,16 @@ var MintAPIClient = class {
 import {
   PremintConfigVersion
 } from "@zoralabs/protocol-deployments";
-var convertCollectionFromApi = (collection) => ({
-  ...collection,
-  contractAdmin: collection.contractAdmin,
-  additionalAdmins: []
-});
+var convertCollectionFromApi = (collection) => {
+  if (!collection)
+    return void 0;
+  return {
+    additionalAdmins: collection.additionalAdmins || [],
+    contractAdmin: collection.contractAdmin,
+    contractName: collection.contractName,
+    contractURI: collection.contractURI
+  };
+};
 var convertPremintFromApi = (premint) => {
   if (premint.config_version === PremintConfigVersion.V1 || !premint.config_version) {
     const tokenConfig = premint.tokenConfig;
@@ -591,6 +633,7 @@ var convertPremintFromApi = (premint) => {
 var convertGetPremintApiResponse = (response) => ({
   ...convertPremintFromApi(response.premint),
   collection: convertCollectionFromApi(response.collection),
+  collectionAddress: response.collection_address,
   signature: response.signature
 });
 var encodePremintV1ForAPI = ({
@@ -637,6 +680,7 @@ var encodePremintForAPI = ({
 };
 var encodePostSignatureInput = ({
   collection,
+  collectionAddress,
   premintConfigVersion,
   premintConfig,
   signature,
@@ -648,6 +692,7 @@ var encodePostSignatureInput = ({
   }),
   signature,
   collection,
+  collection_address: collectionAddress,
   chain_name: networkConfigByChain[chainId].zoraBackendChainName
 });
 
@@ -683,13 +728,11 @@ var getSignature = async ({
 var PremintAPIClient = class {
   constructor(chainId, httpClient2) {
     this.postSignature = async ({
-      collection,
       signature,
-      ...premintConfigAndVersion
+      ...rest
     }) => {
       const data = encodePostSignatureInput({
-        collection,
-        ...premintConfigAndVersion,
+        ...rest,
         chainId: this.networkConfig.chainId,
         signature
       });
@@ -746,6 +789,37 @@ var defaultTokenConfigV1MintArguments = () => ({
   royaltyBPS: 1e3
   // 10%,
 });
+var pickTokenConfigV1 = (tokenConfig) => ({
+  maxSupply: tokenConfig.maxSupply,
+  maxTokensPerAddress: tokenConfig.maxTokensPerAddress,
+  pricePerToken: tokenConfig.pricePerToken,
+  mintDuration: tokenConfig.mintDuration,
+  mintStart: tokenConfig.mintStart,
+  royaltyBPS: tokenConfig.royaltyBPS,
+  tokenURI: tokenConfig.tokenURI,
+  royaltyRecipient: tokenConfig.payoutRecipient
+});
+var pickTokenConfigV2 = (tokenConfig) => ({
+  maxSupply: tokenConfig.maxSupply,
+  maxTokensPerAddress: tokenConfig.maxTokensPerAddress,
+  pricePerToken: tokenConfig.pricePerToken,
+  mintDuration: tokenConfig.mintDuration,
+  mintStart: tokenConfig.mintStart,
+  royaltyBPS: tokenConfig.royaltyBPS,
+  tokenURI: tokenConfig.tokenURI,
+  payoutRecipient: tokenConfig.payoutRecipient,
+  createReferral: tokenConfig.createReferral || zeroAddress2
+});
+var tokenConfigV1WithDefault = (tokenConfig, fixedPriceMinter) => ({
+  ...pickTokenConfigV1(tokenConfig),
+  ...defaultTokenConfigV1MintArguments(),
+  fixedPriceMinter
+});
+var tokenConfigV2WithDefault = (tokenConfig, fixedPriceMinter) => ({
+  ...pickTokenConfigV2(tokenConfig),
+  ...defaultTokenConfigV2MintArguments(),
+  fixedPriceMinter
+});
 var defaultTokenConfigV2MintArguments = () => ({
   maxSupply: OPEN_EDITION_MINT_SIZE,
   maxTokensPerAddress: 0n,
@@ -758,32 +832,29 @@ var defaultTokenConfigV2MintArguments = () => ({
 });
 var makeTokenConfigWithDefaults = ({
   chainId,
-  premintConfigVersion,
   tokenCreationConfig,
-  payoutRecipient
+  supportedPremintVersions: supportedPremintVersions2
 }) => {
-  if (premintConfigVersion === PremintConfigVersion2.V3) {
-    throw new Error("PremintV3 not supported in SDK");
-  }
-  const fixedPriceMinter = tokenCreationConfig.fixedPriceMinter || getDefaultFixedPriceMinterAddress(chainId);
-  if (premintConfigVersion === PremintConfigVersion2.V1) {
-    return {
-      fixedPriceMinter,
-      ...defaultTokenConfigV1MintArguments(),
-      royaltyRecipient: payoutRecipient,
-      ...tokenCreationConfig
-    };
-  } else if (premintConfigVersion === PremintConfigVersion2.V2) {
+  const fixedPriceMinter = getDefaultFixedPriceMinterAddress(chainId);
+  if (!supportedPremintVersions2.includes(PremintConfigVersion2.V2)) {
+    if (tokenCreationConfig.createReferral) {
+      throw new Error("Contract does not support create referral");
+    }
     return {
-      fixedPriceMinter,
-      ...defaultTokenConfigV2MintArguments(),
-      payoutRecipient,
-      createReferral: zeroAddress2,
-      ...tokenCreationConfig
+      premintConfigVersion: PremintConfigVersion2.V1,
+      tokenConfig: tokenConfigV1WithDefault(
+        tokenCreationConfig,
+        fixedPriceMinter
+      )
     };
-  } else {
-    throw new Error(`Invalid premint config version ${premintConfigVersion}`);
   }
+  return {
+    premintConfigVersion: PremintConfigVersion2.V2,
+    tokenConfig: tokenConfigV2WithDefault(
+      tokenCreationConfig,
+      fixedPriceMinter
+    )
+  };
 };
 function getPremintedLogFromReceipt(receipt) {
   for (const data of receipt.logs) {
@@ -893,17 +964,22 @@ var PremintClient = class {
    */
   async isValidSignature({
     signature,
-    collection,
     premintConfig,
-    premintConfigVersion
+    premintConfigVersion,
+    ...collectionAndOrAddress
   }) {
+    const collectionAddressToUse = await getPremintCollectionAddress({
+      ...collectionAndOrAddress,
+      publicClient: this.publicClient
+    });
     const { isAuthorized, recoveredAddress } = await isValidSignature({
       chainId: this.chain.id,
       signature,
-      collection,
       publicClient: this.publicClient,
       premintConfig,
-      premintConfigVersion: premintConfigVersion || PremintConfigVersion2.V1
+      premintConfigVersion: premintConfigVersion || PremintConfigVersion2.V1,
+      collectionAddress: collectionAddressToUse,
+      collection: collectionAndOrAddress.collection
     });
     return { isValid: isAuthorized, recoveredSigner: recoveredAddress };
   }
@@ -953,12 +1029,12 @@ function createPremintClient(clientConfig) {
 function makePremintReturn({
   premintConfig,
   premintConfigVersion,
-  collectionAddress,
-  collection,
   publicClient,
   apiClient,
-  chainId
+  chainId,
+  ...collectionAndAddress
 }) {
+  const { collection, collectionAddress } = collectionAndAddress;
   const typedDataDefinition = premintTypedDataDefinition2({
     verifyingContract: collectionAddress,
     premintConfig,
@@ -991,20 +1067,19 @@ function makePremintReturn({
     signerAccount
   }) => {
     if (checkSignature) {
-      await validateSignature({
-        collection: {
-          ...collection,
-          additionalAdmins: []
-        },
+      const isAuthorized = await isAuthorizedToCreatePremint({
+        collectionAddress,
+        additionalAdmins: collection?.additionalAdmins,
+        contractAdmin: collection?.contractAdmin,
         publicClient,
-        signerAccount
+        signer: signerAccount
       });
+      if (!isAuthorized) {
+        throw new Error("Not authorized to create premint");
+      }
     }
     await apiClient.postSignature({
-      collection: {
-        ...collection,
-        additionalAdmins: []
-      },
+      ...toContractCreationConfigOrAddress(collectionAndAddress),
       signature,
       premintConfig,
       premintConfigVersion
@@ -1039,43 +1114,21 @@ async function signPremint({
     signerAccount: account
   };
 }
-var validateSignature = async ({
-  collection,
-  publicClient,
-  signerAccount
-}) => {
-  const isAuthorized = await isAuthorizedToCreatePremint({
-    collection,
-    publicClient,
-    signer: typeof signerAccount === "string" ? signerAccount : signerAccount.address,
-    collectionAddress: await getPremintCollectionAddress({
-      collection,
-      publicClient
-    })
-  });
-  if (!isAuthorized) {
-    throw new Error("Not authorized to create premint");
-  }
-};
 async function createPremint({
-  payoutRecipient: creatorAccount,
-  collection,
   tokenCreationConfig,
-  premintConfigVersion,
   uid,
   publicClient,
   apiClient,
-  chainId
+  chainId,
+  ...collectionOrAddress
 }) {
   const {
     premintConfig,
-    premintConfigVersion: actualVersion,
-    collectionAddress
+    premintConfigVersion,
+    collectionAddress: collectionAddressToUse
   } = await prepareCreatePremintConfig({
-    payoutRecipient: creatorAccount,
-    collection,
+    ...collectionOrAddress,
     tokenCreationConfig,
-    premintConfigVersion,
     uid,
     publicClient,
     apiClient,
@@ -1083,59 +1136,49 @@ async function createPremint({
   });
   return makePremintReturn({
     premintConfig,
-    premintConfigVersion: actualVersion,
-    collectionAddress,
-    collection,
+    premintConfigVersion,
+    collectionAddress: collectionAddressToUse,
+    collection: collectionOrAddress.collection,
     publicClient,
     apiClient,
     chainId
   });
 }
 async function prepareCreatePremintConfig({
-  payoutRecipient,
-  collection,
   tokenCreationConfig,
-  premintConfigVersion,
   uid,
   publicClient,
   apiClient,
-  chainId
+  chainId,
+  ...collectionOrAddress
 }) {
-  const collectionWithAdditionalAdmins = {
-    ...collection,
-    additionalAdmins: collection.additionalAdmins || []
-  };
   const newContractAddress = await getPremintCollectionAddress({
     publicClient,
-    collection: collectionWithAdditionalAdmins
+    ...collectionOrAddress
   });
   let uidToUse = uid;
   if (typeof uidToUse !== "number") {
     uidToUse = await apiClient.getNextUID(newContractAddress);
   }
-  const actualVersion = premintConfigVersion || PremintConfigVersion2.V1;
-  if (!await supportsPremintVersion({
-    version: actualVersion,
-    publicClient,
-    tokenContract: newContractAddress
-  })) {
-    throw new Error(
-      `Premint version ${actualVersion} not supported by contract`
-    );
-  }
+  const supportedVersions = await supportedPremintVersions({
+    tokenContract: newContractAddress,
+    publicClient
+  });
+  const tokenConfigAndVersion = makeTokenConfigWithDefaults({
+    tokenCreationConfig,
+    chainId,
+    supportedPremintVersions: supportedVersions
+  });
   const premintConfig = makeNewPremint({
-    tokenConfig: makeTokenConfigWithDefaults({
-      // @ts-ignore
-      premintConfigVersion: actualVersion,
-      tokenCreationConfig,
-      payoutRecipient: typeof payoutRecipient === "string" ? payoutRecipient : payoutRecipient.address,
-      chainId
-    }),
+    ...tokenConfigAndVersion,
     uid: uidToUse
   });
-  return {
+  const premintConfigAndVersion = {
     premintConfig,
-    premintConfigVersion: actualVersion,
+    premintConfigVersion: tokenConfigAndVersion.premintConfigVersion
+  };
+  return {
+    ...premintConfigAndVersion,
     collectionAddress: newContractAddress
   };
 }
@@ -1181,7 +1224,8 @@ async function deletePremint({
   const {
     premintConfig,
     premintConfigVersion,
-    collection: collectionCreationConfig
+    collection: collectionCreationConfig,
+    collectionAddress
   } = await apiClient.getSignature({
     collectionAddress: collection,
     uid
@@ -1194,7 +1238,7 @@ async function deletePremint({
   return makePremintReturn({
     premintConfig: deletedPremint,
     premintConfigVersion,
-    collectionAddress: collection,
+    collectionAddress,
     collection: collectionCreationConfig,
     publicClient,
     apiClient,
@@ -1206,6 +1250,7 @@ async function makeMintParameters({
   tokenContract,
   minterAccount,
   mintArguments,
+  firstMinter,
   apiClient,
   publicClient
 }) {
@@ -1215,7 +1260,13 @@ async function makeMintParameters({
   if (!minterAccount) {
     throw new Error("Wallet not passed in");
   }
-  const { premintConfig, premintConfigVersion, collection, signature } = await apiClient.getSignature({
+  const {
+    premintConfig,
+    premintConfigVersion,
+    collection,
+    collectionAddress,
+    signature
+  } = await apiClient.getSignature({
     collectionAddress: tokenContract,
     uid
   });
@@ -1236,38 +1287,29 @@ async function makeMintParameters({
       mintReferral: mintArguments?.mintReferral
     })
   };
-  if (premintConfigVersion === PremintConfigVersion2.V1) {
-    return makeSimulateContractParamaters({
-      account: minterAccount,
-      abi: zoraCreator1155PremintExecutorImplABI2,
-      functionName: "premintV1",
-      value,
-      address: getPremintExecutorAddress(),
-      args: [
-        collection,
-        premintConfig,
-        signature,
-        numberToMint,
-        mintArgumentsContract
-      ]
-    });
-  } else if (premintConfigVersion === PremintConfigVersion2.V2) {
-    return makeSimulateContractParamaters({
-      account: minterAccount,
-      abi: zoraCreator1155PremintExecutorImplABI2,
-      functionName: "premintV2",
-      value,
-      address: getPremintExecutorAddress(),
-      args: [
-        collection,
+  const collectionOrEmpty = collection ? defaultAdditionalAdmins(collection) : emptyContractCreationConfig();
+  const collectionAddressToSubmit = collection ? zeroAddress2 : collectionAddress;
+  const firstMinterToSubmit = firstMinter || (typeof minterAccount === "string" ? minterAccount : minterAccount.address);
+  return makeSimulateContractParamaters({
+    account: minterAccount,
+    abi: zoraCreator1155PremintExecutorImplABI2,
+    functionName: "premint",
+    value,
+    address: getPremintExecutorAddress(),
+    args: [
+      collectionOrEmpty,
+      collectionAddressToSubmit,
+      encodePremintConfig({
         premintConfig,
-        signature,
-        numberToMint,
-        mintArgumentsContract
-      ]
-    });
-  }
-  throw new Error(`Invalid premint config version ${premintConfigVersion}`);
+        premintConfigVersion
+      }),
+      signature,
+      numberToMint,
+      mintArgumentsContract,
+      firstMinterToSubmit,
+      zeroAddress2
+    ]
+  });
 }
 function makeUrls({
   uid,
@@ -1288,7 +1330,9 @@ function makeUrls({
 }
 
 // src/premint/contract-types.ts
-import { PremintConfigVersion as PremintConfigVersionOrig } from "@zoralabs/protocol-deployments";
+import {
+  PremintConfigVersion as PremintConfigVersionOrig
+} from "@zoralabs/protocol-deployments";
 var PremintConfigVersion3 = ((PremintConfigVersion4) => {
   PremintConfigVersion4[PremintConfigVersion4["V1"] = PremintConfigVersionOrig.V1] = "V1";
   PremintConfigVersion4[PremintConfigVersion4["V2"] = PremintConfigVersionOrig.V2] = "V2";
@@ -2064,8 +2108,10 @@ export {
   createMintClient,
   createPremintClient,
   decodeCallFailedError,
+  defaultAdditionalAdmins,
   defaultTokenConfigV1MintArguments,
   defaultTokenConfigV2MintArguments,
+  emptyContractCreationConfig,
   encodeCollectOnManager,
   encodePostSignatureInput,
   encodePremintForAPI,
@@ -2098,6 +2144,7 @@ export {
   sumBalances,
   supportedPremintVersions,
   supportsPremintVersion,
+  toContractCreationConfigOrAddress,
   tryRecoverPremintSigner,
   unwrapAndForwardEthPermitAndTypedDataDefinition
 };