@onekeyfe/hd-core 0.0.2 → 0.0.5

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import EventEmitter, { EventEmitter as EventEmitter$1 } from 'events';
 import { Messages, Transport, OneKeyDeviceInfo } from '@onekeyfe/hd-transport';
 export { Messages as PROTO } from '@onekeyfe/hd-transport';
-import { EthereumPublicKey, EthereumMessageSignature, Success as Success$1, Address, MultisigRedeemScriptType, InputScriptType, PublicKey, MessageSignature, TxInputType, TxOutputType, PrevInput, TxOutputBinType, TxInput, RecoveryDeviceType, SafetyCheckLevel } from '@onekeyfe/hd-transport/src/types/messages';
+import { EthereumPublicKey, EthereumMessageSignature, Success as Success$1, Address, MultisigRedeemScriptType, InputScriptType, PublicKey, MessageSignature, PrevInput, TxOutputBinType, TxInput, TxOutputType, TxInputType, RecoveryDeviceType, SafetyCheckLevel, StarcoinAddress as StarcoinAddress$1, StarcoinPublicKey as StarcoinPublicKey$1, StarcoinMessageSignature, StarcoinSignedTx } from '@onekeyfe/hd-transport/src/types/messages';
 
 interface CommonParams {
     keepSession?: boolean;
@@ -167,7 +167,7 @@ declare function getFeatures(connectId?: string): Response<Features>;
 
 declare function checkFirmwareRelease(connectId?: string): Response<IDeviceFirmwareStatus>;
 
-declare function init$1(settings: Partial<ConnectSettings>): Promise<void> | void;
+declare function init$1(settings: Partial<ConnectSettings>): Promise<boolean>;
 
 declare function checkBLEFirmwareRelease(connectId?: string): Response<IDeviceFirmwareStatus>;
 
@@ -361,6 +361,20 @@ declare type BTCSignMessageParams = {
 };
 declare function btcSignMessage(connectId: string, params: CommonParams & BTCSignMessageParams): Response<MessageSignature>;
 
+declare type SignedTransaction = {
+    signatures: string[];
+    serializedTx: string;
+    txid?: string;
+};
+declare type TransactionOptions = {
+    version?: number;
+    lock_time?: number;
+    expiry?: number;
+    overwintered?: boolean;
+    version_group_id?: number;
+    timestamp?: number;
+    branch_id?: number;
+};
 declare type RefTransaction = {
     hash: string;
     version: number;
@@ -417,7 +431,7 @@ declare type BTCSignTransactionParams = {
     branchId?: number;
     timestamp?: number;
 };
-declare function btcSignTransaction(connectId: string, params: CommonParams & BTCSignTransactionParams): Response<Success$1>;
+declare function btcSignTransaction(connectId: string, params: CommonParams & BTCSignTransactionParams): Response<SignedTransaction>;
 
 declare type BTCVerifyMessageParams = {
     address: string;
@@ -488,6 +502,49 @@ declare function deviceFlags(connectId: string, params: CommonParams & DeviceFla
 
 declare function deviceUpdateReboot(connectId: string): Response<Success$1>;
 
+declare type StarcoinAddress = {
+    path: string;
+} & StarcoinAddress$1;
+declare type StarcoinGetAddressParams = {
+    path: string | number[];
+    showOnOneKey?: boolean;
+};
+declare function starcoinGetAddress(connectId: string, params: CommonParams & StarcoinGetAddressParams): Response<StarcoinAddress>;
+declare function starcoinGetAddress(connectId: string, params: CommonParams & {
+    bundle?: StarcoinGetAddressParams[];
+}): Response<Array<StarcoinAddress>>;
+
+declare type StarcoinPublicKey = {
+    path: string;
+} & StarcoinPublicKey$1;
+declare type StarcoinGetPublicKeyParams = {
+    path: string | number[];
+    showOnOneKey?: boolean;
+};
+declare function starcoinGetPublicKey(connectId: string, params: CommonParams & StarcoinGetPublicKeyParams): Response<StarcoinPublicKey>;
+declare function starcoinGetPublicKey(connectId: string, params: CommonParams & {
+    bundle?: StarcoinGetPublicKeyParams[];
+}): Response<Array<StarcoinPublicKey>>;
+
+declare type StarcoinSignMessageParams = {
+    path: string | number[];
+    messageHex: string;
+};
+declare function starcoinSignMessage(connectId: string, params: CommonParams & StarcoinSignMessageParams): Response<StarcoinMessageSignature>;
+
+declare type StarcoinSignTransactionParams = {
+    path: string | number[];
+    rawTx: string;
+};
+declare function starcoinSignTransaction(connectId: string, params: CommonParams & StarcoinSignTransactionParams): Response<StarcoinSignedTx>;
+
+declare type StarcoinVerifyMessageParams = {
+    publicKey: string;
+    messageHex: string;
+    signature: string;
+};
+declare function starcoinVerifyMessage(connectId: string, params: CommonParams & StarcoinVerifyMessageParams): Response<Success$1>;
+
 declare type CoreApi = {
     init: typeof init$1;
     on: typeof on;
@@ -523,6 +580,11 @@ declare type CoreApi = {
     btcSignMessage: typeof btcSignMessage;
     btcSignTransaction: typeof btcSignTransaction;
     btcVerifyMessage: typeof btcVerifyMessage;
+    starcoinGetAddress: typeof starcoinGetAddress;
+    starcoinGetPublicKey: typeof starcoinGetPublicKey;
+    starcoinSignMessage: typeof starcoinSignMessage;
+    starcoinSignTransaction: typeof starcoinSignTransaction;
+    starcoinVerifyMessage: typeof starcoinVerifyMessage;
 };
 
 declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
@@ -540,10 +602,52 @@ declare type MessageFactoryFn<Group, Event> = UnionToIntersection<Event extends
     payload: undefined;
 } : never>;
 
+declare const DEVICE_EVENT = "DEVICE_EVENT";
+declare const DEVICE: {
+    readonly CONNECT: "device-connect";
+    readonly CONNECT_UNACQUIRED: "device-connect_unacquired";
+    readonly DISCONNECT: "device-disconnect";
+    readonly CHANGED: "device-changed";
+    readonly ACQUIRE: "device-acquire";
+    readonly RELEASE: "device-release";
+    readonly ACQUIRED: "device-acquired";
+    readonly RELEASED: "device-released";
+    readonly USED_ELSEWHERE: "device-used_elsewhere";
+    readonly UNREADABLE: "unreadable-device";
+    readonly LOADING: "device-loading";
+    readonly BUTTON: "button";
+    readonly PIN: "pin";
+    readonly PASSPHRASE: "passphrase";
+    readonly PASSPHRASE_ON_DEVICE: "passphrase_on_device";
+    readonly WORD: "word";
+};
+interface DeviceButtonRequestPayload extends Omit<Messages.ButtonRequest, 'code'> {
+    code?: Messages.ButtonRequest['code'] | 'ButtonRequest_FirmwareUpdate';
+}
+interface DeviceButtonRequest {
+    type: typeof DEVICE.BUTTON;
+    payload: DeviceButtonRequestPayload & {
+        device: KnownDevice | null;
+    };
+}
+declare type DeviceEvent = DeviceButtonRequest;
+declare type DeviceEventMessage = DeviceEvent & {
+    event: typeof DEVICE_EVENT;
+};
+declare type DeviceEventListenerFn = (type: typeof DEVICE_EVENT, cb: (event: DeviceEventMessage) => void) => void;
+declare const createDeviceMessage: MessageFactoryFn<typeof DEVICE_EVENT, DeviceEvent>;
+
 declare const UI_EVENT = "UI_EVENT";
 declare const UI_REQUEST: {
     readonly REQUEST_PIN: "ui-request_pin";
+    readonly INVALID_PIN: "ui-invalid_pin";
+    readonly REQUEST_BUTTON: "ui-button";
+    readonly CLOSE_UI_WINDOW: "ui-close_window";
 };
+interface UiRequestWithoutPayload {
+    type: typeof UI_REQUEST.CLOSE_UI_WINDOW;
+    payload?: typeof undefined;
+}
 declare type UiRequestDeviceAction = {
     type: typeof UI_REQUEST.REQUEST_PIN;
     payload: {
@@ -551,7 +655,11 @@ declare type UiRequestDeviceAction = {
         type?: Messages.PinMatrixRequestType;
     };
 };
-declare type UiEvent = UiRequestDeviceAction;
+interface UiRequestButton {
+    type: typeof UI_REQUEST.REQUEST_BUTTON;
+    payload: DeviceButtonRequest['payload'];
+}
+declare type UiEvent = UiRequestWithoutPayload | UiRequestDeviceAction | UiRequestButton;
 declare type UiEventMessage = UiEvent & {
     event: typeof UI_EVENT;
 };
@@ -633,35 +741,13 @@ declare const CORE_EVENT = "CORE_EVENT";
 declare type CoreMessage = {
     id?: string;
     success?: true | false;
-} & (IFrameEventMessage | IFrameCallMessage | UiResponseMessage | UiEventMessage);
+} & (IFrameEventMessage | IFrameCallMessage | UiResponseMessage | UiEventMessage | DeviceEventMessage);
 declare type PostMessageEvent = MessageEvent<any>;
 declare const parseMessage: (messageData: any) => CoreMessage;
 declare const createErrorMessage: (error: Error & {
     code?: string;
 }) => Unsuccessful;
 
-declare const DEVICE: {
-    readonly CONNECT: "device-connect";
-    readonly CONNECT_UNACQUIRED: "device-connect_unacquired";
-    readonly DISCONNECT: "device-disconnect";
-    readonly CHANGED: "device-changed";
-    readonly ACQUIRE: "device-acquire";
-    readonly RELEASE: "device-release";
-    readonly ACQUIRED: "device-acquired";
-    readonly RELEASED: "device-released";
-    readonly USED_ELSEWHERE: "device-used_elsewhere";
-    readonly UNREADABLE: "unreadable-device";
-    readonly LOADING: "device-loading";
-    readonly BUTTON: "button";
-    readonly PIN: "pin";
-    readonly PASSPHRASE: "passphrase";
-    readonly PASSPHRASE_ON_DEVICE: "passphrase_on_device";
-    readonly WORD: "word";
-};
-interface DeviceButtonRequestPayload extends Omit<Messages.ButtonRequest, 'code'> {
-    code?: Messages.ButtonRequest['code'] | 'ButtonRequest_FirmwareUpdate';
-}
-
 declare type DeviceDescriptorDiff = {
     didUpdate: boolean;
     connected: OneKeyDeviceInfo[];
@@ -755,6 +841,59 @@ declare type Deferred<T, I = any, D = any> = {
 };
 declare function create<T, I = any, D = any>(arg?: I, data?: D): Deferred<T, I, D>;
 
+declare const getDeviceType: (features?: {
+    vendor: string;
+    onekey_serial: string;
+    se_ver: string;
+    serial_no: string;
+    onekey_version: string;
+    ble_name: string;
+    ble_ver: string;
+    ble_enable: boolean;
+    major_version: number;
+    minor_version: number;
+    patch_version: number;
+    bootloader_mode: boolean | null;
+    device_id: string | null;
+    pin_protection: boolean | null;
+    passphrase_protection: boolean | null;
+    language: string | null;
+    label: string | null;
+    initialized: boolean | null;
+    revision: string | null;
+    bootloader_hash: string | null;
+    imported: boolean | null;
+    unlocked: boolean | null;
+    _passphrase_cached?: boolean | undefined;
+    firmware_present: boolean | null;
+    needs_backup: boolean | null;
+    flags: number | null;
+    model: string;
+    fw_major: number | null;
+    fw_minor: number | null;
+    fw_patch: number | null;
+    fw_vendor: string | null;
+    unfinished_backup: boolean | null;
+    no_backup: boolean | null;
+    recovery_mode: boolean | null;
+    capabilities: ("Capability_Bitcoin" | "Capability_Bitcoin_like" | "Capability_Binance" | "Capability_Cardano" | "Capability_Crypto" | "Capability_EOS" | "Capability_Ethereum" | "Capability_Lisk" | "Capability_Monero" | "Capability_NEM" | "Capability_Ripple" | "Capability_Stellar" | "Capability_Tezos" | "Capability_U2F" | "Capability_Shamir" | "Capability_ShamirGroups" | "Capability_PassphraseEntry")[];
+    backup_type: "Bip39" | "Slip39_Basic" | "Slip39_Advanced" | null;
+    sd_card_present: boolean | null;
+    sd_protection: boolean | null;
+    wipe_code_protection: boolean | null;
+    session_id: string | null;
+    passphrase_always_on_device: boolean | null;
+    safety_checks: "Strict" | "PromptAlways" | "PromptTemporarily" | null;
+    auto_lock_delay_ms: number | null;
+    display_rotation: number | null;
+    experimental_features: boolean | null;
+} | undefined) => IDeviceType;
+declare const getDeviceUUID: (features: Features) => string;
+declare const getDeviceLabel: (features: Features) => string;
+
+declare const getHDPath: (path: string) => Array<number>;
+declare const getScriptType: (path: Array<number>) => InputScriptType;
+
 declare type RunOptions = {
     keepSession?: boolean;
 };
@@ -858,4 +997,4 @@ declare class DataManager {
 
 declare const HardwareSdk: ({ init, call, dispose, eventEmitter, uiResponse, cancel, }: InjectApi) => CoreApi;
 
-export { AssetsMap, CORE_EVENT, CallMethod, CallMethodAnyResponse, CallMethodKeys, CallMethodPayload, CallMethodResponse, CallMethodUnion, CommonParams, ConnectSettings, Core, CoreApi, CoreMessage, DEFAULT_PRIORITY, DEVICE, DataManager, Deferred, Device$1 as Device, DeviceButtonRequestPayload, DeviceMode, DeviceStatus, DeviceTypeMap, errors as ERRORS, Features, FirmwareRange, FirmwareRelease, IBLEFirmwareReleaseInfo, IDeviceBLEFirmwareStatus, IDeviceFirmwareStatus, IDeviceType, IFRAME, IFirmwareReleaseInfo, IFrameBridge, IFrameCallMessage, IFrameEvent, IFrameEventMessage, IFrameInit, ILocale, ITransportStatus, IVersionArray, KnownDevice, MethodResponseMessage, PostMessageEvent, RESPONSE_EVENT, ReleaseInfo, RemoteConfigResponse, Response, SearchDevice, Success, TransportReleaseStatus, UI_EVENT, UI_REQUEST, UI_RESPONSE, UiEvent, UiEventMessage, UiPromise, UiPromiseResponse, UiRequestDeviceAction, UiResponseEvent, UiResponseMessage, UiResponsePin, UnavailableCapabilities, UnavailableCapability, Unsuccessful, VersionArray, corsValidator, create, createErrorMessage, createIFrameMessage, createResponseMessage, createUiMessage, createUiResponse, HardwareSdk as default, enableLog, getEnv, 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, CommonParams, ConnectSettings, Core, CoreApi, CoreMessage, DEFAULT_PRIORITY, DEVICE, DEVICE_EVENT, DataManager, Deferred, Device$1 as Device, DeviceButtonRequest, DeviceButtonRequestPayload, DeviceChangePinParams, DeviceEvent, DeviceEventListenerFn, DeviceEventMessage, 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, IDeviceType, IFRAME, IFirmwareReleaseInfo, IFrameBridge, IFrameCallMessage, IFrameEvent, IFrameEventMessage, IFrameInit, ILocale, ITransportStatus, IVersionArray, KnownDevice, MethodResponseMessage, PostMessageEvent, RESPONSE_EVENT, RefTransaction, ReleaseInfo, RemoteConfigResponse, Response, SearchDevice, SignedTransaction, StarcoinAddress, StarcoinGetAddressParams, StarcoinGetPublicKeyParams, StarcoinPublicKey, StarcoinSignMessageParams, StarcoinSignTransactionParams, StarcoinVerifyMessageParams, 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, getDeviceUUID, getEnv, getHDPath, getScriptType, getTimeStamp, httpRequest, init as initCore, initLog, isValidVersionArray, isValidVersionString, normalizeVersionArray, parseConnectSettings, parseMessage, versionCompare, versionSplit };