@onekeyfe/hd-core 0.0.10 → 0.1.2

package/dist/index.d.ts

@@ -6,6 +6,9 @@ import { EthereumPublicKey, EthereumMessageSignature, Success as Success$1, Addr
 interface CommonParams {
     keepSession?: boolean;
 }
+declare type Params<T> = CommonParams & T & {
+    bundle?: undefined;
+};
 interface Unsuccessful {
     success: false;
     payload: {
@@ -27,11 +30,13 @@ declare const ERROR_CODES: {
     Method_InvalidParameter: string;
     Call_API: string;
     Call_NotResponse: string;
+    Method_FirmwareUpdate_DownloadFailed: string;
     Transport_InvalidProtobuf: string;
     Device_FwException: string;
     Device_UnexpectedMode: string;
     Device_CallInProgress: string;
     Device_InitializeFailed: string;
+    Device_Interrupted: string;
     Not_Use_Onekey_Device: string;
     Runtime: string;
     Init_NotInitialized: string;
@@ -167,16 +172,69 @@ declare type DeviceFirmwareRange = {
         max?: string;
     };
 };
+declare type FeaturesNarrowing = {
+    major_version: 2;
+    fw_major: null;
+    fw_minor: null;
+    fw_patch: null;
+    bootloader_mode: true;
+    firmware_present: false;
+} | {
+    major_version: 2;
+    fw_major: null;
+    fw_minor: null;
+    fw_patch: null;
+    bootloader_mode: null;
+    firmware_present: null;
+} | {
+    major_version: 2;
+    fw_major: 2;
+    fw_minor: number;
+    fw_patch: number;
+    bootloader_mode: true;
+    firmware_present: true;
+} | {
+    major_version: 1;
+    fw_major: null;
+    fw_minor: null;
+    fw_patch: null;
+    bootloader_mode: true;
+    firmware_present: false;
+} | {
+    major_version: 1;
+    fw_major: null;
+    fw_minor: null;
+    fw_patch: null;
+    bootloader_mode: true;
+    firmware_present: true;
+};
+declare type StrictFeatures = Features & FeaturesNarrowing;
 
 declare function searchDevices(): Response<SearchDevice[]>;
 
 declare function getFeatures(connectId?: string): Response<Features>;
 
-declare function checkFirmwareRelease(connectId?: string): Response<IDeviceFirmwareStatus>;
+declare type FirmwareRelease$1 = {
+    status: IDeviceFirmwareStatus;
+    changelog: {
+        'en-US': string;
+        'zh-CN': string;
+    }[];
+    release: IFirmwareReleaseInfo;
+};
+declare function checkFirmwareRelease(connectId?: string): Response<FirmwareRelease$1>;
 
 declare function init$1(settings: Partial<ConnectSettings>): Promise<boolean>;
 
-declare function checkBLEFirmwareRelease(connectId?: string): Response<IDeviceFirmwareStatus>;
+declare type BleFirmwareRelease = {
+    status: IDeviceBLEFirmwareStatus;
+    changelog: {
+        'zh-CN': string;
+        'en-US': string;
+    }[];
+    release: IBLEFirmwareReleaseInfo;
+};
+declare function checkBLEFirmwareRelease(connectId?: string): Response<BleFirmwareRelease>;
 
 interface FirmwareRange {
     '1': {
@@ -188,7 +246,8 @@ interface FirmwareRange {
         max: string;
     };
 }
-declare type VersionArray = [1 | 2, number, number];
+declare type MajorVersion = 1 | 2;
+declare type VersionArray = [MajorVersion, number, number];
 declare type FirmwareRelease = {
     required: boolean;
     url: string;
@@ -834,6 +893,17 @@ declare function cipherKeyValue(connectId: string, params: CommonParams & {
     bundle?: CipheredKeyValueParams[];
 }): Response<Array<CipheredKeyValue>>;
 
+interface FirmwareUpdateBinary {
+    binary: ArrayBuffer;
+}
+interface FirmwareUpdate {
+    version: number[];
+    btcOnly?: boolean;
+    updateType: 'firmware' | 'ble';
+}
+declare function firmwareUpdate(connectId: string | undefined, params: Params<FirmwareUpdate>): Response<Messages.Success>;
+declare function firmwareUpdate(connectId: string | undefined, params: Params<FirmwareUpdateBinary>): Response<Messages.Success>;
+
 declare type CoreApi = {
     init: typeof init$1;
     on: typeof on;
@@ -842,7 +912,7 @@ declare type CoreApi = {
     dispose: () => void;
     call: (params: any) => Promise<any>;
     uiResponse: typeof uiResponse;
-    cancel: (params?: string) => void;
+    cancel: (connectId?: string) => void;
     searchDevices: typeof searchDevices;
     getFeatures: typeof getFeatures;
     checkFirmwareRelease: typeof checkFirmwareRelease;
@@ -881,6 +951,7 @@ declare type CoreApi = {
     solSignTransaction: typeof solSignTransaction;
     stellarGetAddress: typeof stellarGetAddress;
     stellarSignTransaction: typeof stellarSignTransaction;
+    firmwareUpdate: typeof firmwareUpdate;
 };
 
 declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
@@ -941,6 +1012,7 @@ declare const UI_REQUEST: {
     readonly CLOSE_UI_WINDOW: "ui-close_window";
     readonly BLUETOOTH_PERMISSION: "ui-bluetooth_permission";
     readonly LOCATION_PERMISSION: "ui-location_permission";
+    readonly FIRMWARE_PROGRESS: "ui-firmware-progress";
 };
 interface UiRequestWithoutPayload {
     type: typeof UI_REQUEST.CLOSE_UI_WINDOW | typeof UI_REQUEST.BLUETOOTH_PERMISSION | typeof UI_REQUEST.LOCATION_PERMISSION;
@@ -957,7 +1029,14 @@ interface UiRequestButton {
     type: typeof UI_REQUEST.REQUEST_BUTTON;
     payload: DeviceButtonRequest['payload'];
 }
-declare type UiEvent = UiRequestWithoutPayload | UiRequestDeviceAction | UiRequestButton;
+interface FirmwareProgress {
+    type: typeof UI_REQUEST.FIRMWARE_PROGRESS;
+    payload: {
+        device: Device$1;
+        progress: number;
+    };
+}
+declare type UiEvent = UiRequestWithoutPayload | UiRequestDeviceAction | UiRequestButton | FirmwareProgress;
 declare type UiEventMessage = UiEvent & {
     event: typeof UI_EVENT;
 };
@@ -967,6 +1046,7 @@ declare const IFRAME: {
     readonly INIT: "iframe-init";
     readonly INIT_BRIDGE: "iframe-init-bridge";
     readonly CALL: "iframe-call";
+    readonly CANCEL: "iframe-cancel";
 };
 interface IFrameInit {
     type: typeof IFRAME.INIT;
@@ -1011,6 +1091,13 @@ interface IFrameCallMessage {
     type: typeof IFRAME.CALL;
     payload: CallMethodPayload;
 }
+interface IFrameCancelMessage {
+    event: typeof IFRAME.CANCEL;
+    type: typeof IFRAME.CANCEL;
+    payload: {
+        connectId?: string;
+    };
+}
 declare const RESPONSE_EVENT = "RESPONSE_EVENT";
 interface MethodResponseMessage {
     event: typeof RESPONSE_EVENT;
@@ -1039,7 +1126,7 @@ declare const CORE_EVENT = "CORE_EVENT";
 declare type CoreMessage = {
     id?: string;
     success?: true | false;
-} & (IFrameEventMessage | IFrameCallMessage | UiResponseMessage | UiEventMessage | DeviceEventMessage);
+} & (IFrameEventMessage | IFrameCallMessage | IFrameCancelMessage | UiResponseMessage | UiEventMessage | DeviceEventMessage);
 declare type PostMessageEvent = MessageEvent<any>;
 declare const parseMessage: (messageData: any) => CoreMessage;
 declare const createErrorMessage: (error: Error & {
@@ -1121,7 +1208,7 @@ declare class Log {
 declare const initLog: (prefix: string, enabled?: boolean | undefined) => Log;
 declare const enableLog: (enabled?: boolean | undefined) => void;
 
-declare const httpRequest: (url: string, _type: string) => any;
+declare const httpRequest: (url: string, type: string) => any;
 declare const getTimeStamp: () => number;
 
 declare const isValidVersionString: (version: string) => boolean;
@@ -1219,7 +1306,6 @@ declare class Device extends EventEmitter {
     unavailableCapabilities: UnavailableCapabilities;
     instance: number;
     internalState: string[];
-    loaded: boolean;
     needReloadDevice: boolean;
     keepSession: boolean;
     constructor(descriptor: OneKeyDeviceInfo);
@@ -1228,13 +1314,16 @@ declare class Device extends EventEmitter {
     connect(): Promise<boolean>;
     acquire(): Promise<void>;
     release(): Promise<void>;
+    getCommands(): DeviceCommands;
     getInternalState(): string;
     initialize(): Promise<void>;
     getFeatures(): Promise<void>;
     _updateFeatures(feat: Features): void;
     updateDescriptor(descriptor: OneKeyDeviceInfo): void;
+    updateFromCache(device: Device): void;
     run(fn?: () => Promise<void>, options?: RunOptions): Promise<void>;
     _runInner<T>(fn: (() => Promise<T>) | undefined, options: RunOptions): Promise<undefined>;
+    interruption(): void;
     getMode(): "normal" | "bootloader" | "initialize" | "seedless";
     getFirmwareVersion(): IVersionArray | null;
     getBLEFirmwareVersion(): IVersionArray | null;
@@ -1287,7 +1376,17 @@ declare class DataManager {
         default: JSON;
     };
     static getFirmwareStatus: (features: Features) => IDeviceFirmwareStatus;
+    static getFirmwareChangelog: (features: Features) => {
+        "zh-CN": string;
+        "en-US": string;
+    }[];
+    static getFirmwareLeatestRelease: (features: Features) => IFirmwareReleaseInfo;
     static getBLEFirmwareStatus: (features: Features) => IDeviceBLEFirmwareStatus;
+    static getBleFirmwareChangelog: (features: Features) => {
+        "zh-CN": string;
+        "en-US": string;
+    }[];
+    static getBleFirmwareLeatestRelease: (features: Features) => IBLEFirmwareReleaseInfo;
     static getTransportStatus: (localVersion: string) => ITransportStatus;
     static load(settings: ConnectSettings): Promise<void>;
     static getProtobufMessages(): JSON;
@@ -1297,4 +1396,4 @@ declare class DataManager {
 
 declare const HardwareSdk: ({ init, call, dispose, eventEmitter, uiResponse, cancel, }: InjectApi) => CoreApi;
 
-export { AccountAddress, AccountAddresses, AssetsMap, BTCAddress, BTCGetAddressParams, BTCGetPublicKeyParams, BTCPublicKey, BTCSignMessageParams, BTCSignTransactionParams, BTCVerifyMessageParams, CORE_EVENT, CallMethod, CallMethodAnyResponse, CallMethodKeys, CallMethodPayload, CallMethodResponse, CallMethodUnion, CipheredKeyValue, CipheredKeyValueParams, CommonParams, ConnectSettings, Core, CoreApi, CoreMessage, DEFAULT_PRIORITY, DEVICE, DEVICE_EVENT, DataManager, Deferred, Device$1 as Device, DeviceButtonRequest, DeviceButtonRequestPayload, DeviceChangePinParams, DeviceEvent, DeviceEventListenerFn, DeviceEventMessage, DeviceFirmwareRange, DeviceFlagsParams, DeviceMode, DeviceRecoveryParams, DeviceResetParams, DeviceSettingsParams, DeviceStatus, DeviceTypeMap, errors as ERRORS, EVMAccessList, EVMAddress, EVMGetAddressParams, EVMGetPublicKeyParams, EVMPublicKey, EVMSignMessageEIP712Params, EVMSignMessageParams, EVMSignTransactionParams, EVMSignTypedDataParams, EVMSignedTx, EVMTransaction, EVMTransactionEIP1559, EVMVerifyMessageParams, EthereumSignTypedDataMessage, EthereumSignTypedDataTypeProperty, EthereumSignTypedDataTypes, Features, FirmwareRange, FirmwareRelease, IBLEFirmwareReleaseInfo, IDeviceBLEFirmwareStatus, IDeviceFirmwareStatus, IDeviceModel, IDeviceType, IFRAME, IFirmwareReleaseInfo, IFrameBridge, IFrameCallMessage, IFrameEvent, IFrameEventMessage, IFrameInit, ILocale, ITransportStatus, IVersionArray, KnownDevice, MethodResponseMessage, NEMAddress, NEMAggregateModificationTransaction, NEMGetAddressParams, NEMImportanceTransaction, NEMMosaic, NEMMosaicCreationTransaction, NEMMultisigTransaction, NEMProvisionNamespaceTransaction, NEMSignTransactionParams, NEMSupplyChangeTransaction, NEMTransaction, NEMTransferTransaction, PostMessageEvent, RESPONSE_EVENT, RefTransaction, ReleaseInfo, RemoteConfigResponse, Response, SearchDevice, SignedTransaction, SolanaAddress, SolanaGetAddressParams, SolanaSignTransactionParams, SolanaSignedTx, StarcoinAddress, StarcoinGetAddressParams, StarcoinGetPublicKeyParams, StarcoinPublicKey, StarcoinSignMessageParams, StarcoinSignTransactionParams, StarcoinVerifyMessageParams, StellarAddress, StellarAsset, StellarGetAddressParams, StellarOperation, StellarSignTransactionParams, StellarTransaction, Success, TransactionOptions, TransportReleaseStatus, UI_EVENT, UI_REQUEST, UI_RESPONSE, UiEvent, UiEventMessage, UiPromise, UiPromiseResponse, UiRequestButton, UiRequestDeviceAction, UiRequestWithoutPayload, UiResponseEvent, UiResponseMessage, UiResponsePin, UnavailableCapabilities, UnavailableCapability, Unsuccessful, VersionArray, corsValidator, create, createDeviceMessage, createErrorMessage, createIFrameMessage, createResponseMessage, createUiMessage, createUiResponse, HardwareSdk as default, enableLog, getDeviceLabel, getDeviceType, getDeviceTypeByBleName, getDeviceTypeByDeviceId, getDeviceUUID, getEnv, getHDPath, getScriptType, getTimeStamp, httpRequest, init as initCore, initLog, isValidVersionArray, isValidVersionString, normalizeVersionArray, parseConnectSettings, parseMessage, versionCompare, versionSplit };
+export { AccountAddress, AccountAddresses, AssetsMap, BTCAddress, BTCGetAddressParams, BTCGetPublicKeyParams, BTCPublicKey, BTCSignMessageParams, BTCSignTransactionParams, BTCVerifyMessageParams, CORE_EVENT, CallMethod, CallMethodAnyResponse, CallMethodKeys, CallMethodPayload, CallMethodResponse, CallMethodUnion, CipheredKeyValue, CipheredKeyValueParams, CommonParams, ConnectSettings, Core, CoreApi, CoreMessage, DEFAULT_PRIORITY, DEVICE, DEVICE_EVENT, DataManager, Deferred, Device$1 as Device, DeviceButtonRequest, DeviceButtonRequestPayload, DeviceChangePinParams, DeviceEvent, DeviceEventListenerFn, DeviceEventMessage, DeviceFirmwareRange, DeviceFlagsParams, DeviceMode, DeviceRecoveryParams, DeviceResetParams, DeviceSettingsParams, DeviceStatus, DeviceTypeMap, errors as ERRORS, EVMAccessList, EVMAddress, EVMGetAddressParams, EVMGetPublicKeyParams, EVMPublicKey, EVMSignMessageEIP712Params, EVMSignMessageParams, EVMSignTransactionParams, EVMSignTypedDataParams, EVMSignedTx, EVMTransaction, EVMTransactionEIP1559, EVMVerifyMessageParams, EthereumSignTypedDataMessage, EthereumSignTypedDataTypeProperty, EthereumSignTypedDataTypes, Features, FirmwareProgress, FirmwareRange, FirmwareRelease, IBLEFirmwareReleaseInfo, IDeviceBLEFirmwareStatus, IDeviceFirmwareStatus, IDeviceModel, IDeviceType, IFRAME, IFirmwareReleaseInfo, IFrameBridge, IFrameCallMessage, IFrameCancelMessage, IFrameEvent, IFrameEventMessage, IFrameInit, ILocale, ITransportStatus, IVersionArray, KnownDevice, MajorVersion, MethodResponseMessage, NEMAddress, NEMAggregateModificationTransaction, NEMGetAddressParams, NEMImportanceTransaction, NEMMosaic, NEMMosaicCreationTransaction, NEMMultisigTransaction, NEMProvisionNamespaceTransaction, NEMSignTransactionParams, NEMSupplyChangeTransaction, NEMTransaction, NEMTransferTransaction, Params, PostMessageEvent, RESPONSE_EVENT, RefTransaction, ReleaseInfo, RemoteConfigResponse, Response, SearchDevice, SignedTransaction, SolanaAddress, SolanaGetAddressParams, SolanaSignTransactionParams, SolanaSignedTx, StarcoinAddress, StarcoinGetAddressParams, StarcoinGetPublicKeyParams, StarcoinPublicKey, StarcoinSignMessageParams, StarcoinSignTransactionParams, StarcoinVerifyMessageParams, StellarAddress, StellarAsset, StellarGetAddressParams, StellarOperation, StellarSignTransactionParams, StellarTransaction, StrictFeatures, Success, TransactionOptions, TransportReleaseStatus, UI_EVENT, UI_REQUEST, UI_RESPONSE, UiEvent, UiEventMessage, UiPromise, UiPromiseResponse, UiRequestButton, UiRequestDeviceAction, UiRequestWithoutPayload, UiResponseEvent, UiResponseMessage, UiResponsePin, UnavailableCapabilities, UnavailableCapability, Unsuccessful, VersionArray, corsValidator, create, createDeviceMessage, createErrorMessage, createIFrameMessage, createResponseMessage, createUiMessage, createUiResponse, HardwareSdk as default, enableLog, getDeviceLabel, getDeviceType, getDeviceTypeByBleName, getDeviceTypeByDeviceId, getDeviceUUID, getEnv, getHDPath, getScriptType, getTimeStamp, httpRequest, init as initCore, initLog, isValidVersionArray, isValidVersionString, normalizeVersionArray, parseConnectSettings, parseMessage, versionCompare, versionSplit };