pezkuwi-ui/docs/ui-keyring/classes/_keyring_.keyring.md

Hierarchy

Base

↳ Keyring

Implements

• KeyringStruct

Constructors

constructor

⊕ new Keyring(): Keyring

Inherited from Base.constructor

Defined in Base.ts:22

Returns: Keyring

---

Accessors

accounts

get accounts(): object

Inherited from Base.accounts

Defined in Base.ts:30

Returns: object

---

addresses

get addresses(): object

Inherited from Base.addresses

Defined in Base.ts:34

Returns: object

---

keyring

get keyring(): KeyringInstance

Inherited from Base.keyring

Defined in Base.ts:38

Returns: KeyringInstance

---

Methods

addAccountPair

▸ addAccountPair(pair: KeyringPair, password: string): KeyringPair

Defined in Keyring.ts:22

Parameters:

Name	Type
pair	KeyringPair
password	string

Returns: KeyringPair

---

backupAccount

▸ backupAccount(pair: KeyringPair, password: string): KeyringPair$Json

Defined in Keyring.ts:29

Parameters:

Name	Type
pair	KeyringPair
password	string

Returns: KeyringPair$Json

---

createAccount

▸ createAccount(seed: Uint8Array, password?: undefined | string, meta?: KeyringPair$Meta): KeyringPair

Defined in Keyring.ts:39

Parameters:

Name	Type	Default value
seed	Uint8Array	-
Optional password	undefined | string	-
Default value meta	KeyringPair$Meta	{}

Returns: KeyringPair

---

createAccountExternal

▸ createAccountExternal(publicKey: Uint8Array, meta?: KeyringPair$Meta): KeyringPair

Defined in Keyring.ts:47

Parameters:

Name	Type	Default value
publicKey	Uint8Array	-
Default value meta	KeyringPair$Meta	{}

Returns: KeyringPair

---

createAccountMnemonic

▸ createAccountMnemonic(seed: string, password?: undefined | string, meta?: KeyringPair$Meta): KeyringPair

Defined in Keyring.ts:55

Parameters:

Name	Type	Default value
seed	string	-
Optional password	undefined | string	-
Default value meta	KeyringPair$Meta	{}

Returns: KeyringPair

---

decodeAddress

▸ decodeAddress(key: string | Uint8Array): Uint8Array

Inherited from Base.decodeAddress

Defined in Base.ts:46

Parameters:

Name	Type
key	string | Uint8Array

Returns: Uint8Array

---

encodeAddress

▸ encodeAddress(key: string | Uint8Array): string

Inherited from Base.encodeAddress

Defined in Base.ts:50

Parameters:

Name	Type
key	string | Uint8Array

Returns: string

---

encryptAccount

▸ encryptAccount(pair: KeyringPair, password: string): void

Defined in Keyring.ts:63

Parameters:

Name	Type
pair	KeyringPair
password	string

Returns: void

---

forgetAccount

▸ forgetAccount(address: string): void

Defined in Keyring.ts:72

Parameters:

Name	Type
address	string

Returns: void

---

forgetAddress

▸ forgetAddress(address: string): void

Defined in Keyring.ts:77

Parameters:

Name	Type
address	string

Returns: void

---

getAccount

▸ getAccount(address: string | Uint8Array): KeyringAddress

Defined in Keyring.ts:81

Parameters:

Name	Type
address	string | Uint8Array

Returns: KeyringAddress

---

getAccounts

▸ getAccounts(): Array<KeyringAddress>

Defined in Keyring.ts:85

Returns: Array<KeyringAddress>

---

getAddress

▸ getAddress(_address: string | Uint8Array, type?: "account" | "address"): KeyringAddress

Defined in Keyring.ts:94

Parameters:

Name	Type	Default value
_address	string | Uint8Array	-
Default value type	"account" | "address"	"address"

Returns: KeyringAddress

---

getAddresses

▸ getAddresses(): Array<KeyringAddress>

Defined in Keyring.ts:115

Returns: Array<KeyringAddress>

---

getPair

▸ getPair(address: string | Uint8Array): KeyringPair

Inherited from Base.getPair

Defined in Base.ts:54

Parameters:

Name	Type
address	string | Uint8Array

Returns: KeyringPair

---

getPairs

▸ getPairs(): Array<KeyringPair>

Inherited from Base.getPairs

Defined in Base.ts:58

Returns: Array<KeyringPair>

---

isAvailable

▸ isAvailable(_address: Uint8Array | string): boolean

Inherited from Base.isAvailable

Defined in Base.ts:64

Parameters:

Name	Type
_address	Uint8Array | string

Returns: boolean

---

isPassValid

▸ isPassValid(password: string): boolean

Inherited from Base.isPassValid

Defined in Base.ts:74

Parameters:

Name	Type
password	string

Returns: boolean

---

loadAll

▸ loadAll(options: KeyringOptions): void

Defined in Keyring.ts:156

Parameters:

Name	Type
options	KeyringOptions

Returns: void

---

restoreAccount

▸ restoreAccount(json: KeyringPair$Json, password: string): KeyringPair

Defined in Keyring.ts:170

Parameters:

Name	Type
json	KeyringPair$Json
password	string

Returns: KeyringPair

---

saveAccount

▸ saveAccount(pair: KeyringPair, password?: undefined | string): void

Defined in Keyring.ts:188

Parameters:

Name	Type
pair	KeyringPair
Optional password	undefined | string

Returns: void

---

saveAccountMeta

▸ saveAccountMeta(pair: KeyringPair, meta: KeyringPair$Meta): void

Defined in Keyring.ts:197

Parameters:

Name	Type
pair	KeyringPair
meta	KeyringPair$Meta

Returns: void

---

saveAddress

▸ saveAddress(address: string, meta: KeyringPair$Meta): void

Defined in Keyring.ts:207

Parameters:

Name	Type
address	string
meta	KeyringPair$Meta

Returns: void

---

saveRecent

▸ saveRecent(address: string): SingleAddress

Defined in Keyring.ts:227

Parameters:

Name	Type
address	string

Returns: SingleAddress

---

setAddressPrefix

▸ setAddressPrefix(prefix: number): void

Inherited from Base.setAddressPrefix

Defined in Base.ts:78

Parameters:

Name	Type
prefix	number

Returns: void

---

setDevMode

▸ setDevMode(isDevelopment: boolean): void

Inherited from Base.setDevMode

Defined in Base.ts:82

Parameters:

Name	Type
isDevelopment	boolean

Returns: void

---