@zoralabs/protocol-sdk 0.11.7 → 0.11.9

package/src/create/mint-from-create.ts

@@ -75,6 +75,7 @@ export function makeOnchainPrepareMintFromCreate({
   minter,
   getContractMintFee,
   contractVersion,
+  chainId,
 }: {
   contractAddress: Address;
   tokenId: bigint;
@@ -82,6 +83,7 @@ export function makeOnchainPrepareMintFromCreate({
   minter: Address;
   getContractMintFee: () => Promise<bigint>;
   contractVersion: string;
+  chainId: number;
 }): AsyncPrepareMint {
   return async (params: MintParametersBase): Promise<PrepareMintReturn> => {
     const subgraphSalesConfig = await toSalesStrategyFromSubgraph({
@@ -98,6 +100,7 @@ export function makeOnchainPrepareMintFromCreate({
         ...params,
         tokenContract: contractAddress,
         tokenId,
+        chainId,
       }),
       costs: parseMintCosts({
         allowListEntry: params.allowListEntry,

package/src/fixtures/rewards-query-results.ts

@@ -4,10 +4,17 @@ import {
   CreatorERC20zQueryResult,
 } from "../rewards/subgraph-queries";
 
-const mockResult = (erz20z: Address): RewardsToken => ({
+const mockResult = ({
+  erz20z,
+  secondaryActivated,
+}: {
+  erz20z: Address;
+  secondaryActivated: boolean;
+}): RewardsToken => ({
   salesStrategies: [
     {
       zoraTimedMinter: {
+        secondaryActivated,
         erc20Z: {
           id: erz20z,
         },
@@ -19,7 +26,7 @@ const mockResult = (erz20z: Address): RewardsToken => ({
 export const mockRewardsQueryResults = ({
   erc20z,
 }: {
-  erc20z: Address[];
+  erc20z: { secondaryActivated: boolean; erz20z: Address }[];
 }): CreatorERC20zQueryResult => ({
   zoraCreateTokens: erc20z.map(mockResult),
 });

package/src/mint/mint-client.test.ts

@@ -1,16 +1,28 @@
 import { describe, expect, vi } from "vitest";
-import { Address, erc20Abi, parseAbi, parseEther } from "viem";
+import {
+  Address,
+  erc20Abi,
+  parseAbi,
+  parseEther,
+  TransactionReceipt,
+  parseEventLogs,
+} from "viem";
 import { zora, zoraSepolia } from "viem/chains";
-import { zoraCreator1155ImplABI } from "@zoralabs/protocol-deployments";
+import {
+  zoraCreator1155ImplABI,
+  CommentIdentifier,
+  commentsABI,
+  callerAndCommenterABI,
+} from "@zoralabs/protocol-deployments";
 import { forkUrls, makeAnvilTest, writeContractWithRetries } from "src/anvil";
 import { createCollectorClient, createCreatorClient } from "src/sdk";
 import { getAllowListEntry } from "src/allow-list/allow-list-client";
+import { SubgraphMintGetter } from "./subgraph-mint-getter";
+import { new1155ContractVersion } from "src/create/contract-setup";
 import {
   demoContractMetadataURI,
   demoTokenMetadataURI,
-} from "src/create/1155-create-helper.test";
-import { SubgraphMintGetter } from "./subgraph-mint-getter";
-import { new1155ContractVersion } from "src/create/contract-setup";
+} from "src/fixtures/contract-setup";
 import { ISubgraphQuerier } from "src/apis/subgraph-querier";
 import { mockTimedSaleStrategyTokenQueryResult } from "src/fixtures/mint-query-results";
 
@@ -18,52 +30,64 @@ const erc721ABI = parseAbi([
   "function balanceOf(address owner) public view returns (uint256)",
 ] as const);
 
+const getCommentIdentifierFromReceipt = (
+  receipt: TransactionReceipt,
+): CommentIdentifier => {
+  const logs = parseEventLogs({
+    abi: commentsABI,
+    logs: receipt.logs,
+    eventName: "Commented",
+  });
+
+  if (logs.length === 0) {
+    throw new Error("No Commented event found in receipt");
+  }
+
+  return logs[0]!.args.commentIdentifier;
+};
+
 describe("mint-helper", () => {
   makeAnvilTest({
-    forkBlockNumber: 16028671,
-    forkUrl: forkUrls.zoraMainnet,
-    anvilChainId: zora.id,
+    forkBlockNumber: 16028124,
+    forkUrl: forkUrls.zoraSepolia,
+    anvilChainId: zoraSepolia.id,
   })(
-    "mints a new 1155 token",
+    "mints a new 1155 token with a comment",
     async ({ viemClients }) => {
-      const { testClient, walletClient, publicClient } = viemClients;
+      const { testClient, walletClient, publicClient, chain } = viemClients;
       const creatorAccount = (await walletClient.getAddresses())[0]!;
       await testClient.setBalance({
         address: creatorAccount,
         value: parseEther("2000"),
       });
       const targetContract: Address =
-        "0xa2fea3537915dc6c7c7a97a82d1236041e6feb2e";
-      const targetTokenId = 1n;
+        "0xD42557F24034b53e7340A40bb5813eF9Ba88F2b4";
+      const targetTokenId = 3n;
       const collectorClient = createCollectorClient({
-        chainId: zora.id,
+        chainId: chain.id,
         publicClient,
       });
 
-      const {
-        token: mintable,
-        prepareMint,
-        primaryMintActive,
-      } = await collectorClient.getToken({
-        tokenContract: targetContract,
-        mintType: "1155",
-        tokenId: targetTokenId,
-      });
-
-      mintable.maxSupply;
-      mintable.totalMinted;
-      mintable.tokenURI;
-      mintable;
+      const { prepareMint, primaryMintActive } = await collectorClient.getToken(
+        {
+          tokenContract: targetContract,
+          mintType: "1155",
+          tokenId: targetTokenId,
+        },
+      );
 
       expect(primaryMintActive).toBe(true);
       expect(prepareMint).toBeDefined();
 
+      const quantityToMint = 5n;
+
       const { parameters, costs } = prepareMint!({
         minterAccount: creatorAccount,
-        quantityToMint: 1,
+        quantityToMint,
+        mintComment: "This is a fun comment :)",
       });
 
-      expect(costs.totalCostEth).toBe(1n * parseEther("0.000777"));
+      expect(costs.totalCostEth).toBe(quantityToMint * parseEther("0.000111"));
 
       const oldBalance = await publicClient.readContract({
         abi: zoraCreator1155ImplABI,
@@ -84,7 +108,20 @@ describe("mint-helper", () => {
       });
       expect(receipt).to.not.be.null;
       expect(oldBalance).to.be.equal(0n);
-      expect(newBalance).to.be.equal(1n);
+      expect(newBalance).to.be.equal(quantityToMint);
+
+      // search for the Commented event in the logs
+      const commentIdentifier = getCommentIdentifierFromReceipt(receipt);
+
+      expect(commentIdentifier).toBeDefined();
+
+      const logs = parseEventLogs({
+        abi: callerAndCommenterABI,
+        logs: receipt.logs,
+        eventName: "MintedAndCommented",
+      });
+
+      expect(logs.length).toBe(1);
     },
     12 * 1000,
   );

package/src/mint/mint-client.ts

@@ -24,19 +24,22 @@ export class MintClient {
   private readonly publicClient: IPublicClient;
   private readonly mintGetter: IOnchainMintGetter;
   private readonly premintGetter: IPremintGetter;
-
+  private readonly chainId: number;
   constructor({
     publicClient,
     premintGetter,
     mintGetter,
+    chainId,
   }: {
     publicClient: IPublicClient;
     premintGetter: IPremintGetter;
     mintGetter: IOnchainMintGetter;
+    chainId: number;
   }) {
     this.publicClient = publicClient;
     this.mintGetter = mintGetter;
     this.premintGetter = premintGetter;
+    this.chainId = chainId;
   }
 
   /**
@@ -54,6 +57,7 @@ export class MintClient {
       publicClient: this.publicClient,
       mintGetter: this.mintGetter,
       premintGetter: this.premintGetter,
+      chainId: this.chainId,
     });
   }
 
@@ -69,6 +73,7 @@ export class MintClient {
       mintGetter: this.mintGetter,
       premintGetter: this.premintGetter,
       publicClient: this.publicClient,
+      chainId: this.chainId,
     });
   }
 
@@ -87,6 +92,7 @@ export class MintClient {
       mintGetter: this.mintGetter,
       premintGetter: this.premintGetter,
       publicClient: this.publicClient,
+      chainId: this.chainId,
     });
   }
 
@@ -110,17 +116,20 @@ async function mint({
   publicClient,
   mintGetter,
   premintGetter,
+  chainId,
 }: {
   parameters: MakeMintParametersArguments;
   publicClient: IPublicClient;
   mintGetter: IOnchainMintGetter;
   premintGetter: IPremintGetter;
+  chainId: number;
 }): Promise<PrepareMintReturn> {
   const { prepareMint, primaryMintActive } = await getMint({
     params: parameters,
     mintGetter,
     premintGetter,
     publicClient,
+    chainId,
   });
 
   if (!primaryMintActive) {

package/src/mint/mint-queries.ts

@@ -36,11 +36,13 @@ export async function getMint({
   mintGetter,
   premintGetter,
   publicClient,
+  chainId,
 }: {
   params: GetMintParameters;
   mintGetter: IOnchainMintGetter;
   premintGetter: IPremintGetter;
   publicClient: IPublicClient;
+  chainId: number;
 }): Promise<MintableReturn> {
   const { tokenContract } = params;
   if (isOnChainMint(params)) {
@@ -53,7 +55,7 @@ export async function getMint({
       blockTime: blockTime,
     });
 
-    return toMintableReturn(result);
+    return toMintableReturn(result, chainId);
   }
 
   const premint = await premintGetter.get({
@@ -103,17 +105,19 @@ export async function getMintsOfContract({
   mintGetter,
   premintGetter,
   publicClient,
+  chainId,
 }: {
   params: GetMintsOfContractParameters;
   mintGetter: IOnchainMintGetter;
   premintGetter: IPremintGetter;
   publicClient: IPublicClient;
+  chainId: number;
 }): Promise<{ contract?: ContractInfo; tokens: MintableReturn[] }> {
   const onchainMints = (
     await mintGetter.getContractMintable({
       tokenAddress: params.tokenContract,
     })
-  ).map(toMintableReturn);
+  ).map((result) => toMintableReturn(result, chainId));
 
   const offchainMints = await getPremintsOfContractMintable({
     mintGetter,
@@ -270,7 +274,7 @@ function parsePremint({
 }
 
 export const makeOnchainPrepareMint =
-  (result: OnchainSalesConfigAndTokenInfo): PrepareMint =>
+  (result: OnchainSalesConfigAndTokenInfo, chainId: number): PrepareMint =>
   (params: MintParametersBase) => {
     if (!result.salesConfig) {
       throw new Error("No valid sales config found for token");
@@ -280,6 +284,7 @@ export const makeOnchainPrepareMint =
       parameters: makeOnchainMintCall({
         token: result as Concrete<OnchainSalesConfigAndTokenInfo>,
         mintParams: params,
+        chainId,
       }),
       erc20Approval: getRequiredErc20Approvals(params, result.salesConfig),
       costs: parseMintCosts({
@@ -290,7 +295,10 @@ export const makeOnchainPrepareMint =
     };
   };
 
-function toMintableReturn(result: GetMintableReturn): MintableReturn {
+function toMintableReturn(
+  result: GetMintableReturn,
+  chainId: number,
+): MintableReturn {
   const primaryMintActive = result.primaryMintActive;
   if (!primaryMintActive) {
     return {
@@ -306,7 +314,10 @@ function toMintableReturn(result: GetMintableReturn): MintableReturn {
     primaryMintActive,
     primaryMintEnd: result.primaryMintEnd,
     secondaryMarketActive: result.secondaryMarketActive,
-    prepareMint: makeOnchainPrepareMint(result.salesConfigAndTokenInfo),
+    prepareMint: makeOnchainPrepareMint(
+      result.salesConfigAndTokenInfo,
+      chainId,
+    ),
   };
 }
 

package/src/mint/mint-transactions.ts

@@ -11,6 +11,8 @@ import {
   erc20MinterABI,
   zoraCreator1155ImplABI,
   zoraTimedSaleStrategyABI,
+  callerAndCommenterABI,
+  callerAndCommenterAddress,
 } from "@zoralabs/protocol-deployments";
 import { zora721Abi, zora1155LegacyAbi } from "src/constants";
 import {
@@ -32,9 +34,11 @@ import { AllowListEntry } from "src/allow-list/types";
 export function makeOnchainMintCall({
   token,
   mintParams,
+  chainId,
 }: {
   token: Concrete<OnchainSalesConfigAndTokenInfo>;
   mintParams: Omit<MakeMintParametersArgumentsBase, "tokenContract">;
+  chainId: number;
 }): SimulateContractParametersWithAccount {
   if (token.mintType === "721") {
     return makePrepareMint721TokenParams({
@@ -48,6 +52,7 @@ export function makeOnchainMintCall({
     salesConfigAndTokenInfo: token,
     tokenContract: token.contract.address,
     tokenId: token.tokenId!,
+    chainId,
     ...mintParams,
   });
 }
@@ -57,6 +62,69 @@ export type MintableParameters = Pick<
   "contractVersion" | "salesConfig"
 >;
 
+function makeZoraTimedSaleStrategyMintCall({
+  minterAccount,
+  salesConfigAndTokenInfo,
+  mintQuantity,
+  mintTo,
+  tokenContract,
+  tokenId,
+  mintReferral,
+  mintComment,
+  chainId,
+}: {
+  minterAccount: Address | Account;
+  salesConfigAndTokenInfo: Concrete<MintableParameters>;
+  mintQuantity: bigint;
+  mintTo: Address;
+  tokenContract: Address;
+  tokenId: GenericTokenIdTypes;
+  mintReferral?: Address;
+  mintComment?: string;
+  chainId: number;
+}) {
+  // if there is a mint comment, use the caller and commenter
+  if (mintComment && mintComment !== "") {
+    return makeContractParameters({
+      abi: callerAndCommenterABI,
+      address:
+        callerAndCommenterAddress[
+          chainId as keyof typeof callerAndCommenterAddress
+        ],
+      functionName: "timedSaleMintAndComment",
+      account: minterAccount,
+      value:
+        salesConfigAndTokenInfo.salesConfig.mintFeePerQuantity * mintQuantity,
+      args: [
+        mintTo,
+        mintQuantity,
+        tokenContract,
+        tokenId,
+        mintReferral || zeroAddress,
+        mintComment,
+      ],
+    });
+  }
+
+  return makeContractParameters({
+    abi: zoraTimedSaleStrategyABI,
+    functionName: "mint",
+    account: minterAccount,
+    address: salesConfigAndTokenInfo.salesConfig.address,
+    value:
+      salesConfigAndTokenInfo.salesConfig.mintFeePerQuantity * mintQuantity,
+    /* args: mintTo, quantity, collection, tokenId, mintReferral, comment */
+    args: [
+      mintTo,
+      mintQuantity,
+      tokenContract,
+      BigInt(tokenId),
+      mintReferral || zeroAddress,
+      "",
+    ],
+  });
+}
+
 export function makePrepareMint1155TokenParams({
   tokenContract: tokenContract,
   tokenId,
@@ -67,9 +135,11 @@ export function makePrepareMint1155TokenParams({
   mintRecipient,
   quantityToMint,
   allowListEntry,
+  chainId,
 }: {
   salesConfigAndTokenInfo: Concrete<MintableParameters>;
   tokenId: GenericTokenIdTypes;
+  chainId: number;
 } & Pick<
   MakeMintParametersArgumentsBase,
   | "minterAccount"
@@ -101,22 +171,16 @@ export function makePrepareMint1155TokenParams({
   }
 
   if (saleType === "timed") {
-    return makeContractParameters({
-      abi: zoraTimedSaleStrategyABI,
-      functionName: "mint",
-      account: minterAccount,
-      address: salesConfigAndTokenInfo.salesConfig.address,
-      value:
-        salesConfigAndTokenInfo.salesConfig.mintFeePerQuantity * mintQuantity,
-      /* args: mintTo, quantity, collection, tokenId, mintReferral, comment */
-      args: [
-        mintTo,
-        mintQuantity,
-        tokenContract,
-        BigInt(tokenId),
-        mintReferral || zeroAddress,
-        mintComment || "",
-      ],
+    return makeZoraTimedSaleStrategyMintCall({
+      minterAccount,
+      salesConfigAndTokenInfo,
+      mintQuantity,
+      mintTo,
+      tokenContract,
+      tokenId,
+      mintReferral,
+      mintComment,
+      chainId,
     });
   }
 

package/src/rewards/rewards-client.test.ts

@@ -1,12 +1,12 @@
 import { describe, expect, vi } from "vitest";
 import { encodeAbiParameters, erc20Abi, parseEther } from "viem";
-import { zoraSepolia } from "viem/chains";
+import { zoraSepolia, base } from "viem/chains";
 import {
   forkUrls,
   makeAnvilTest,
   simulateAndWriteContractWithRetries,
 } from "src/anvil";
-import { createCollectorClient } from "src/sdk";
+import { createCollectorClient, createCreatorClient } from "src/sdk";
 import { new1155ContractVersion } from "src/create/contract-setup";
 import { ISubgraphQuerier } from "src/apis/subgraph-querier";
 import { mockTimedSaleStrategyTokenQueryResult } from "src/fixtures/mint-query-results";
@@ -16,11 +16,32 @@ import {
   zoraCreator1155ImplABI,
 } from "@zoralabs/protocol-deployments";
 import { makeContractParameters } from "src/utils";
-import { mockRewardsQueryResults } from "src/fixtures/rewards-query-results";
 import { setupContractAndToken } from "src/fixtures/contract-setup";
 import { advanceToSaleAndAndLaunchMarket } from "src/fixtures/secondary";
+import { CreatorERC20zQueryResult } from "./subgraph-queries";
 
 describe("rewardsClient", () => {
+  makeAnvilTest({
+    forkBlockNumber: 22375202,
+    forkUrl: forkUrls.baseMainnet,
+    anvilChainId: base.id,
+  })(
+    "it can query rewards balances where there are multiple minters",
+    async ({ viemClients: { publicClient, chain } }) => {
+      const creatorClient = createCreatorClient({
+        chainId: chain.id,
+        publicClient,
+      });
+      const rewardsBalance = await creatorClient.getRewardsBalances({
+        account: "0x129F04B140Acc1AA350be2F9f048C178103c62f3",
+      });
+
+      const erc20zKeys = Object.keys(rewardsBalance.secondaryRoyalties.erc20);
+
+      expect(erc20zKeys.length).toBeGreaterThan(0);
+    },
+    20_000,
+  );
   makeAnvilTest({
     forkBlockNumber: 14653556,
     forkUrl: forkUrls.zoraSepolia,
@@ -251,20 +272,31 @@ describe("rewardsClient", () => {
 
       // now we should be able to get rewards balances for these royalties
 
+      const mockResult: CreatorERC20zQueryResult = {
+        zoraCreateTokens: [
+          {
+            salesStrategies: [
+              {
+                zoraTimedMinter: {
+                  secondaryActivated: true,
+                  erc20Z: { id: erc20z },
+                },
+              },
+            ],
+          },
+        ],
+      };
+
       // we need to stub the subgraph return
       rewardsGetter.subgraphQuerier.query = vi
         .fn<ISubgraphQuerier["query"]>()
-        .mockResolvedValue(
-          mockRewardsQueryResults({
-            erc20z: [erc20z],
-          }),
-        );
+        .mockResolvedValue(mockResult);
 
       const rewardsBalance = await creatorClient.getRewardsBalances({
         account: creatorAccount,
       });
 
-      expect(rewardsBalance.secondaryRoyalties.eth).toBeGreaterThan(0);
+      expect(rewardsBalance.protocolRewards).toBeGreaterThan(0n);
       expect(rewardsBalance.secondaryRoyalties.erc20[erc20z]).toBeGreaterThan(
         0,
       );

package/src/rewards/rewards-queries.ts

@@ -77,7 +77,13 @@ export const getRewardsBalance = async ({
   rewardsGetter: IRewardsGetter;
 }): Promise<RewardsBalance> => {
   const address = typeof account === "string" ? account : account.address;
-  const erc20Zs = await rewardsGetter.getErc20ZzForCreator({ address });
+  const erc20ZsAndSecondaryActivated = await rewardsGetter.getErc20ZzForCreator(
+    { address },
+  );
+
+  const validErc20Zs = erc20ZsAndSecondaryActivated
+    .filter(({ secondaryActivated }) => secondaryActivated)
+    .map(({ erc20z }) => erc20z);
 
   // Perform multicall to get protocol rewards balance and unclaimed fees
   const result = await (publicClient as PublicClientWithMulticall).multicall({
@@ -98,7 +104,7 @@ export const getRewardsBalance = async ({
           ],
         abi: erc20ZRoyaltiesABI,
         functionName: "getUnclaimedFeesBatch",
-        args: [erc20Zs],
+        args: [validErc20Zs],
       },
     ],
     multicallAddress: multicall3Address,
@@ -147,9 +153,13 @@ const makeClaimSecondaryRoyaltiesCalls = async ({
   chainId: number;
   rewardsGetter: IRewardsGetter;
 }) => {
-  const erc20z = await rewardsGetter.getErc20ZzForCreator({
-    address: claimFor,
-  });
+  const erc20ZsAndSecondaryActivated = await rewardsGetter.getErc20ZzForCreator(
+    { address: claimFor },
+  );
+
+  const erc20z = erc20ZsAndSecondaryActivated
+    .filter(({ secondaryActivated }) => secondaryActivated)
+    .map(({ erc20z }) => erc20z);
 
   const royaltiesAddress =
     erc20ZRoyaltiesAddress[chainId as keyof typeof erc20ZRoyaltiesAddress];

package/src/rewards/subgraph-queries.ts

@@ -4,7 +4,8 @@ import { Address } from "viem";
 export type RewardsToken = {
   salesStrategies: [
     {
-      zoraTimedMinter: {
+      zoraTimedMinter?: {
+        secondaryActivated: boolean;
         erc20Z: {
           id: Address;
         };
@@ -33,6 +34,7 @@ export function buildCreatorERC20zs({
         }
         salesStrategies {
           zoraTimedMinter {
+            secondaryActivated
             erc20Z {
               id
             }

package/src/rewards/subgraph-rewards-getter.ts

@@ -4,7 +4,9 @@ import { Address } from "viem";
 import { buildCreatorERC20zs } from "./subgraph-queries";
 
 export interface IRewardsGetter {
-  getErc20ZzForCreator: (params: { address: Address }) => Promise<Address[]>;
+  getErc20ZzForCreator: (params: {
+    address: Address;
+  }) => Promise<{ secondaryActivated: boolean; erc20z: Address }[]>;
 }
 
 export class SubgraphRewardsGetter
@@ -15,19 +17,31 @@ export class SubgraphRewardsGetter
     super(chainId, subgraphQuerier);
   }
 
-  async getErc20ZzForCreator({
-    address,
-  }: {
-    address: Address;
-  }): Promise<Address[]> {
+  async getErc20ZzForCreator({ address }: { address: Address }) {
     const queryResults = await this.querySubgraphWithRetries(
       buildCreatorERC20zs({ address }),
     );
 
-    return (
-      queryResults?.map(
-        (result) => result.salesStrategies[0].zoraTimedMinter.erc20Z.id,
-      ) || []
+    const results = (
+      queryResults?.map((result) => {
+        const timedMinter = result.salesStrategies[0].zoraTimedMinter;
+
+        if (!timedMinter) {
+          return null;
+        }
+
+        return {
+          secondaryActivated: timedMinter.secondaryActivated,
+          erc20z: timedMinter.erc20Z.id,
+        };
+      }) || []
+    ).filter(
+      (
+        idAndActivated,
+      ): idAndActivated is { secondaryActivated: boolean; erc20z: Address } =>
+        !!idAndActivated,
     );
+
+    return results;
   }
 }

package/src/sdk.ts

@@ -116,6 +116,7 @@ export function createCollectorClient(
     publicClient: params.publicClient,
     premintGetter: premintGetterToUse,
     mintGetter: mintGetterToUse,
+    chainId: params.chainId,
   });
   const secondaryClient = new SecondaryClient({
     publicClient: params.publicClient,