🩹 (signer-eth): Provide web3checks with generic parser context

LedgerHQ · Feb 3, 2025 · 6e943ad · 6e943ad
1 parent 31b6056
commit 6e943ad
Show file tree

Hide file tree

Showing 8 changed files with 87 additions and 9 deletions.
diff --git a/packages/signer/context-module/src/DefaultContextModule.ts b/packages/signer/context-module/src/DefaultContextModule.ts
@@ -13,6 +13,7 @@ import { type NftContextLoader } from "./nft/domain/NftContextLoader";
 import { type ContextLoader } from "./shared/domain/ContextLoader";
 import {
   type ClearSignContext,
+  type ClearSignContextSuccess,
   ClearSignContextType,
 } from "./shared/model/ClearSignContext";
 import {
@@ -106,7 +107,7 @@ export class DefaultContextModule implements ContextModule {
 
   public async getWeb3Checks(
     transactionContext: Web3CheckContext,
-  ): Promise<ClearSignContext | null> {
+  ): Promise<ClearSignContextSuccess<ClearSignContextType.WEB3_CHECK> | null> {
     const web3Checks = await this._web3CheckLoader.load(transactionContext);
 
     if (web3Checks.isLeft()) {

diff --git a/packages/signer/signer-eth/src/api/app-binder/SignTransactionDeviceActionTypes.ts b/packages/signer/signer-eth/src/api/app-binder/SignTransactionDeviceActionTypes.ts
@@ -1,5 +1,6 @@
 import {
   type ClearSignContextSuccess,
+  type ClearSignContextType,
   type ContextModule,
 } from "@ledgerhq/context-module";
 import {
@@ -52,7 +53,7 @@ export type SignTransactionDAInternalState = {
   readonly error: SignTransactionDAError | null;
   readonly challenge: string | null;
   readonly clearSignContexts: ClearSignContextSuccess[] | GenericContext | null;
-  readonly web3Check: ClearSignContextSuccess | null;
+  readonly web3Check: ClearSignContextSuccess<ClearSignContextType.WEB3_CHECK> | null;
   readonly serializedTransaction: Uint8Array | null;
   readonly chainId: number | null;
   readonly transactionType: TransactionType | null;

diff --git a/...-eth/src/internal/app-binder/device-action/SignTransaction/SignTransactionDeviceAction.ts b/...-eth/src/internal/app-binder/device-action/SignTransaction/SignTransactionDeviceAction.ts
@@ -1,5 +1,6 @@
 import {
   type ClearSignContextSuccess,
+  type ClearSignContextType,
   type ContextModule,
 } from "@ledgerhq/context-module";
 import {
@@ -78,7 +79,7 @@ export type MachineDependencies = {
   readonly provideContext: (arg0: {
     input: {
       clearSignContexts: ClearSignContextSuccess[];
-      web3Check: ClearSignContextSuccess | null;
+      web3Check: ClearSignContextSuccess<ClearSignContextType.WEB3_CHECK> | null;
     };
   }) => Promise<Maybe<CommandErrorResult<EthErrorCodes>>>;
   readonly provideGenericContext: (arg0: {
@@ -89,6 +90,7 @@ export type MachineDependencies = {
       derivationPath: string;
       serializedTransaction: Uint8Array;
       context: GenericContext;
+      web3Check: ClearSignContextSuccess<ClearSignContextType.WEB3_CHECK> | null;
     };
   }) => Promise<
     Maybe<CommandErrorResult<ProvideTransactionGenericContextTaskErrorCodes>>
@@ -389,6 +391,7 @@ export class SignTransactionDeviceAction extends XStateDeviceAction<
                 context._internalState.serializedTransaction!,
               context: context._internalState
                 .clearSignContexts as GenericContext,
+              web3Check: context._internalState.web3Check,
             }),
             onDone: {
               actions: assign({
@@ -499,7 +502,7 @@ export class SignTransactionDeviceAction extends XStateDeviceAction<
     const provideContext = async (arg0: {
       input: {
         clearSignContexts: ClearSignContextSuccess[];
-        web3Check: ClearSignContextSuccess | null;
+        web3Check: ClearSignContextSuccess<ClearSignContextType.WEB3_CHECK> | null;
       };
     }) =>
       new ProvideTransactionContextTask(internalApi, {
@@ -515,6 +518,7 @@ export class SignTransactionDeviceAction extends XStateDeviceAction<
         derivationPath: string;
         serializedTransaction: Uint8Array;
         context: GenericContext;
+        web3Check: ClearSignContextSuccess<ClearSignContextType.WEB3_CHECK> | null;
       };
     }) =>
       new ProvideTransactionGenericContextTask(internalApi, {
@@ -524,6 +528,7 @@ export class SignTransactionDeviceAction extends XStateDeviceAction<
         derivationPath: arg0.input.derivationPath,
         serializedTransaction: arg0.input.serializedTransaction,
         context: arg0.input.context,
+        web3Check: arg0.input.web3Check,
       }).run();
 
     const signTransaction = async (arg0: {

diff --git a/packages/signer/signer-eth/src/internal/app-binder/task/GetWeb3CheckTask.test.ts b/packages/signer/signer-eth/src/internal/app-binder/task/GetWeb3CheckTask.test.ts
@@ -107,6 +107,36 @@ describe("GetWeb3CheckTask", () => {
           error: new InvalidStatusWordError("error"),
         });
       });
+
+      it("should return null if the type is not a ClearSignContextSuccess web3check", async () => {
+        // GIVEN
+        mapperMock.mapTransactionToSubset.mockReturnValue(
+          Right({ subset: {}, serializedTransaction: new Uint8Array() }),
+        );
+        apiMock.sendCommand.mockResolvedValueOnce(
+          CommandResultFactory({ data: { web3ChecksEnabled: true } }),
+        );
+        apiMock.sendCommand.mockResolvedValueOnce(
+          CommandResultFactory({ data: { address: "address" } }),
+        );
+        contextModuleMock.getWeb3Checks.mockResolvedValue({
+          type: "invalid-type",
+          id: 1,
+        });
+
+        // WHEN
+        const result = await new GetWeb3CheckTask(apiMock, {
+          contextModule: contextModuleMock as unknown as ContextModule,
+          mapper: mapperMock as unknown as TransactionMapperService,
+          transaction,
+          derivationPath,
+        }).run();
+
+        // THEN
+        expect(result).toEqual({
+          web3Check: null,
+        });
+      });
     });
 
     describe("success", () => {

diff --git a/packages/signer/signer-eth/src/internal/app-binder/task/GetWeb3CheckTask.ts b/packages/signer/signer-eth/src/internal/app-binder/task/GetWeb3CheckTask.ts
@@ -18,7 +18,7 @@ import { type TransactionMapperService } from "@internal/transaction/service/map
 
 export type GetWeb3CheckTaskResult =
   | {
-      readonly web3Check: ClearSignContextSuccess | null;
+      readonly web3Check: ClearSignContextSuccess<ClearSignContextType.WEB3_CHECK> | null;
     }
   | {
       readonly web3Check: null;
@@ -90,7 +90,7 @@ export class GetWeb3CheckTask {
 
     if (
       web3CheckContext === null ||
-      web3CheckContext?.type === ClearSignContextType.ERROR
+      web3CheckContext?.type !== ClearSignContextType.WEB3_CHECK
     ) {
       return {
         web3Check: null,

diff --git a/packages/signer/signer-eth/src/internal/app-binder/task/ProvideTransactionContextTask.ts b/packages/signer/signer-eth/src/internal/app-binder/task/ProvideTransactionContextTask.ts
@@ -31,7 +31,7 @@ export type ProvideTransactionContextTaskArgs = {
    * The valid clear sign contexts offerred by the `BuildTrancationContextTask`.
    */
   clearSignContexts: ClearSignContextSuccess[];
-  web3Check: ClearSignContextSuccess | null;
+  web3Check: ClearSignContextSuccess<ClearSignContextType.WEB3_CHECK> | null;
 };
 
 /**

diff --git a/...gner/signer-eth/src/internal/app-binder/task/ProvideTransactionGenericContextTask.test.ts b/...gner/signer-eth/src/internal/app-binder/task/ProvideTransactionGenericContextTask.test.ts
@@ -1,7 +1,7 @@
 import {
   type ClearSignContextSuccess,
   type ClearSignContextSuccessType,
-  type ClearSignContextType,
+  ClearSignContextType,
   type ContextModule,
   type PkiCertificate,
 } from "@ledgerhq/context-module";
@@ -52,6 +52,7 @@ describe("ProvideTransactionGenericContextTask", () => {
     chainId,
     transactionParser,
     contextModule,
+    web3Check: null,
   };
 
   const apiMock = makeDeviceActionInternalApiMock();
@@ -293,5 +294,39 @@ describe("ProvideTransactionGenericContextTask", () => {
       // THEN
       expect(apiMock.sendCommand).toHaveBeenCalledTimes(1);
     });
+
+    it("should load the web3 check certificate", async () => {
+      // GIVEN
+      const web3Check: ClearSignContextSuccess = {
+        type: ClearSignContextType.WEB3_CHECK,
+        certificate: {
+          keyUsageNumber: 0,
+          payload: new Uint8Array([0x12, 0x34]),
+        },
+        payload: "0x01020304",
+      };
+      jest.spyOn(SendCommandInChunksTask.prototype, "run").mockResolvedValue(
+        CommandResultFactory({
+          data: "0x1234",
+        }),
+      );
+      jest.spyOn(SendPayloadInChunksTask.prototype, "run").mockResolvedValue(
+        CommandResultFactory({
+          data: "0x5678",
+        }),
+      );
+      jest
+        .spyOn(ProvideTransactionFieldDescriptionTask.prototype, "run")
+        .mockResolvedValue(Nothing);
+
+      // WHEN
+      await new ProvideTransactionGenericContextTask(apiMock, {
+        ...defaultArgs,
+        web3Check,
+      }).run();
+
+      // THEN
+      expect(apiMock.sendCommand).toHaveBeenCalledTimes(3);
+    });
   });
 });
diff --git a/...es/signer/signer-eth/src/internal/app-binder/task/ProvideTransactionGenericContextTask.ts b/...es/signer/signer-eth/src/internal/app-binder/task/ProvideTransactionGenericContextTask.ts
@@ -40,6 +40,7 @@ export type ProvideTransactionGenericContextTaskArgs = {
   readonly derivationPath: string;
   readonly serializedTransaction: Uint8Array;
   readonly context: GenericContext;
+  readonly web3Check: ClearSignContextSuccess<ClearSignContextType.WEB3_CHECK> | null;
 };
 
 export type ProvideTransactionGenericContextTaskErrorCodes =
@@ -100,8 +101,13 @@ export class ProvideTransactionGenericContextTask {
       return Just(transactionInfoResult);
     }
 
+    // If there is a web3 check, add it to the transactionField array
+    const fields = this.args.web3Check
+      ? [...this.args.context.transactionFields, this.args.web3Check]
+      : this.args.context.transactionFields;
+
     // Provide the transaction field description and according metadata reference
-    for (const field of this.args.context.transactionFields) {
+    for (const field of fields) {
       const result = await new ProvideTransactionFieldDescriptionTask(
         this.api,
         {