@faremeter/wallet-ledger 0.16.0 → 0.17.0

package/dist/src/evm.d.ts

@@ -1,4 +1,15 @@
 import { type ChainInfo } from "@faremeter/types/evm";
 import type { LedgerEvmWallet, UserInterface } from "./types.js";
+/**
+ * Creates a Ledger hardware wallet interface for EVM chains.
+ *
+ * Connects to a Ledger device and returns a wallet that can sign
+ * transactions and EIP-712 typed data.
+ *
+ * @param ui - User interface for displaying prompts and messages.
+ * @param chain - EVM chain configuration.
+ * @param derivationPath - BIP-44 derivation path (e.g., "m/44'/60'/0'/0/0").
+ * @returns A Ledger EVM wallet interface.
+ */
 export declare function createLedgerEvmWallet(ui: UserInterface, chain: ChainInfo, derivationPath: string): Promise<LedgerEvmWallet>;
 //# sourceMappingURL=evm.d.ts.map

package/dist/src/evm.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"evm.d.ts","sourceRoot":"","sources":["../../src/evm.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAGtD,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE9D,wBAAsB,qBAAqB,CACzC,EAAE,EAAE,aAAa,EACjB,KAAK,EAAE,SAAS,EAChB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,eAAe,CAAC,CAuJ1B"}
+{"version":3,"file":"evm.d.ts","sourceRoot":"","sources":["../../src/evm.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAGtD,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE9D;;;;;;;;;;GAUG;AACH,wBAAsB,qBAAqB,CACzC,EAAE,EAAE,aAAa,EACjB,KAAK,EAAE,SAAS,EAChB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,eAAe,CAAC,CAuJ1B"}

package/dist/src/evm.js

@@ -3,6 +3,17 @@ import Eth from "@ledgerhq/hw-app-eth/lib-es/Eth.js";
 import {} from "@faremeter/types/evm";
 import { type } from "arktype";
 import { createTransport } from "./transport.js";
+/**
+ * Creates a Ledger hardware wallet interface for EVM chains.
+ *
+ * Connects to a Ledger device and returns a wallet that can sign
+ * transactions and EIP-712 typed data.
+ *
+ * @param ui - User interface for displaying prompts and messages.
+ * @param chain - EVM chain configuration.
+ * @param derivationPath - BIP-44 derivation path (e.g., "m/44'/60'/0'/0/0").
+ * @returns A Ledger EVM wallet interface.
+ */
 export async function createLedgerEvmWallet(ui, chain, derivationPath) {
     const transport = await createTransport();
     const eth = new Eth(transport);

package/dist/src/index.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @title Ledger Wallet Package
+ * @sidebarTitle Wallet Ledger
+ * @description Ledger hardware wallet integration for EVM and Solana
+ * @packageDocumentation
+ */
 export { createLedgerEvmWallet } from "./evm.js";
 export { createLedgerSolanaWallet } from "./solana.js";
 export { selectLedgerAccount } from "./utils.js";

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,OAAO,CAAC;AAC9C,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAC9C,YAAY,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AACnE,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,qBAAqB,EAAE,MAAM,OAAO,CAAC;AAC9C,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAC9C,YAAY,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AACnE,cAAc,aAAa,CAAC"}

package/dist/src/index.js

@@ -1,3 +1,9 @@
+/**
+ * @title Ledger Wallet Package
+ * @sidebarTitle Wallet Ledger
+ * @description Ledger hardware wallet integration for EVM and Solana
+ * @packageDocumentation
+ */
 export { createLedgerEvmWallet } from "./evm.js";
 export { createLedgerSolanaWallet } from "./solana.js";
 export { selectLedgerAccount } from "./utils.js";

package/dist/src/interface.d.ts

@@ -1,7 +1,21 @@
+/**
+ * Arguments for creating a readline-based user interface.
+ */
 export type createReadlineInterfaceArgs = {
+    /** Input stream (typically process.stdin). */
     stdin: NodeJS.ReadableStream;
+    /** Output stream (typically process.stdout). */
     stdout: NodeJS.WritableStream;
 };
+/**
+ * Creates a readline-based user interface for Ledger interactions.
+ *
+ * Provides a simple terminal interface for displaying messages and
+ * prompting for user input during account selection.
+ *
+ * @param args - Input and output streams for the readline interface.
+ * @returns A UserInterface implementation using Node.js readline.
+ */
 export declare function createReadlineInterface(args: createReadlineInterfaceArgs): Promise<{
     message: (msg: string) => undefined;
     question: (q: string) => Promise<string>;

package/dist/src/interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interface.d.ts","sourceRoot":"","sources":["../../src/interface.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,2BAA2B,GAAG;IACxC,KAAK,EAAE,MAAM,CAAC,cAAc,CAAC;IAC7B,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC;CAC/B,CAAC;AAEF,wBAAsB,uBAAuB,CAC3C,IAAI,EAAE,2BAA2B;mBAShB,MAAM;kBACD,MAAM;;GAM7B"}
+{"version":3,"file":"interface.d.ts","sourceRoot":"","sources":["../../src/interface.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAC,cAAc,CAAC;IAC7B,gDAAgD;IAChD,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC;CAC/B,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAsB,uBAAuB,CAC3C,IAAI,EAAE,2BAA2B;mBAShB,MAAM;kBACD,MAAM;;GAM7B"}

package/dist/src/interface.js

@@ -1,3 +1,12 @@
+/**
+ * Creates a readline-based user interface for Ledger interactions.
+ *
+ * Provides a simple terminal interface for displaying messages and
+ * prompting for user input during account selection.
+ *
+ * @param args - Input and output streams for the readline interface.
+ * @returns A UserInterface implementation using Node.js readline.
+ */
 export async function createReadlineInterface(args) {
     const readline = await import("readline");
     const rl = readline.createInterface({

package/dist/src/solana.d.ts

@@ -1,3 +1,13 @@
 import type { LedgerSolanaWallet } from "./types.js";
+/**
+ * Creates a Ledger hardware wallet interface for Solana.
+ *
+ * Connects to a Ledger device and returns a wallet that can sign
+ * Solana versioned transactions.
+ *
+ * @param network - Solana network identifier (e.g., "mainnet-beta", "devnet").
+ * @param derivationPath - BIP-44 derivation path (e.g., "44'/501'/0'").
+ * @returns A Ledger Solana wallet interface.
+ */
 export declare function createLedgerSolanaWallet(network: string, derivationPath: string): Promise<LedgerSolanaWallet>;
 //# sourceMappingURL=solana.d.ts.map

package/dist/src/solana.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"solana.d.ts","sourceRoot":"","sources":["../../src/solana.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAElD,wBAAsB,wBAAwB,CAC5C,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,kBAAkB,CAAC,CA0B7B"}
+{"version":3,"file":"solana.d.ts","sourceRoot":"","sources":["../../src/solana.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAElD;;;;;;;;;GASG;AACH,wBAAsB,wBAAwB,CAC5C,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,kBAAkB,CAAC,CA6B7B"}

package/dist/src/solana.js

@@ -1,20 +1,32 @@
 import { PublicKey, VersionedTransaction } from "@solana/web3.js";
 import Solana from "@ledgerhq/hw-app-solana/lib-es/Solana.js";
 import { createTransport } from "./transport.js";
+/**
+ * Creates a Ledger hardware wallet interface for Solana.
+ *
+ * Connects to a Ledger device and returns a wallet that can sign
+ * Solana versioned transactions.
+ *
+ * @param network - Solana network identifier (e.g., "mainnet-beta", "devnet").
+ * @param derivationPath - BIP-44 derivation path (e.g., "44'/501'/0'").
+ * @returns A Ledger Solana wallet interface.
+ */
 export async function createLedgerSolanaWallet(network, derivationPath) {
     const transport = await createTransport();
     const solana = new Solana(transport);
     const { address } = await solana.getAddress(derivationPath);
     const publicKey = new PublicKey(address);
+    const signTransaction = async (tx) => {
+        const message = tx.message.serialize();
+        const signature = await solana.signTransaction(derivationPath, Buffer.from(message));
+        tx.addSignature(publicKey, signature.signature);
+        return tx;
+    };
     return {
         network,
         publicKey,
-        updateTransaction: async (tx) => {
-            const message = tx.message.serialize();
-            const signature = await solana.signTransaction(derivationPath, Buffer.from(message));
-            tx.addSignature(publicKey, signature.signature);
-            return tx;
-        },
+        partiallySignTransaction: signTransaction,
+        updateTransaction: signTransaction,
         disconnect: async () => {
             await transport.close();
         },

package/dist/src/types.d.ts

@@ -2,6 +2,9 @@ import type { Hex, TransactionSerializable, TypedDataDefinition } from "viem";
 import { evm } from "@faremeter/types";
 import type { PublicKey, VersionedTransaction } from "@solana/web3.js";
 import type Transport from "@ledgerhq/hw-transport";
+/**
+ * Ledger hardware wallet interface for EVM chains.
+ */
 export interface LedgerEvmWallet {
     chain: evm.ChainInfo;
     address: Hex;
@@ -9,9 +12,13 @@ export interface LedgerEvmWallet {
     signTypedData: (params: TypedDataDefinition) => Promise<Hex>;
     disconnect: () => Promise<void>;
 }
+/**
+ * Ledger hardware wallet interface for Solana.
+ */
 export interface LedgerSolanaWallet {
     network: string;
     publicKey: PublicKey;
+    partiallySignTransaction: (tx: VersionedTransaction) => Promise<VersionedTransaction>;
     updateTransaction: (tx: VersionedTransaction) => Promise<VersionedTransaction>;
     disconnect: () => Promise<void>;
 }
@@ -19,9 +26,18 @@ export interface LedgerTransportWrapper {
     transport: Transport;
     close: () => Promise<void>;
 }
+/**
+ * User interface abstraction for Ledger interactions.
+ *
+ * Used to display prompts and receive user input during
+ * device selection and account enumeration.
+ */
 export interface UserInterface {
+    /** Displays a message to the user. */
     message: (msg: string) => void;
+    /** Prompts the user for input and returns their response. */
     question: (prompt: string) => Promise<string>;
+    /** Closes the interface and releases resources. */
     close: () => Promise<void>;
 }
 //# sourceMappingURL=types.d.ts.map

package/dist/src/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAC9E,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,KAAK,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvE,OAAO,KAAK,SAAS,MAAM,wBAAwB,CAAC;AAEpD,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,GAAG,CAAC,SAAS,CAAC;IACrB,OAAO,EAAE,GAAG,CAAC;IACb,eAAe,EAAE,CAAC,EAAE,EAAE,uBAAuB,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/D,aAAa,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAC7D,UAAU,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,SAAS,CAAC;IACrB,iBAAiB,EAAE,CACjB,EAAE,EAAE,oBAAoB,KACrB,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACnC,UAAU,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/B,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9C,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5B"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAC9E,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,KAAK,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvE,OAAO,KAAK,SAAS,MAAM,wBAAwB,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,GAAG,CAAC,SAAS,CAAC;IACrB,OAAO,EAAE,GAAG,CAAC;IACb,eAAe,EAAE,CAAC,EAAE,EAAE,uBAAuB,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/D,aAAa,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAC7D,UAAU,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,SAAS,CAAC;IACrB,wBAAwB,EAAE,CACxB,EAAE,EAAE,oBAAoB,KACrB,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACnC,iBAAiB,EAAE,CACjB,EAAE,EAAE,oBAAoB,KACrB,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACnC,UAAU,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5B;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,sCAAsC;IACtC,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/B,6DAA6D;IAC7D,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9C,mDAAmD;IACnD,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5B"}

package/dist/src/utils.d.ts

@@ -1,4 +1,15 @@
 import type { UserInterface } from "./types.js";
+/**
+ * Interactively selects a Ledger account from the device.
+ *
+ * Enumerates accounts on the connected Ledger device and prompts the
+ * user to select one via the provided user interface.
+ *
+ * @param ui - User interface for displaying accounts and receiving selection.
+ * @param type - Account type to enumerate ("evm" or "solana").
+ * @param numAccounts - Number of accounts to scan (default: 5).
+ * @returns The selected account's derivation path and address, or null if selection cancelled.
+ */
 export declare function selectLedgerAccount(ui: UserInterface, type: "evm" | "solana", numAccounts?: number): Promise<{
     path: string;
     address: string;

package/dist/src/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAU7C,wBAAsB,mBAAmB,CACvC,EAAE,EAAE,aAAa,EACjB,IAAI,EAAE,KAAK,GAAG,QAAQ,EACtB,WAAW,SAAI,GACd,OAAO,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,CAyDnD"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAU7C;;;;;;;;;;GAUG;AACH,wBAAsB,mBAAmB,CACvC,EAAE,EAAE,aAAa,EACjB,IAAI,EAAE,KAAK,GAAG,QAAQ,EACtB,WAAW,SAAI,GACd,OAAO,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,CAyDnD"}

package/dist/src/utils.js

@@ -8,6 +8,17 @@ function evmDerivationPath(index) {
 function solanaDerivationPath(index) {
     return `44'/501'/${index}'`;
 }
+/**
+ * Interactively selects a Ledger account from the device.
+ *
+ * Enumerates accounts on the connected Ledger device and prompts the
+ * user to select one via the provided user interface.
+ *
+ * @param ui - User interface for displaying accounts and receiving selection.
+ * @param type - Account type to enumerate ("evm" or "solana").
+ * @param numAccounts - Number of accounts to scan (default: 5).
+ * @returns The selected account's derivation path and address, or null if selection cancelled.
+ */
 export async function selectLedgerAccount(ui, type, numAccounts = 5) {
     const isEvm = type === "evm";
     ui.message(`\nScanning first ${numAccounts} ${isEvm ? "Ethereum" : "Solana"} accounts...`);