@zoralabs/protocol-sdk 0.5.3-mints.0 → 0.5.4-MINT.0

package/.turbo/turbo-build.log

@@ -1,4 +1,3 @@
-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.build.json
@@ -8,9 +7,9 @@ $ tsup
 CLI Cleaning output folder
 CJS Build start
 ESM Build start
-CJS dist/index.cjs     49.78 KB
-CJS dist/index.cjs.map 96.89 KB
-CJS ⚡️ Build success in 65ms
-ESM dist/index.js     46.16 KB
-ESM dist/index.js.map 96.98 KB
-ESM ⚡️ Build success in 66ms
+ESM dist/index.js     48.29 KB
+ESM dist/index.js.map 101.92 KB
+ESM ⚡️ Build success in 118ms
+CJS dist/index.cjs     52.47 KB
+CJS dist/index.cjs.map 101.90 KB
+CJS ⚡️ Build success in 119ms

package/CHANGELOG.md

@@ -1,10 +1,19 @@
 # @zoralabs/protocol-sdk
 
-## 0.5.3-mints.0
+## 0.5.4-MINT.0
 
 ### Patch Changes
 
-- @zoralabs/1155-deployments@0.0.14-mints.0
+- b07a4729: Added functionality to be able to query for MINTs to use when collecting from an account
+- Updated dependencies [a4d2d3d2]
+- Updated dependencies [3401be26]
+  - @zoralabs/protocol-deployments@0.1.1-MINT.0
+
+## 0.5.3
+
+### Patch Changes
+
+- a07499d: Allows an `Account` object to be passed for `signTypedData` compatiblity with Local Accounts
 
 ## 0.5.2
 

package/dist/apis/chain-constants.d.ts

@@ -9,5 +9,6 @@ export type NetworkConfig = {
 };
 export declare const REWARD_PER_TOKEN: bigint;
 export declare const networkConfigByChain: Record<number, NetworkConfig>;
+export declare const getSubgraphUrl: (chainId: number) => string;
 export {};
 //# sourceMappingURL=chain-constants.d.ts.map

package/dist/apis/chain-constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chain-constants.d.ts","sourceRoot":"","sources":["../../src/apis/chain-constants.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAIhE,KAAK,gBAAgB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC;AAE3D,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,wBAAwB,EAAE,MAAM,CAAC;IACjC,oBAAoB,EAAE,gBAAgB,CAAC;IACvC,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,eAAO,MAAM,gBAAgB,QAAyB,CAAC;AAEvD,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAuE9D,CAAC"}
+{"version":3,"file":"chain-constants.d.ts","sourceRoot":"","sources":["../../src/apis/chain-constants.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAIhE,KAAK,gBAAgB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC;AAE3D,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,wBAAwB,EAAE,MAAM,CAAC;IACjC,oBAAoB,EAAE,gBAAgB,CAAC;IACvC,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,eAAO,MAAM,gBAAgB,QAAyB,CAAC;AAEvD,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAuE9D,CAAC;AAEF,eAAO,MAAM,cAAc,YAAa,MAAM,KAAG,MAQhD,CAAC"}

package/dist/index.cjs

@@ -41,7 +41,9 @@ __export(src_exports, {
   encodePremintForAPI: () => encodePremintForAPI,
   getApiNetworkConfigForChain: () => getApiNetworkConfigForChain,
   getDefaultFixedPriceMinterAddress: () => getDefaultFixedPriceMinterAddress,
+  getMINTsToCollectWith: () => getMINTsToCollectWith,
   getMintCosts: () => getMintCosts,
+  getMintsAccountBalanceQuery: () => getMintsAccountBalanceQuery,
   getPremintCollectionAddress: () => getPremintCollectionAddress,
   getPremintExecutorAddress: () => getPremintExecutorAddress,
   getPremintMintCosts: () => getPremintMintCosts,
@@ -57,6 +59,7 @@ __export(src_exports, {
   premintTypedDataDefinition: () => premintTypedDataDefinition,
   recoverCreatorFromCreatorAttribution: () => recoverCreatorFromCreatorAttribution,
   recoverPremintSigner: () => recoverPremintSigner,
+  selectMintsToCollectWithFromQueryResult: () => selectMintsToCollectWithFromQueryResult,
   supportedPremintVersions: () => supportedPremintVersions,
   supportsPremintVersion: () => supportsPremintVersion,
   tryRecoverPremintSigner: () => tryRecoverPremintSigner,
@@ -67,10 +70,10 @@ module.exports = __toCommonJS(src_exports);
 
 // src/premint/premint-client.ts
 var import_viem4 = require("viem");
-var import_deployments2 = require("@zoralabs/1155-deployments");
+var import_protocol_deployments2 = require("@zoralabs/protocol-deployments");
 
 // src/premint/preminter.ts
-var import_deployments = require("@zoralabs/1155-deployments");
+var import_protocol_deployments = require("@zoralabs/protocol-deployments");
 var import_viem = require("viem");
 
 // src/premint/contract-types.ts
@@ -130,7 +133,7 @@ var PremintConfigVersion = /* @__PURE__ */ ((PremintConfigVersion2) => {
 })(PremintConfigVersion || {});
 
 // src/premint/preminter.ts
-var getPremintExecutorAddress = () => import_deployments.zoraCreator1155PremintExecutorImplAddress[999];
+var getPremintExecutorAddress = () => import_protocol_deployments.zoraCreator1155PremintExecutorImplAddress[999];
 var premintTypedDataDefinition = ({
   verifyingContract,
   chainId,
@@ -167,7 +170,7 @@ async function isAuthorizedToCreatePremint({
   signer
 }) {
   return await publicClient.readContract({
-    abi: import_deployments.zoraCreator1155PremintExecutorImplABI,
+    abi: import_protocol_deployments.zoraCreator1155PremintExecutorImplABI,
     address: getPremintExecutorAddress(),
     functionName: "isAuthorizedToCreatePremint",
     args: [signer, collection.contractAdmin, collectionAddress]
@@ -283,7 +286,7 @@ var supportedPremintVersions = async ({
   publicClient
 }) => {
   return await publicClient.readContract({
-    abi: import_deployments.zoraCreator1155PremintExecutorImplABI,
+    abi: import_protocol_deployments.zoraCreator1155PremintExecutorImplABI,
     address: getPremintExecutorAddress(),
     functionName: "supportedPremintSignatureVersions",
     args: [tokenContract]
@@ -302,7 +305,7 @@ async function getPremintCollectionAddress({
 }) {
   return publicClient.readContract({
     address: getPremintExecutorAddress(),
-    abi: import_deployments.zoraCreator1155PremintExecutorImplABI,
+    abi: import_protocol_deployments.zoraCreator1155PremintExecutorImplABI,
     functionName: "getContractAddress",
     args: [collection]
   });
@@ -350,7 +353,7 @@ async function getPremintMintFee({
   try {
     return await publicClient.readContract({
       address: getPremintExecutorAddress(),
-      abi: import_deployments.zoraCreator1155PremintExecutorImplABI,
+      abi: import_protocol_deployments.zoraCreator1155PremintExecutorImplABI,
       functionName: "mintFee",
       args: [tokenContract]
     });
@@ -379,7 +382,7 @@ function makeMintRewardsRecipient({
   return [mintReferral, platformReferral];
 }
 function getDefaultFixedPriceMinterAddress(chainId) {
-  return import_deployments.zoraCreatorFixedPriceSaleStrategyAddress[chainId];
+  return import_protocol_deployments.zoraCreatorFixedPriceSaleStrategyAddress[chainId];
 }
 
 // src/apis/http-api-base.ts
@@ -545,6 +548,13 @@ var networkConfigByChain = {
     subgraphUrl: getSubgraph("zora-create-zora-testnet", "stable")
   }
 };
+var getSubgraphUrl = (chainId) => {
+  const networkConfig = networkConfigByChain[chainId];
+  if (!networkConfig) {
+    throw new Error(`Network not configured for chain id ${chainId}`);
+  }
+  return networkConfig.subgraphUrl;
+};
 
 // src/mint/mint-api-client.ts
 var getApiNetworkConfigForChain = (chainId) => {
@@ -851,7 +861,7 @@ function getPremintedLogFromReceipt(receipt) {
   for (const data of receipt.logs) {
     try {
       const decodedLog = (0, import_viem4.decodeEventLog)({
-        abi: import_deployments2.zoraCreator1155PremintExecutorImplABI,
+        abi: import_protocol_deployments2.zoraCreator1155PremintExecutorImplABI,
         eventName: "PremintedV2",
         ...data
       });
@@ -1029,7 +1039,7 @@ var PremintClient = class {
       tokenConfig: makeTokenConfigWithDefaults({
         premintConfigVersion: actualVersion,
         tokenCreationConfig,
-        creatorAccount,
+        creatorAccount: typeof creatorAccount === "string" ? creatorAccount : creatorAccount.address,
         chainId: this.chain.id
       }),
       uid: uidToUse
@@ -1163,7 +1173,7 @@ var PremintClient = class {
     if (premintConfigVersion === "1" /* V1 */) {
       return {
         account: minterAccount,
-        abi: import_deployments2.zoraCreator1155PremintExecutorImplABI,
+        abi: import_protocol_deployments2.zoraCreator1155PremintExecutorImplABI,
         functionName: "premintV1",
         value,
         address: getPremintExecutorAddress(),
@@ -1178,7 +1188,7 @@ var PremintClient = class {
     } else if (premintConfigVersion === "2" /* V2 */) {
       return {
         account: minterAccount,
-        abi: import_deployments2.zoraCreator1155PremintExecutorImplABI,
+        abi: import_protocol_deployments2.zoraCreator1155PremintExecutorImplABI,
         functionName: "premintV2",
         value,
         address: getPremintExecutorAddress(),
@@ -1267,7 +1277,7 @@ async function signAndSubmitPremint({
 
 // src/mint/mint-client.ts
 var import_viem5 = require("viem");
-var import_deployments3 = require("@zoralabs/1155-deployments");
+var import_protocol_deployments3 = require("@zoralabs/protocol-deployments");
 var MintError = class extends Error {
 };
 var MintInactiveError = class extends Error {
@@ -1380,14 +1390,14 @@ async function makePrepareMint1155TokenParams({
     quantityToMint: mintQuantity
   }).totalCost;
   const result = {
-    abi: import_deployments3.zoraCreator1155ImplABI,
+    abi: import_protocol_deployments3.zoraCreator1155ImplABI,
     functionName: "mintWithRewards",
     account: minterAccount,
     value: mintValue,
     address: tokenAddress,
     /* args: minter, tokenId, quantity, minterArguments, mintReferral */
     args: [
-      salesConfigAndTokenInfo?.fixedPrice.address || import_deployments3.zoraCreatorFixedPriceSaleStrategyAddress[999],
+      salesConfigAndTokenInfo?.fixedPrice.address || import_protocol_deployments3.zoraCreatorFixedPriceSaleStrategyAddress[999],
       BigInt(tokenId),
       mintQuantity,
       (0, import_viem5.encodeAbiParameters)((0, import_viem5.parseAbiParameters)("address, string"), [
@@ -1401,7 +1411,7 @@ async function makePrepareMint1155TokenParams({
 }
 
 // src/create/1155-create-helper.ts
-var import_deployments4 = require("@zoralabs/1155-deployments");
+var import_protocol_deployments4 = require("@zoralabs/protocol-deployments");
 var import_viem6 = require("viem");
 var SALE_END_FOREVER = 18446744073709551615n;
 var ROYALTY_BPS_DEFAULT = 1e3;
@@ -1446,32 +1456,32 @@ function create1155TokenSetupArgs({
   };
   const setupActions = [
     (0, import_viem6.encodeFunctionData)({
-      abi: import_deployments4.zoraCreator1155ImplABI,
+      abi: import_protocol_deployments4.zoraCreator1155ImplABI,
       functionName: "assumeLastTokenIdMatches",
       args: [nextTokenId - 1n]
     }),
     createReferral ? (0, import_viem6.encodeFunctionData)({
-      abi: import_deployments4.zoraCreator1155ImplABI,
+      abi: import_protocol_deployments4.zoraCreator1155ImplABI,
       functionName: "setupNewTokenWithCreateReferral",
       args: [tokenMetadataURI, maxSupply, createReferral]
     }) : (0, import_viem6.encodeFunctionData)({
-      abi: import_deployments4.zoraCreator1155ImplABI,
+      abi: import_protocol_deployments4.zoraCreator1155ImplABI,
       functionName: "setupNewToken",
       args: [tokenMetadataURI, maxSupply]
     }),
     (0, import_viem6.encodeFunctionData)({
-      abi: import_deployments4.zoraCreator1155ImplABI,
+      abi: import_protocol_deployments4.zoraCreator1155ImplABI,
       functionName: "addPermission",
       args: [0n, fixedPriceMinterAddress, PERMISSION_BIT_MINTER]
     }),
     (0, import_viem6.encodeFunctionData)({
-      abi: import_deployments4.zoraCreator1155ImplABI,
+      abi: import_protocol_deployments4.zoraCreator1155ImplABI,
       functionName: "callSale",
       args: [
         nextTokenId,
         fixedPriceMinterAddress,
         (0, import_viem6.encodeFunctionData)({
-          abi: import_deployments4.zoraCreatorFixedPriceSaleStrategyABI,
+          abi: import_protocol_deployments4.zoraCreatorFixedPriceSaleStrategyABI,
           functionName: "setSale",
           args: [nextTokenId, salesConfigWithDefaults]
         })
@@ -1481,7 +1491,7 @@ function create1155TokenSetupArgs({
   if (mintToCreatorCount) {
     setupActions.push(
       (0, import_viem6.encodeFunctionData)({
-        abi: import_deployments4.zoraCreator1155ImplABI,
+        abi: import_protocol_deployments4.zoraCreator1155ImplABI,
         functionName: "adminMint",
         args: [account, nextTokenId, mintToCreatorCount, "0x"]
       })
@@ -1490,7 +1500,7 @@ function create1155TokenSetupArgs({
   if (royaltySettings) {
     setupActions.push(
       (0, import_viem6.encodeFunctionData)({
-        abi: import_deployments4.zoraCreator1155ImplABI,
+        abi: import_protocol_deployments4.zoraCreator1155ImplABI,
         functionName: "updateRoyaltiesForToken",
         args: [
           nextTokenId,
@@ -1509,7 +1519,7 @@ var getTokenIdFromCreateReceipt = (receipt) => {
   for (const data of receipt.logs) {
     try {
       const decodedLog = (0, import_viem6.decodeEventLog)({
-        abi: import_deployments4.zoraCreator1155ImplABI,
+        abi: import_protocol_deployments4.zoraCreator1155ImplABI,
         eventName: "SetupNewToken",
         ...data
       });
@@ -1525,9 +1535,9 @@ async function getContractExists(publicClient, contract, account) {
   let contractExists = false;
   if (typeof contract !== "string") {
     contractAddress = await publicClient.readContract({
-      abi: import_deployments4.zoraCreator1155FactoryImplABI,
+      abi: import_protocol_deployments4.zoraCreator1155FactoryImplABI,
       // Since this address is deterministic we can hardcode a chain id safely here.
-      address: import_deployments4.zoraCreator1155FactoryImplAddress[999],
+      address: import_protocol_deployments4.zoraCreator1155FactoryImplAddress[999],
       functionName: "deterministicContractAddress",
       args: [
         account,
@@ -1538,7 +1548,7 @@ async function getContractExists(publicClient, contract, account) {
     });
     try {
       await publicClient.readContract({
-        abi: import_deployments4.zoraCreator1155ImplABI,
+        abi: import_protocol_deployments4.zoraCreator1155ImplABI,
         address: contractAddress,
         functionName: "contractVersion"
       });
@@ -1573,14 +1583,14 @@ function create1155CreatorClient({
     let nextTokenId = 1n;
     if (contractExists) {
       nextTokenId = await publicClient.readContract({
-        abi: import_deployments4.zoraCreator1155ImplABI,
+        abi: import_protocol_deployments4.zoraCreator1155ImplABI,
         functionName: "nextTokenId",
         address: contractAddress
       });
     }
     const fixedPriceMinterAddress = await publicClient.readContract({
-      abi: import_deployments4.zoraCreator1155FactoryImplABI,
-      address: import_deployments4.zoraCreator1155FactoryImplAddress[999],
+      abi: import_protocol_deployments4.zoraCreator1155FactoryImplABI,
+      address: import_protocol_deployments4.zoraCreator1155FactoryImplAddress[999],
       functionName: "fixedPriceMinter"
     });
     let tokenSetupActions = create1155TokenSetupArgs({
@@ -1603,11 +1613,11 @@ function create1155CreatorClient({
       throw new Error("Invariant: contract cannot be missing and an address");
     }
     if (!contractExists && typeof contract !== "string") {
-      const request = {
-        abi: import_deployments4.zoraCreator1155FactoryImplABI,
+      const request2 = {
+        abi: import_protocol_deployments4.zoraCreator1155FactoryImplABI,
         functionName: "createContractDeterministic",
         account,
-        address: import_deployments4.zoraCreator1155FactoryImplAddress[999],
+        address: import_protocol_deployments4.zoraCreator1155FactoryImplAddress[999],
         args: [
           contract.uri,
           contract.name,
@@ -1622,21 +1632,21 @@ function create1155CreatorClient({
         ]
       };
       return {
-        request,
+        request: request2,
         tokenSetupActions,
         contractAddress,
         contractExists
       };
     } else if (contractExists) {
-      const request = {
-        abi: import_deployments4.zoraCreator1155ImplABI,
+      const request2 = {
+        abi: import_protocol_deployments4.zoraCreator1155ImplABI,
         functionName: "multicall",
         account,
         address: contractAddress,
         args: [tokenSetupActions]
       };
       return {
-        request,
+        request: request2,
         tokenSetupActions,
         contractAddress,
         contractExists
@@ -1646,6 +1656,75 @@ function create1155CreatorClient({
   }
   return { createNew1155Token };
 }
+
+// src/mints/mints-queries.ts
+var import_graphql_request = require("graphql-request");
+var getMintsAccountBalanceQuery = (account) => {
+  const query = import_graphql_request.gql`
+    query GetMintAccountBalances($account: String!) {
+      mintTokenBalances(where: { account: $account }) {
+        balance
+        mintToken {
+          id
+          pricePerToken
+        }
+      }
+    }
+  `;
+  return {
+    query,
+    variables: { account }
+  };
+};
+var selectMintsToCollectWithFromQueryResult = (mintAccountBalances, quantityToCollect) => {
+  const parsed = mintAccountBalances.map((r) => {
+    return {
+      tokenId: BigInt(r.mintToken.id),
+      quantity: BigInt(r.balance),
+      pricePerToken: BigInt(r.mintToken.pricePerToken)
+    };
+  });
+  const sorted = parsed.sort((a, b) => {
+    if (a.pricePerToken < b.pricePerToken) {
+      return -1;
+    }
+    return 1;
+  });
+  let remainingQuantity = quantityToCollect;
+  const tokenIds = [];
+  const quantities = [];
+  while (remainingQuantity > 0) {
+    const next = sorted.shift();
+    if (!next) {
+      throw new Error("Not enough MINTs to collect with");
+    }
+    const quantityToUse = remainingQuantity > next.quantity ? next.quantity : remainingQuantity;
+    tokenIds.push(next.tokenId);
+    quantities.push(quantityToUse);
+    remainingQuantity -= quantityToUse;
+  }
+  return {
+    tokenIds,
+    quantities
+  };
+};
+var getMINTsToCollectWith = async ({
+  account,
+  chainId,
+  quantityToCollect
+}) => {
+  const subgraphUrl = getSubgraphUrl(chainId);
+  const { query, variables } = getMintsAccountBalanceQuery(account);
+  const result = await (0, import_graphql_request.request)(
+    subgraphUrl,
+    query,
+    variables
+  );
+  return selectMintsToCollectWithFromQueryResult(
+    result.mintTokenBalances,
+    quantityToCollect
+  );
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   DEFAULT_SALE_SETTINGS,
@@ -1669,7 +1748,9 @@ function create1155CreatorClient({
   encodePremintForAPI,
   getApiNetworkConfigForChain,
   getDefaultFixedPriceMinterAddress,
+  getMINTsToCollectWith,
   getMintCosts,
+  getMintsAccountBalanceQuery,
   getPremintCollectionAddress,
   getPremintExecutorAddress,
   getPremintMintCosts,
@@ -1685,6 +1766,7 @@ function create1155CreatorClient({
   premintTypedDataDefinition,
   recoverCreatorFromCreatorAttribution,
   recoverPremintSigner,
+  selectMintsToCollectWithFromQueryResult,
   supportedPremintVersions,
   supportsPremintVersion,
   tryRecoverPremintSigner,