@keepkey/keepkey.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • KeepKey

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

autoButton

autoButton: boolean = false

device

device: Device

features

features: Messages.Features.AsObject

Methods

acknowledgeWithCharacter

  • acknowledgeWithCharacter(character: string): Promise<[number, any]>

  • Parameters

    • character: string

    Returns Promise<[number, any]>

acknowledgeWithCharacterDelete

  • acknowledgeWithCharacterDelete(): Promise<[number, any]>

acknowledgeWithCharacterDone

  • acknowledgeWithCharacterDone(): Promise<[number, any]>

acknowledgeWithCharacterProto

  • acknowledgeWithCharacterProto(character: string, _delete: boolean, _done: boolean): Promise<[number, any]>

  • Parameters

    • character: string
    • _delete: boolean
    • _done: boolean

    Returns Promise<[number, any]>

acknowledgeWithPassphrase

  • acknowledgeWithPassphrase(passphrase: string): Promise<[number, any]>

  • Parameters

    • passphrase: string

    Returns Promise<[number, any]>

acknowledgeWithPin

  • acknowledgeWithPin(pin: string): Promise<[number, any]>

  • Parameters

    • pin: string

    Returns Promise<[number, any]>

applyPolicy

  • applyPolicy(p: Types.PolicyType.AsObject): Promise<void>

  • Parameters

    • p: Types.PolicyType.AsObject

    Returns Promise<void>

applySettings

  • applySettings(s: Messages.ApplySettings.AsObject): Promise<void>

  • Parameters

    • s: Messages.ApplySettings.AsObject

    Returns Promise<void>

cancel

  • cancel(): Promise<void>

changePin

  • changePin(): Promise<void>

cipherKeyValue

  • cipherKeyValue(v: Messages.CipherKeyValue.AsObject): Promise<string | Uint8Array>

  • Parameters

    • v: Messages.CipherKeyValue.AsObject

    Returns Promise<string | Uint8Array>

clearSession

  • clearSession(): Promise<void>

decryptKeyValue

  • decryptKeyValue(v: Messages.CipherKeyValue.AsObject): Promise<string | Uint8Array>

  • Parameters

    • v: Messages.CipherKeyValue.AsObject

    Returns Promise<string | Uint8Array>

ethereumGetAddress

  • ethereumGetAddress(a: Messages.EthereumGetAddress.AsObject): Promise<string>

  • Parameters

    • a: Messages.EthereumGetAddress.AsObject

    Returns Promise<string>

ethereumSignMessage

  • ethereumSignMessage(m: Messages.EthereumSignMessage.AsObject): Promise<any>

  • Parameters

    • m: Messages.EthereumSignMessage.AsObject

    Returns Promise<any>

ethereumSignTx

  • ethereumSignTx(tx: Messages.EthereumSignTx.AsObject, addressType?: OutputAddressType, exchangeType?: ExchangeType, data?: Uint8Array | string, chainId?: number): Promise<any>

  • Parameters

    • tx: Messages.EthereumSignTx.AsObject
    • Optional addressType: OutputAddressType
    • Optional exchangeType: ExchangeType
    • Optional data: Uint8Array | string
    • Optional chainId: number

    Returns Promise<any>

ethereumVerifyMessage

  • ethereumVerifyMessage(m: Messages.EthereumVerifyMessage.AsObject): Promise<any>

  • Parameters

    • m: Messages.EthereumVerifyMessage.AsObject

    Returns Promise<any>

firmwareErase

  • firmwareErase(): Promise<void>

getAddress

  • getAddress(g: Messages.GetAddress.AsObject): Promise<string>

  • Parameters

    • g: Messages.GetAddress.AsObject

    Returns Promise<string>

getAllCoinsAsMap

  • getAllCoinsAsMap(): Promise<object>

getCoinShortcutXPubPairs

  • getCoinShortcutXPubPairs(coinTable: Types.CoinType.AsObject[]): Promise<[string, string][]>

  • Parameters

    • coinTable: Types.CoinType.AsObject[]

    Returns Promise<[string, string][]>

getCoinTable

  • getCoinTable(start?: number, end?: number): Promise<Types.CoinType.AsObject[]>

  • Parameters

    • Default value start: number = 0
    • Default value end: number = start + 10

    Returns Promise<Types.CoinType.AsObject[]>

getEntropy

  • getEntropy(size: number): Promise<string | Uint8Array>

  • Parameters

    • size: number

    Returns Promise<string | Uint8Array>

getFeatures

  • getFeatures(): Promise<Messages.Features.AsObject>

  • Returns Promise<Messages.Features.AsObject>

getNumCoins

  • getNumCoins(): Promise<number>

getPublicKey

  • getPublicKey(g: Messages.GetPublicKey.AsObject): Promise<[Types.HDNodeType.AsObject, string]>

  • Parameters

    • g: Messages.GetPublicKey.AsObject

    Returns Promise<[Types.HDNodeType.AsObject, string]>

initialize

  • initialize(): Promise<Messages.Features.AsObject | void>

  • Returns Promise<Messages.Features.AsObject | void>

loadDevice

  • loadDevice(l: Messages.LoadDevice.AsObject): Promise<void>

  • Parameters

    • l: Messages.LoadDevice.AsObject

    Returns Promise<void>

ping

  • ping(p: Messages.Ping.AsObject): Promise<string | undefined>

  • Parameters

    • p: Messages.Ping.AsObject

    Returns Promise<string | undefined>

Private prepareSignTx

  • prepareSignTx(coinName: string, inputs: any[], outputs: any[], exchangeOutputs?: any[]): Promise<any>

  • Parameters

    • coinName: string
    • inputs: any[]
    • outputs: any[]
    • Optional exchangeOutputs: any[]

    Returns Promise<any>

recoveryDevice

  • recoveryDevice(r: Messages.RecoveryDevice.AsObject): Promise<void>

  • Parameters

    • r: Messages.RecoveryDevice.AsObject

    Returns Promise<void>

removePin

  • removePin(): Promise<void>

resetDevice

  • resetDevice(r: Messages.ResetDevice.AsObject): Promise<void>

  • Parameters

    • r: Messages.ResetDevice.AsObject

    Returns Promise<void>

send

  • send(events: Event[]): Promise<void>

signMessage

  • signMessage(s: Messages.SignMessage.AsObject): Promise<Array<string | Uint8Array>>

  • Parameters

    • s: Messages.SignMessage.AsObject

    Returns Promise<Array<string | Uint8Array>>

signTransaction

  • signTransaction(coinName: string, inputs: any[], outputs: any[], exchangeOutputs?: any[], version?: number, lockTime?: number): Promise<[string[], string]>

  • Parameters

    • coinName: string
    • inputs: any[]
    • outputs: any[]
    • Default value exchangeOutputs: any[] = []
    • Optional version: number
    • Optional lockTime: number

    Returns Promise<[string[], string]>

softReset

  • softReset(): Promise<void>

verifyMessage

  • verifyMessage(addr: string, coinName: string, msg: string | Uint8Array, sig: string | Uint8Array): Promise<void>

  • Parameters

    • addr: string
    • coinName: string
    • msg: string | Uint8Array
    • sig: string | Uint8Array

    Returns Promise<void>

wipeDevice

  • wipeDevice(): Promise<void>

Static withWebUSB

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc