@onekeyfe/hd-core 0.0.8 → 0.1.0

package/dist/index.d.ts

@@ -1,11 +1,14 @@
 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, PrevInput, TxOutputBinType, TxInput, TxOutputType, TxInputType, RecoveryDeviceType, SafetyCheckLevel, StarcoinAddress as StarcoinAddress$1, StarcoinPublicKey as StarcoinPublicKey$1, StarcoinMessageSignature, StarcoinSignedTx } 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, NEMAddress as NEMAddress$1, NEMSignedTx, SolanaAddress as SolanaAddress$1, SolanaSignedTx as SolanaSignedTx$1, StellarAddress as StellarAddress$1, StellarSignedTx, CipheredKeyValue as CipheredKeyValue$1 } from '@onekeyfe/hd-transport/src/types/messages';
 
 interface CommonParams {
     keepSession?: boolean;
 }
+declare type Params<T> = CommonParams & T & {
+    bundle?: undefined;
+};
 interface Unsuccessful {
     success: false;
     payload: {
@@ -27,6 +30,7 @@ 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;
@@ -157,9 +161,53 @@ declare type SearchDevice = {
 declare type Device$1 = KnownDevice;
 declare type Features = Messages.Features;
 declare type IDeviceType = 'classic' | 'mini' | 'touch' | 'pro';
+declare type IDeviceModel = 'model_mini' | 'model_touch';
 declare type IDeviceFirmwareStatus = 'valid' | 'outdated' | 'required' | 'unknown' | 'none';
 declare type IDeviceBLEFirmwareStatus = 'valid' | 'outdated' | 'required' | 'unknown' | 'none';
 declare type ITransportStatus = 'valid' | 'outdated';
+declare type DeviceFirmwareRange = {
+    [deviceType in IDeviceType | IDeviceModel]?: {
+        min: string;
+        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[]>;
 
@@ -181,7 +229,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;
@@ -545,6 +594,299 @@ declare type StarcoinVerifyMessageParams = {
 };
 declare function starcoinVerifyMessage(connectId: string, params: CommonParams & StarcoinVerifyMessageParams): Response<Success$1>;
 
+declare type NEMAddress = {
+    path: string;
+} & NEMAddress$1;
+declare type NEMGetAddressParams = {
+    path: string | number[];
+    network?: number;
+    showOnOneKey?: boolean;
+};
+declare function nemGetAddress(connectId: string, params: CommonParams & NEMGetAddressParams): Response<NEMAddress>;
+declare function nemGetAddress(connectId: string, params: CommonParams & {
+    bundle?: NEMGetAddressParams[];
+}): Response<Array<NEMAddress>>;
+
+declare type MosaicID = {
+    namespaceId: string;
+    name: string;
+};
+declare type MosaicDefinition = {
+    levy?: {
+        type?: number;
+        fee?: number;
+        recipient?: string;
+        mosaicId?: MosaicID;
+    };
+    id: MosaicID;
+    description: string;
+    properties?: Array<{
+        name: 'divisibility' | 'initialSupply' | 'supplyMutable' | 'transferable';
+        value: string;
+    }>;
+};
+declare type NEMMosaic = {
+    mosaicId: MosaicID;
+    quantity: number;
+};
+declare type Modification = {
+    modificationType: number;
+    cosignatoryAccount: string;
+};
+declare type Message = {
+    payload?: string;
+    type?: number;
+    publicKey?: string;
+};
+declare type TransactionCommon = {
+    version: number;
+    timeStamp: number;
+    fee: number;
+    deadline?: number;
+    signer?: string;
+};
+declare type NEMTransferTransaction = TransactionCommon & {
+    type: 0x0101;
+    recipient: string;
+    amount: number | string;
+    mosaics?: NEMMosaic[];
+    message?: Message;
+};
+declare type NEMImportanceTransaction = TransactionCommon & {
+    type: 0x0801;
+    importanceTransfer: {
+        mode: number;
+        publicKey: string;
+    };
+};
+declare type NEMAggregateModificationTransaction = TransactionCommon & {
+    type: 0x1001;
+    modifications?: Modification[];
+    minCosignatories: {
+        relativeChange: number;
+    };
+};
+declare type NEMProvisionNamespaceTransaction = TransactionCommon & {
+    type: 0x2001;
+    newPart?: string;
+    parent?: string;
+    rentalFeeSink?: string;
+    rentalFee?: number;
+};
+declare type NEMMosaicCreationTransaction = TransactionCommon & {
+    type: 0x4001;
+    mosaicDefinition: MosaicDefinition;
+    creationFeeSink?: string;
+    creationFee?: number;
+};
+declare type NEMSupplyChangeTransaction = TransactionCommon & {
+    type: 0x4002;
+    mosaicId: MosaicID;
+    supplyType: number;
+    delta?: number;
+};
+declare type Transaction = NEMTransferTransaction | NEMImportanceTransaction | NEMAggregateModificationTransaction | NEMProvisionNamespaceTransaction | NEMMosaicCreationTransaction | NEMSupplyChangeTransaction;
+declare type NEMMultisigTransaction = TransactionCommon & {
+    type: 0x0102 | 0x1002 | 0x1004;
+    otherTrans: Transaction;
+};
+declare type NEMTransaction = Transaction | NEMMultisigTransaction;
+declare type NEMSignTransactionParams = {
+    path: string | number[];
+    transaction: NEMTransaction;
+};
+declare function nemSignTransaction(connectId: string, params: CommonParams & NEMSignTransactionParams): Response<NEMSignedTx>;
+
+declare type SolanaAddress = {
+    path: string;
+} & SolanaAddress$1;
+declare type SolanaGetAddressParams = {
+    path: string | number[];
+    showOnOneKey?: boolean;
+};
+declare function solGetAddress(connectId: string, params: CommonParams & SolanaGetAddressParams): Response<SolanaAddress>;
+declare function solGetAddress(connectId: string, params: CommonParams & {
+    bundle?: SolanaGetAddressParams[];
+}): Response<Array<SolanaAddress>>;
+
+declare type SolanaSignedTx = {
+    path: string;
+} & SolanaSignedTx$1;
+declare type SolanaSignTransactionParams = {
+    path: string | number[];
+    rawTx?: string;
+};
+declare function solSignTransaction(connectId: string, params: CommonParams & SolanaSignTransactionParams): Response<SolanaSignedTx>;
+declare function solSignTransaction(connectId: string, params: CommonParams & {
+    bundle?: SolanaSignTransactionParams[];
+}): Response<Array<SolanaSignedTx>>;
+
+declare type StellarAddress = {
+    path: string;
+} & StellarAddress$1;
+declare type StellarGetAddressParams = {
+    path: string | number[];
+    showOnOneKey?: boolean;
+};
+declare function stellarGetAddress(connectId: string, params: CommonParams & StellarGetAddressParams): Response<StellarAddress>;
+declare function stellarGetAddress(connectId: string, params: CommonParams & {
+    bundle?: StellarGetAddressParams[];
+}): Response<Array<StellarAddress>>;
+
+declare type StellarAsset = {
+    type: 0 | 1 | 2;
+    code: string;
+    issuer?: string;
+};
+declare type StellarCreateAccountOperation = {
+    type: 'createAccount';
+    source?: string;
+    destination: string;
+    startingBalance: string;
+};
+declare type StellarPaymentOperation = {
+    type: 'payment';
+    source?: string;
+    destination: string;
+    asset?: StellarAsset | typeof undefined;
+    amount: string;
+};
+declare type StellarPathPaymentOperation = {
+    type: 'pathPayment';
+    source?: string;
+    sendAsset: StellarAsset;
+    sendMax: string;
+    destination: string;
+    destAsset: StellarAsset;
+    destAmount: string;
+    path?: StellarAsset[];
+};
+declare type StellarPassiveOfferOperation = {
+    type: 'createPassiveOffer';
+    source?: string;
+    buying: StellarAsset;
+    selling: StellarAsset;
+    amount: string;
+    price: {
+        n: number;
+        d: number;
+    };
+};
+declare type StellarManageOfferOperation = {
+    type: 'manageOffer';
+    source?: string;
+    buying: StellarAsset;
+    selling: StellarAsset;
+    amount: string;
+    offerId?: string;
+    price: {
+        n: number;
+        d: number;
+    };
+};
+declare type StellarSetOptionsOperation = {
+    type: 'setOptions';
+    source?: string;
+    signer?: {
+        type: 0 | 1 | 2;
+        key: string | Buffer;
+        weight?: number;
+    };
+    inflationDest?: string;
+    clearFlags?: number;
+    setFlags?: number;
+    masterWeight?: number | string;
+    lowThreshold?: number | string;
+    medThreshold?: number | string;
+    highThreshold?: number | string;
+    homeDomain?: string;
+};
+declare type StellarChangeTrustOperation = {
+    type: 'changeTrust';
+    source?: string;
+    line: StellarAsset;
+    limit?: string;
+};
+declare type StellarAllowTrustOperation = {
+    type: 'allowTrust';
+    source?: string;
+    trustor: string;
+    assetCode: string;
+    assetType: number;
+    authorize?: boolean | typeof undefined;
+};
+declare type StellarAccountMergeOperation = {
+    type: 'accountMerge';
+    source?: string;
+    destination: string;
+};
+declare type StellarManageDataOperation = {
+    type: 'manageData';
+    source?: string;
+    name: string;
+    value?: Buffer | string;
+};
+declare type StellarBumpSequenceOperation = {
+    type: 'bumpSequence';
+    source?: string;
+    bumpTo: string;
+};
+declare type StellarInflationOperation = {
+    type: 'inflation';
+    source?: string;
+};
+declare type StellarOperation = StellarCreateAccountOperation | StellarPaymentOperation | StellarPathPaymentOperation | StellarPassiveOfferOperation | StellarManageOfferOperation | StellarSetOptionsOperation | StellarChangeTrustOperation | StellarAllowTrustOperation | StellarAccountMergeOperation | StellarInflationOperation | StellarManageDataOperation | StellarBumpSequenceOperation;
+declare type StellarTransaction = {
+    source: string;
+    fee: number;
+    sequence: string | number;
+    timebounds?: {
+        minTime: number;
+        maxTime: number;
+    };
+    memo?: {
+        type: 0 | 1 | 2 | 3 | 4;
+        id?: string;
+        text?: string;
+        hash?: string | Buffer;
+    };
+    operations: StellarOperation[];
+};
+declare type StellarSignTransactionParams = {
+    path: string | number[];
+    networkPassphrase: string;
+    transaction: StellarTransaction;
+};
+declare function stellarSignTransaction(connectId: string, params: CommonParams & StellarSignTransactionParams): Response<StellarSignedTx>;
+
+declare type CipheredKeyValue = {
+    path: string;
+} & CipheredKeyValue$1;
+declare type CipheredKeyValueParams = {
+    path: string | number[];
+    key: string;
+    value: string;
+    encrypt?: boolean;
+    askOnEncrypt?: boolean;
+    askOnDecrypt?: boolean;
+    iv?: string;
+};
+declare function cipherKeyValue(connectId: string, params: CommonParams & CipheredKeyValueParams): Response<CipheredKeyValue>;
+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;
@@ -559,6 +901,7 @@ declare type CoreApi = {
     checkFirmwareRelease: typeof checkFirmwareRelease;
     checkBLEFirmwareRelease: typeof checkBLEFirmwareRelease;
     checkTransportRelease: typeof checkTransportRelease;
+    cipherKeyValue: typeof cipherKeyValue;
     deviceBackup: typeof deviceBackup;
     deviceChangePin: typeof deviceChangePin;
     deviceFlags: typeof deviceFlags;
@@ -585,6 +928,13 @@ declare type CoreApi = {
     starcoinSignMessage: typeof starcoinSignMessage;
     starcoinSignTransaction: typeof starcoinSignTransaction;
     starcoinVerifyMessage: typeof starcoinVerifyMessage;
+    nemGetAddress: typeof nemGetAddress;
+    nemSignTransaction: typeof nemSignTransaction;
+    solGetAddress: typeof solGetAddress;
+    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;
@@ -645,6 +995,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;
@@ -661,7 +1012,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;
 };
@@ -825,7 +1183,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;
@@ -932,6 +1290,7 @@ declare class Device extends EventEmitter {
     connect(): Promise<boolean>;
     acquire(): Promise<void>;
     release(): Promise<void>;
+    getCommands(): DeviceCommands;
     getInternalState(): string;
     initialize(): Promise<void>;
     getFeatures(): Promise<void>;
@@ -1001,4 +1360,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, 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, 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, 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 };