[Coin Fmk] Simplify use of SignerContext (#6844)

* feat: simplify SignerContext generic signature

Signed-off-by: Stéphane Prohaszka <[email protected]>

* chore: changeset

Signed-off-by: Stéphane Prohaszka <[email protected]>

* chore: missing Algorand optimisation

Signed-off-by: Stéphane Prohaszka <[email protected]>

* fix: lint issue

Signed-off-by: Stéphane Prohaszka <[email protected]>

---------

Signed-off-by: Stéphane Prohaszka <[email protected]>

.changeset/old-snakes-hide.md

@@ -0,0 +1,11 @@
+---
+"@ledgerhq/coin-framework": minor
+"@ledgerhq/coin-algorand": patch
+"@ledgerhq/coin-polkadot": patch
+"@ledgerhq/coin-solana": patch
+"@ledgerhq/coin-near": patch
+"@ledgerhq/coin-evm": patch
+"@ledgerhq/live-common": patch
+---
+
+Simplify SignerContext generic signature

libs/coin-framework/src/signer.ts

@@ -2,4 +2,4 @@
 // The transport is passed to the method provided and then closed.
 // So we can't keep an instance depending on the transport, as it will usefull outside of the `job`.
 export type PassthroughFn<T, U> = (signer: T) => Promise<U>;
-export type SignerContext<T, U> = (deviceId: string, fn: PassthroughFn<T, U>) => Promise<U>;
+export type SignerContext<T> = <U>(deviceId: string, fn: PassthroughFn<T, U>) => Promise<U>;

libs/coin-modules/coin-algorand/src/bridge/js.ts

@@ -24,11 +24,9 @@ import {
   toOperationExtraRaw,
 } from "../serialization";
 import type { Transaction } from "../types";
-import { AlgorandAddress, AlgorandSignature, AlgorandSigner } from "../signer";
+import { AlgorandSigner } from "../signer";
 
-export function buildCurrencyBridge(
-  signerContext: SignerContext<AlgorandSigner, AlgorandAddress | AlgorandSignature>,
-): CurrencyBridge {
+export function buildCurrencyBridge(signerContext: SignerContext<AlgorandSigner>): CurrencyBridge {
   const getAddress = resolver(signerContext);
 
   const scanAccounts = makeScanAccounts({
@@ -44,7 +42,7 @@ export function buildCurrencyBridge(
 }
 
 export function buildAccountBridge(
-  signerContext: SignerContext<AlgorandSigner, AlgorandAddress | AlgorandSignature>,
+  signerContext: SignerContext<AlgorandSigner>,
 ): AccountBridge<Transaction> {
   const getAddress = resolver(signerContext);
 
@@ -70,9 +68,7 @@ export function buildAccountBridge(
   };
 }
 
-export function createBridges(
-  signerContext: SignerContext<AlgorandSigner, AlgorandAddress | AlgorandSignature>,
-) {
+export function createBridges(signerContext: SignerContext<AlgorandSigner>) {
   return {
     currencyBridge: buildCurrencyBridge(signerContext),
     accountBridge: buildAccountBridge(signerContext),

libs/coin-modules/coin-algorand/src/hw-getAddress.ts

@@ -1,15 +1,11 @@
 import { GetAddressFn } from "@ledgerhq/coin-framework/bridge/getAddressWrapper";
 import { SignerContext } from "@ledgerhq/coin-framework/signer";
 import { GetAddressOptions } from "@ledgerhq/coin-framework/derivation";
-import { AlgorandAddress, AlgorandSignature, AlgorandSigner } from "./signer";
+import { AlgorandSigner } from "./signer";
 
-const resolver = (
-  signerContext: SignerContext<AlgorandSigner, AlgorandAddress | AlgorandSignature>,
-): GetAddressFn => {
+const resolver = (signerContext: SignerContext<AlgorandSigner>): GetAddressFn => {
   return async (deviceId: string, { path, verify }: GetAddressOptions) => {
-    const r = (await signerContext(deviceId, signer =>
-      signer.getAddress(path, verify || false),
-    )) as AlgorandAddress;
+    const r = await signerContext(deviceId, signer => signer.getAddress(path, verify || false));
     return {
       address: r.address,
       publicKey: r.publicKey,

libs/coin-modules/coin-algorand/src/js-signOperation.ts

@@ -9,17 +9,15 @@ import { SignerContext } from "@ledgerhq/coin-framework/signer";
 import { BigNumber } from "bignumber.js";
 import { Observable } from "rxjs";
 import { buildTransactionPayload, encodeToBroadcast, encodeToSign } from "./buildTransaction";
-import type { AlgorandAddress, AlgorandSignature, AlgorandSigner } from "./signer";
+import type { AlgorandSigner } from "./signer";
 import type { Transaction, AlgorandOperation } from "./types";
 import { encodeOperationId } from "@ledgerhq/coin-framework/operation";
 
 /**
  * Sign Transaction with Ledger hardware
  */
 export const buildSignOperation =
-  (
-    signerContext: SignerContext<AlgorandSigner, AlgorandAddress | AlgorandSignature>,
-  ): SignOperationFnSignature<Transaction> =>
+  (signerContext: SignerContext<AlgorandSigner>): SignOperationFnSignature<Transaction> =>
   ({
     account,
     transaction,
@@ -45,9 +43,9 @@ export const buildSignOperation =
 
         o.next({ type: "device-signature-requested" });
 
-        const { signature } = (await signerContext(deviceId, signer =>
+        const { signature } = await signerContext(deviceId, signer =>
           signer.sign(freshAddressPath, toSign),
-        )) as AlgorandSignature;
+        );
 
         if (cancelled) return;
 

libs/coin-modules/coin-evm/src/__tests__/unit/hw-getAddress.unit.test.ts

@@ -1,6 +1,6 @@
 import eip55 from "eip55";
 import { getCryptoCurrencyById } from "@ledgerhq/cryptoassets/currencies";
-import type { EvmAddress, EvmSignature, EvmSigner } from "../../types/signer";
+import type { EvmSigner } from "../../types/signer";
 import resolver from "../../hw-getAddress";
 
 const address = "0xc3f95102D5c8F2c83e49Ce3Acfb905eDfb7f37dE";
@@ -10,10 +10,7 @@ const spy = jest.fn().mockImplementation(async () =>
     address: address.toLowerCase(),
   }),
 );
-const mockSignerFactory = (
-  _: string,
-  fn: (signer: EvmSigner) => Promise<EvmAddress | EvmSignature>,
-): Promise<EvmAddress | EvmSignature> =>
+const mockSignerFactory = <T>(_: string, fn: (signer: EvmSigner) => Promise<T>): Promise<T> =>
   fn({
     getAddress: spy,
   } as any);

libs/coin-modules/coin-evm/src/__tests__/unit/signOperation.unit.test.ts

@@ -3,7 +3,7 @@ import { Account } from "@ledgerhq/types-live";
 import { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
 import { SignerContext } from "@ledgerhq/coin-framework/signer";
 import { getCryptoCurrencyById, listCryptoCurrencies } from "@ledgerhq/cryptoassets";
-import type { EvmAddress, EvmSignature, EvmSigner } from "../../types/signer";
+import type { EvmSigner } from "../../types/signer";
 import { buildSignOperation, applyEIP155 } from "../../signOperation";
 import { Transaction as EvmTransaction } from "../../types";
 import { makeAccount } from "../fixtures/common.fixtures";
@@ -44,9 +44,9 @@ const transactionEIP1559: EvmTransaction = {
 
 const estimatedFees = getEstimatedFees(transactionEIP1559);
 
-const mockSignerContext: SignerContext<EvmSigner, EvmAddress | EvmSignature> = (
+const mockSignerContext: SignerContext<EvmSigner> = <T>(
   _: string,
-  fn: (signer: EvmSigner) => Promise<EvmAddress | EvmSignature>,
+  fn: (signer: EvmSigner) => Promise<T>,
 ) => {
   return fn({
     setLoadConfig: jest.fn(),

libs/coin-modules/coin-evm/src/bridge/js.ts

@@ -7,7 +7,7 @@ import {
 import { SignerContext } from "@ledgerhq/coin-framework/signer";
 import type { AccountBridge, Bridge, CurrencyBridge } from "@ledgerhq/types-live";
 import getAddressWrapper from "@ledgerhq/coin-framework/bridge/getAddressWrapper";
-import type { EvmAddress, EvmSignature, EvmSigner } from "../types/signer";
+import type { EvmSigner } from "../types/signer";
 import type { Transaction as EvmTransaction } from "../types/index";
 import { estimateMaxSpendable } from "../estimateMaxSpendable";
 import { getTransactionStatus } from "../getTransactionStatus";
@@ -21,9 +21,7 @@ import { broadcast } from "../broadcast";
 import resolver from "../hw-getAddress";
 import { setCoinConfig, type CoinConfig } from "../config";
 
-export function buildCurrencyBridge(
-  signerContext: SignerContext<EvmSigner, EvmAddress | EvmSignature>,
-): CurrencyBridge {
+export function buildCurrencyBridge(signerContext: SignerContext<EvmSigner>): CurrencyBridge {
   const getAddress = resolver(signerContext);
 
   const scanAccounts = makeScanAccounts({
@@ -43,7 +41,7 @@ export function buildCurrencyBridge(
 }
 
 export function buildAccountBridge(
-  signerContext: SignerContext<EvmSigner, EvmAddress | EvmSignature>,
+  signerContext: SignerContext<EvmSigner>,
 ): AccountBridge<EvmTransaction> {
   const getAddress = resolver(signerContext);
 
@@ -64,7 +62,7 @@ export function buildAccountBridge(
 }
 
 export function createBridges(
-  signerContext: SignerContext<EvmSigner, EvmAddress | EvmSignature>,
+  signerContext: SignerContext<EvmSigner>,
   coinConfig: CoinConfig,
 ): Bridge<EvmTransaction> {
   setCoinConfig(coinConfig);

libs/coin-modules/coin-evm/src/hw-getAddress.ts

@@ -2,15 +2,13 @@ import eip55 from "eip55";
 import { SignerContext } from "@ledgerhq/coin-framework/signer";
 import { GetAddressOptions } from "@ledgerhq/coin-framework/derivation";
 import { GetAddressFn } from "@ledgerhq/coin-framework/bridge/getAddressWrapper";
-import { EvmAddress, EvmSignature, EvmSigner } from "./types/signer";
+import { EvmSigner } from "./types/signer";
 
-const resolver = (
-  signerContext: SignerContext<EvmSigner, EvmAddress | EvmSignature>,
-): GetAddressFn => {
+const resolver = (signerContext: SignerContext<EvmSigner>): GetAddressFn => {
   return async (deviceId: string, { path, verify, currency }: GetAddressOptions) => {
-    const { address, publicKey, chainCode } = (await signerContext(deviceId, signer =>
+    const { address, publicKey, chainCode } = await signerContext(deviceId, signer =>
       signer.getAddress(path, verify, false, currency?.ethereumLikeInfo?.chainId.toString()),
-    )) as EvmAddress;
+    );
 
     return {
       address: eip55.encode(address),

libs/coin-modules/coin-evm/src/hw-signMessage.ts

@@ -2,7 +2,7 @@ import { ethers } from "ethers";
 import { SignerContext } from "@ledgerhq/coin-framework/signer";
 import { isEIP712Message } from "@ledgerhq/evm-tools/message/EIP712/index";
 import { Account, AnyMessage, DeviceId, TypedEvmMessage } from "@ledgerhq/types-live";
-import { EvmSignature, EvmSigner } from "./types/signer";
+import { EvmSigner } from "./types/signer";
 
 export const prepareMessageToSign = ({ message }: { message: string }): TypedEvmMessage => {
   const parsedMessage = ((): string | Record<string, unknown> => {
@@ -37,7 +37,7 @@ export const prepareMessageToSign = ({ message }: { message: string }): TypedEvm
 };
 
 export const signMessage =
-  (signerContext: SignerContext<EvmSigner, EvmSignature>) =>
+  (signerContext: SignerContext<EvmSigner>) =>
   async (
     deviceId: DeviceId,
     account: Account,

libs/coin-modules/coin-evm/src/signOperation.ts

@@ -10,7 +10,7 @@ import { SignerContext } from "@ledgerhq/coin-framework/signer";
 import { isNFTActive } from "@ledgerhq/coin-framework/nft/support";
 import type { LoadConfig, ResolutionConfig } from "@ledgerhq/hw-app-eth/lib/services/types";
 import { buildOptimisticOperation } from "./buildOptimisticOperation";
-import { EvmAddress, EvmSignature, EvmSigner } from "./types/signer";
+import { EvmSignature, EvmSigner } from "./types/signer";
 import { prepareForSignOperation } from "./prepareTransaction";
 import { getSerializedTransaction } from "./transaction";
 import { Transaction } from "./types";
@@ -45,9 +45,7 @@ export const applyEIP155 = (vAsHex: string, chainId: number): number => {
  * Sign Transaction with Ledger hardware
  */
 export const buildSignOperation =
-  (
-    signerContext: SignerContext<EvmSigner, EvmAddress | EvmSignature>,
-  ): SignOperationFnSignature<Transaction> =>
+  (signerContext: SignerContext<EvmSigner>): SignOperationFnSignature<Transaction> =>
   ({
     account,
     deviceId,

libs/coin-modules/coin-near/src/bridge/js.ts

@@ -16,12 +16,10 @@ import broadcast from "../js-broadcast";
 import estimateMaxSpendable from "../js-estimateMaxSpendable";
 import { preload, hydrate, getPreloadStrategy } from "../preload";
 import { assignToAccountRaw, assignFromAccountRaw } from "../serialization";
-import { NearAddress, NearSignature, NearSigner } from "../signer";
+import { NearSigner } from "../signer";
 import { NearCoinConfig, setCoinConfig } from "../config";
 
-export function buildCurrencyBridge(
-  signerContext: SignerContext<NearSigner, NearAddress | NearSignature>,
-): CurrencyBridge {
+export function buildCurrencyBridge(signerContext: SignerContext<NearSigner>): CurrencyBridge {
   const getAddress = resolver(signerContext);
 
   const scanAccounts = makeScanAccounts({
@@ -38,7 +36,7 @@ export function buildCurrencyBridge(
 }
 
 export function buildAccountBridge(
-  signerContext: SignerContext<NearSigner, NearAddress | NearSignature>,
+  signerContext: SignerContext<NearSigner>,
 ): AccountBridge<Transaction> {
   const getAddress = resolver(signerContext);
 
@@ -61,7 +59,7 @@ export function buildAccountBridge(
 }
 
 export function createBridges(
-  signerContext: SignerContext<NearSigner, NearAddress | NearSignature>,
+  signerContext: SignerContext<NearSigner>,
   coinConfig: NearCoinConfig,
 ) {
   setCoinConfig(coinConfig);

libs/coin-modules/coin-near/src/hw-getAddress.ts

@@ -1,15 +1,11 @@
 import { GetAddressFn } from "@ledgerhq/coin-framework/bridge/getAddressWrapper";
 import { SignerContext } from "@ledgerhq/coin-framework/signer";
 import { GetAddressOptions } from "@ledgerhq/coin-framework/derivation";
-import { NearAddress, NearSignature, NearSigner } from "./signer";
+import { NearSigner } from "./signer";
 
-const resolver = (
-  signerContext: SignerContext<NearSigner, NearAddress | NearSignature>,
-): GetAddressFn => {
+const resolver = (signerContext: SignerContext<NearSigner>): GetAddressFn => {
   return async (deviceId: string, { path, verify }: GetAddressOptions) => {
-    const r = (await signerContext(deviceId, signer =>
-      signer.getAddress(path, verify || false),
-    )) as NearAddress;
+    const r = await signerContext(deviceId, signer => signer.getAddress(path, verify || false));
     return {
       address: r.address,
       publicKey: r.publicKey,

libs/coin-modules/coin-near/src/js-signOperation.ts

@@ -13,7 +13,7 @@ import type {
 } from "@ledgerhq/types-live";
 import { encodeOperationId } from "@ledgerhq/coin-framework/operation";
 import { buildTransaction } from "./js-buildTransaction";
-import { NearAddress, NearSignature, NearSigner } from "./signer";
+import { NearSigner } from "./signer";
 import { SignerContext } from "@ledgerhq/coin-framework/signer";
 
 const buildOptimisticOperation = (
@@ -61,9 +61,7 @@ const buildOptimisticOperation = (
  * Sign Transaction with Ledger hardware
  */
 export const buildSignOperation =
-  (
-    signerContext: SignerContext<NearSigner, NearAddress | NearSignature>,
-  ): SignOperationFnSignature<Transaction> =>
+  (signerContext: SignerContext<NearSigner>): SignOperationFnSignature<Transaction> =>
   ({
     account,
     transaction,
@@ -81,14 +79,14 @@ export const buildSignOperation =
           throw new FeeNotLoaded();
         }
 
-        const { publicKey } = (await signerContext(deviceId, signer =>
+        const { publicKey } = await signerContext(deviceId, signer =>
           signer.getAddress(account.freshAddressPath),
-        )) as NearAddress;
+        );
         const unsigned = await buildTransaction(account, transaction, publicKey);
 
-        const response = (await signerContext(deviceId, signer =>
+        const response = await signerContext(deviceId, signer =>
           signer.signTransaction(unsigned.encode(), account.freshAddressPath),
-        )) as NearSignature;
+        );
 
         const signedTransaction = new nearAPI.transactions.SignedTransaction({
           transaction: unsigned,

libs/coin-modules/coin-polkadot/src/bridge/index.ts

@@ -7,12 +7,7 @@ import {
 } from "@ledgerhq/coin-framework/bridge/jsHelpers";
 import { SignerContext } from "@ledgerhq/coin-framework/signer";
 import type { AccountBridge, CurrencyBridge } from "@ledgerhq/types-live";
-import {
-  PolkadotSigner,
-  type PolkadotAddress,
-  type PolkadotSignature,
-  type Transaction,
-} from "../types";
+import { PolkadotSigner, type Transaction } from "../types";
 import signerGetAddress from "../signer";
 import broadcast from "./broadcast";
 import createTransaction from "./createTransaction";
@@ -29,9 +24,7 @@ import {
 } from "./serialization";
 import { getPreloadStrategy, hydrate, preload } from "./preload";
 
-function buildCurrencyBridge(
-  signerContext: SignerContext<PolkadotSigner, PolkadotAddress | PolkadotSignature>,
-): CurrencyBridge {
+function buildCurrencyBridge(signerContext: SignerContext<PolkadotSigner>): CurrencyBridge {
   const getAddress = signerGetAddress(signerContext);
 
   const scanAccounts = makeScanAccounts({
@@ -48,7 +41,7 @@ function buildCurrencyBridge(
 }
 
 function buildAccountBridge(
-  signerContext: SignerContext<PolkadotSigner, PolkadotAddress | PolkadotSignature>,
+  signerContext: SignerContext<PolkadotSigner>,
 ): AccountBridge<Transaction> {
   const getAddress = signerGetAddress(signerContext);
 
@@ -73,9 +66,7 @@ function buildAccountBridge(
   };
 }
 
-export function createBridges(
-  signerContext: SignerContext<PolkadotSigner, PolkadotAddress | PolkadotSignature>,
-) {
+export function createBridges(signerContext: SignerContext<PolkadotSigner>) {
   return {
     currencyBridge: buildCurrencyBridge(signerContext),
     accountBridge: buildAccountBridge(signerContext),