@bytezhang/hardware-trezor-adapter 0.0.7 → 0.0.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytezhang/hardware-trezor-adapter",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "Trezor hardware wallet adapter using IConnector abstraction",
   "author": "OneKey",
   "license": "MIT",

package/dist/index.d.mts

@@ -1,198 +0,0 @@
-import { IHardwareWallet, IConnector, TransportType, IUiHandler, DeviceInfo, Response, ChainCapability, HardwareEventMap, DeviceEventListener, ChainForFingerprint, EvmGetAddressParams, EvmAddress, ProgressCallback, EvmGetPublicKeyParams, EvmPublicKey, EvmSignTxParams, EvmSignedTx, EvmSignMsgParams, EvmSignature, EvmSignTypedDataParams, BtcGetAddressParams, BtcAddress, BtcGetPublicKeyParams, BtcPublicKey, BtcSignTxParams, BtcSignedTx, BtcSignMsgParams, BtcSignature, SolGetAddressParams, SolAddress, SolGetPublicKeyParams, SolPublicKey, SolSignTxParams, SolSignedTx, SolSignMsgParams, SolSignature } from '@bytezhang/hardware-wallet-core';
-import { AbstractProxyClient } from '@bytezhang/hardware-transport-core';
-
-/**
- * Trezor 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
- * - Integrates with IUiHandler for interactive flows (PIN, passphrase)
- */
-declare class TrezorAdapter implements IHardwareWallet {
-    readonly vendor: "trezor";
-    private readonly connector;
-    private readonly emitter;
-    private _uiHandler;
-    private _discoveredDevices;
-    private _sessions;
-    constructor(connector: IConnector);
-    get activeTransport(): TransportType | null;
-    getAvailableTransports(): TransportType[];
-    switchTransport(_type: TransportType): Promise<void>;
-    setUiHandler(handler: Partial<IUiHandler>): void;
-    init(_config?: unknown): Promise<void>;
-    dispose(): Promise<void>;
-    searchDevices(): Promise<DeviceInfo[]>;
-    connectDevice(connectId: string): Promise<Response<string>>;
-    disconnectDevice(connectId: string): Promise<void>;
-    getDeviceInfo(connectId: string, deviceId: string): Promise<Response<DeviceInfo>>;
-    getSupportedChains(): ChainCapability[];
-    on<K extends keyof HardwareEventMap>(event: K, listener: (event: HardwareEventMap[K]) => void): void;
-    on(event: string, listener: DeviceEventListener): void;
-    off<K extends keyof HardwareEventMap>(event: K, listener: (event: HardwareEventMap[K]) => void): void;
-    off(event: string, listener: DeviceEventListener): void;
-    cancel(connectId: string): void;
-    /**
-     * For Trezor, the chain fingerprint is the hardware device_id from firmware.
-     * Trezor has a persistent device identity, so no address derivation is needed.
-     */
-    getChainFingerprint(connectId: string, deviceId: string, _chain: ChainForFingerprint): Promise<Response<string>>;
-    evmGetAddress(connectId: string, _deviceId: string, params: EvmGetAddressParams): Promise<Response<EvmAddress>>;
-    evmGetAddresses(connectId: string, deviceId: string, params: EvmGetAddressParams[], onProgress?: ProgressCallback): Promise<Response<EvmAddress[]>>;
-    evmGetPublicKey(connectId: string, _deviceId: string, params: EvmGetPublicKeyParams): Promise<Response<EvmPublicKey>>;
-    evmSignTransaction(connectId: string, _deviceId: string, params: EvmSignTxParams): Promise<Response<EvmSignedTx>>;
-    evmSignMessage(connectId: string, _deviceId: string, params: EvmSignMsgParams): Promise<Response<EvmSignature>>;
-    evmSignTypedData(connectId: string, _deviceId: string, params: EvmSignTypedDataParams): Promise<Response<EvmSignature>>;
-    btcGetAddress(connectId: string, _deviceId: string, params: BtcGetAddressParams): Promise<Response<BtcAddress>>;
-    btcGetAddresses(connectId: string, deviceId: string, params: BtcGetAddressParams[], onProgress?: ProgressCallback): Promise<Response<BtcAddress[]>>;
-    btcGetPublicKey(connectId: string, _deviceId: string, params: BtcGetPublicKeyParams): Promise<Response<BtcPublicKey>>;
-    btcSignTransaction(connectId: string, _deviceId: string, params: BtcSignTxParams): Promise<Response<BtcSignedTx>>;
-    btcSignMessage(connectId: string, _deviceId: string, params: BtcSignMsgParams): Promise<Response<BtcSignature>>;
-    btcGetMasterFingerprint(connectId: string, _deviceId: string): Promise<Response<{
-        masterFingerprint: string;
-    }>>;
-    solGetAddress(connectId: string, _deviceId: string, params: SolGetAddressParams): Promise<Response<SolAddress>>;
-    solGetAddresses(connectId: string, deviceId: string, params: SolGetAddressParams[], onProgress?: ProgressCallback): Promise<Response<SolAddress[]>>;
-    solGetPublicKey(connectId: string, _deviceId: string, params: SolGetPublicKeyParams): Promise<Response<SolPublicKey>>;
-    solSignTransaction(connectId: string, _deviceId: string, params: SolSignTxParams): Promise<Response<SolSignedTx>>;
-    solSignMessage(_connectId: string, _deviceId: string, _params: SolSignMsgParams): Promise<Response<SolSignature>>;
-    /**
-     * Call the connector with session resolution.
-     * Looks up sessionId from connectId, falls back to connectId itself.
-     */
-    private connectorCall;
-    /**
-     * Ensure device permission before proceeding.
-     * - No connectId (searchDevices): check environment-level permission
-     * - With connectId (business methods): check device-level permission
-     * If not granted, calls onDevicePermission so the consumer can request access.
-     */
-    private _ensureDevicePermission;
-    /**
-     * Convert a thrown error to a Response failure.
-     * Parses TrezorConnect error strings to map to HardwareErrorCode values.
-     */
-    private errorToFailure;
-    /**
-     * Parse TrezorConnect error codes from error message strings.
-     * The connector throws errors with messages like "Trezor ethereumGetAddress failed: <error>".
-     * We also check for embedded code patterns.
-     */
-    private parseErrorCode;
-    /**
-     * Enrich error messages with actionable recovery info for the caller.
-     */
-    private enrichErrorMessage;
-    /**
-     * Generic batch call with progress reporting.
-     * If any single call fails, returns the failure immediately.
-     */
-    private batchCall;
-    /** Ensure a hex string has the `0x` prefix. */
-    private ensure0x;
-    /** Ensure a hex string is `0x`-prefixed and zero-padded to 64 hex chars (32 bytes). */
-    private padHex64;
-    private deviceConnectHandler;
-    private deviceDisconnectHandler;
-    private uiRequestHandler;
-    private uiEventHandler;
-    private registerEventListeners;
-    private unregisterEventListeners;
-    private handleUiEvent;
-    private connectorDeviceToDeviceInfo;
-    private extractDeviceInfoFromPayload;
-    private unknownDevice;
-}
-
-/**
- * Response shape returned by connector.call() results that follow
- * the TrezorConnect success/failure pattern.
- *
- * The connector may either:
- * 1. Return the result directly (success case from TrezorDirectConnector)
- * 2. Throw an error (failure case from TrezorDirectConnector)
- *
- * These types are kept for error parsing when the connector propagates
- * TrezorConnect error strings.
- */
-interface ConnectorCallError {
-    message: string;
-    code?: string;
-}
-/**
- * Abstraction over @trezor/connect API surface.
- *
- * Does NOT include `init()` — the consumer calls init() inside createConnect().
- * Adapter calls dispose() when switching or tearing down.
- */
-interface ITrezorConnect {
-    dispose(): void;
-    cancel(reason?: string): void;
-    on(event: string, handler: (...args: unknown[]) => void): void;
-    off(event: string, handler: (...args: unknown[]) => void): void;
-    removeAllListeners?(): void;
-    uiResponse(response: {
-        type: string;
-        payload: unknown;
-    }): void;
-    enumerate?(): Promise<Array<Record<string, unknown>>>;
-    ethereumGetAddress(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    ethereumGetPublicKey(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    ethereumSignTransaction(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    ethereumSignMessage(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    ethereumSignTypedData(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    getAddress(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    getPublicKey(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    signTransaction(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    signMessage(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    solanaGetAddress(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    solanaSignTransaction(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-}
-/**
- * Response shape returned by all @trezor/connect methods.
- */
-type TrezorConnectResponse = {
-    success: true;
-    payload: Record<string, unknown>;
-} | {
-    success: false;
-    payload: {
-        error: string;
-        code?: string;
-    };
-};
-
-/**
- * Trezor method stubs on top of AbstractProxyClient.
- *
- * All cross-process Trezor proxy clients (Electron IPC, Extension messaging)
- * extend this class. They only need to implement:
- * - `sendCall()` — the transport channel
- * - `dispose()` / `cancel()` / `uiResponse()` — lifecycle
- *
- * The 11 TrezorConnect method stubs are defined here once.
- */
-declare abstract class TrezorProxyClient extends AbstractProxyClient implements ITrezorConnect {
-    abstract dispose(): void;
-    abstract cancel(reason?: string): void;
-    abstract uiResponse(response: {
-        type: string;
-        payload: unknown;
-    }): void;
-    ethereumGetAddress(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    ethereumGetPublicKey(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    ethereumSignTransaction(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    ethereumSignMessage(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    ethereumSignTypedData(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    getAddress(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    getPublicKey(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    signTransaction(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    signMessage(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    solanaGetAddress(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    solanaSignTransaction(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-}
-
-export { type ConnectorCallError, type ITrezorConnect, TrezorAdapter, type TrezorConnectResponse, TrezorProxyClient };

package/dist/index.d.ts

@@ -1,198 +0,0 @@
-import { IHardwareWallet, IConnector, TransportType, IUiHandler, DeviceInfo, Response, ChainCapability, HardwareEventMap, DeviceEventListener, ChainForFingerprint, EvmGetAddressParams, EvmAddress, ProgressCallback, EvmGetPublicKeyParams, EvmPublicKey, EvmSignTxParams, EvmSignedTx, EvmSignMsgParams, EvmSignature, EvmSignTypedDataParams, BtcGetAddressParams, BtcAddress, BtcGetPublicKeyParams, BtcPublicKey, BtcSignTxParams, BtcSignedTx, BtcSignMsgParams, BtcSignature, SolGetAddressParams, SolAddress, SolGetPublicKeyParams, SolPublicKey, SolSignTxParams, SolSignedTx, SolSignMsgParams, SolSignature } from '@bytezhang/hardware-wallet-core';
-import { AbstractProxyClient } from '@bytezhang/hardware-transport-core';
-
-/**
- * Trezor 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
- * - Integrates with IUiHandler for interactive flows (PIN, passphrase)
- */
-declare class TrezorAdapter implements IHardwareWallet {
-    readonly vendor: "trezor";
-    private readonly connector;
-    private readonly emitter;
-    private _uiHandler;
-    private _discoveredDevices;
-    private _sessions;
-    constructor(connector: IConnector);
-    get activeTransport(): TransportType | null;
-    getAvailableTransports(): TransportType[];
-    switchTransport(_type: TransportType): Promise<void>;
-    setUiHandler(handler: Partial<IUiHandler>): void;
-    init(_config?: unknown): Promise<void>;
-    dispose(): Promise<void>;
-    searchDevices(): Promise<DeviceInfo[]>;
-    connectDevice(connectId: string): Promise<Response<string>>;
-    disconnectDevice(connectId: string): Promise<void>;
-    getDeviceInfo(connectId: string, deviceId: string): Promise<Response<DeviceInfo>>;
-    getSupportedChains(): ChainCapability[];
-    on<K extends keyof HardwareEventMap>(event: K, listener: (event: HardwareEventMap[K]) => void): void;
-    on(event: string, listener: DeviceEventListener): void;
-    off<K extends keyof HardwareEventMap>(event: K, listener: (event: HardwareEventMap[K]) => void): void;
-    off(event: string, listener: DeviceEventListener): void;
-    cancel(connectId: string): void;
-    /**
-     * For Trezor, the chain fingerprint is the hardware device_id from firmware.
-     * Trezor has a persistent device identity, so no address derivation is needed.
-     */
-    getChainFingerprint(connectId: string, deviceId: string, _chain: ChainForFingerprint): Promise<Response<string>>;
-    evmGetAddress(connectId: string, _deviceId: string, params: EvmGetAddressParams): Promise<Response<EvmAddress>>;
-    evmGetAddresses(connectId: string, deviceId: string, params: EvmGetAddressParams[], onProgress?: ProgressCallback): Promise<Response<EvmAddress[]>>;
-    evmGetPublicKey(connectId: string, _deviceId: string, params: EvmGetPublicKeyParams): Promise<Response<EvmPublicKey>>;
-    evmSignTransaction(connectId: string, _deviceId: string, params: EvmSignTxParams): Promise<Response<EvmSignedTx>>;
-    evmSignMessage(connectId: string, _deviceId: string, params: EvmSignMsgParams): Promise<Response<EvmSignature>>;
-    evmSignTypedData(connectId: string, _deviceId: string, params: EvmSignTypedDataParams): Promise<Response<EvmSignature>>;
-    btcGetAddress(connectId: string, _deviceId: string, params: BtcGetAddressParams): Promise<Response<BtcAddress>>;
-    btcGetAddresses(connectId: string, deviceId: string, params: BtcGetAddressParams[], onProgress?: ProgressCallback): Promise<Response<BtcAddress[]>>;
-    btcGetPublicKey(connectId: string, _deviceId: string, params: BtcGetPublicKeyParams): Promise<Response<BtcPublicKey>>;
-    btcSignTransaction(connectId: string, _deviceId: string, params: BtcSignTxParams): Promise<Response<BtcSignedTx>>;
-    btcSignMessage(connectId: string, _deviceId: string, params: BtcSignMsgParams): Promise<Response<BtcSignature>>;
-    btcGetMasterFingerprint(connectId: string, _deviceId: string): Promise<Response<{
-        masterFingerprint: string;
-    }>>;
-    solGetAddress(connectId: string, _deviceId: string, params: SolGetAddressParams): Promise<Response<SolAddress>>;
-    solGetAddresses(connectId: string, deviceId: string, params: SolGetAddressParams[], onProgress?: ProgressCallback): Promise<Response<SolAddress[]>>;
-    solGetPublicKey(connectId: string, _deviceId: string, params: SolGetPublicKeyParams): Promise<Response<SolPublicKey>>;
-    solSignTransaction(connectId: string, _deviceId: string, params: SolSignTxParams): Promise<Response<SolSignedTx>>;
-    solSignMessage(_connectId: string, _deviceId: string, _params: SolSignMsgParams): Promise<Response<SolSignature>>;
-    /**
-     * Call the connector with session resolution.
-     * Looks up sessionId from connectId, falls back to connectId itself.
-     */
-    private connectorCall;
-    /**
-     * Ensure device permission before proceeding.
-     * - No connectId (searchDevices): check environment-level permission
-     * - With connectId (business methods): check device-level permission
-     * If not granted, calls onDevicePermission so the consumer can request access.
-     */
-    private _ensureDevicePermission;
-    /**
-     * Convert a thrown error to a Response failure.
-     * Parses TrezorConnect error strings to map to HardwareErrorCode values.
-     */
-    private errorToFailure;
-    /**
-     * Parse TrezorConnect error codes from error message strings.
-     * The connector throws errors with messages like "Trezor ethereumGetAddress failed: <error>".
-     * We also check for embedded code patterns.
-     */
-    private parseErrorCode;
-    /**
-     * Enrich error messages with actionable recovery info for the caller.
-     */
-    private enrichErrorMessage;
-    /**
-     * Generic batch call with progress reporting.
-     * If any single call fails, returns the failure immediately.
-     */
-    private batchCall;
-    /** Ensure a hex string has the `0x` prefix. */
-    private ensure0x;
-    /** Ensure a hex string is `0x`-prefixed and zero-padded to 64 hex chars (32 bytes). */
-    private padHex64;
-    private deviceConnectHandler;
-    private deviceDisconnectHandler;
-    private uiRequestHandler;
-    private uiEventHandler;
-    private registerEventListeners;
-    private unregisterEventListeners;
-    private handleUiEvent;
-    private connectorDeviceToDeviceInfo;
-    private extractDeviceInfoFromPayload;
-    private unknownDevice;
-}
-
-/**
- * Response shape returned by connector.call() results that follow
- * the TrezorConnect success/failure pattern.
- *
- * The connector may either:
- * 1. Return the result directly (success case from TrezorDirectConnector)
- * 2. Throw an error (failure case from TrezorDirectConnector)
- *
- * These types are kept for error parsing when the connector propagates
- * TrezorConnect error strings.
- */
-interface ConnectorCallError {
-    message: string;
-    code?: string;
-}
-/**
- * Abstraction over @trezor/connect API surface.
- *
- * Does NOT include `init()` — the consumer calls init() inside createConnect().
- * Adapter calls dispose() when switching or tearing down.
- */
-interface ITrezorConnect {
-    dispose(): void;
-    cancel(reason?: string): void;
-    on(event: string, handler: (...args: unknown[]) => void): void;
-    off(event: string, handler: (...args: unknown[]) => void): void;
-    removeAllListeners?(): void;
-    uiResponse(response: {
-        type: string;
-        payload: unknown;
-    }): void;
-    enumerate?(): Promise<Array<Record<string, unknown>>>;
-    ethereumGetAddress(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    ethereumGetPublicKey(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    ethereumSignTransaction(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    ethereumSignMessage(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    ethereumSignTypedData(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    getAddress(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    getPublicKey(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    signTransaction(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    signMessage(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    solanaGetAddress(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    solanaSignTransaction(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-}
-/**
- * Response shape returned by all @trezor/connect methods.
- */
-type TrezorConnectResponse = {
-    success: true;
-    payload: Record<string, unknown>;
-} | {
-    success: false;
-    payload: {
-        error: string;
-        code?: string;
-    };
-};
-
-/**
- * Trezor method stubs on top of AbstractProxyClient.
- *
- * All cross-process Trezor proxy clients (Electron IPC, Extension messaging)
- * extend this class. They only need to implement:
- * - `sendCall()` — the transport channel
- * - `dispose()` / `cancel()` / `uiResponse()` — lifecycle
- *
- * The 11 TrezorConnect method stubs are defined here once.
- */
-declare abstract class TrezorProxyClient extends AbstractProxyClient implements ITrezorConnect {
-    abstract dispose(): void;
-    abstract cancel(reason?: string): void;
-    abstract uiResponse(response: {
-        type: string;
-        payload: unknown;
-    }): void;
-    ethereumGetAddress(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    ethereumGetPublicKey(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    ethereumSignTransaction(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    ethereumSignMessage(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    ethereumSignTypedData(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    getAddress(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    getPublicKey(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    signTransaction(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    signMessage(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    solanaGetAddress(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-    solanaSignTransaction(params: Record<string, unknown>): Promise<TrezorConnectResponse>;
-}
-
-export { type ConnectorCallError, type ITrezorConnect, TrezorAdapter, type TrezorConnectResponse, TrezorProxyClient };