default
@iota/ledgerjs-hw-app-iota / default
Class: default
Defined in: Iota.ts:47
Iota API
Example
import Iota from "@iota/ledgerjs-hw-app-iota";
const iota = new Iota(transport)
Constructors
Constructor
new default(
transport,scrambleKey?,verbose?):Iota
Defined in: Iota.ts:51
Parameters
transport
Transport
scrambleKey?
string = 'default_iota_scramble_key'
verbose?
boolean = false
Returns
Iota
Properties
transport
transport:
Transport
Defined in: Iota.ts:48
Methods
getPublicKey()
getPublicKey(
path,displayOnDevice?):Promise<GetPublicKeyResult>
Defined in: Iota.ts:68
Retrieves the public key associated with a particular BIP32 path from the Ledger app.
Parameters
path
string
the path to retrieve.
displayOnDevice?
boolean = false
whether or not the address should be displayed on the device.
Returns
Promise<GetPublicKeyResult>
getVersion()
getVersion():
Promise<GetVersionResult>
Defined in: Iota.ts:157
Retrieve the app version on the attached Ledger device.
Returns
Promise<GetVersionResult>
signTransaction()
signTransaction(
path,txn,options?):Promise<SignTransactionResult>
Defined in: Iota.ts:97
Sign a transaction with the key at a BIP32 path.
Parameters
path
string
The path to use when signing the transaction.
txn
Uint8Array
The transaction bytes to sign.
options?
Additional options used for clear signing purposes.
bcsObjects
Uint8Array<ArrayBufferLike>[]
Returns
Promise<SignTransactionResult>