@zoralabs/protocol-deployments 0.3.5-COMMENTS.3 → 0.3.5-COMMENTS.5

package/src/typedData.ts

@@ -18,6 +18,7 @@ import {
   iPremintDefinitionsABI,
   sponsoredSparksSpenderAddress,
   commentsAddress,
+  callerAndCommenterAddress,
 } from "./generated/wagmi";
 import {
   PremintConfigEncoded,
@@ -31,6 +32,7 @@ import {
   TokenCreationConfigV3,
   PermitComment,
   PermitSparkComment,
+  PermitMintAndComment,
 } from "./types";
 
 const premintTypedDataDomain = ({
@@ -546,3 +548,68 @@ export const permitSparkCommentTypedDataDefinition = (
 
 // todo: explain
 export const sparkValue = () => parseEther("0.000001");
+
+/**
+ * Defines the EIP-712 typed data structure for PermitTimedSaleMintAndComment
+ */
+const permitTimedSaleMintAndCommentTypedDataType = {
+  PermitTimedSaleMintAndComment: [
+    { name: "commenter", type: "address" },
+    { name: "quantity", type: "uint256" },
+    { name: "collection", type: "address" },
+    { name: "tokenId", type: "uint256" },
+    { name: "mintReferral", type: "address" },
+    { name: "comment", type: "string" },
+    { name: "deadline", type: "uint256" },
+    { name: "nonce", type: "bytes32" },
+    { name: "sourceChainId", type: "uint32" },
+    { name: "destinationChainId", type: "uint32" },
+  ],
+} as const;
+
+/**
+ * Generates the domain separator for the CallerAndCommenter contract
+ */
+const callerAndCommenterDomain = ({
+  signingChainId,
+  destinationChainId,
+}: {
+  signingChainId: number;
+  destinationChainId: keyof typeof callerAndCommenterAddress;
+}) => ({
+  name: "CallerAndCommenter",
+  version: "1",
+  chainId: signingChainId,
+  verifyingContract: callerAndCommenterAddress[destinationChainId],
+});
+
+/**
+ * Generates the typed data definition for a permit timed sale mint and comment operation.
+ *
+ * This function creates a structured data object that can be used for EIP-712 signing,
+ * allowing users to sign a message on one chain that permits a timed sale mint and comment
+ * action to be executed on another chain.
+ *
+ * @param message - The {@link PermitMintAndComment} containing the details of the permit.
+ * @param signingAccount - (optional) The account that is signing the message, if different from the commenter.
+ * This is typically used when the commenter is a smart wallet, and the signing account is one of its owners.
+ * @returns A {@link TypedDataDefinition} object compatible with EIP-712 for structured data hashing and signing,
+ * including types, message, primary type, domain, and the signer's account address.
+ */
+export const permitMintAndCommentTypedDataDefinition = (
+  message: PermitMintAndComment,
+  signingAccount?: Address,
+): TypedDataDefinition<
+  typeof permitTimedSaleMintAndCommentTypedDataType,
+  "PermitTimedSaleMintAndComment"
+> & { account: Address } => ({
+  types: permitTimedSaleMintAndCommentTypedDataType,
+  message,
+  primaryType: "PermitTimedSaleMintAndComment",
+  domain: callerAndCommenterDomain({
+    signingChainId: message.sourceChainId,
+    destinationChainId:
+      message.destinationChainId as keyof typeof callerAndCommenterAddress,
+  }),
+  account: signingAccount || message.commenter,
+});

package/src/types.ts

@@ -7,7 +7,7 @@ import {
 } from "./generated/wagmi";
 import { Address } from "viem";
 
-import { commentsABI } from "./generated/wagmi";
+import { commentsABI, callerAndCommenterABI } from "./generated/wagmi";
 
 export enum PremintConfigVersion {
   V1 = "1",
@@ -163,3 +163,17 @@ export type PermitComment = AbiParametersToPrimitiveTypes<
 export type PermitSparkComment = AbiParametersToPrimitiveTypes<
   ExtractAbiFunction<typeof commentsABI, "hashPermitSparkComment">["inputs"]
 >[0];
+
+/**
+ * The PermitTimedSaleMintAndComment type represents the data structure for a permit timed sale mint and comment,
+ * where a user can sign a message to mint during a timed sale and leave a comment in a single transaction.
+ * This can be executed on the destination chain by anyone.
+ *
+ * The permit includes details such as the minting parameters, comment text, and chain IDs for the source and destination chains.
+ */
+export type PermitMintAndComment = AbiParametersToPrimitiveTypes<
+  ExtractAbiFunction<
+    typeof callerAndCommenterABI,
+    "hashPermitTimedSaleMintAndComment"
+  >["inputs"]
+>[0];