@zoralabs/protocol-sdk 0.4.2 → 0.5.0

package/.turbo/turbo-build.log

@@ -1,15 +1,16 @@
+warning package.json: "dependencies" has dependency "vite" with range "4.5.0" that collides with a dependency in "devDependencies" of the same name with version "^4.5.0"
 $ tsup
 CLI Building entry: src/index.ts
 CLI Using tsconfig: tsconfig.json
-CLI tsup v7.2.0
+CLI tsup v7.3.0
 CLI Using tsup config: /home/runner/work/zora-protocol-private/zora-protocol-private/packages/protocol-sdk/tsup.config.js
 CLI Target: es2021
 CLI Cleaning output folder
 CJS Build start
 ESM Build start
-CJS dist/index.cjs     50.18 KB
-CJS dist/index.cjs.map 97.76 KB
-CJS ⚡️ Build success in 38ms
-ESM dist/index.js     46.61 KB
-ESM dist/index.js.map 97.90 KB
-ESM ⚡️ Build success in 42ms
+CJS dist/index.cjs     50.09 KB
+CJS dist/index.cjs.map 96.94 KB
+CJS ⚡️ Build success in 85ms
+ESM dist/index.js     46.17 KB
+ESM dist/index.js.map 97.00 KB
+ESM ⚡️ Build success in 85ms

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @zoralabs/protocol-sdk
 
+## 0.5.0
+
+### Minor Changes
+
+- a52d245: Fix premint v2 support in premint client and add support for sepolia to SDK:
+
+  - Fix chain constants config for Zora Goerli.
+  - Support Zora-Sepolia for premint client.
+  - Fix passing of `config_version` to and from the backend API.
+  - Change parameter on `makeMintParameters` from `account` to `minterAccount`.
+  - Fix price minter address for premint client by chain, since it is not the same on all chains (yet).
+
+### Patch Changes
+
+- Updated dependencies [3af77cf]
+- Updated dependencies [23dba1c]
+  - @zoralabs/protocol-deployments@0.0.12
+
+## 0.4.3
+
+### Patch Changes
+
+- 92b1b0e: Export premint conversions
+
 ## 0.4.2
 
 ### Patch Changes

package/README.md

@@ -300,7 +300,7 @@ async function mintCreatedForFreeToken(walletClient: WalletClient, publicClient:
   const premintClient = createPremintClient({chain: walletClient.chain!});
 
   const simulateContractParameters = await premintClient.makeMintParameters({
-    account: minterAccount,
+    minterAccount,
     tokenContract: "0xf8dA7f53c283d898818af7FB9d98103F559bDac2",
     uid: 3,
     mintArguments: {

package/dist/index.cjs

@@ -28,13 +28,19 @@ __export(src_exports, {
   PreminterDomain: () => PreminterDomain,
   ZORA_API_BASE: () => ZORA_API_BASE,
   applyUpdateToPremint: () => applyUpdateToPremint,
+  convertCollectionFromApi: () => convertCollectionFromApi,
+  convertGetPremintApiResponse: () => convertGetPremintApiResponse,
+  convertPremintFromApi: () => convertPremintFromApi,
   create1155CreatorClient: () => create1155CreatorClient,
   create1155TokenSetupArgs: () => create1155TokenSetupArgs,
   createMintClient: () => createMintClient,
   createPremintClient: () => createPremintClient,
   defaultTokenConfigV1MintArguments: () => defaultTokenConfigV1MintArguments,
   defaultTokenConfigV2MintArguments: () => defaultTokenConfigV2MintArguments,
+  encodePostSignatureInput: () => encodePostSignatureInput,
+  encodePremintForAPI: () => encodePremintForAPI,
   getApiNetworkConfigForChain: () => getApiNetworkConfigForChain,
+  getDefaultFixedPriceMinterAddress: () => getDefaultFixedPriceMinterAddress,
   getMintCosts: () => getMintCosts,
   getPremintCollectionAddress: () => getPremintCollectionAddress,
   getPremintExecutorAddress: () => getPremintExecutorAddress,
@@ -158,20 +164,8 @@ async function isAuthorizedToCreatePremint({
   collection,
   collectionAddress,
   publicClient,
-  premintConfig,
-  premintConfigVersion,
-  signature,
   signer
 }) {
-  if (premintConfigVersion === "1" /* V1 */) {
-    const [isValidSignature2] = await publicClient.readContract({
-      abi: import_protocol_deployments.zoraCreator1155PremintExecutorImplABI,
-      address: getPremintExecutorAddress(),
-      functionName: "isValidSignature",
-      args: [collection, premintConfig, signature]
-    });
-    return isValidSignature2;
-  }
   return await publicClient.readContract({
     abi: import_protocol_deployments.zoraCreator1155PremintExecutorImplABI,
     address: getPremintExecutorAddress(),
@@ -223,9 +217,7 @@ async function isValidSignature({
     signer: recoveredAddress,
     collection,
     collectionAddress: tokenContract,
-    publicClient,
-    signature,
-    ...premintConfigAndVersion
+    publicClient
   });
   return {
     isAuthorized,
@@ -386,6 +378,9 @@ function makeMintRewardsRecipient({
 }) {
   return [mintReferral, platformReferral];
 }
+function getDefaultFixedPriceMinterAddress(chainId) {
+  return import_protocol_deployments.zoraCreatorFixedPriceSaleStrategyAddress[chainId];
+}
 
 // src/apis/http-api-base.ts
 var BadResponseError = class extends Error {
@@ -478,78 +473,75 @@ var zora721Abi = (0, import_viem2.parseAbi)([
 var import_chains = require("viem/chains");
 var import_viem3 = require("viem");
 var REWARD_PER_TOKEN = (0, import_viem3.parseEther)("0.000777");
-var BackendChainNamesLookup = {
-  ZORA_MAINNET: "ZORA-MAINNET",
-  ZORA_GOERLI: "ZORA-GOERLI",
-  OPTIMISM_MAINNET: "OPTIMISM-MAINNET",
-  OPTIMISM_GOERLI: "OPTIMISM-GOERLI",
-  ETHEREUM_MAINNET: "ETHEREUM-MAINNET",
-  ETHEREUM_GOERLI: "ETHEREUM-GOERLI",
-  BASE_MAINNET: "BASE-MAINNET",
-  BASE_GOERLI: "BASE-GOERLI"
-};
 var networkConfigByChain = {
   [import_chains.mainnet.id]: {
     chainId: import_chains.mainnet.id,
     isTestnet: false,
-    zoraPathChainName: "eth",
-    zoraBackendChainName: BackendChainNamesLookup.ETHEREUM_MAINNET,
+    zoraCollectPathChainName: "eth",
+    zoraBackendChainName: "ETHEREUM-MAINNET",
     subgraphUrl: getSubgraph("zora-create-mainnet", "stable")
   },
   [import_chains.goerli.id]: {
     chainId: import_chains.goerli.id,
     isTestnet: true,
-    zoraPathChainName: "gor",
-    zoraBackendChainName: BackendChainNamesLookup.ETHEREUM_GOERLI,
+    zoraCollectPathChainName: "gor",
+    zoraBackendChainName: "ETHEREUM-GOERLI",
     subgraphUrl: getSubgraph("zora-create-goerli", "stable")
   },
   [import_chains.zora.id]: {
     chainId: import_chains.zora.id,
     isTestnet: false,
-    zoraPathChainName: "zora",
-    zoraBackendChainName: BackendChainNamesLookup.ZORA_MAINNET,
+    zoraCollectPathChainName: "zora",
+    zoraBackendChainName: "ZORA-MAINNET",
     subgraphUrl: getSubgraph("zora-create-zora-mainnet", "stable")
   },
   [import_chains.zoraTestnet.id]: {
-    chainId: import_chains.zora.id,
+    chainId: import_chains.zoraTestnet.id,
     isTestnet: true,
-    zoraPathChainName: "zgor",
-    zoraBackendChainName: BackendChainNamesLookup.ZORA_GOERLI,
+    zoraCollectPathChainName: "zgor",
+    zoraBackendChainName: "ZORA-GOERLI",
     subgraphUrl: getSubgraph("zora-create-zora-testnet", "stable")
   },
+  [import_chains.zoraSepolia.id]: {
+    chainId: import_chains.zoraSepolia.id,
+    isTestnet: true,
+    zoraCollectPathChainName: "zsep",
+    zoraBackendChainName: "ZORA-SEPOLIA",
+    subgraphUrl: getSubgraph("zora-create-zora-sepolia", "stable")
+  },
   [import_chains.optimism.id]: {
     chainId: import_chains.optimism.id,
     isTestnet: false,
-    zoraPathChainName: "opt",
-    zoraBackendChainName: BackendChainNamesLookup.OPTIMISM_MAINNET,
+    zoraCollectPathChainName: "opt",
+    zoraBackendChainName: "OPTIMISM-MAINNET",
     subgraphUrl: getSubgraph("zora-create-optimism", "stable")
   },
   [import_chains.optimismGoerli.id]: {
     chainId: import_chains.optimismGoerli.id,
     isTestnet: true,
-    zoraPathChainName: "ogor",
-    zoraBackendChainName: BackendChainNamesLookup.OPTIMISM_GOERLI,
+    zoraCollectPathChainName: "ogor",
+    zoraBackendChainName: "OPTIMISM-GOERLI",
     subgraphUrl: getSubgraph("zora-create-optimism-goerli", "stable")
   },
   [import_chains.base.id]: {
     chainId: import_chains.base.id,
     isTestnet: false,
-    zoraPathChainName: "base",
-    zoraBackendChainName: BackendChainNamesLookup.BASE_MAINNET,
+    zoraCollectPathChainName: "base",
+    zoraBackendChainName: "BASE-MAINNET",
     subgraphUrl: getSubgraph("zora-create-base-mainnet", "stable")
   },
   [import_chains.baseGoerli.id]: {
     chainId: import_chains.baseGoerli.id,
     isTestnet: true,
-    zoraPathChainName: "bgor",
-    zoraBackendChainName: BackendChainNamesLookup.BASE_GOERLI,
+    zoraCollectPathChainName: "bgor",
+    zoraBackendChainName: "BASE-GOERLI",
     subgraphUrl: getSubgraph("zora-create-base-goerli", "stable")
   },
   [import_chains.foundry.id]: {
     chainId: import_chains.foundry.id,
     isTestnet: true,
-    zoraPathChainName: "zgor",
-    zoraBackendChainName: BackendChainNamesLookup.ZORA_GOERLI,
+    zoraCollectPathChainName: "zgor",
+    zoraBackendChainName: "ZORA-GOERLI",
     subgraphUrl: getSubgraph("zora-create-zora-testnet", "stable")
   }
 };
@@ -637,7 +629,9 @@ var convertPremintFromApi = (premint) => {
     return {
       premintConfigVersion: "1" /* V1 */,
       premintConfig: {
-        ...premint,
+        deleted: premint.deleted,
+        uid: premint.uid,
+        version: premint.version,
         tokenConfig: {
           ...tokenConfig,
           fixedPriceMinter: tokenConfig.fixedPriceMinter,
@@ -655,7 +649,9 @@ var convertPremintFromApi = (premint) => {
     return {
       premintConfigVersion: "2" /* V2 */,
       premintConfig: {
-        ...premint,
+        deleted: premint.deleted,
+        uid: premint.uid,
+        version: premint.version,
         tokenConfig: {
           ...tokenConfig,
           fixedPriceMinter: tokenConfig.fixedPriceMinter,
@@ -681,6 +677,7 @@ var encodePremintV1ForAPI = ({
   ...premint
 }) => ({
   ...premint,
+  config_version: "1",
   tokenConfig: {
     ...tokenConfig,
     maxSupply: tokenConfig.maxSupply.toString(),
@@ -695,6 +692,7 @@ var encodePremintV2ForAPI = ({
   ...premint
 }) => ({
   ...premint,
+  config_version: "2",
   tokenConfig: {
     ...tokenConfig,
     maxSupply: tokenConfig.maxSupply.toString(),
@@ -824,11 +822,12 @@ var defaultTokenConfigV2MintArguments = () => ({
   // 10%,
 });
 var makeTokenConfigWithDefaults = ({
+  chainId,
   premintConfigVersion,
   tokenCreationConfig,
   creatorAccount
 }) => {
-  const fixedPriceMinter = tokenCreationConfig.fixedPriceMinter || getDefaultFixedPriceMinterAddress();
+  const fixedPriceMinter = tokenCreationConfig.fixedPriceMinter || getDefaultFixedPriceMinterAddress(chainId);
   if (premintConfigVersion === "1" /* V1 */) {
     return {
       fixedPriceMinter,
@@ -1030,7 +1029,8 @@ var PremintClient = class {
       tokenConfig: makeTokenConfigWithDefaults({
         premintConfigVersion: actualVersion,
         tokenCreationConfig,
-        creatorAccount
+        creatorAccount,
+        chainId: this.chain.id
       }),
       uid: uidToUse
     });
@@ -1108,13 +1108,13 @@ var PremintClient = class {
   async getMintCosts({
     tokenContract,
     quantityToMint,
-    tokenCreationConfig
+    pricePerToken
   }) {
     return await getPremintMintCosts({
       publicClient: this.publicClient,
       quantityToMint,
       tokenContract,
-      tokenPrice: tokenCreationConfig.pricePerToken
+      tokenPrice: pricePerToken
     });
   }
   /**
@@ -1132,13 +1132,13 @@ var PremintClient = class {
   async makeMintParameters({
     uid,
     tokenContract,
-    account,
+    minterAccount,
     mintArguments
   }) {
     if (mintArguments && mintArguments?.quantityToMint < 1) {
       throw new Error("Quantity to mint cannot be below 1");
     }
-    if (!account) {
+    if (!minterAccount) {
       throw new Error("Wallet not passed in");
     }
     const { premintConfig, premintConfigVersion, collection, signature } = await this.getPremintSignature({
@@ -1154,7 +1154,7 @@ var PremintClient = class {
     })).totalCost;
     const mintArgumentsContract = {
       mintComment: mintArguments?.mintComment || "",
-      mintRecipient: mintArguments?.mintRecipient || (typeof account === "string" ? account : account.address),
+      mintRecipient: mintArguments?.mintRecipient || (typeof minterAccount === "string" ? minterAccount : minterAccount.address),
       mintRewardsRecipients: makeMintRewardsRecipient({
         mintReferral: mintArguments?.mintReferral,
         platformReferral: mintArguments?.platformReferral
@@ -1162,7 +1162,7 @@ var PremintClient = class {
     };
     if (premintConfigVersion === "1" /* V1 */) {
       return {
-        account,
+        account: minterAccount,
         abi: import_protocol_deployments2.zoraCreator1155PremintExecutorImplABI,
         functionName: "premintV1",
         value,
@@ -1176,17 +1176,15 @@ var PremintClient = class {
         ]
       };
     } else if (premintConfigVersion === "2" /* V2 */) {
-      const toPost = premintConfig;
       return {
-        account,
+        account: minterAccount,
         abi: import_protocol_deployments2.zoraCreator1155PremintExecutorImplABI,
         functionName: "premintV2",
         value,
         address: getPremintExecutorAddress(),
-        // args are:  ContractCreationConfig calldata contractConfig, PremintConfigV2 calldata premintConfig, bytes calldata signature, uint256 quantityToMint, MintArguments calldata mintArguments
         args: [
           collection,
-          toPost,
+          premintConfig,
           signature,
           numberToMint,
           mintArgumentsContract
@@ -1216,8 +1214,8 @@ function makeUrls({
   const network = getApiNetworkConfigForChain(chain.id);
   return {
     explorer: tokenId ? `https://${chain.blockExplorers?.default.url}/token/${address}/instance/${tokenId}` : null,
-    zoraCollect: `https://${network.isTestnet ? "testnet." : ""}zora.co/collect/${network.zoraPathChainName}:${address}/${zoraTokenPath}`,
-    zoraManage: `https://${network.isTestnet ? "testnet." : ""}zora.co/collect/${network.zoraPathChainName}:${address}/${zoraTokenPath}`
+    zoraCollect: `https://${network.isTestnet ? "testnet." : ""}zora.co/collect/${network.zoraCollectPathChainName}:${address}/${zoraTokenPath}`,
+    zoraManage: `https://${network.isTestnet ? "testnet." : ""}zora.co/collect/${network.zoraCollectPathChainName}:${address}/${zoraTokenPath}`
   };
 }
 async function signAndSubmitPremint({
@@ -1248,14 +1246,12 @@ async function signAndSubmitPremint({
   if (checkSignature) {
     const isAuthorized = await isAuthorizedToCreatePremint({
       collection,
-      signature,
       publicClient,
       signer: typeof account === "string" ? account : account.address,
       collectionAddress: await getPremintCollectionAddress({
         collection,
         publicClient
-      }),
-      ...premintConfigAndVersion
+      })
     });
     if (!isAuthorized) {
       throw new Error("Not authorized to create premint");
@@ -1268,9 +1264,6 @@ async function signAndSubmitPremint({
   });
   return { premint, verifyingContract };
 }
-function getDefaultFixedPriceMinterAddress() {
-  return import_protocol_deployments2.zoraCreatorFixedPriceSaleStrategyAddress[999];
-}
 
 // src/mint/mint-client.ts
 var import_viem5 = require("viem");
@@ -1663,13 +1656,19 @@ function create1155CreatorClient({
   PreminterDomain,
   ZORA_API_BASE,
   applyUpdateToPremint,
+  convertCollectionFromApi,
+  convertGetPremintApiResponse,
+  convertPremintFromApi,
   create1155CreatorClient,
   create1155TokenSetupArgs,
   createMintClient,
   createPremintClient,
   defaultTokenConfigV1MintArguments,
   defaultTokenConfigV2MintArguments,
+  encodePostSignatureInput,
+  encodePremintForAPI,
   getApiNetworkConfigForChain,
+  getDefaultFixedPriceMinterAddress,
   getMintCosts,
   getPremintCollectionAddress,
   getPremintExecutorAddress,