@onekeyfe/hwk-ledger-adapter 1.1.26-alpha.11 → 1.1.26-alpha.13

package/dist/index.d.mts

@@ -1,6 +1,7 @@
-import { IHardwareWallet, IConnector, TransportType, UiResponseEvent, DeviceInfo, Response, ChainCapability, EvmGetAddressParams, EvmAddress, EvmSignTxParams, EvmSignedTx, EvmSignMsgParams, EvmSignature, EvmSignTypedDataParams, BtcGetAddressParams, BtcAddress, BtcGetPublicKeyParams, BtcPublicKey, BtcSignTxParams, BtcSignedTx, BtcSignPsbtParams, BtcSignedPsbt, BtcSignMsgParams, BtcSignature, SolGetAddressParams, SolAddress, SolSignTxParams, SolSignedTx, SolSignMsgParams, SolSignature, TronGetAddressParams, TronAddress, TronSignTxParams, TronSignedTx, TronSignMsgParams, TronSignature, HardwareEventMap, DeviceEventListener, ChainForFingerprint, ConnectionType, DeviceDescriptor, ConnectorDevice, ConnectorSession, ConnectorEventType, ConnectorEventMap, DeviceChangeEvent, Failure, HardwareErrorCode } from '@onekeyfe/hwk-adapter-core';
-import { DeviceManagementKit, DeviceActionState as DeviceActionState$1, DiscoveredDevice, ExecuteDeviceActionReturnType } from '@ledgerhq/device-management-kit';
+import { IHardwareWallet, IConnector, TransportType, UiResponseEvent, DeviceInfo, Response, ChainCapability, EvmGetAddressParams, EvmAddress, EvmSignTxParams, EvmSignedTx, EvmSignMsgParams, EvmSignature, EvmSignTypedDataParams, BtcGetAddressParams, BtcAddress, BtcGetPublicKeyParams, BtcPublicKey, BtcSignTxParams, BtcSignedTx, BtcSignPsbtParams, BtcSignedPsbt, BtcSignMsgParams, BtcSignature, SolGetAddressParams, SolAddress, SolSignTxParams, SolSignedTx, SolSignMsgParams, SolSignature, TronGetAddressParams, TronAddress, TronSignTxParams, TronSignedTx, TronSignMsgParams, TronSignature, HardwareEventMap, DeviceEventListener, ChainForFingerprint, DeviceDescriptor, DeviceChangeEvent, ConnectionType, ConnectorDevice, ConnectorSession, ConnectorEventType, ConnectorEventMap, Failure, HardwareErrorCode } from '@onekeyfe/hwk-adapter-core';
+import { DeviceActionState as DeviceActionState$1, DiscoveredDevice, ExecuteDeviceActionReturnType, DeviceManagementKit } from '@ledgerhq/device-management-kit';
 import { Address, Signature, SignerEth as SignerEth$1, TypedData } from '@ledgerhq/device-signer-kit-ethereum';
+import { ContextModule } from '@ledgerhq/context-module';
 import { SignerBtc as SignerBtc$1 } from '@ledgerhq/device-signer-kit-bitcoin';
 import { SignerSolana } from '@ledgerhq/device-signer-kit-solana';
 import Transport from '@ledgerhq/hw-transport';
@@ -13,16 +14,6 @@ interface LedgerAdapterOptions {
      */
     handleSelectDevice?: boolean;
 }
-/**
- * Ledger hardware wallet adapter that delegates to an IConnector.
- *
- * This is a thin translation layer that:
- * - Accepts a pre-configured IConnector (transport decisions are made at connector creation time)
- * - Translates IHardwareWallet method calls to connector.call() invocations
- * - Maps connector results/errors to our Response<T> format with enriched error messages
- * - Translates connector events to HardwareEventMap events
- * - Emits `REQUEST_DEVICE_PERMISSION` for OS-level permission checks
- */
 declare class LedgerAdapter implements IHardwareWallet {
     readonly vendor: "ledger";
     private readonly connector;
@@ -31,15 +22,10 @@ declare class LedgerAdapter implements IHardwareWallet {
     private _discoveredDevices;
     private _sessions;
     private readonly _uiRegistry;
+    private _btcHighIndexConfirmedThisSession;
     private readonly _jobQueue;
+    private _doConnectAbortController;
     constructor(connector: IConnector, options?: LedgerAdapterOptions);
-    /**
-     * Classify a method's interruptibility.
-     * - Signing / typed data / transaction → 'confirm' (user may decide via preemption UI)
-     * - Read-only queries (getAddress / getPublicKey / getMasterFingerprint) → 'safe'
-     *   (auto-cancels any pending read for the same device)
-     */
-    private static _getInterruptibility;
     get activeTransport(): TransportType | null;
     getAvailableTransports(): TransportType[];
     switchTransport(_type: TransportType): Promise<void>;
@@ -53,6 +39,11 @@ declare class LedgerAdapter implements IHardwareWallet {
     dispose(): Promise<void>;
     uiResponse(response: UiResponseEvent): void;
     searchDevices(): Promise<DeviceInfo[]>;
+    private static readonly MAX_BUSINESS_RETRY_BUDGET;
+    private static readonly STUCK_APP_RETRY_DELAY_MS;
+    private static readonly MAX_DOCONNECT_CONFIRMS;
+    private _lastCancelReason;
+    private static _createDeviceBusyError;
     connectDevice(connectId: string): Promise<Response<string>>;
     disconnectDevice(connectId: string): Promise<void>;
     getDeviceInfo(connectId: string, deviceId: string): Promise<Response<DeviceInfo>>;
@@ -109,12 +100,21 @@ declare class LedgerAdapter implements IHardwareWallet {
      * - If ANY session exists (Ledger IDs are ephemeral), reuse it.
      * - Otherwise: search → 1 device: auto-connect, multiple: ask user, 0: throw.
      */
-    private static readonly MAX_DEVICE_RETRY;
     private _connectingPromise;
     private _waitForDeviceConnect;
+    /**
+     * Decide whether a BTC pubkey call needs `showOnDevice=true` because of
+     * the BTC App's account-index policy, asking the user once per session.
+     *
+     * Returns the params to pass through (with `showOnDevice` possibly
+     * promoted), or `null` if the user declined.
+     */
+    private _gateBtcHighIndex;
+    private _waitForBtcHighIndexConfirm;
     private ensureConnected;
     private _doConnect;
     private _connectFirstOrSelect;
+    private _connectDeviceOrThrow;
     private _chooseDeviceFromList;
     /**
      * Call the connector with automatic session resolution and disconnect retry.
@@ -126,24 +126,30 @@ declare class LedgerAdapter implements IHardwareWallet {
      */
     private connectorCall;
     /**
-     * Race a promise against an abort signal. If the signal fires, rejects with the
-     * signal's reason (or a generic Error). The underlying connector.call() cannot
-     * actually be cancelled on Ledger DMK, but the caller gets the abort immediately.
+     * Race a promise against an abort signal. On abort, rejects with
+     * signal.reason → instance _lastCancelReason → generic Error('Aborted').
      */
-    private static _abortable;
+    private _abortable;
     /** Throw an AbortError if signal is already aborted. */
     private static _throwIfAborted;
     /** Actual work done under the job queue — connection, fingerprint, call, and recovery. */
     private _runConnectorCall;
+    /**
+     * Stuck-app recovery: pause for the device's UI transition, then retry once.
+     *
+     * Caller has already cleared the session + reset connector. We wait so Stax
+     * finishes its post-CloseApp animation, then go through ensureConnected +
+     * fingerprint check + call exactly once. Caller decides what to do on a
+     * second stuck-app hit.
+     */
+    private _retryAfterStuckApp;
+    private _sleepAbortable;
     /**
      * Clear stale session, reconnect, and retry the call.
      *
-     * Two-stage recovery: the inner retry first re-uses the current DMK to
-     * cut latency; if that still fails with a disconnect/timeout, the DMK
-     * itself is likely wedged (transport stuck after an abnormal teardown
-     * — process killed, USB yanked, browser kept the offscreen page across
-     * a session boundary). In that case we fully `connector.reset()` to
-     * force a fresh DMK + transport on the next round.
+     * Timeout recovery starts with a full connector reset. After an APDU
+     * timeout, DMK/transport state may still emit malformed responses; retrying
+     * on the same DMK can poison the next chain switch.
      */
     private _retryWithFreshConnection;
     /**
@@ -172,6 +178,103 @@ declare class LedgerAdapter implements IHardwareWallet {
     private connectorDeviceToDeviceInfo;
 }
 
+/**
+ * Re-export DMK types under local aliases for backward compatibility.
+ * These replace the previous duck-typed interfaces with the real SDK types.
+ */
+type DmkDiscoveredDevice = DiscoveredDevice;
+/**
+ * DMK DeviceAction — the Observable-based return type of all DMK signer methods.
+ *
+ * This is a permissive alias for `ExecuteDeviceActionReturnType` that accepts
+ * any Error and IntermediateValue generics. Signer wrapper code only cares about
+ * the Output type and the observable/cancel shape.
+ */
+type DeviceAction<T> = ExecuteDeviceActionReturnType<T, any, any>;
+/**
+ * DMK DeviceActionState — re-exported with permissive Error/IntermediateValue.
+ * The real type is a discriminated union on `status`.
+ */
+type DeviceActionState<T> = DeviceActionState$1<T, any, any>;
+/** ETH address result — re-exported from DMK for backward compatibility. */
+type SignerEvmAddress = Address;
+/** ETH signature result — re-exported from DMK for backward compatibility. */
+type SignerEvmSignature = Signature;
+/** BTC address result (WalletAddress not exported from DMK top-level). */
+interface SignerBtcAddress {
+    address: string;
+}
+
+/**
+ * Manages device discovery, connection, and session tracking.
+ * Wraps DMK's Observable APIs into simpler imperative calls.
+ */
+declare class LedgerDeviceManager {
+    private readonly _dmk;
+    private readonly _discovered;
+    private readonly _sessions;
+    private readonly _sessionToDevice;
+    private _listenSub;
+    constructor(dmk: DeviceManagementKit);
+    /**
+     * One-shot enumeration: subscribe to listenToAvailableDevices,
+     * take the first emission, unsubscribe, return DeviceDescriptors.
+     */
+    enumerate(): Promise<DeviceDescriptor[]>;
+    /**
+     * Continuous listening: tracks device connect/disconnect via diffing.
+     */
+    listen(onChange: (event: DeviceChangeEvent) => void): void;
+    stopListening(): void;
+    /**
+     * Resolve to the latest snapshot of advertising devices observed within
+     * `timeoutMs`. Rewrites `_discovered` so it tracks the live list.
+     *
+     * `listenToAvailableDevices` is a BehaviorSubject — it emits the cached
+     * list on subscribe and *only* re-emits when the list changes. A stable
+     * list of currently-advertising devices therefore produces only the
+     * subscription frame; treating that frame as "fossil to be discarded"
+     * caused devices to flicker in/out of the UI as searches alternated
+     * between "saw a change frame" and "saw only the cached frame".
+     *
+     * The window still gives a chance for the active scan to update the list
+     * (e.g. drop a peripheral that just stopped broadcasting), but if nothing
+     * changes we trust the snapshot — DMK silence on a stable list means
+     * "everything's still there".
+     */
+    getLiveDevices(timeoutMs?: number): Promise<DmkDiscoveredDevice[]>;
+    /**
+     * Trigger browser device selection (WebHID requestDevice).
+     * Starts discovery for a short period, then stops.
+     */
+    /**
+     * Start BLE discovery if not already running.
+     * Does NOT stop — DMK keeps scanning in the background so that
+     * listenToAvailableDevices() always has fresh data.
+     */
+    private _discoverySub;
+    requestDevice(): Promise<void>;
+    /** Lookup a previously-discovered device's display name. */
+    getDeviceName(deviceId: string): string | undefined;
+    /** Connect to a previously discovered device. Returns sessionId. */
+    connect(deviceId: string): Promise<string>;
+    /** Disconnect a session. */
+    disconnect(sessionId: string): Promise<void>;
+    getSessionId(deviceId: string): string | undefined;
+    getDeviceId(sessionId: string): string | undefined;
+    /** Get the underlying DMK instance (needed by SignerManager). */
+    getDmk(): DeviceManagementKit;
+    stopDiscovery(): void;
+    dispose(): void;
+    /**
+     * Tear down RxJS subscriptions and local state without closing the DMK.
+     * For light-reset paths that want to drop session state but keep the
+     * underlying transport alive for retry. Call this instead of orphaning
+     * the manager — bare null assignment leaks _listenSub / _discoverySub.
+     */
+    disposeKeepingDmk(): void;
+}
+
 /**
  * A function that lazily loads and returns the transport factory
  * for the Ledger DMK builder (e.g. webHidTransportFactory, rnBleTransportFactory).
@@ -209,16 +312,12 @@ declare class LedgerConnectorBase implements IConnector {
     readonly connectionType: ConnectionType;
     private _connectIdToPath;
     private _pathToConnectId;
-    /** Register a connectId <-> path mapping from a device descriptor. */
-    private _registerDeviceId;
     /** Get DMK path from external connectId. Falls back to connectId itself. */
     private _getPathForConnectId;
     /** Get external connectId from DMK path. Falls back to path itself. */
     private _getConnectIdForPath;
     private readonly _cancellers;
     private readonly _sessionStateSubs;
-    private _diagDeviceListSub;
-    private _diagDeviceListPrev;
     /**
      * Resolves a Ledger signer kit module by package name.
      * Override via constructor to use CJS paths for Metro (React Native).
@@ -243,6 +342,12 @@ declare class LedgerConnectorBase implements IConnector {
      * Override in subclasses to extract stable identifiers (e.g. BLE hex ID).
      */
     protected _resolveConnectId(descriptor: DeviceDescriptor): string;
+    /**
+     * Authoritative discovery for this transport. Default = enumerate snapshot
+     * (USB/HID). BLE overrides to drive from a live scan window since DMK's
+     * enumerate() cache survives peripherals going offline.
+     */
+    protected _discoverDescriptors(dm: LedgerDeviceManager): Promise<DeviceDescriptor[]>;
     searchDevices(): Promise<ConnectorDevice[]>;
     connect(deviceId?: string): Promise<ConnectorSession>;
     disconnect(sessionId: string): Promise<void>;
@@ -259,15 +364,6 @@ declare class LedgerConnectorBase implements IConnector {
     private _watchSessionState;
     private _unwatchSessionState;
     private _handleAutonomousDisconnect;
-    /**
-     * Start a long-lived listenToAvailableDevices subscription whose only job
-     * is to log every emission (with diff vs previous) so we can determine
-     * whether DMK proactively re-emits the device list when a USB device is
-     * unplugged or a BLE peripheral disappears. Pure observation — does NOT
-     * touch any cache or emit any event. See _diagDeviceListSub comment for
-     * rationale.
-     */
-    private _startDiagnosticDeviceListListen;
     call(sessionId: string, method: string, params: unknown): Promise<unknown>;
     private _dispatch;
     cancel(sessionId: string): Promise<void>;
@@ -292,8 +388,12 @@ declare class LedgerConnectorBase implements IConnector {
      */
     private _replaceSession;
     /**
-     * Light reset: clear signer/session state but keep DMK, BLE scan, and ID mapping alive.
+     * Light reset: clear signer/session state but keep DMK and ID mapping alive.
      * Used by connect() retry — we want to re-discover with the same transport.
+     *
+     * Note: drops the device manager but tears down its RxJS subs first via
+     * disposeKeepingDmk(). Bare null-assignment would leak _listenSub /
+     * _discoverySub and double-scan after the next _initManagers().
      */
     private _resetSignersAndSessions;
     private _resetAll;
@@ -307,77 +407,6 @@ declare class LedgerConnectorBase implements IConnector {
     private _wrapError;
 }
 
-/**
- * Manages device discovery, connection, and session tracking.
- * Wraps DMK's Observable APIs into simpler imperative calls.
- */
-declare class LedgerDeviceManager {
-    private readonly _dmk;
-    private readonly _discovered;
-    private readonly _sessions;
-    private readonly _sessionToDevice;
-    private _listenSub;
-    constructor(dmk: DeviceManagementKit);
-    /**
-     * One-shot enumeration: subscribe to listenToAvailableDevices,
-     * take the first emission, unsubscribe, return DeviceDescriptors.
-     */
-    enumerate(): Promise<DeviceDescriptor[]>;
-    /**
-     * Continuous listening: tracks device connect/disconnect via diffing.
-     */
-    listen(onChange: (event: DeviceChangeEvent) => void): void;
-    stopListening(): void;
-    /**
-     * Trigger browser device selection (WebHID requestDevice).
-     * Starts discovery for a short period, then stops.
-     */
-    /**
-     * Start BLE discovery if not already running.
-     * Does NOT stop — DMK keeps scanning in the background so that
-     * listenToAvailableDevices() always has fresh data.
-     */
-    private _discoverySub;
-    requestDevice(): Promise<void>;
-    /** Connect to a previously discovered device. Returns sessionId. */
-    connect(deviceId: string): Promise<string>;
-    /** Disconnect a session. */
-    disconnect(sessionId: string): Promise<void>;
-    getSessionId(deviceId: string): string | undefined;
-    getDeviceId(sessionId: string): string | undefined;
-    /** Get the underlying DMK instance (needed by SignerManager). */
-    getDmk(): DeviceManagementKit;
-    stopDiscovery(): void;
-    dispose(): void;
-}
-
-/**
- * Re-export DMK types under local aliases for backward compatibility.
- * These replace the previous duck-typed interfaces with the real SDK types.
- */
-type DmkDiscoveredDevice = DiscoveredDevice;
-/**
- * DMK DeviceAction — the Observable-based return type of all DMK signer methods.
- *
- * This is a permissive alias for `ExecuteDeviceActionReturnType` that accepts
- * any Error and IntermediateValue generics. Signer wrapper code only cares about
- * the Output type and the observable/cancel shape.
- */
-type DeviceAction<T> = ExecuteDeviceActionReturnType<T, any, any>;
-/**
- * DMK DeviceActionState — re-exported with permissive Error/IntermediateValue.
- * The real type is a discriminated union on `status`.
- */
-type DeviceActionState<T> = DeviceActionState$1<T, any, any>;
-/** ETH address result — re-exported from DMK for backward compatibility. */
-type SignerEvmAddress = Address;
-/** ETH signature result — re-exported from DMK for backward compatibility. */
-type SignerEvmSignature = Signature;
-/** BTC address result (WalletAddress not exported from DMK top-level). */
-interface SignerBtcAddress {
-    address: string;
-}
-
 /** Optional context attached to the rejection when a canceller fires. */
 interface CancelReason {
     code?: number;
@@ -393,8 +422,9 @@ interface CancelReason {
  * so upstream error classifiers can distinguish failure contexts (e.g. Blind signing
  * disabled vs. generic Invalid data).
  *
- * @param timeoutMs  Timeout in ms. Resets each time the Observable emits (device is alive).
- *                   Pass 0 to disable. Default: 30s.
+ * @param timeoutMs  Idle watchdog ms. Re-armed on each emission, paused
+ *                   during interactive pending. 0 disables. Default 65s
+ *                   (covers DMK's 60s + margin; we're a backstop only).
  * @param onRegisterCanceller  Optional callback that receives a function which, when
  *                             called, unsubscribes and cancels the underlying DeviceAction
  *                             (releases DMK's IntentQueue slot). Caller is responsible
@@ -428,8 +458,14 @@ type SignerEthBuilderFn = (args: {
     dmk: DeviceManagementKit;
     sessionId: string;
 }) => {
+    withContextModule?(contextModule: ContextModule): {
+        build(): SignerEth$1;
+    };
     build(): SignerEth$1;
 } | Promise<{
+    withContextModule?(contextModule: ContextModule): {
+        build(): SignerEth$1;
+    };
     build(): SignerEth$1;
 }>;
 /**
@@ -445,6 +481,8 @@ declare class SignerManager {
     invalidate(_sessionId: string): void;
     clearAll(): void;
     private static _defaultBuilder;
+    private static _createContextModule;
+    static wrapBlindSigningReportNonBlocking<T extends ContextModule>(contextModule: T): T;
 }
 
 type BtcWallet = Parameters<SignerBtc$1['getWalletAddress']>[0];
@@ -598,30 +636,17 @@ declare class AppManager {
     private _wait;
 }
 
-/**
- * Ledger-specific Failure: adds `appName` for "the currently-open app" — a
- * Ledger hardware concept not shared with other vendors, so it lives here
- * rather than in core's generic Failure.
- */
 type LedgerFailure = Omit<Failure, 'payload'> & {
     payload: Failure['payload'] & {
         appName?: string;
+        _tag?: string;
     };
 };
 interface WrapErrorOptions {
-    /**
-     * Fallback app name when the raw error doesn't carry `appName` itself
-     * (DMK signer errors don't). Used by mapLedgerError so downstream
-     * AppNotOpen / WrongApp / AppTooOld toasts can interpolate `{appName}`.
-     */
+    /** Fallback when err has no `appName` (DMK signer errors don't carry it). */
     defaultAppName?: string;
 }
-/**
- * Structurally compatible with `Failure`; writes `appName` only when provided,
- * so `'appName' in payload` is a reliable "has info" signal for consumers.
- */
-declare function ledgerFailure(code: HardwareErrorCode, error: string, appName?: string): LedgerFailure;
-/** Check if an error (or any error in its chain) represents a locked Ledger device. */
+declare function ledgerFailure(code: HardwareErrorCode, error: string, appName?: string, tag?: string, params?: Record<string, unknown>): LedgerFailure;
 declare function isDeviceLockedError(err: unknown): boolean;
 /**
  * Map a Ledger DMK error to a HardwareErrorCode and human-readable message.
@@ -657,4 +682,19 @@ declare function offSdkEvent(listener: SdkEventListener): void;
  */
 declare function extractBleHexId(name?: string): string | undefined;
 
-export { AppManager, type DeviceActionState, type DmkDiscoveredDevice, DmkTransport, LedgerAdapter, LedgerConnectorBase, type LedgerConnectorBaseOptions, LedgerDeviceManager, type LedgerFailure, type SdkEvent, type SdkEventListener, type SdkLogEvent, SignerBtc, type SignerBtcAddress, SignerEth, type SignerEvmAddress, type SignerEvmSignature, SignerManager, SignerSol, type TransportFactory, deviceActionToPromise, extractBleHexId, isDeviceLockedError, ledgerFailure, mapLedgerError, offSdkEvent, onSdkEvent };
+/**
+ * Ledger DMK transport identifiers that represent BLE devices.
+ *
+ * Known today:
+ * - "BLE": generic/web BLE descriptors
+ * - "RN_BLE": @ledgerhq/device-transport-kit-react-native-ble
+ *
+ * Keep the suffix check here so future DMK BLE transports (for example
+ * "FOO_BLE") are handled in one place instead of scattering string checks.
+ */
+declare function isLedgerDmkBleTransport(transport?: string): boolean;
+declare function isLedgerBleConnectionType(connectionType?: ConnectionType): boolean;
+declare function isLedgerBleDescriptor(connectionType: ConnectionType, descriptor: DeviceDescriptor): boolean;
+declare function isValidLedgerBleConnectId(connectId?: string): boolean;
+
+export { AppManager, type DeviceActionState, type DmkDiscoveredDevice, DmkTransport, LedgerAdapter, LedgerConnectorBase, type LedgerConnectorBaseOptions, LedgerDeviceManager, type LedgerFailure, type SdkEvent, type SdkEventListener, type SdkLogEvent, SignerBtc, type SignerBtcAddress, SignerEth, type SignerEvmAddress, type SignerEvmSignature, SignerManager, SignerSol, type TransportFactory, deviceActionToPromise, extractBleHexId, isDeviceLockedError, isLedgerBleConnectionType, isLedgerBleDescriptor, isLedgerDmkBleTransport, isValidLedgerBleConnectId, ledgerFailure, mapLedgerError, offSdkEvent, onSdkEvent };