WalletCore/wallet.core.jni/StoredKey

StoredKey

Represents a key stored as an encrypted file.

Constructors

open fun StoredKey(name: String, password: Array<Byte>, encryptionLevel: StoredKeyEncryptionLevel)

Creates a new key, with given encryption strength level.

open fun StoredKey(name: String, password: Array<Byte>, encryptionLevel: StoredKeyEncryptionLevel, encryption: StoredKeyEncryption)

Creates a new key, with given encryption strength level.

StoredKey

open fun StoredKey(name: String, password: Array<Byte>)

Creates a new key.

StoredKey

open fun StoredKey(name: String, password: Array<Byte>, encryption: StoredKeyEncryption)

Creates a new key.

Functions

account

open fun account(index: Int): Account

Returns the account at a given index.

accountCount

open fun accountCount(): Int

The number of accounts.

accountForCoin

open fun accountForCoin(coin: CoinType, wallet: HDWallet): Account

Returns the account for a specific coin, creating it if necessary.

accountForCoinDerivation

open fun accountForCoinDerivation(coin: CoinType, derivation: Derivation, wallet: HDWallet): Account

Returns the account for a specific coin + derivation, creating it if necessary.

addAccount

open fun addAccount(address: String, coin: CoinType, derivationPath: String, publicKey: String, extendedPublicKey: String)

Adds a new account, using given derivation path.

addAccountDerivation

open fun addAccountDerivation(address: String, coin: CoinType, derivation: Derivation, derivationPath: String, publicKey: String, extendedPublicKey: String)

Adds a new account, using given derivation (usually TWDerivationDefault) and derivation path (usually matches path from derivation, but custom possible).

decryptMnemonic

open fun decryptMnemonic(password: Array<Byte>): String

Decrypts the mnemonic phrase.

decryptPrivateKey

open fun decryptPrivateKey(password: Array<Byte>): Array<Byte>

Decrypts the private key.

decryptPrivateKeyEncoded

open fun decryptPrivateKeyEncoded(password: Array<Byte>): String

Decrypts the encoded private key.

encryptionParameters

open fun encryptionParameters(): String

Retrieve stored key encoding parameters, as JSON string.

exportJSON

open fun exportJSON(): Array<Byte>

Exports the key as JSON

fixAddresses

open fun fixAddresses(password: Array<Byte>): Boolean

Fills in empty and invalid addresses.

hasPrivateKeyEncoded

open fun hasPrivateKeyEncoded(): Boolean

Whether the private key is encoded.

identifier

open fun identifier(): String

Stored key unique identifier.

importHDWallet

open fun importHDWallet(mnemonic: String, name: String, password: Array<Byte>, coin: CoinType): StoredKey

Imports an HD wallet.

importHDWalletWithEncryption

open fun importHDWalletWithEncryption(mnemonic: String, name: String, password: Array<Byte>, coin: CoinType, encryption: StoredKeyEncryption): StoredKey

Imports an HD wallet.

importJSON

open fun importJSON(json: Array<Byte>): StoredKey

Imports a key from JSON.

importPrivateKey

open fun importPrivateKey(privateKey: Array<Byte>, name: String, password: Array<Byte>, coin: CoinType): StoredKey

Imports a private key.

importPrivateKeyEncoded

open fun importPrivateKeyEncoded(privateKey: String, name: String, password: Array<Byte>, coin: CoinType): StoredKey

Imports an encoded private key.

importPrivateKeyEncodedWithEncryption

open fun importPrivateKeyEncodedWithEncryption(privateKey: String, name: String, password: Array<Byte>, coin: CoinType, encryption: StoredKeyEncryption): StoredKey

Imports an encoded private key.

importPrivateKeyWithEncryption

open fun importPrivateKeyWithEncryption(privateKey: Array<Byte>, name: String, password: Array<Byte>, coin: CoinType, encryption: StoredKeyEncryption): StoredKey

Imports a private key.

isMnemonic

open fun isMnemonic(): Boolean

Whether this key is a mnemonic phrase for a HD wallet.

load