@zoralabs/protocol-sdk 0.11.3 → 0.11.4-COMMENTS.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @zoralabs/protocol-sdk@0.11.3 build /home/runner/work/zora-protocol-private/zora-protocol-private/packages/protocol-sdk
+> @zoralabs/protocol-sdk@0.11.4-COMMENTS.0 build /home/runner/work/zora-protocol-private/zora-protocol-private/packages/protocol-sdk
 > pnpm tsup
 
 CLI Building entry: src/index.ts
@@ -10,9 +10,9 @@ CLI Target: es2021
 CLI Cleaning output folder
 CJS Build start
 ESM Build start
-ESM dist/index.js     218.03 KB
-ESM dist/index.js.map 452.53 KB
-ESM ⚡️ Build success in 335ms
 CJS dist/index.cjs     224.30 KB
 CJS dist/index.cjs.map 454.54 KB
-CJS ⚡️ Build success in 352ms
+CJS ⚡️ Build success in 335ms
+ESM dist/index.js     218.03 KB
+ESM dist/index.js.map 452.53 KB
+ESM ⚡️ Build success in 343ms

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @zoralabs/protocol-sdk
 
+## 0.11.4-COMMENTS.0
+
+### Patch Changes
+
+- Updated dependencies [4928687d]
+- Updated dependencies [7e285fb1]
+- Updated dependencies [a141e322]
+  - @zoralabs/protocol-deployments@0.3.6-COMMENTS.0
+
 ## 0.11.3
 
 ### Patch Changes

package/dist/test-utils.d.ts

@@ -1,6 +1,7 @@
 import { zoraCreator1155FactoryImplAddress } from "@zoralabs/protocol-deployments";
 import { Address, Hex, PublicClient } from "viem";
-export declare const waitForSuccess: (hash: Hex, publicClient: PublicClient) => Promise<void>;
+import { NewContractParams } from "./create/types";
+export declare const waitForSuccess: (hash: Hex, publicClient: PublicClient) => Promise<import("viem").TransactionReceipt>;
 export declare const getFixedPricedMinter: ({ publicClient, chainId, }: {
     publicClient: PublicClient;
     chainId: keyof typeof zoraCreator1155FactoryImplAddress;
@@ -8,4 +9,5 @@ export declare const getFixedPricedMinter: ({ publicClient, chainId, }: {
 export declare const fixedPriceMinterMinterArguments: ({ mintRecipient, }: {
     mintRecipient: Address;
 }) => `0x${string}`;
+export declare function randomNewContract(): NewContractParams;
 //# sourceMappingURL=test-utils.d.ts.map

package/dist/test-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"test-utils.d.ts","sourceRoot":"","sources":["../src/test-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,iCAAiC,EAClC,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,OAAO,EACP,GAAG,EACH,YAAY,EAGb,MAAM,MAAM,CAAC;AAGd,eAAO,MAAM,cAAc,SAAgB,GAAG,gBAAgB,YAAY,kBAMzE,CAAC;AAEF,eAAO,MAAM,oBAAoB,+BAG9B;IACD,YAAY,EAAE,YAAY,CAAC;IAC3B,OAAO,EAAE,MAAM,OAAO,iCAAiC,CAAC;CACzD,2BAKG,CAAC;AAEL,eAAO,MAAM,+BAA+B,uBAEzC;IACD,aAAa,EAAE,OAAO,CAAC;CACxB,kBAAwE,CAAC"}
+{"version":3,"file":"test-utils.d.ts","sourceRoot":"","sources":["../src/test-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,iCAAiC,EAClC,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,OAAO,EACP,GAAG,EACH,YAAY,EAGb,MAAM,MAAM,CAAC;AACd,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAGnD,eAAO,MAAM,cAAc,SAAgB,GAAG,gBAAgB,YAAY,+CAQzE,CAAC;AAEF,eAAO,MAAM,oBAAoB,+BAG9B;IACD,YAAY,EAAE,YAAY,CAAC;IAC3B,OAAO,EAAE,MAAM,OAAO,iCAAiC,CAAC;CACzD,2BAKG,CAAC;AAEL,eAAO,MAAM,+BAA+B,uBAEzC;IACD,aAAa,EAAE,OAAO,CAAC;CACxB,kBAAwE,CAAC;AAI1E,wBAAgB,iBAAiB,IAAI,iBAAiB,CAKrD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zoralabs/protocol-sdk",
-  "version": "0.11.3",
+  "version": "0.11.4-COMMENTS.0",
   "repository": "https://github.com/ourzora/zora-protocol",
   "license": "MIT",
   "type": "module",
@@ -17,7 +17,7 @@
   },
   "dependencies": {
     "abitype": "^1.0.2",
-    "@zoralabs/protocol-deployments": "^0.3.5"
+    "@zoralabs/protocol-deployments": "^0.3.6-COMMENTS.0"
   },
   "peerDependencies": {
     "viem": "^2.21.21"

package/src/comments/comments.test.ts

@@ -0,0 +1,342 @@
+import { describe, expect } from "vitest";
+import { forkUrls, makeAnvilTest, writeContractWithRetries } from "src/anvil";
+import { base, zora } from "viem/chains";
+import {
+  commentsABI,
+  commentsAddress,
+  emptyCommentIdentifier,
+  PermitComment,
+  PermitSparkComment,
+  sparkValue,
+  CommentIdentifier,
+  permitSparkCommentTypedDataDefinition,
+  permitMintAndCommentTypedDataDefinition,
+  PermitMintAndComment,
+  callerAndCommenterAddress as callerAndCommenterAddresses,
+  callerAndCommenterABI,
+  zoraCreator1155ImplABI,
+} from "@zoralabs/protocol-deployments";
+import {
+  Address,
+  keccak256,
+  toBytes,
+  zeroAddress,
+  parseEther,
+  TransactionReceipt,
+  parseEventLogs,
+  hashTypedData,
+} from "viem";
+import { createCreatorClient } from "src/sdk";
+import { randomNewContract, waitForSuccess } from "src/test-utils";
+import { permitCommentTypedDataDefinition } from "@zoralabs/protocol-deployments";
+import { demoTokenMetadataURI } from "src/fixtures/contract-setup";
+
+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;
+};
+const randomNonce = () => keccak256(toBytes(Math.round(Math.random() * 1000)));
+const thirtySecondsFromNow =
+  BigInt(Math.round(new Date().getTime() / 1000)) + 30n;
+// todo: move this to protocol-deployments
+describe("comments", () => {
+  makeAnvilTest({
+    forkUrl: forkUrls.zoraMainnet,
+    forkBlockNumber: 21297211,
+    anvilChainId: zora.id,
+  })(
+    "can sign and execute a cross-chain comment, and sign and execute a cross-chain spark comment",
+    async ({
+      viemClients: { publicClient, walletClient, chain, testClient },
+    }) => {
+      // Get the chain ID and set up addresses for different roles
+      const chainId = chain.id;
+      const [
+        collectorAddress,
+        creatorAddress,
+        executorAddress,
+        sparkerAddress,
+      ] = (await walletClient.getAddresses()!) as [
+        Address,
+        Address,
+        Address,
+        Address,
+      ];
+
+      // Create a creator client for interacting with the protocol
+      const creatorClient = createCreatorClient({
+        chainId,
+        publicClient,
+      });
+
+      // Step 1: Create a new 1155 contract and token
+      const { contractAddress, newTokenId, parameters, prepareMint } =
+        await creatorClient.create1155({
+          contract: randomNewContract(),
+          token: {
+            tokenMetadataURI: demoTokenMetadataURI,
+          },
+          account: creatorAddress,
+        });
+
+      // Deploy the new contract
+      const { request } = await publicClient.simulateContract(parameters);
+      await writeContractWithRetries({
+        request,
+        walletClient,
+        publicClient,
+      });
+
+      // Prepare to mint a token
+      const { parameters: collectParameters } = await prepareMint({
+        quantityToMint: 1n,
+        minterAccount: collectorAddress,
+      });
+
+      // Step 2: Mint an 1155 token on the new contract
+      const { request: mintRequest } =
+        await publicClient.simulateContract(collectParameters);
+      await writeContractWithRetries({
+        request: mintRequest,
+        walletClient,
+        publicClient,
+      });
+
+      // Set up cross-chain comment parameters
+      const sourceChainId = base.id; // The chain ID where the comment originates
+
+      const commentsAddressForChainId =
+        commentsAddress[chainId as keyof typeof commentsAddress];
+
+      // Step 3: Prepare a cross-chain comment
+      const permitComment: PermitComment = {
+        sourceChainId,
+        contractAddress,
+        destinationChainId: chainId,
+        tokenId: newTokenId,
+        commenter: collectorAddress,
+        text: "hello world",
+        deadline: thirtySecondsFromNow,
+        nonce: randomNonce(),
+        referrer: zeroAddress,
+        commenterSmartWallet: zeroAddress,
+        replyTo: emptyCommentIdentifier(),
+      };
+
+      // Generate typed data for signing
+      const typedData = permitCommentTypedDataDefinition(permitComment);
+
+      expect(typedData.domain!.chainId).toEqual(sourceChainId);
+      expect(typedData.account).toEqual(collectorAddress);
+      expect(typedData.domain!.verifyingContract).toEqual(
+        commentsAddressForChainId,
+      );
+      expect(typedData.domain!.verifyingContract).toEqual(
+        commentsAddressForChainId,
+      );
+
+      const hashed = await publicClient.readContract({
+        abi: commentsABI,
+        address: commentsAddressForChainId,
+        functionName: "hashPermitComment",
+        args: [permitComment],
+      });
+
+      expect(hashed).toEqual(hashTypedData(typedData));
+
+      // Ensure the commenter has enough balance for the spark value
+      await testClient.setBalance({
+        address: collectorAddress,
+        value: sparkValue(),
+      });
+
+      // Step 4: Sign the cross-chain comment
+      const signature = await walletClient.signTypedData(typedData);
+
+      // Ensure the executor has enough balance to execute the transaction
+      await testClient.setBalance({
+        address: executorAddress,
+        value: parseEther("1"),
+      });
+
+      // Step 5: Simulate and execute the cross-chain comment
+      const { request: commentRequest } = await publicClient.simulateContract({
+        abi: commentsABI,
+        address: commentsAddressForChainId,
+        functionName: "permitComment",
+        args: [permitComment, signature],
+        account: executorAddress,
+        value: sparkValue(),
+      });
+
+      const commentHash = await walletClient.writeContract(commentRequest);
+      const receipt = await publicClient.waitForTransactionReceipt({
+        hash: commentHash,
+      });
+
+      expect(receipt.status).toBe("success");
+
+      // Extract the comment identifier from the transaction receipt
+      const commentIdentifier = getCommentIdentifierFromReceipt(receipt);
+
+      // Step 6: Prepare a spark (like) for the comment
+      const sparkComment: PermitSparkComment = {
+        sparksQuantity: 3n,
+        sparker: sparkerAddress,
+        deadline: thirtySecondsFromNow,
+        nonce: randomNonce(),
+        referrer: zeroAddress,
+        sourceChainId,
+        destinationChainId: chainId,
+        comment: commentIdentifier,
+      };
+
+      const sparkTypedData =
+        permitSparkCommentTypedDataDefinition(sparkComment);
+
+      // Step 7: Sign the spark comment
+      const sparkSignature = await walletClient.signTypedData(sparkTypedData);
+
+      // Step 8: Simulate and execute the spark comment
+      const { request: sparkRequest } = await publicClient.simulateContract({
+        abi: commentsABI,
+        address: commentsAddressForChainId,
+        functionName: "permitSparkComment",
+        args: [sparkComment, sparkSignature],
+        account: executorAddress,
+        value: sparkValue() * sparkComment.sparksQuantity,
+      });
+
+      const sparkHash = await walletClient.writeContract(sparkRequest);
+
+      await waitForSuccess(sparkHash, publicClient);
+
+      // Step 9: Verify the spark count
+      const sparkCount = await publicClient.readContract({
+        abi: commentsABI,
+        address: commentsAddressForChainId,
+        functionName: "commentSparksQuantity",
+        args: [commentIdentifier],
+      });
+
+      expect(sparkCount).toEqual(sparkComment.sparksQuantity);
+    },
+    40_000,
+  );
+  makeAnvilTest({
+    forkUrl: forkUrls.zoraMainnet,
+    forkBlockNumber: 21297211,
+    anvilChainId: zora.id,
+  })(
+    "can sign and execute a cross-chain timed sale mint and comment",
+    async ({
+      viemClients: { publicClient, walletClient, chain, testClient },
+    }) => {
+      // Get the chain ID and set up addresses for different roles
+      const chainId = chain.id;
+      const [commenterAddress, executorAddress] =
+        (await walletClient.getAddresses()!) as [Address, Address, Address];
+
+      // Create a creator client for interacting with the protocol
+      const creatorClient = createCreatorClient({
+        chainId,
+        publicClient,
+      });
+
+      // Step 1: Create a new 1155 contract and token
+      const { contractAddress, newTokenId, parameters } =
+        await creatorClient.create1155({
+          contract: randomNewContract(),
+          token: {
+            tokenMetadataURI: demoTokenMetadataURI,
+          },
+          account: commenterAddress,
+        });
+
+      // Deploy the new contract
+      const { request } = await publicClient.simulateContract(parameters);
+      await writeContractWithRetries({
+        request,
+        walletClient,
+        publicClient,
+      });
+
+      // Step 2: Prepare the permit data for timed sale mint and comment
+      const thirtySecondsFromNow = BigInt(Math.floor(Date.now() / 1000) + 30);
+      const quantity = 3n;
+      const mintReferral = zeroAddress;
+      const comment = "This is a test comment for timed sale mint";
+
+      const permitMintAndComment: PermitMintAndComment = {
+        commenter: commenterAddress,
+        quantity,
+        collection: contractAddress,
+        tokenId: newTokenId,
+        mintReferral,
+        comment,
+        deadline: thirtySecondsFromNow,
+        nonce: randomNonce(),
+        sourceChainId: chainId,
+        destinationChainId: chainId,
+      };
+
+      // Step 3: Generate the typed data for signing
+      const typedData =
+        permitMintAndCommentTypedDataDefinition(permitMintAndComment);
+
+      // Step 4: Sign the typed data
+      const signature = await walletClient.signTypedData(typedData);
+
+      await testClient.setBalance({
+        address: executorAddress,
+        value: parseEther("1"),
+      });
+
+      // Step 5: Simulate and execute the permitTimedSaleMintAndComment function
+      const callerAndCommenterAddress =
+        callerAndCommenterAddresses[
+          chainId as keyof typeof callerAndCommenterAddresses
+        ];
+      const { request: permitRequest } = await publicClient.simulateContract({
+        abi: callerAndCommenterABI,
+        address: callerAndCommenterAddress,
+        functionName: "permitTimedSaleMintAndComment",
+        args: [permitMintAndComment, signature],
+        account: executorAddress,
+        value: quantity * parseEther("0.000111"),
+      });
+
+      const receipt = await writeContractWithRetries({
+        publicClient,
+        walletClient,
+        request: permitRequest,
+      });
+
+      // Step 6: Verify the comment was created
+      const commentIdentifier = getCommentIdentifierFromReceipt(receipt);
+      expect(commentIdentifier).toBeDefined();
+
+      // Step 7: Verify the token was minted
+      const balance = await publicClient.readContract({
+        abi: zoraCreator1155ImplABI,
+        address: contractAddress,
+        functionName: "balanceOf",
+        args: [commenterAddress, newTokenId],
+      });
+
+      expect(balance).toEqual(quantity);
+    },
+    40_000, // Increased timeout to 30 seconds
+  );
+});

package/src/create/1155-create-helper.test.ts

@@ -16,16 +16,13 @@ import { forkUrls, makeAnvilTest, writeContractWithRetries } from "src/anvil";
 import { zora } from "viem/chains";
 import { AllowList } from "src/allow-list/types";
 import { createAllowList } from "src/allow-list/allow-list-client";
-import { NewContractParams } from "./types";
 import { SubgraphContractGetter } from "./contract-getter";
 import {
   DEFAULT_MINIMUM_MARKET_ETH,
   DEFAULT_MARKET_COUNTDOWN,
 } from "./minter-defaults";
-import {
-  demoContractMetadataURI,
-  demoTokenMetadataURI,
-} from "src/fixtures/contract-setup";
+import { randomNewContract } from "src/test-utils";
+import { demoTokenMetadataURI } from "src/fixtures/contract-setup";
 
 const anvilTest = makeAnvilTest({
   forkUrl: forkUrls.zoraMainnet,
@@ -56,13 +53,6 @@ const minterIsMinterOnToken = async ({
   });
 };
 
-function randomNewContract(): NewContractParams {
-  return {
-    name: `testContract-${Math.round(Math.random() * 1_000_000)}`,
-    uri: demoContractMetadataURI,
-  };
-}
-
 describe("create-helper", () => {
   anvilTest(
     "when no sales config is provided, it creates a new 1155 contract and token using the timed sale strategy",

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

@@ -176,7 +176,7 @@ describe("secondary", () => {
       });
 
       // now get the price ot buy on secondary
-      const quantityToBuy = 1000n;
+      const quantityToBuy = 10n;
 
       const buyResult = await collectorClient.buy1155OnSecondary({
         account: collectorAccount,
@@ -215,7 +215,7 @@ describe("secondary", () => {
       expect(balance - balanceBefore).toBe(quantityToBuy);
 
       // now sell 10_000n tokens
-      const quantityToSell = 10_000n;
+      const quantityToSell = 100n;
 
       const sellResult = await collectorClient.sell1155OnSecondary({
         account: collectorAccount,

package/src/test-utils.ts

@@ -9,6 +9,7 @@ import {
   encodeAbiParameters,
   parseAbiParameters,
 } from "viem";
+import { NewContractParams } from "./create/types";
 import { expect } from "vitest";
 
 export const waitForSuccess = async (hash: Hex, publicClient: PublicClient) => {
@@ -17,6 +18,8 @@ export const waitForSuccess = async (hash: Hex, publicClient: PublicClient) => {
   });
 
   expect(receipt.status).toBe("success");
+
+  return receipt;
 };
 
 export const getFixedPricedMinter = async ({
@@ -37,3 +40,12 @@ export const fixedPriceMinterMinterArguments = ({
 }: {
   mintRecipient: Address;
 }) => encodeAbiParameters(parseAbiParameters("address"), [mintRecipient]);
+
+const demoContractMetadataURI = "ipfs://DUMMY/contract.json";
+
+export function randomNewContract(): NewContractParams {
+  return {
+    name: `testContract-${Math.round(Math.random() * 1_000_000)}`,
+    uri: demoContractMetadataURI,
+  };
+}