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

package/dist/index.d.mts

@@ -51,10 +51,19 @@ declare enum HardwareErrorCode {
      * permission" toast and let the user retry manually.
      */
     DevicePermissionDenied = 10303,
+    /**
+     * BLE SMP pairing did not complete within the GATT bonding window.
+     * GATT connected but the device didn't acknowledge SMP — typically
+     * because the user didn't confirm the passkey on the device, or the
+     * device went out of range mid-pairing. Distinct from OperationTimeout
+     * (generic) and from DeviceLocked (Secure Element actually locked).
+     */
+    BlePairingTimeout = 10304,
     PinInvalid = 10400,
     PinCancelled = 10401,
     PassphraseRejected = 10402,
-    AppNotOpen = 10500,
+    /** Chain app NOT INSTALLED on device. User must install via Ledger Live. */
+    AppNotInstalled = 10500,
     WrongApp = 10501,
     /** 0x911c Command code not supported — app predates current SDK. */
     AppTooOld = 10502,
@@ -80,6 +89,18 @@ declare enum HardwareErrorCode {
     /** 0xb007 Aborted due to unexpected state (malformed PSBT / missing UTXO). */
     BtcUnexpectedState = 11301
 }
+/**
+ * Device-level failures the SDK cannot self-recover from — affect the entire
+ * batch (vs per-chain failures like AppNotInstalled / WrongApp which soft-
+ * skip in onboarding). Combined with `accounts.length === 0`, signals
+ * genuine orphan. Also reused as the batch-abort whitelist for HWK.
+ * Single source of truth.
+ *
+ * UserRejected (device-side reject) is included: pressing reject is an
+ * explicit "I don't consent" — continuing the batch to ask again on the
+ * next chain is harassment, not helpful.
+ */
+declare const ORPHAN_ELIGIBLE_ERROR_CODES: number[];
 
 interface Success<T> {
     success: true;
@@ -90,11 +111,12 @@ interface Failure {
     payload: {
         error: string;
         code: HardwareErrorCode;
+        params?: Record<string, unknown>;
     };
 }
 type Response<T> = Success<T> | Failure;
 declare function success<T>(payload: T): Success<T>;
-declare function failure(code: HardwareErrorCode, error: string): Failure;
+declare function failure(code: HardwareErrorCode, error: string, params?: Record<string, unknown>): Failure;
 
 type VendorType = 'trezor' | 'ledger';
 type ConnectionType = 'usb' | 'ble';
@@ -436,90 +458,6 @@ declare const DEVICE: {
     readonly CHANGED: "device-changed";
 };
 
-/** 10 min — every UI request is human-in-the-loop; bias toward "wait long". */
-declare const UI_REQUEST_DEFAULT_TIMEOUT_MS = 600000;
-declare const UI_REQUEST_PREEMPTED_TAG = "UiRequestPreempted";
-declare const UI_REQUEST_CANCELLED_TAG = "UiRequestCancelled";
-declare const UI_REQUEST_TIMEOUT_TAG = "UiRequestTimeout";
-/**
- * Per-type single-slot registry for adapter-level UI requests. A new `wait`
- * of the same type preempts (rejects) the prior one. Unknown response types
- * are dropped silently so the public `uiResponse` entry never throws.
- */
-declare class UiRequestRegistry {
-    private pending;
-    wait<T = unknown>(requestType: string, options?: {
-        timeoutMs?: number;
-    }): Promise<T>;
-    resolve(responseType: string, payload: unknown): void;
-    cancel(requestType?: string): void;
-    reset(): void;
-    hasPending(requestType?: string): boolean;
-}
-
-/**
- * Per-device serial job queue with preemption support and stuck recovery.
- * Ensures that only one operation runs at a time per device, with intelligent
- * handling of conflicting operations.
- *
- * The 'confirm' level uses the standard UI request/response flow:
- * emits REQUEST_PREEMPTION → waits for RECEIVE_PREEMPTION via UiRequestRegistry.
- */
-
-type Interruptibility = 'none' | 'safe' | 'confirm';
-type PreemptionDecision = 'cancel-current' | 'wait' | 'reject-new';
-interface JobOptions {
-    interruptibility?: Interruptibility;
-    label?: string;
-}
-interface ActiveJobInfo {
-    label?: string;
-    interruptibility: Interruptibility;
-    startedAt: number;
-}
-interface PreemptionEvent {
-    deviceId: string;
-    currentJob: ActiveJobInfo;
-    newJob: {
-        label?: string;
-        interruptibility: Interruptibility;
-    };
-}
-interface DeviceJobQueueDeps {
-    /** Emit a UI request event to the frontend. */
-    emit: (event: string, data: unknown) => void;
-    /** Registry for waiting on UI responses. */
-    uiRegistry: UiRequestRegistry;
-}
-declare class DeviceJobQueue {
-    private readonly _queues;
-    private readonly _active;
-    private readonly _deps;
-    /** Incremented on clear() so stale queued jobs can detect invalidation. */
-    private _generation;
-    constructor(deps?: DeviceJobQueueDeps);
-    /**
-     * Enqueue a job for a specific device.
-     * If a job is already running for this device, behavior depends on interruptibility:
-     * - 'none': new job queues silently (no preemption possible)
-     * - 'safe': current job is auto-cancelled, new job runs immediately after
-     * - 'confirm': emits REQUEST_PREEMPTION and waits for UI response
-     */
-    enqueue<T>(deviceId: string, job: (signal: AbortSignal) => Promise<T>, options?: JobOptions): Promise<T>;
-    /** Manually cancel the active job on a device. Returns false if job is non-interruptible. */
-    cancelActive(deviceId: string): boolean;
-    /** Force cancel regardless of interruptibility. `reason` becomes signal.reason. */
-    forceCancelActive(deviceId: string, reason?: Error): boolean;
-    /** Get info about the currently active job for a device, or null if idle. */
-    getActiveJob(deviceId: string): ActiveJobInfo | null;
-    clear(): void;
-    /**
-     * Request preemption decision via UI request/response flow.
-     * Falls back to 'wait' if deps are not provided.
-     */
-    private _requestPreemptionDecision;
-}
-
 declare const UI_EVENT = "UI_EVENT";
 declare const UI_REQUEST: {
     readonly REQUEST_PIN: "ui-request-pin";
@@ -531,7 +469,7 @@ declare const UI_REQUEST: {
     readonly REQUEST_DEVICE_PERMISSION: "ui-request-device-permission";
     readonly REQUEST_SELECT_DEVICE: "ui-request-select-device";
     readonly REQUEST_DEVICE_CONNECT: "ui-request-device-connect";
-    readonly REQUEST_PREEMPTION: "ui-request-preemption";
+    readonly REQUEST_BTC_HIGH_INDEX_CONFIRM: "ui-request-btc-high-index-confirm";
     readonly CLOSE_UI_WINDOW: "ui-close";
     readonly DEVICE_PROGRESS: "ui-device_progress";
     readonly FIRMWARE_PROGRESS: "ui-firmware-progress";
@@ -545,9 +483,15 @@ declare const UI_RESPONSE: {
     readonly RECEIVE_SELECT_DEVICE: "receive-select-device";
     readonly RECEIVE_DEVICE_CONNECT: "receive-device-connect";
     readonly RECEIVE_DEVICE_PERMISSION: "receive-device-permission";
-    readonly RECEIVE_PREEMPTION: "receive-preemption";
+    readonly RECEIVE_BTC_HIGH_INDEX_CONFIRM: "receive-btc-high-index-confirm";
     readonly CANCEL: "cancel";
 };
+type DevicePermissionDeniedReason = 'bluetoothTurnedOff' | 'permissionDenied' | (string & Record<never, never>);
+type DevicePermissionResponse = {
+    granted: boolean;
+    reason?: DevicePermissionDeniedReason;
+    message?: string;
+};
 type UiResponseEvent = {
     type: typeof UI_RESPONSE.RECEIVE_PIN;
     payload: string;
@@ -576,13 +520,11 @@ type UiResponseEvent = {
     };
 } | {
     type: typeof UI_RESPONSE.RECEIVE_DEVICE_PERMISSION;
-    payload: {
-        granted: boolean;
-    };
+    payload: DevicePermissionResponse;
 } | {
-    type: typeof UI_RESPONSE.RECEIVE_PREEMPTION;
+    type: typeof UI_RESPONSE.RECEIVE_BTC_HIGH_INDEX_CONFIRM;
     payload: {
-        decision: PreemptionDecision;
+        confirmed: boolean;
     };
 } | {
     type: typeof UI_RESPONSE.CANCEL;
@@ -619,6 +561,8 @@ type ConnectorEventType = 'device-connect' | 'device-disconnect' | 'ui-request'
  * These map to user-facing prompts (confirm on device, open app, etc.).
  */
 declare enum EConnectorInteraction {
+    /** Adapter is actively searching for the device (no session yet) */
+    Searching = "searching",
     /** Device requires user to open a specific app */
     ConfirmOpenApp = "confirm-open-app",
     /** Device requires user to unlock */
@@ -629,6 +573,11 @@ declare enum EConnectorInteraction {
     InteractionComplete = "interaction-complete"
 }
 type ConnectorUiEvent = {
+    type: EConnectorInteraction.Searching;
+    payload: {
+        sessionId: string;
+    };
+} | {
     type: EConnectorInteraction.ConfirmOpenApp;
     payload: {
         sessionId: string;
@@ -795,18 +744,23 @@ type UiRequestEvent = {
 } | {
     type: typeof UI_REQUEST.REQUEST_DEVICE_CONNECT;
     payload: {
+        /** Vendor that emitted the request, e.g. 'ledger', 'trezor'. */
+        vendor: string;
+        /**
+         * Why the SDK is asking for a reconnect. Lets the app render
+         * vendor-aware copy without inspecting message strings.
+         * - 'device-not-found': search returned 0 / device not reachable.
+         * Future values can be added (e.g. 'pairing-failed') as new fallback
+         * causes are surfaced.
+         */
+        reason: string;
+        /**
+         * Best-effort English fallback. Apps should prefer rendering via
+         * `vendor` + `reason` for i18n; fall back to this if the combination
+         * isn't recognized.
+         */
         message: string;
     };
-} | {
-    type: typeof UI_REQUEST.REQUEST_PREEMPTION;
-    payload: {
-        deviceId: string;
-        currentJob: ActiveJobInfo;
-        newJob: {
-            label?: string;
-            interruptibility: Interruptibility;
-        };
-    };
 } | {
     type: typeof UI_REQUEST.CLOSE_UI_WINDOW;
     payload: Record<string, never>;
@@ -912,18 +866,17 @@ interface HardwareEventMap {
     [UI_REQUEST.REQUEST_DEVICE_CONNECT]: {
         type: typeof UI_REQUEST.REQUEST_DEVICE_CONNECT;
         payload: {
+            vendor: string;
+            reason: string;
             message: string;
         };
     };
-    [UI_REQUEST.REQUEST_PREEMPTION]: {
-        type: typeof UI_REQUEST.REQUEST_PREEMPTION;
+    [UI_REQUEST.REQUEST_BTC_HIGH_INDEX_CONFIRM]: {
+        type: typeof UI_REQUEST.REQUEST_BTC_HIGH_INDEX_CONFIRM;
         payload: {
-            deviceId: string;
-            currentJob: ActiveJobInfo;
-            newJob: {
-                label?: string;
-                interruptibility: Interruptibility;
-            };
+            vendor: string;
+            path: string;
+            accountIndex: number;
         };
     };
     [UI_REQUEST.CLOSE_UI_WINDOW]: {
@@ -1001,10 +954,16 @@ interface DeviceDescriptor {
     vendor?: number;
     /** Device type/model identifier */
     type?: string;
-    /** BLE device name (e.g., "Nano X 123A") — contains stable 4-digit HEX suffix */
+    /** Human-readable display name from the transport layer. */
     name?: string;
+    /** Stable Ledger BLE identifier from the raw RN BLE `Device.name` field. */
+    bleName?: string;
+    /** User-visible Ledger BLE local name from the raw RN BLE `Device.localName` field. */
+    localName?: string;
     /** Transport identifier (e.g., 'WEB-HID', 'BLE') */
     transport?: string;
+    /** BLE RSSI when provided by the transport scanner. */
+    rssi?: number | null;
 }
 interface DeviceConnectEvent {
     type: 'device-connected';
@@ -1016,6 +975,53 @@ interface DeviceDisconnectEvent {
 }
 type DeviceChangeEvent = DeviceConnectEvent | DeviceDisconnectEvent;
 
+/**
+ * Pure FIFO job queue. Every enqueue chains onto the tail; jobs run one at
+ * a time across all devices. The queue is intentionally passive — it does
+ * NOT decide whether to interrupt or ask the user. Those are application-
+ * layer concerns owned by the caller (e.g. a UI button handler that wants
+ * to ask "device is busy, interrupt current?" before submitting). The
+ * queue exposes inspection (`getActiveJob`) and explicit cancellation
+ * (`cancelActive` / `cancelAll`) so callers can implement those policies
+ * synchronously, without racing against in-flight enqueues.
+ */
+interface JobOptions {
+    label?: string;
+    rejectIfBusy?: boolean;
+    busyError?: Error;
+}
+interface ActiveJobInfo {
+    deviceId: string;
+    label?: string;
+    startedAt: number;
+}
+declare class DeviceJobQueue {
+    private _tail;
+    private _active;
+    private readonly _jobs;
+    /** Incremented on clear() so queued-but-not-yet-running jobs detect invalidation. */
+    private _generation;
+    private readonly _generationCancelReasons;
+    /**
+     * Enqueue a job. Runs after every previously-enqueued job has settled.
+     * `deviceId` is a label only — used by inspection / cancellation routing.
+     */
+    enqueue<T>(deviceId: string, job: (signal: AbortSignal) => Promise<T>, options?: JobOptions): Promise<T>;
+    /** Cancel the active job. If `deviceId` is given, only cancels when it matches. */
+    cancelActive(deviceId?: string): boolean;
+    /** Force cancel the active job. `reason` becomes signal.reason. */
+    forceCancelActive(deviceId?: string, reason?: Error): boolean;
+    /** Cancel the active job (alias for callers that previously needed multi-device cancel). */
+    cancelAllActive(reason?: Error): void;
+    /** Cancel the active job and invalidate queued jobs that have not started. */
+    cancelActiveAndPending(deviceId?: string, reason?: Error): boolean;
+    /** Get info about the currently active job, or null if idle. */
+    getActiveJob(deviceId?: string): ActiveJobInfo | null;
+    /** True if any job is currently running. */
+    isBusy(): boolean;
+    clear(reason?: Error): void;
+}
+
 /**
  * Minimal typed event emitter using Map<string, Set<listener>>.
  * Each adapter uses this for device events (connect, disconnect, pin, etc.).
@@ -1040,6 +1046,32 @@ declare class TypedEventEmitter<TMap extends Record<string, any> = Record<string
     removeAllListeners(): void;
 }
 
+/** 10 min — every UI request is human-in-the-loop; bias toward "wait long". */
+declare const UI_REQUEST_DEFAULT_TIMEOUT_MS = 600000;
+declare const UI_REQUEST_PREEMPTED_TAG = "UiRequestPreempted";
+declare const UI_REQUEST_CANCELLED_TAG = "UiRequestCancelled";
+declare const UI_REQUEST_TIMEOUT_TAG = "UiRequestTimeout";
+/**
+ * Per-type single-slot registry for adapter-level UI requests. A new `wait`
+ * of the same type supersedes (rejects) the prior pending entry. With the
+ * job queue running globally serially, cross-type collisions don't occur in
+ * normal flow — same-type preemption is a defensive measure for callers
+ * that fire the same request twice without waiting on the first.
+ *
+ * Unknown response types are dropped silently so the public `uiResponse`
+ * entry never throws.
+ */
+declare class UiRequestRegistry {
+    private pending;
+    wait<T = unknown>(requestType: string, options?: {
+        timeoutMs?: number;
+    }): Promise<T>;
+    resolve(responseType: string, payload: unknown): void;
+    cancel(requestType?: string): void;
+    reset(): void;
+    hasPending(requestType?: string): boolean;
+}
+
 /**
  * Compare two semver strings (e.g. "2.1.0" vs "2.3.1").
  * Returns -1 if a < b, 0 if equal, 1 if a > b.
@@ -1075,4 +1107,4 @@ declare function batchCall<TParam, TResult>(params: TParam[], callFn: (p: TParam
     total: number;
 }) => void): Promise<Response<TResult[]>>;
 
-export { type ActiveJobInfo, type BtcAddress, type BtcGetAddressParams, type BtcGetPublicKeyParams, type BtcPublicKey, type BtcRefTransaction, type BtcSignMsgParams, type BtcSignPsbtParams, type BtcSignTxParams, type BtcSignature, type BtcSignedPsbt, type BtcSignedTx, type BtcTxInput, type BtcTxOutput, CHAIN_FINGERPRINT_PATHS, type ChainCapability, type ChainForFingerprint, type ConnectionType, type ConnectorDevice, type ConnectorEventMap, type ConnectorEventType, type ConnectorSession, type ConnectorUiEvent, DEVICE, DEVICE_EVENT, type DeviceCapabilities, type DeviceChangeEvent, type DeviceConnectEvent, type DeviceDescriptor, type DeviceDisconnectEvent, type DeviceEvent, type DeviceEventListener, type DeviceInfo, DeviceJobQueue, type DeviceJobQueueDeps, type DeviceTarget, EConnectorInteraction, type EIP712Domain, type EvmAddress, type EvmGetAddressParams, type EvmSignMsgParams, type EvmSignTxParams, type EvmSignTypedDataFull, type EvmSignTypedDataHash, type EvmSignTypedDataParams, type EvmSignature, type EvmSignedTx, type Failure, HardwareErrorCode, type HardwareEvent, type HardwareEventMap, type IBtcMethods, type IConnector, type IEvmMethods, type IHardwareBridge, type IHardwareWallet, type ISolMethods, type ITronMethods, type Interruptibility, type JobOptions, type PassphraseResponse, type PreemptionDecision, type PreemptionEvent, type QrDisplayData, type QrResponseData, type Response, SDK, type SdkEvent, type SolAddress, type SolGetAddressParams, type SolSignMsgParams, type SolSignTxParams, type SolSignature, type SolSignedTx, type Success, type TransportType, type TronAddress, type TronGetAddressParams, type TronSignMsgParams, type TronSignTxParams, type TronSignature, type TronSignedTx, TypedEventEmitter, UI_EVENT, UI_REQUEST, UI_REQUEST_CANCELLED_TAG, UI_REQUEST_DEFAULT_TIMEOUT_MS, UI_REQUEST_PREEMPTED_TAG, UI_REQUEST_TIMEOUT_TAG, UI_RESPONSE, type UiRequestEvent, UiRequestRegistry, type UiResponseEvent, type VendorType, batchCall, bytesToHex, compareSemver, createBridgedConnector, deriveDeviceFingerprint, enrichErrorMessage, ensure0x, failure, hexToBytes, padHex64, stripHex, success };
+export { type ActiveJobInfo, type BtcAddress, type BtcGetAddressParams, type BtcGetPublicKeyParams, type BtcPublicKey, type BtcRefTransaction, type BtcSignMsgParams, type BtcSignPsbtParams, type BtcSignTxParams, type BtcSignature, type BtcSignedPsbt, type BtcSignedTx, type BtcTxInput, type BtcTxOutput, CHAIN_FINGERPRINT_PATHS, type ChainCapability, type ChainForFingerprint, type ConnectionType, type ConnectorDevice, type ConnectorEventMap, type ConnectorEventType, type ConnectorSession, type ConnectorUiEvent, DEVICE, DEVICE_EVENT, type DeviceCapabilities, type DeviceChangeEvent, type DeviceConnectEvent, type DeviceDescriptor, type DeviceDisconnectEvent, type DeviceEvent, type DeviceEventListener, type DeviceInfo, DeviceJobQueue, type DevicePermissionDeniedReason, type DevicePermissionResponse, type DeviceTarget, EConnectorInteraction, type EIP712Domain, type EvmAddress, type EvmGetAddressParams, type EvmSignMsgParams, type EvmSignTxParams, type EvmSignTypedDataFull, type EvmSignTypedDataHash, type EvmSignTypedDataParams, type EvmSignature, type EvmSignedTx, type Failure, HardwareErrorCode, type HardwareEvent, type HardwareEventMap, type IBtcMethods, type IConnector, type IEvmMethods, type IHardwareBridge, type IHardwareWallet, type ISolMethods, type ITronMethods, type JobOptions, ORPHAN_ELIGIBLE_ERROR_CODES, type PassphraseResponse, type QrDisplayData, type QrResponseData, type Response, SDK, type SdkEvent, type SolAddress, type SolGetAddressParams, type SolSignMsgParams, type SolSignTxParams, type SolSignature, type SolSignedTx, type Success, type TransportType, type TronAddress, type TronGetAddressParams, type TronSignMsgParams, type TronSignTxParams, type TronSignature, type TronSignedTx, TypedEventEmitter, UI_EVENT, UI_REQUEST, UI_REQUEST_CANCELLED_TAG, UI_REQUEST_DEFAULT_TIMEOUT_MS, UI_REQUEST_PREEMPTED_TAG, UI_REQUEST_TIMEOUT_TAG, UI_RESPONSE, type UiRequestEvent, UiRequestRegistry, type UiResponseEvent, type VendorType, batchCall, bytesToHex, compareSemver, createBridgedConnector, deriveDeviceFingerprint, enrichErrorMessage, ensure0x, failure, hexToBytes, padHex64, stripHex, success };