✨ (signer-solana): Add solana SignMessageUseCase

LedgerHQ · Nov 5, 2024 · d10d1a0 · d10d1a0
1 parent 02ec232
commit d10d1a0
Show file tree

Hide file tree

Showing 18 changed files with 851 additions and 13 deletions.
diff --git a/.changeset/tender-starfishes-cover.md b/.changeset/tender-starfishes-cover.md
@@ -0,0 +1,5 @@
+---
+"@ledgerhq/device-signer-kit-solana": patch
+---
+
+Added Solana SignMessageUseCase
diff --git a/apps/sample/src/components/SignerSolanaView/index.tsx b/apps/sample/src/components/SignerSolanaView/index.tsx
@@ -7,6 +7,9 @@ import {
   type GetAppConfigurationDAIntermediateValue,
   type GetAppConfigurationDAOutput,
   SignerSolanaBuilder,
+  type SignMessageDAError,
+  type SignMessageDAIntermediateValue,
+  type SignMessageDAOutput,
 } from "@ledgerhq/device-signer-kit-solana";
 
 import { DeviceActionsList } from "@/components/DeviceActionsView/DeviceActionsList";
@@ -52,19 +55,52 @@ export const SignerSolanaView: React.FC<{ sessionId: string }> = ({
         GetAddressDAIntermediateValue
       >,
       {
-        title: "Get app configuration",
+        title: "Sign off chain message",
         description:
-          "Perform all the actions necessary to get the Solana app configuration from the device",
-        executeDeviceAction: () => {
-          return signer.getAppConfiguration();
+          "Perform all the actions necessary to sign an off chain message with Solana app",
+        executeDeviceAction: ({ derivationPath, message }) => {
+          if (!signer) {
+            throw new Error("Signer not initialized");
+          }
+          return signer.signMessage(derivationPath, message);
+        },
+        initialValues: {
+          derivationPath: "44'/60'/0'/0/0",
+          message: "Hello World",
+        },
+        deviceModelId,
+      } satisfies DeviceActionProps<
+        SignMessageDAOutput,
+        {
+          derivationPath: string;
+          message: string;
+        },
+        SignMessageDAError,
+        SignMessageDAIntermediateValue
+      >,
+      {
+        title: "Sign off chain message",
+        description:
+          "Perform all the actions necessary to sign an off chain message with Solana app",
+        executeDeviceAction: ({ derivationPath, message }) => {
+          if (!signer) {
+            throw new Error("Signer not initialized");
+          }
+          return signer.signMessage(derivationPath, message);
+        },
+        initialValues: {
+          derivationPath: "44'/60'/0'/0/0",
+          message: "Hello World",
         },
-        initialValues: {},
         deviceModelId,
       } satisfies DeviceActionProps<
-        GetAppConfigurationDAOutput,
-        Record<string, never>,
-        GetAppConfigurationDAError,
-        GetAppConfigurationDAIntermediateValue
+        SignMessageDAOutput,
+        {
+          derivationPath: string;
+          message: string;
+        },
+        SignMessageDAError,
+        SignMessageDAIntermediateValue
       >,
     ],
     [deviceModelId, signer],

diff --git a/packages/signer/signer-solana/src/api/index.ts b/packages/signer/signer-solana/src/api/index.ts
@@ -9,5 +9,10 @@ export type {
   GetAppConfigurationDAIntermediateValue,
   GetAppConfigurationDAOutput,
 } from "@api/app-binder/GetAppConfigurationDeviceActionTypes";
+export type {
+  SignMessageDAError,
+  SignMessageDAIntermediateValue,
+  SignMessageDAOutput,
+} from "@api/app-binder/SignMessageDeviceActionTypes";
 export type { SignerSolana } from "@api/SignerSolana";
 export { SignerSolanaBuilder } from "@api/SignerSolanaBuilder";
diff --git a/packages/signer/signer-solana/src/internal/DefaultSignerSolana.test.ts b/packages/signer/signer-solana/src/internal/DefaultSignerSolana.test.ts
@@ -24,6 +24,16 @@ describe("DefaultSignerSolana", () => {
     expect(dmk.executeDeviceAction).toHaveBeenCalled();
   });
 
+  it("should call signMessage", () => {
+    const dmk = {
+      executeDeviceAction: jest.fn(),
+    } as unknown as DeviceManagementKit;
+    const sessionId = {} as DeviceSessionId;
+    const signer = new DefaultSignerSolana({ dmk, sessionId });
+    signer.signMessage("44'/60'/0'/0/0", "Hello world");
+    expect(dmk.executeDeviceAction).toHaveBeenCalled();
+  });
+
   it("should call getAppConfiguration", () => {
     const dmk = {
       executeDeviceAction: jest.fn(),

diff --git a/packages/signer/signer-solana/src/internal/DefaultSignerSolana.ts b/packages/signer/signer-solana/src/internal/DefaultSignerSolana.ts
@@ -16,6 +16,7 @@ import { type SignerSolana } from "@api/SignerSolana";
 import { type GetAddressUseCase } from "./use-cases/address/GetAddressUseCase";
 import { type GetAppConfigurationUseCase } from "./use-cases/app-configuration/GetAppConfigurationUseCase";
 import { useCasesTypes } from "./use-cases/di/useCasesTypes";
+import { type SignMessageUseCase } from "./use-cases/message/SignMessageUseCase";
 import { makeContainer } from "./di";
 
 export type DefaultSignerSolanaConstructorArgs = {
@@ -42,7 +43,9 @@ export class DefaultSignerSolana implements SignerSolana {
     _derivationPath: string,
     _message: string,
   ): SignMessageDAReturnType {
-    return {} as SignMessageDAReturnType;
+    return this._container
+      .get<SignMessageUseCase>(useCasesTypes.SignMessageUseCase)
+      .execute(_derivationPath, _message);
   }
 
   getAddress(

diff --git a/packages/signer/signer-solana/src/internal/app-binder/SolanaAppBinder.test.ts b/packages/signer/signer-solana/src/internal/app-binder/SolanaAppBinder.test.ts
@@ -1,8 +1,10 @@
 import {
+  type DeviceActionIntermediateValue,
   type DeviceActionState,
   DeviceActionStatus,
   type DeviceManagementKit,
   type DeviceSessionId,
+  type DmkError,
   SendCommandInAppDeviceAction,
   UserInteractionRequired,
 } from "@ledgerhq/device-management-kit";
@@ -20,6 +22,7 @@ import {
 } from "@api/index";
 
 import { GetPubKeyCommand } from "./command/GetPubKeyCommand";
+import { SignMessageDeviceAction } from "./device-action/SignPersonalMessage/SignMessageDeviceAction";
 import { SolanaAppBinder } from "./SolanaAppBinder";
 
 describe("SolanaAppBinder", () => {
@@ -209,4 +212,80 @@ describe("SolanaAppBinder", () => {
       });
     });
   });
+
+  describe("signMessage", () => {
+    it("should return the signed message", (done) => {
+      // GIVEN
+      const signedMessage = new Uint8Array([0x1c, 0x8a, 0x54, 0x05, 0x10]);
+      const signMessageArgs = {
+        derivationPath: "44'/501'",
+        message: "Hello world",
+      };
+
+      jest.spyOn(mockedDmk, "executeDeviceAction").mockReturnValue({
+        observable: from([
+          {
+            status: DeviceActionStatus.Completed,
+            output: signedMessage,
+          } as DeviceActionState<
+            Uint8Array,
+            DmkError,
+            DeviceActionIntermediateValue
+          >,
+        ]),
+        cancel: jest.fn(),
+      });
+
+      // WHEN
+      const appBinder = new SolanaAppBinder(mockedDmk, "sessionId");
+      const { observable } = appBinder.signMessage(signMessageArgs);
+
+      // THEN
+      const states: DeviceActionState<Uint8Array, unknown, unknown>[] = [];
+      observable.subscribe({
+        next: (state) => {
+          states.push(state);
+        },
+        error: (err) => {
+          done(err);
+        },
+        complete: () => {
+          try {
+            expect(states).toEqual([
+              {
+                status: DeviceActionStatus.Completed,
+                output: signedMessage,
+              },
+            ]);
+            done();
+          } catch (err) {
+            done(err);
+          }
+        },
+      });
+    });
+
+    it("should call executeDeviceAction with correct parameters", () => {
+      // GIVEN
+      const signMessageArgs = {
+        derivationPath: "44'/501'",
+        message: "Hello world",
+      };
+
+      // WHEN
+      const appBinder = new SolanaAppBinder(mockedDmk, "sessionId");
+      appBinder.signMessage(signMessageArgs);
+
+      // THEN
+      expect(mockedDmk.executeDeviceAction).toHaveBeenCalledWith({
+        sessionId: "sessionId",
+        deviceAction: new SignMessageDeviceAction({
+          input: {
+            derivationPath: signMessageArgs.derivationPath,
+            message: signMessageArgs.message,
+          },
+        }),
+      });
+    });
+  });
 });
diff --git a/packages/signer/signer-solana/src/internal/app-binder/SolanaAppBinder.ts b/packages/signer/signer-solana/src/internal/app-binder/SolanaAppBinder.ts
@@ -15,6 +15,7 @@ import { externalTypes } from "@internal/externalTypes";
 
 import { GetAppConfigurationCommand } from "./command/GetAppConfigurationCommand";
 import { GetPubKeyCommand } from "./command/GetPubKeyCommand";
+import { SignMessageDeviceAction } from "./device-action/SignPersonalMessage/SignMessageDeviceAction";
 
 @injectable()
 export class SolanaAppBinder {
@@ -48,11 +49,19 @@ export class SolanaAppBinder {
     return {} as SignTransactionDAReturnType;
   }
 
-  signMessage(_args: {
+  signMessage(args: {
     derivationPath: string;
     message: string;
   }): SignMessageDAReturnType {
-    return {} as SignMessageDAReturnType;
+    return this.dmk.executeDeviceAction({
+      sessionId: this.sessionId,
+      deviceAction: new SignMessageDeviceAction({
+        input: {
+          derivationPath: args.derivationPath,
+          message: args.message,
+        },
+      }),
+    });
   }
 
   getAppConfiguration(): GetAppConfigurationDAReturnType {