@zoralabs/protocol-sdk 0.5.7-MINT.3 → 0.5.7

package/test-integration/premint-client.test.ts

@@ -0,0 +1,146 @@
+import { zoraSepolia, zoraTestnet } from "viem/chains";
+import { describe } from "vitest";
+
+import { createPremintClient } from "src/premint/premint-client";
+import { forkUrls, makeAnvilTest } from "src/anvil";
+import { PremintConfigVersion } from "src/premint/contract-types";
+
+const zoraGoerliTest = makeAnvilTest({
+  forkBlockNumber: 2107926,
+  forkUrl: forkUrls.zoraGoerli,
+  anvilChainId: zoraTestnet.id,
+});
+
+const zoraSepoliaTest = makeAnvilTest({
+  forkBlockNumber: 3118200,
+  forkUrl: forkUrls.zoraSepolia,
+  anvilChainId: zoraSepolia.id,
+});
+
+const tests = [
+  {
+    anvilTest: zoraGoerliTest,
+    chain: zoraTestnet,
+  },
+  {
+    anvilTest: zoraSepoliaTest,
+    chain: zoraSepolia,
+  },
+];
+
+tests.forEach(({ anvilTest, chain }) => {
+  describe(chain.name, () => {
+    describe("ZoraCreator1155Premint", () => {
+      describe("v2 signatures", () => {
+        anvilTest(
+          "can sign and execute on the forked premint contract",
+          async ({
+            viemClients: { walletClient, publicClient, testClient },
+          }) => {
+            const [creatorAccount, createReferralAccount, minterAccount] =
+              await walletClient.getAddresses();
+            const premintClient = createPremintClient({
+              chain,
+              publicClient,
+            });
+
+            const { uid, verifyingContract } =
+              await premintClient.createPremint({
+                walletClient,
+                creatorAccount: creatorAccount!,
+                checkSignature: true,
+                collection: {
+                  contractAdmin: creatorAccount!,
+                  contractName: "Testing Contract Premint V2",
+                  contractURI:
+                    "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3f",
+                },
+                premintConfigVersion: PremintConfigVersion.V2,
+                tokenCreationConfig: {
+                  tokenURI:
+                    "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2f",
+                  createReferral: createReferralAccount!,
+                },
+              });
+
+            const mintParameters = await premintClient.makeMintParameters({
+              minterAccount: minterAccount!,
+              tokenContract: verifyingContract,
+              uid,
+            });
+
+            const mintCosts = await premintClient.getMintCosts({
+              tokenContract: verifyingContract,
+              quantityToMint: 1n,
+              pricePerToken: 0n,
+            });
+
+            await testClient.setBalance({
+              address: minterAccount!,
+              value: mintCosts.totalCost,
+            });
+
+            // if simulation succeeds, mint will succeed
+            await publicClient.simulateContract(mintParameters);
+          },
+          20 * 1000,
+        );
+      });
+
+      describe("v1 signatures", () => {
+        anvilTest(
+          "can sign and execute on the forked premint contract",
+          async ({
+            viemClients: { walletClient, publicClient, testClient },
+          }) => {
+            const [creatorAccount, minterAccount] =
+              await walletClient.getAddresses();
+            const premintClient = createPremintClient({
+              chain,
+              publicClient,
+            });
+
+            const { uid, verifyingContract } =
+              await premintClient.createPremint({
+                walletClient,
+                creatorAccount: creatorAccount!,
+                checkSignature: true,
+                collection: {
+                  contractAdmin: creatorAccount!,
+                  contractName: `Testing Contract Premint V1 ${publicClient.chain?.name}`,
+                  contractURI:
+                    "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3fg",
+                },
+                premintConfigVersion: PremintConfigVersion.V1,
+                tokenCreationConfig: {
+                  tokenURI:
+                    "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
+                },
+              });
+
+            const mintParameters = await premintClient.makeMintParameters({
+              minterAccount: minterAccount!,
+              tokenContract: verifyingContract,
+              uid,
+            });
+
+            const mintCosts = await premintClient.getMintCosts({
+              tokenContract: verifyingContract,
+              quantityToMint: 1n,
+              pricePerToken: 0n,
+            });
+
+            await testClient.setBalance({
+              address: minterAccount!,
+              value: mintCosts.totalCost,
+            });
+
+            // if simulation succeeds, mint will succeed
+            await publicClient.simulateContract(mintParameters);
+          },
+          20 * 1000,
+        );
+      });
+    });
+  });
+});

package/tsconfig.build.json

@@ -0,0 +1,10 @@
+{
+  "extends": "zoralabs-tsconfig/tsconfig.json",
+  "compilerOptions": {
+    "lib": ["es2021", "DOM"],
+    "baseUrl": ".",
+    "outDir": "dist"
+  },
+  "exclude": ["node_modules/**", "dist/**", "**/*test.ts"],
+  "include": ["src/**/*.ts"],
+}

package/tsup.config.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  entry: ["src/index.ts"],
+  sourcemap: true,
+  clean: true,
+  tsconfig: "tsconfig.build.json",
+  dts: false,
+  format: ["cjs", "esm"],
+  onSuccess:
+    "tsc --project tsconfig.build.json --emitDeclarationOnly --declaration --declarationMap",
+});

package/dist/mints/mints-queries.d.ts

@@ -1,59 +0,0 @@
-import { Address } from "viem";
-type CollectQueryResult = {
-    tokenIds: bigint[];
-    quantities: bigint[];
-};
-export declare const getMintsAccountBalanceWithPriceQuery: (account: Address) => {
-    query: string;
-    variables: {
-        account: `0x${string}`;
-    };
-};
-export type MintAccountBalance = {
-    balance: string;
-    mintToken: {
-        id: string;
-        pricePerToken: string;
-    };
-};
-export type MintAccountBalancesQueryResult = {
-    mintTokenBalances: MintAccountBalance[];
-};
-/**
- * Given the result of a mint token balances query, selects the best MINTs to use to collect with that will satisfy the quantity,
- * by selecting the lowest priced MINTs first. Throws an error if not enough mints to collect with.
- */
-export declare const selectMintsToCollectWithFromQueryResult: (mintAccountBalances: MintAccountBalance[], quantityToCollect: bigint) => {
-    tokenIds: bigint[];
-    quantities: bigint[];
-};
-/**
- * Given an array of mint account balances, sums the balances.
- * @param mintAccountBalances
- * @returns Total balance
- */
-export declare const sumBalances: (mintAccountBalances: Pick<MintAccountBalance, "balance">[]) => bigint;
-/***
- * Given an account and quantity of MINTs to use to collect with, queries for MINTs
- * owned by an account, and selects the best MINTs to use to collect with that will satisfy that quantity.
- * @param account Account to query for MINTs
- * @param chainId
- * @param quantityToCollect How many MINTs to use to collect with
- * @returns
- */
-export declare const getMINTsToCollectWith: ({ account, chainId, quantityToCollect, }: {
-    account: Address;
-    chainId: number;
-    quantityToCollect: bigint;
-}) => Promise<CollectQueryResult>;
-/***
- * Given an account, queries for MINTs owned by an account, and sums the balances.
- * @param account Account to query for MINTs
- * @returns Total MINTs balance of account
- */
-export declare const getMINTsBalance: ({ chainId, account, }: {
-    account: Address;
-    chainId: number;
-}) => Promise<bigint>;
-export {};
-//# sourceMappingURL=mints-queries.d.ts.map

package/dist/mints/mints-queries.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"mints-queries.d.ts","sourceRoot":"","sources":["../../src/mints/mints-queries.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAG/B,KAAK,kBAAkB,GAAG;IACxB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,oCAAoC,YAAa,OAAO;;;;;CAiBpE,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE;QACT,EAAE,EAAE,MAAM,CAAC;QACX,aAAa,EAAE,MAAM,CAAC;KACvB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,iBAAiB,EAAE,kBAAkB,EAAE,CAAC;CACzC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uCAAuC,wBAC7B,kBAAkB,EAAE,qBACtB,MAAM;;;CAyC1B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,WAAW,wBACD,KAAK,kBAAkB,EAAE,SAAS,CAAC,EAAE,WAK3D,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB;aAKvB,OAAO;aACP,MAAM;uBACI,MAAM;MACvB,QAAQ,kBAAkB,CAe7B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe;aAIjB,OAAO;aACP,MAAM;qBAahB,CAAC"}

package/src/mints/mints-queries.ts

@@ -1,159 +0,0 @@
-import { getSubgraphUrl } from "src/apis/chain-constants";
-import { Address } from "viem";
-import { request, gql } from "graphql-request";
-
-type CollectQueryResult = {
-  tokenIds: bigint[];
-  quantities: bigint[];
-};
-
-export const getMintsAccountBalanceWithPriceQuery = (account: Address) => {
-  const query = gql`
-    query GetMintAccountBalances($account: String!) {
-      mintAccountBalances(where: { account: $account }) {
-        balance
-        mintToken {
-          id
-          pricePerToken
-        }
-      }
-    }
-  `;
-
-  return {
-    query,
-    variables: { account },
-  };
-};
-
-export type MintAccountBalance = {
-  balance: string;
-  mintToken: {
-    id: string;
-    pricePerToken: string;
-  };
-};
-
-export type MintAccountBalancesQueryResult = {
-  mintTokenBalances: MintAccountBalance[];
-};
-
-/**
- * Given the result of a mint token balances query, selects the best MINTs to use to collect with that will satisfy the quantity,
- * by selecting the lowest priced MINTs first. Throws an error if not enough mints to collect with.
- */
-export const selectMintsToCollectWithFromQueryResult = (
-  mintAccountBalances: MintAccountBalance[],
-  quantityToCollect: bigint,
-) => {
-  const parsed = mintAccountBalances.map((r) => {
-    return {
-      tokenId: BigInt(r.mintToken.id),
-      quantity: BigInt(r.balance),
-      pricePerToken: BigInt(r.mintToken.pricePerToken),
-    };
-  });
-
-  // now we want to find the best tokens to collect with, sorted by lowest price ascending
-  // given its a bigint, lets not do a straight subtraction but sort based on result of comparison gt/lt:
-  const sorted = parsed.sort((a, b) => {
-    if (a.pricePerToken < b.pricePerToken) {
-      return -1;
-    }
-    return 1;
-  });
-
-  // we need to get array of tokenIds and quantities to collect with:
-  let remainingQuantity = quantityToCollect;
-  const tokenIds: bigint[] = [];
-  const quantities: bigint[] = [];
-
-  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,
-  };
-};
-
-/**
- * Given an array of mint account balances, sums the balances.
- * @param mintAccountBalances
- * @returns Total balance
- */
-export const sumBalances = (
-  mintAccountBalances: Pick<MintAccountBalance, "balance">[],
-) => {
-  return mintAccountBalances.reduce((acc, curr) => {
-    return acc + BigInt(curr.balance);
-  }, BigInt(0));
-};
-
-/***
- * Given an account and quantity of MINTs to use to collect with, queries for MINTs
- * owned by an account, and selects the best MINTs to use to collect with that will satisfy that quantity.
- * @param account Account to query for MINTs
- * @param chainId
- * @param quantityToCollect How many MINTs to use to collect with
- * @returns
- */
-export const getMINTsToCollectWith = async ({
-  account,
-  chainId,
-  quantityToCollect,
-}: {
-  account: Address;
-  chainId: number;
-  quantityToCollect: bigint;
-}): Promise<CollectQueryResult> => {
-  const subgraphUrl = getSubgraphUrl(chainId);
-
-  const { query, variables } = getMintsAccountBalanceWithPriceQuery(account);
-
-  const result = await request<MintAccountBalancesQueryResult>(
-    subgraphUrl,
-    query,
-    variables,
-  );
-
-  return selectMintsToCollectWithFromQueryResult(
-    result.mintTokenBalances,
-    quantityToCollect,
-  );
-};
-
-/***
- * Given an account, queries for MINTs owned by an account, and sums the balances.
- * @param account Account to query for MINTs
- * @returns Total MINTs balance of account
- */
-export const getMINTsBalance = async ({
-  chainId,
-  account,
-}: {
-  account: Address;
-  chainId: number;
-}) => {
-  const subgraphUrl = getSubgraphUrl(chainId);
-
-  const { query, variables } = getMintsAccountBalanceWithPriceQuery(account);
-
-  const result = await request<MintAccountBalancesQueryResult>(
-    subgraphUrl,
-    query,
-    variables,
-  );
-
-  return sumBalances(result.mintTokenBalances);
-};