feat: implements static decrypt notifications & getMetadata utils

WalletConnect · Nov 29, 2023 · 2e6a0a2 · 2e6a0a2
1 parent 5b78ef9
commit 2e6a0a2
Show file tree

Hide file tree

Showing 6 changed files with 68 additions and 2 deletions.
diff --git a/packages/web3wallet/src/client.ts b/packages/web3wallet/src/client.ts
@@ -2,6 +2,7 @@ import EventEmitter from "events";
 import { CLIENT_CONTEXT } from "./constants";
 import { Engine } from "./controllers";
 import { IWeb3Wallet, Web3WalletTypes } from "./types";
+import { Notifications } from "./utils";
 
 export class Web3Wallet extends IWeb3Wallet {
   public name: IWeb3Wallet["name"];
@@ -10,6 +11,7 @@ export class Web3Wallet extends IWeb3Wallet {
   public events: IWeb3Wallet["events"] = new EventEmitter();
   public engine: IWeb3Wallet["engine"];
   public metadata: IWeb3Wallet["metadata"];
+  public static notifications: Web3WalletTypes.INotifications = Notifications;
 
   static async init(opts: Web3WalletTypes.Options) {
     const client = new Web3Wallet(opts);
@@ -173,6 +175,15 @@ export class Web3Wallet extends IWeb3Wallet {
     }
   };
 
+  public registerDeviceToken: IWeb3Wallet["registerDeviceToken"] = (params) => {
+    try {
+      return this.engine.registerDeviceToken(params);
+    } catch (error: any) {
+      this.logger.error(error.message);
+      throw error;
+    }
+  };
+
   // ---------- Private ----------------------------------------------- //
 
   private async initialize() {

diff --git a/packages/web3wallet/src/controllers/engine.ts b/packages/web3wallet/src/controllers/engine.ts
@@ -98,6 +98,11 @@ export class Engine extends IWeb3WalletEngine {
     return this.authClient.formatMessage(params, iss);
   };
 
+  // Push //
+  public registerDeviceToken: IWeb3WalletEngine["registerDeviceToken"] = (params) => {
+    return this.client.core.echo.registerDeviceToken(params);
+  };
+
   // ---------- Private ----------------------------------------------- //
 
   private onSessionRequest = (event: Web3WalletTypes.SessionRequest) => {

diff --git a/packages/web3wallet/src/types/client.ts b/packages/web3wallet/src/types/client.ts
@@ -1,8 +1,9 @@
 import EventEmmiter, { EventEmitter } from "events";
-import { ICore, ProposalTypes, Verify } from "@walletconnect/types";
+import { ICore, CoreTypes, ProposalTypes, Verify } from "@walletconnect/types";
 import { AuthClientTypes } from "@walletconnect/auth-client";
 import { IWeb3WalletEngine } from "./engine";
 import { Logger } from "@walletconnect/logger";
+import { JsonRpcPayload, JsonRpcRequest } from "@walletconnect/jsonrpc-utils";
 
 export declare namespace Web3WalletTypes {
   type Event = "session_proposal" | "session_request" | "session_delete" | "auth_request";
@@ -41,7 +42,21 @@ export declare namespace Web3WalletTypes {
     name?: string;
   }
 
-  type Metadata = AuthClientTypes.Metadata;
+  type Metadata = CoreTypes.Metadata;
+
+  interface INotifications {
+    decryptMessage: (params: {
+      topic: string;
+      encryptedMessage: string;
+      storageOptions?: CoreTypes.Options["storageOptions"];
+      storage?: CoreTypes.Options["storage"];
+    }) => Promise<JsonRpcPayload>;
+    getMetadata: (params: {
+      topic: string;
+      storageOptions?: CoreTypes.Options["storageOptions"];
+      storage?: CoreTypes.Options["storage"];
+    }) => Promise<CoreTypes.Metadata>;
+  }
 }
 
 export abstract class IWeb3WalletEvents extends EventEmmiter {
@@ -104,6 +119,8 @@ export abstract class IWeb3Wallet {
   public abstract respondAuthRequest: IWeb3WalletEngine["respondAuthRequest"];
   public abstract getPendingAuthRequests: IWeb3WalletEngine["getPendingAuthRequests"];
   public abstract formatMessage: IWeb3WalletEngine["formatMessage"];
+  // push
+  public abstract registerDeviceToken: IWeb3WalletEngine["registerDeviceToken"];
 
   // ---------- Event Handlers ----------------------------------------------- //
   public abstract on: <E extends Web3WalletTypes.Event>(

diff --git a/packages/web3wallet/src/types/engine.ts b/packages/web3wallet/src/types/engine.ts
@@ -83,4 +83,12 @@ export abstract class IWeb3WalletEngine {
 
   // format payload to message string
   public abstract formatMessage(payload: AuthEngineTypes.CacaoRequestPayload, iss: string): string;
+
+  // ---------- Push ------------------------------------------------- //
+  public abstract registerDeviceToken(params: {
+    clientId: string;
+    token: string;
+    notificationType: "fcm" | "apns" | "apns-sandbox" | "noop";
+    enableAlwaysDecrypted?: boolean;
+  }): Promise<void>;
 }
diff --git a/packages/web3wallet/src/utils/index.ts b/packages/web3wallet/src/utils/index.ts
@@ -0,0 +1 @@
+export * from "./notifications";
diff --git a/packages/web3wallet/src/utils/notifications.ts b/packages/web3wallet/src/utils/notifications.ts
@@ -0,0 +1,24 @@
+import { Core } from "@walletconnect/core";
+import { Web3WalletTypes } from "../types";
+import { SessionStore } from "@walletconnect/sign-client";
+
+export const Notifications: Web3WalletTypes.INotifications = {
+  decryptMessage: async (params) => {
+    const core = new Core({
+      storageOptions: params.storageOptions,
+      storage: params.storage,
+    });
+    await core.crypto.init();
+    return core.crypto.decode(params.topic, params.encryptedMessage);
+  },
+  getMetadata: async (params) => {
+    const core = new Core({
+      storageOptions: params.storageOptions,
+      storage: params.storage,
+    });
+    const sessionStore = new SessionStore(core, core.logger);
+    await sessionStore.init();
+    const session = sessionStore.get(params.topic);
+    return session?.peer.metadata;
+  },
+};