@ukeyfe/hardware-core 1.1.13

package/src/types/api/allNetworkGetAddress.ts

@@ -0,0 +1,129 @@
+import type { CommonParams, Response, Unsuccessful } from '../params';
+import type { CardanoAddressParameters } from './cardano';
+
+export type INetwork =
+  | 'evm'
+  // BTC forks
+  | 'btc'
+  | 'tbtc'
+  | 'doge'
+  | 'neurai'
+  | 'ltc'
+  | 'bch'
+  // Other
+  | 'sol'
+  | 'algo'
+  | 'near'
+  | 'stc'
+  | 'cfx'
+  | 'tron'
+  | 'aptos'
+  | 'xrp'
+  | 'cosmos'
+  | 'ada'
+  | 'sui'
+  | 'fil'
+  | 'dot'
+  | 'kaspa'
+  | 'nexa'
+  | 'dynex'
+  | 'nervos'
+  | 'scdo'
+  | 'ton'
+  | 'alph'
+  | 'nostr'
+  | 'benfen'
+  | 'neo';
+
+export type CommonResponseParams = {
+  path: string;
+  network: INetwork;
+  chainName?: string;
+  prefix?: string;
+};
+
+export type AllNetworkAddressParams = {
+  path: string | number[];
+  network: INetwork;
+  chainName?: string;
+  prefix?: string;
+  showOnOneKey?: boolean;
+
+  includePublicKey?: boolean;
+  group?: string;
+  useTweak?: boolean;
+};
+
+type AllNetworkAddressPayload =
+  | {
+      address: string;
+      pub?: string;
+      /**
+       * @deprecated Use `pub` instead.
+       */
+      publicKey?: string;
+      // Nostr public key (bech32)
+      npub?: string;
+    }
+  | {
+      // Cardano
+      addressParameters: CardanoAddressParameters;
+      protocolMagic: number;
+      networkId: number;
+      serializedPath: string;
+      serializedStakingPath: string;
+      address: string;
+      xpub?: string;
+      stakeAddress?: string;
+    }
+  | {
+      // BTC
+      node: {
+        depth: number;
+        fingerprint: number;
+        child_num: number;
+        chain_code: string;
+        private_key: string | null;
+        public_key: string;
+      };
+      xpub: string;
+      root_fingerprint: number;
+      xpubSegwit: string;
+    };
+
+export type AllNetworkAddress = AllNetworkAddressParams & {
+  success: boolean;
+  payload?:
+    | (AllNetworkAddressPayload & { rootFingerprint: number })
+    | {
+        error: string;
+        code: number;
+        connectId?: string;
+        deviceId?: string;
+        params: any;
+      };
+};
+
+export type AllNetworkGetAddressParams = {
+  bundle: AllNetworkAddressParams[];
+};
+
+export type AllNetworkGetAddressParamsByLoop = AllNetworkGetAddressParams & {
+  callbackId?: string;
+  callbackIdFinish?: string;
+  onLoopItemResponse: (data?: AllNetworkAddress) => void;
+  onAllItemsResponse: (data?: AllNetworkAddress[], error?: Unsuccessful) => void;
+};
+
+export declare function allNetworkGetAddress(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & AllNetworkGetAddressParams
+): Response<AllNetworkAddress[]>;
+
+export declare function allNetworkGetAddressByLoop(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & AllNetworkGetAddressParamsByLoop
+  // only return empty array
+): Response<AllNetworkAddress[]>;

package/src/types/api/aptosGetAddress.ts

@@ -0,0 +1,28 @@
+import { AptosAddress as HardwareAptosAddress } from '@ukeyfe/hardware-transport';
+import type { CommonParams, Response } from '../params';
+
+export type AptosAddress = {
+  path: string;
+  pub?: string;
+  /**
+   * @deprecated Use `pub` instead.
+   */
+  publicKey?: string;
+} & HardwareAptosAddress;
+
+export type AptosGetAddressParams = {
+  path: string | number[];
+  showOnOneKey?: boolean;
+};
+
+export declare function aptosGetAddress(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & AptosGetAddressParams
+): Response<AptosAddress>;
+
+export declare function aptosGetAddress(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & { bundle?: AptosGetAddressParams[] }
+): Response<Array<AptosAddress>>;

package/src/types/api/aptosGetPublicKey.ts

@@ -0,0 +1,27 @@
+import type { CommonParams, Response } from '../params';
+
+export type AptosPublicKey = {
+  path: string;
+  pub: string;
+  /**
+   * @deprecated Use `pub` instead.
+   */
+  publicKey?: string;
+};
+
+export type AptosGetPublicKeyParams = {
+  path: string | number[];
+  showOnOneKey?: boolean;
+};
+
+export declare function aptosGetPublicKey(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & AptosGetPublicKeyParams
+): Response<AptosPublicKey>;
+
+export declare function aptosGetPublicKey(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & { bundle?: AptosGetPublicKeyParams[] }
+): Response<Array<AptosPublicKey>>;

package/src/types/api/aptosSignInMessage.ts

@@ -0,0 +1,17 @@
+import { AptosMessageSignature as HardwareAptosMessageSignature } from '@ukeyfe/hardware-transport';
+import type { CommonParams, Response } from '../params';
+
+export type AptosSignInMessageSignature = {
+  path: string;
+} & HardwareAptosMessageSignature;
+
+export type AptosSignInMessageParams = {
+  path: string | number[];
+  payload: string;
+};
+
+export declare function aptosSignInMessage(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & AptosSignInMessageParams
+): Response<AptosSignInMessageSignature>;

package/src/types/api/aptosSignMessage.ts

@@ -0,0 +1,26 @@
+import { AptosMessageSignature as HardwareAptosMessageSignature } from '@ukeyfe/hardware-transport';
+import type { CommonParams, Response } from '../params';
+
+export type AptosMessageSignature = {
+  path: string;
+  fullMessage: string;
+} & HardwareAptosMessageSignature;
+
+declare type AptosMessagePayload = {
+  address?: string;
+  chainId?: string;
+  application?: string;
+  nonce: string;
+  message: string;
+};
+
+export type AptosSignMessageParams = {
+  path: string | number[];
+  payload: AptosMessagePayload;
+};
+
+export declare function aptosSignMessage(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & AptosSignMessageParams
+): Response<AptosMessageSignature>;

package/src/types/api/aptosSignTransaction.ts

@@ -0,0 +1,18 @@
+import { AptosSignedTx as HardwareAptosSignedTx } from '@ukeyfe/hardware-transport';
+import type { CommonParams, Response } from '../params';
+
+export type AptosSignedTx = {
+  path: string;
+} & HardwareAptosSignedTx;
+
+export type AptosSignTransactionParams = {
+  path: string;
+  rawTx?: string;
+  transactionType?: number; // Messages.AptosTransactionType
+};
+
+export declare function aptosSignTransaction(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & AptosSignTransactionParams
+): Response<AptosSignedTx>;

package/src/types/api/benfenGetAddress.ts

@@ -0,0 +1,24 @@
+import { BenfenAddress as HardwareBenfenAddress } from '@ukeyfe/hardware-transport';
+import type { CommonParams, Response } from '../params';
+
+export type BenfenAddress = {
+  path: string;
+  pub?: string;
+} & HardwareBenfenAddress;
+
+export type BenfenGetAddressParams = {
+  path: string | number[];
+  showOnOneKey?: boolean;
+};
+
+export declare function benfenGetAddress(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & BenfenGetAddressParams
+): Response<BenfenAddress>;
+
+export declare function benfenGetAddress(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & { bundle?: BenfenGetAddressParams[] }
+): Response<Array<BenfenAddress>>;

package/src/types/api/benfenGetPublicKey.ts

@@ -0,0 +1,23 @@
+import type { CommonParams, Response } from '../params';
+
+export type BenfenPublicKey = {
+  path: string;
+  pub: string;
+};
+
+export type BenfenGetPublicKeyParams = {
+  path: string | number[];
+  showOnOneKey?: boolean;
+};
+
+export declare function benfenGetPublicKey(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & BenfenGetPublicKeyParams
+): Response<BenfenPublicKey>;
+
+export declare function benfenGetPublicKey(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & { bundle?: BenfenGetPublicKeyParams[] }
+): Response<Array<BenfenPublicKey>>;

package/src/types/api/benfenSignMessage.ts

@@ -0,0 +1,13 @@
+import { BenfenMessageSignature } from '@ukeyfe/hardware-transport';
+import type { CommonParams, Response } from '../params';
+
+export type BenfenSignMessageParams = {
+  path: string | number[];
+  messageHex: string;
+};
+
+export declare function benfenSignMessage(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & BenfenSignMessageParams
+): Response<BenfenMessageSignature>;

package/src/types/api/benfenSignTransaction.ts

@@ -0,0 +1,19 @@
+import { AptosSignedTx as HardwareAptosSignedTx } from '@ukeyfe/hardware-transport';
+import type { CommonParams, Response } from '../params';
+
+export type BenfenSignedTx = {
+  path: string;
+  coinType?: string;
+} & HardwareAptosSignedTx;
+
+export type BenfenSignTransactionParams = {
+  path: string | number[];
+  coinType?: string;
+  rawTx?: string;
+};
+
+export declare function benfenSignTransaction(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & BenfenSignTransactionParams
+): Response<BenfenSignedTx>;

package/src/types/api/btcGetAddress.ts

@@ -0,0 +1,26 @@
+import { Address, InputScriptType, MultisigRedeemScriptType } from '@ukeyfe/hardware-transport';
+import type { CommonParams, Response } from '../params';
+
+export type BTCAddress = {
+  path: string;
+} & Address;
+
+export type BTCGetAddressParams = {
+  path: string | number[];
+  coin?: string;
+  showOnOneKey?: boolean;
+  multisig?: MultisigRedeemScriptType;
+  scriptType?: InputScriptType;
+};
+
+export declare function btcGetAddress(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & BTCGetAddressParams
+): Response<BTCAddress>;
+
+export declare function btcGetAddress(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & { bundle?: BTCGetAddressParams[] }
+): Response<Array<BTCAddress>>;

package/src/types/api/btcGetPublicKey.ts

@@ -0,0 +1,26 @@
+import { InputScriptType, PublicKey } from '@ukeyfe/hardware-transport';
+import type { CommonParams, Response } from '../params';
+
+export type BTCPublicKey = {
+  path: string;
+  xpubSegwit?: string;
+} & PublicKey;
+
+export type BTCGetPublicKeyParams = {
+  path: string | number[];
+  coin?: string;
+  showOnOneKey?: boolean;
+  scriptType?: InputScriptType;
+};
+
+export declare function btcGetPublicKey(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & BTCGetPublicKeyParams
+): Response<BTCPublicKey>;
+
+export declare function btcGetPublicKey(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & { bundle?: BTCGetPublicKeyParams[] }
+): Response<Array<BTCPublicKey>>;

package/src/types/api/btcSignMessage.ts

@@ -0,0 +1,16 @@
+import { MessageSignature } from '@ukeyfe/hardware-transport';
+import type { CommonParams, Response } from '../params';
+
+export type BTCSignMessageParams = {
+  path: string | number[];
+  messageHex: string;
+  coin?: string;
+  noScriptType?: boolean;
+  dAppSignType?: 'ecdsa' | 'bip322-simple';
+};
+
+export declare function btcSignMessage(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & BTCSignMessageParams
+): Response<MessageSignature>;

package/src/types/api/btcSignPsbt.ts

@@ -0,0 +1,13 @@
+import { SignedPsbt } from '@ukeyfe/hardware-transport';
+import type { CommonParams, Response } from '../params';
+
+export type BTCSignPsbtParams = {
+  psbt: string;
+  coin?: string;
+};
+
+export declare function btcSignPsbt(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & BTCSignPsbtParams
+): Response<SignedPsbt>;

package/src/types/api/btcSignTransaction.ts

@@ -0,0 +1,98 @@
+import {
+  TxInput as OrigTxInput,
+  PrevInput,
+  TxOutputBinType,
+  TxOutputType,
+  TxInputType,
+} from '@ukeyfe/hardware-transport';
+import type { CommonParams, Response } from '../params';
+
+export type SignedTransaction = {
+  signatures: string[];
+  serializedTx: string;
+  txid?: string;
+};
+
+export type TransactionOptions = {
+  version?: number;
+  lock_time?: number;
+  expiry?: number;
+  overwintered?: boolean;
+  version_group_id?: number;
+  timestamp?: number;
+  branch_id?: number;
+};
+
+export type RefTransaction =
+  | {
+      hash: string;
+      version: number;
+      inputs: PrevInput[];
+      bin_outputs: TxOutputBinType[];
+      outputs?: typeof undefined;
+      lock_time: number;
+      extra_data?: string;
+      expiry?: number;
+      overwintered?: boolean;
+      version_group_id?: number;
+      timestamp?: number;
+      branch_id?: number;
+    }
+  | {
+      hash: string;
+      version: number;
+      inputs: OrigTxInput[];
+      bin_outputs?: typeof undefined;
+      outputs: TxOutputType[];
+      lock_time: number;
+      extra_data?: string;
+      expiry?: number;
+      overwintered?: boolean;
+      version_group_id?: number;
+      timestamp?: number;
+      branch_id?: number;
+    };
+
+export type AccountAddress = {
+  address: string;
+  path: string;
+  transfers?: number;
+  balance?: string;
+  sent?: string;
+  received?: string;
+};
+
+export type AccountAddresses = {
+  change: AccountAddress[];
+  used: AccountAddress[];
+  unused: AccountAddress[];
+};
+
+export type BTCSignTransactionParams = {
+  coin: string;
+  inputs: TxInputType[];
+  outputs: TxOutputType[];
+  refTxs: RefTransaction[];
+  account?: {
+    // Partial account (addresses)
+    addresses: AccountAddresses;
+  };
+  locktime?: number;
+  version?: number;
+  // Only available for Decred and Zcash
+  expiry?: number;
+  // Only available for Zcash
+  overwintered?: boolean;
+  // Only available for Zcash, set overwintered to nVersionGroupId
+  versionGroupId?: number;
+  // Only available for Zcash when overwintered is true
+  branchId?: number;
+  // Only available for Capricoin
+  timestamp?: number;
+};
+
+export declare function btcSignTransaction(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & BTCSignTransactionParams
+): Response<SignedTransaction>;

package/src/types/api/btcVerifyMessage.ts

@@ -0,0 +1,15 @@
+import { Success } from '@ukeyfe/hardware-transport';
+import type { CommonParams, Response } from '../params';
+
+export type BTCVerifyMessageParams = {
+  address: string;
+  messageHex: string;
+  signature: string;
+  coin: string;
+};
+
+export declare function btcVerifyMessage(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & BTCVerifyMessageParams
+): Response<Success>;