Add name to permitV2 and create form

FhenixProtocol · Nov 27, 2024 · 74052b8 · 74052b8
1 parent ff764d5
commit 74052b8
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 15 deletions.
diff --git a/packages/nextjs/components/PermitModal/Create/Create.tsx b/packages/nextjs/components/PermitModal/Create/Create.tsx
@@ -147,6 +147,17 @@ export const PermitV2ModalCreate = () => {
         </button>
       </div>
 
+      {/* Name */}
+      <div className="flex flex-row items-center justify-start gap-4">
+        <div className="text-sm font-bold">Name:</div>
+        <InputBase
+          name="permit-name"
+          value={name}
+          placeholder="Unnamed Permit"
+          onChange={(value: string) => setName(value)}
+        />
+      </div>
+
       {/* (Sharing) Recipient */}
       {type === PermitV2CreateType.Sharing && (
         <div className="flex flex-row items-center justify-start gap-4">
@@ -162,12 +173,6 @@ export const PermitV2ModalCreate = () => {
         </div>
       )}
 
-      {/* Name */}
-      <div className="flex flex-row items-center justify-start gap-4">
-        <div className="text-sm font-bold">Name (optional):</div>
-        <InputBase name="permit-name" value={name} placeholder="name" onChange={(value: string) => setName(value)} />
-      </div>
-
       {/* Expiration */}
       <div className="flex flex-row items-center justify-start gap-4">
         <div className="text-sm font-bold">Expires in:</div>

diff --git a/packages/nextjs/permits/permitV2.ts b/packages/nextjs/permits/permitV2.ts
@@ -18,9 +18,9 @@ import { getSignatureTypesAndMessage, SignatureTypes } from "./generate";
 
 export class PermitV2 implements PermitV2Interface {
   /**
-   * Optional name for this permit, only for organization and UX
+   * Name for this permit, only for organization and UX
    */
-  public name?: string;
+  public name: string;
   /**
    * The type of the PermitV2 (self / sharing)
    * (self) Permit that will be signed and used by the issuer
@@ -79,7 +79,7 @@ export class PermitV2 implements PermitV2Interface {
    */
   public recipientSignature: string;
 
-  public constructor(options: PermitV2Interface & { name?: string }) {
+  public constructor(options: PermitV2Interface) {
     this.name = options.name;
     this.type = options.type;
     this.issuer = options.issuer;
@@ -94,7 +94,7 @@ export class PermitV2 implements PermitV2Interface {
     this.recipientSignature = options.recipientSignature;
   }
 
-  static async create(options: PermitV2Options & { name?: string }) {
+  static async create(options: PermitV2Options) {
     const { success, data: parsed, error } = PermitV2ParamsValidator.safeParse(options);
 
     if (!success) {
@@ -107,14 +107,13 @@ export class PermitV2 implements PermitV2Interface {
         : await GenerateSealingKey();
 
     return new PermitV2({
-      name: options.name,
       ...parsed,
       sealingPair,
     });
   }
 
   static async createAndSign(
-    options: PermitV2Options & { name?: string },
+    options: PermitV2Options,
     chainId: string | undefined,
     signer: AbstractSigner | undefined,
   ) {
@@ -145,7 +144,7 @@ export class PermitV2 implements PermitV2Interface {
    * Utility to extract the public data from a permit.
    * Used in `serialize`, `getPermission`, `getHash` etc
    */
-  getInterface = (): PermitV2Interface & { name?: string } => {
+  getInterface = (): PermitV2Interface => {
     return {
       name: this.name,
       type: this.type,
@@ -203,7 +202,7 @@ export class PermitV2 implements PermitV2Interface {
     }
 
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const { type, sealingPair, ...permit } = permitData;
+    const { name, type, sealingPair, ...permit } = permitData;
     return {
       ...permit,
       sealingKey: `0x${sealingPair.publicKey}`,

diff --git a/packages/nextjs/permits/permitV2.z.ts b/packages/nextjs/permits/permitV2.z.ts
@@ -7,6 +7,7 @@ const SerializedSealingPair = z.object({
 });
 
 const zPermitV2WithDefaults = z.object({
+  name: z.string().optional().default("Unnamed Permit"),
   type: z.enum(["self", "sharing", "recipient"]),
   issuer: z.string().refine(val => val !== zeroAddress, {
     message: "PermitV2 issuer :: must not be zeroAddress",

diff --git a/packages/nextjs/permits/types.ts b/packages/nextjs/permits/types.ts
@@ -255,6 +255,10 @@ export interface AbstractSigner {
  * Type representing the full PermitV2
  */
 export type PermitV2Interface = {
+  /**
+   * Name for this permit, only for organization and UX
+   */
+  name: string;
   /**
    * The type of the PermitV2 (self / sharing)
    * (self) Permit that will be signed and used by the issuer
@@ -363,7 +367,7 @@ export type SerializedPermitV2 = Omit<PermitV2Interface, "sealingPair"> & {
  * A type representing the PermissionV2 struct that is passed to PermissionedV2.sol to grant encrypted data access.
  */
 export type PermissionV2 = Expand<
-  Omit<PermitV2Interface, "type" | "sealingPair"> & {
+  Omit<PermitV2Interface, "name" | "type" | "sealingPair"> & {
     sealingKey: string;
   }
 >;