feat: Override Ledger transport layer (#125)

* feat: Override Ledger trasnport layer This feature mainly aims to target fullstack frameworks (ex: Next.js) allowing developers to instanciate the Account server-side or client-side.
aleph-im · Mar 13, 2023 · bcf0c14 · bcf0c14
1 parent 9db8e85
commit bcf0c14
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 5 deletions.
diff --git a/src/accounts/providers/Ledger/ethereum.ts b/src/accounts/providers/Ledger/ethereum.ts
@@ -5,6 +5,7 @@ import { Account } from "../../account";
 import { Chain, BaseMessage } from "../../../messages/message";
 import { GetVerificationBuffer } from "../../../messages";
 import { getTransport } from "./transport";
+import { JSExecutionEnvironment } from "../../../utils/env";
 
 const DERIVATION_PATH = "44'/60'/0'/0/0";
 
@@ -47,8 +48,8 @@ export class ETHLedgerAccount extends Account {
 /**
  * This method retrieves an Ethereum account from a connected Ledger device
  */
-export async function GetAccountFromLedger(): Promise<ETHLedgerAccount> {
-    const transport = await getTransport();
+export async function GetAccountFromLedger(overrideEnvironment?: JSExecutionEnvironment): Promise<ETHLedgerAccount> {
+    const transport = await getTransport(overrideEnvironment);
     const signer = new EthApp(transport);
 
     const { version } = await signer.getAppConfiguration();

diff --git a/src/accounts/providers/Ledger/transport.ts b/src/accounts/providers/Ledger/transport.ts
@@ -1,10 +1,13 @@
 import Transport from "@ledgerhq/hw-transport";
-import { isNode } from "../../../utils/env";
+import { isNode, JSExecutionEnvironment } from "../../../utils/env";
 
-export async function getTransport(): Promise<Transport> {
+export async function getTransport(overrideEnvironment?: JSExecutionEnvironment): Promise<Transport> {
     let transport;
 
-    if (isNode()) {
+    if (
+        overrideEnvironment === "node" ||
+        (isNode() && overrideEnvironment !== "browser" && overrideEnvironment !== undefined)
+    ) {
         transport = await import("@ledgerhq/hw-transport-node-hid");
     } else {
         transport = await import("@ledgerhq/hw-transport-webusb");

diff --git a/src/utils/env.ts b/src/utils/env.ts
@@ -18,3 +18,5 @@ export function isNode(): boolean {
 
     return hasNodeVersion && hasNoWindow;
 }
+
+export type JSExecutionEnvironment = "node" | "browser";
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,3 +18,5 @@ export function isNode(): boolean {

		return hasNodeVersion && hasNoWindow;
		}

		export type JSExecutionEnvironment = "node" \| "browser";