✨ (keyring-eth) [DSDK-425]: Add SignTransactionDeviceAction (#227)

LedgerHQ · Sep 2, 2024 · 6c46cde · 6c46cde
2 parents aa6aa1c + c148662
commit 6c46cde
Show file tree

Hide file tree

Showing 17 changed files with 1,261 additions and 149 deletions.
diff --git a/.changeset/serious-snails-deny.md b/.changeset/serious-snails-deny.md
@@ -0,0 +1,5 @@
+---
+"@ledgerhq/keyring-eth": patch
+---
+
+Implement SignTransactionDeviceAction
diff --git a/packages/signer/keyring-eth/src/api/app-binder/SignTransactionDeviceActionTypes.ts b/packages/signer/keyring-eth/src/api/app-binder/SignTransactionDeviceActionTypes.ts
@@ -0,0 +1,61 @@
+import {
+  ClearSignContextSuccess,
+  ContextModule,
+} from "@ledgerhq/context-module";
+import {
+  CommandErrorResult,
+  DeviceActionState,
+  ExecuteDeviceActionReturnType,
+  OpenAppDAError,
+  OpenAppDARequiredInteraction,
+  UserInteractionRequired,
+} from "@ledgerhq/device-sdk-core";
+
+import { Signature } from "@api/model/Signature";
+import { Transaction } from "@api/model/Transaction";
+import { TransactionOptions } from "@api/model/TransactionOptions";
+import { ProvideTransactionContextTaskErrorCodes } from "@internal/app-binder/task/ProvideTransactionContextTask";
+import { TransactionMapperService } from "@internal/transaction/service/mapper/TransactionMapperService";
+
+export type SignTransactionDAOutput = Signature;
+
+export type SignTransactionDAInput = {
+  readonly derivationPath: string;
+  readonly transaction: Transaction;
+  readonly mapper: TransactionMapperService;
+  readonly contextModule: ContextModule;
+  readonly options: TransactionOptions;
+};
+
+export type SignTransactionDAError =
+  | OpenAppDAError
+  | CommandErrorResult["error"]
+  | CommandErrorResult<ProvideTransactionContextTaskErrorCodes>["error"];
+
+type SignTransactionDARequiredInteraction =
+  | OpenAppDARequiredInteraction
+  | UserInteractionRequired.SignTransaction;
+
+export type SignTransactionDAIntermediateValue = {
+  requiredUserInteraction: SignTransactionDARequiredInteraction;
+};
+
+export type SignTransactionDAState = DeviceActionState<
+  SignTransactionDAOutput,
+  SignTransactionDAError,
+  SignTransactionDAIntermediateValue
+>;
+
+export type SignTransactionDAInternalState = {
+  readonly error: SignTransactionDAError | null;
+  readonly challenge: string | null;
+  readonly clearSignContexts: ClearSignContextSuccess[] | null;
+  readonly serializedTransaction: Uint8Array | null;
+  readonly signature: Signature | null;
+};
+
+export type SignTransactionDAReturnType = ExecuteDeviceActionReturnType<
+  SignTransactionDAOutput,
+  SignTransactionDAError,
+  SignTransactionDAIntermediateValue
+>;
diff --git a/...signer/keyring-eth/src/internal/app-binder/command/ProvideTokenInformationCommand.test.ts b/...signer/keyring-eth/src/internal/app-binder/command/ProvideTokenInformationCommand.test.ts
@@ -83,20 +83,6 @@ describe("ProvideTokenInformationCommand", () => {
       );
     });
 
-    it("should return an error if the response is invalid", () => {
-      // GIVEN
-      const response = {
-        statusCode: Uint8Array.from([0x90, 0x00]),
-        data: new Uint8Array(),
-      };
-
-      // WHEN
-      const result = command.parseResponse(response);
-
-      // THEN
-      expect(isSuccessCommandResult(result)).toBe(false);
-    });
-
     it("should return an error if the response is not successful", () => {
       // GIVEN
       const response = {

diff --git a/...ages/signer/keyring-eth/src/internal/app-binder/command/ProvideTokenInformationCommand.ts b/...ages/signer/keyring-eth/src/internal/app-binder/command/ProvideTokenInformationCommand.ts
@@ -10,7 +10,6 @@ import {
   CommandResultFactory,
   CommandUtils,
   GlobalCommandErrorHandler,
-  InvalidStatusWordError,
 } from "@ledgerhq/device-sdk-core";
 
 export type ProvideTokenInformationCommandArgs = {
@@ -52,12 +51,7 @@ export class ProvideTokenInformationCommand
         error: GlobalCommandErrorHandler.handle(response),
       });
     }
-    const tokenIndex = parser.extract8BitUInt();
-    if (tokenIndex === undefined) {
-      return CommandResultFactory({
-        error: new InvalidStatusWordError("tokenIndex is missing"),
-      });
-    }
+    const tokenIndex = parser.extract8BitUInt() ?? 0;
     return CommandResultFactory({ data: { tokenIndex } });
   }
 }
diff --git a/packages/signer/keyring-eth/src/internal/app-binder/command/SignEIP712Command.ts b/packages/signer/keyring-eth/src/internal/app-binder/command/SignEIP712Command.ts
@@ -79,7 +79,7 @@ export class SignEIP712Command
     }
 
     const v = parser.extract8BitUInt();
-    if (!v) {
+    if (v === undefined) {
       return CommandResultFactory({
         error: new InvalidStatusWordError("V is missing"),
       });

diff --git a/packages/signer/keyring-eth/src/internal/app-binder/command/SignPersonalMessageCommand.ts b/packages/signer/keyring-eth/src/internal/app-binder/command/SignPersonalMessageCommand.ts
@@ -69,7 +69,7 @@ export class SignPersonalMessageCommand
 
     // The data is returned only for the last chunk
     const v = parser.extract8BitUInt();
-    if (!v) {
+    if (v === undefined) {
       return CommandResultFactory({ data: Nothing });
     }
 

diff --git a/packages/signer/keyring-eth/src/internal/app-binder/command/SignTransactionCommand.ts b/packages/signer/keyring-eth/src/internal/app-binder/command/SignTransactionCommand.ts
@@ -71,7 +71,7 @@ export class SignTransactionCommand
 
     // The data is returned only for the last chunk
     const v = parser.extract8BitUInt();
-    if (!v) {
+    if (v === undefined) {
       return CommandResultFactory({ data: Nothing });
     }
 

diff --git a/...rnal/app-binder/device-action/SignPersonalMessage/SignPersonalMessageDeviceAction.test.ts b/...rnal/app-binder/device-action/SignPersonalMessage/SignPersonalMessageDeviceAction.test.ts
@@ -1,17 +1,15 @@
 import {
   CommandResultFactory,
   DeviceActionStatus,
-  OpenAppDeviceAction,
   UnknownDeviceExchangeError,
   UserInteractionRequired,
 } from "@ledgerhq/device-sdk-core";
 import { UnknownDAError } from "@ledgerhq/device-sdk-core";
 import { InvalidStatusWordError } from "@ledgerhq/device-sdk-core";
-import { Left, Right } from "purify-ts";
-import { assign, createMachine } from "xstate";
 
 import { SignPersonalMessageDAState } from "@api/index";
 import { makeDeviceActionInternalApiMock } from "@internal/app-binder/device-action/__test-utils__/makeInternalApi";
+import { setupOpenAppDAMock } from "@internal/app-binder/device-action/__test-utils__/setupOpenAppDAMock";
 import { testDeviceActionStates } from "@internal/app-binder/device-action/__test-utils__/testDeviceActionStates";
 
 import { SignPersonalMessageDeviceAction } from "./SignPersonalMessageDeviceAction";
@@ -27,32 +25,6 @@ jest.mock(
   }),
 );
 
-const setupOpenAppDAMock = (error?: unknown) => {
-  (OpenAppDeviceAction as jest.Mock).mockImplementation(() => ({
-    makeStateMachine: jest.fn().mockImplementation(() =>
-      createMachine({
-        initial: "pending",
-        states: {
-          pending: {
-            entry: assign({
-              intermediateValue: {
-                requiredUserInteraction: UserInteractionRequired.ConfirmOpenApp,
-              },
-            }),
-            after: {
-              0: "done",
-            },
-          },
-          done: {
-            type: "final",
-          },
-        },
-        output: () => (error ? Left(error) : Right(undefined)),
-      }),
-    ),
-  }));
-};
-
 describe("SignPersonalMessageDeviceAction", () => {
   const signPersonalMessageMock = jest.fn();