refactor(permissions): use permission enum #1727

src/app/screens/Nostr/ConfirmSignMessage.tsx

@@ -15,6 +15,7 @@ import api from "~/common/lib/api";
 import msg from "~/common/lib/msg";
 import { Event } from "~/extension/ln/nostr/types";
 import type { OriginData } from "~/types";
+import { PermissionMethod } from "~/types";
 
 function ConfirmSignMessage() {
   const navState = useNavigationState();
@@ -38,7 +39,7 @@ function ConfirmSignMessage() {
       if (rememberPermission) {
         await api.addPermission({
           host: origin.host,
-          method: "signMessage",
+          method: PermissionMethod["NOSTR_SIGNMESSAGE"],
           enabled: true,
           blocked: false,
         });

src/extension/background-script/actions/allowances/__tests__/delete.test.ts

@@ -1,5 +1,6 @@
 import db from "~/extension/background-script/db";
 import type { DbAllowance, MessageAllowanceDelete } from "~/types";
+import { PermissionMethod } from "~/types";
 
 import deleteAllowance from "../delete";
 
@@ -38,7 +39,7 @@ const mockPermissions = [
     allowanceId: 1,
     createdAt: "1667291216372",
     host: "pro.kollider.xyz",
-    method: "listChannels",
+    method: PermissionMethod["WEBLN_LISTCHANNELS"],
     blocked: false,
     enabled: true,
   },
@@ -47,7 +48,7 @@ const mockPermissions = [
     allowanceId: 2,
     createdAt: "1667291216372",
     host: "lnmarkets.com",
-    method: "getinfo",
+    method: PermissionMethod["WEBLN_GETINFO"],
     blocked: false,
     enabled: true,
   },
@@ -56,7 +57,7 @@ const mockPermissions = [
     allowanceId: 2,
     createdAt: "1667291216372",
     host: "lnmarkets.com",
-    method: "some-method",
+    method: PermissionMethod["WEBLN_SIGNMESSAGE"],
     blocked: false,
     enabled: true,
   },

src/extension/background-script/actions/ln/request.ts

@@ -1,5 +1,5 @@
 import utils from "~/common/lib/utils";
-import { MessageGenericRequest } from "~/types";
+import { MessageGenericRequest, PermissionMethod } from "~/types";
 
 import db from "../../db";
 import state from "../../state";
@@ -36,7 +36,7 @@ const request = async (
     }
 
     // prefix method with webln to prevent potential naming conflicts (e.g. with nostr calls that also use the permissions)
-    const weblnMethod = `${WEBLN_PREFIX}${method}`;
+    const weblnMethod = `${WEBLN_PREFIX}${method}` as PermissionMethod;
 
     const permission = await db.permissions
       .where("host")

src/extension/background-script/actions/nostr/signEventOrPrompt.ts

@@ -1,6 +1,7 @@
 import utils from "~/common/lib/utils";
 import db from "~/extension/background-script/db";
 import { MessageSignEvent } from "~/types";
+import { PermissionMethod } from "~/types";
 
 import state from "../../state";
 import { validateEvent } from "./helpers";
@@ -22,7 +23,9 @@ const signEventOrPrompt = async (message: MessageSignEvent) => {
     .where("host")
     .equalsIgnoreCase(message.origin.host)
     .and(
-      (permission) => permission.enabled && permission.method === "signMessage"
+      (permission) =>
+        permission.enabled &&
+        permission.method === PermissionMethod["NOSTR_SIGNMESSAGE"]
     )
     .first();
 

src/extension/background-script/actions/permissions/__tests__/add.test.ts

@@ -1,5 +1,6 @@
 import db from "~/extension/background-script/db";
 import type { DbAllowance, MessagePermissionAdd } from "~/types";
+import { PermissionMethod } from "~/types";
 
 import addPermission from "../add";
 
@@ -45,7 +46,7 @@ describe("add permission", () => {
       },
       args: {
         host: stackerNews.host,
-        method: "signMessage",
+        method: PermissionMethod["WEBLN_SIGNMESSAGE"],
         enabled: true,
         blocked: false,
       },
@@ -61,7 +62,7 @@ describe("add permission", () => {
         allowanceId: 3,
         createdAt: "1487076708000",
         host: "stacker.news",
-        method: "signMessage",
+        method: PermissionMethod["WEBLN_SIGNMESSAGE"],
         blocked: false,
         enabled: true,
       },

src/extension/background-script/actions/permissions/__tests__/delete.test.ts

@@ -1,5 +1,6 @@
 import db from "~/extension/background-script/db";
 import type { MessagePermissionDelete } from "~/types";
+import { PermissionMethod } from "~/types";
 
 import deletePermission from "../delete";
 
@@ -15,7 +16,7 @@ const mockPermissions = [
     allowanceId: 3,
     createdAt: "1667291216372",
     host: stackerNews.host,
-    method: "the-request-method-1",
+    method: PermissionMethod["WEBLN_LISTCHANNELS"],
     blocked: false,
     enabled: true,
   },
@@ -24,7 +25,7 @@ const mockPermissions = [
     allowanceId: 3,
     createdAt: "1667291216372",
     host: stackerNews.host,
-    method: "the-request-method-2",
+    method: PermissionMethod["WEBLN_GETINFO"],
     blocked: false,
     enabled: true,
   },
@@ -50,7 +51,7 @@ describe("delete permission", () => {
       },
       args: {
         host: stackerNews.host,
-        method: "the-request-method-2",
+        method: PermissionMethod["WEBLN_GETINFO"],
       },
     };
 

src/types.ts

@@ -501,12 +501,19 @@ export interface Payment extends Omit<DbPayment, "id"> {
   id: number;
 }
 
+export enum PermissionMethod {
+  NOSTR_SIGNMESSAGE = "nostr/signMessage",
+  WEBLN_LISTCHANNELS = "webln/listchannels",
+  WEBLN_GETINFO = "webln/getinfo",
+  WEBLN_SIGNMESSAGE = "webln/signmessage",
+}
+
 export interface DbPermission {
   id?: number;
   createdAt: string;
   allowanceId: number;
   host: string;
-  method: "signMessage";
+  method: PermissionMethod;
   enabled: boolean;
   blocked: boolean;
 }