Class Keystore

Hierarchy

Keystore

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Keystore(theCrypto: Crypto, id: string, origin?: undefined | string): Keystore

- Defined in packages/hd/src/keystore.ts:59
Parameters
- theCrypto: Crypto
- id: string
- Optional origin: undefined | string
Returns Keystore

Properties

crypto

crypto: Crypto

id

id: string

origin

origin: string | undefined

version

version: number = 3

Methods

checkPassword

checkPassword(password: string): boolean

- Defined in packages/hd/src/keystore.ts:224
Parameters
- password: string
Returns boolean

decrypt

decrypt(password: string): HexString

- Defined in packages/hd/src/keystore.ts:201
Parameters
- password: string
Returns HexString

derivedKey

derivedKey(password: string): Buffer

- Defined in packages/hd/src/keystore.ts:230
Parameters
- password: string
Returns Buffer

extendedPrivateKey

extendedPrivateKey(password: string): ExtendedPrivateKey

- Defined in packages/hd/src/keystore.ts:220
Parameters
- password: string
Returns ExtendedPrivateKey

isEmpty

isEmpty(): boolean

- Defined in packages/hd/src/keystore.ts:196
Returns boolean

isFromCkbCli

isFromCkbCli(): boolean

- Defined in packages/hd/src/keystore.ts:114
Returns boolean

save

save(dir: string, __namedParameters?: { name: string; overwrite: boolean }): void

- Defined in packages/hd/src/keystore.ts:92
Keystore file default name is ${id}.json.

Parameters
- dir: string
- Default value __namedParameters: { name: string; overwrite: boolean } = {}
  - name: string
  - overwrite: boolean
Returns void

toJson

toJson(): string

- Defined in packages/hd/src/keystore.ts:110
Returns string

Static create

create(extendedPrivateKey: ExtendedPrivateKey, password: string, options?: { iv?: Buffer; salt?: Buffer }): Keystore

- Defined in packages/hd/src/keystore.ts:144
Parameters
- extendedPrivateKey: ExtendedPrivateKey
- password: string
- Default value options: { iv?: Buffer; salt?: Buffer } = {}
  - Optional iv?: Buffer
  - Optional salt?: Buffer
Returns Keystore

Static createEmpty

createEmpty(): Keystore

- Defined in packages/hd/src/keystore.ts:119
Returns Keystore

Static fromJson

fromJson(json: string): Keystore

- Defined in packages/hd/src/keystore.ts:67
Parameters
- json: string
Returns Keystore

Static load

load(path: string): Keystore

- Defined in packages/hd/src/keystore.ts:81
Load keystore file from path.

Parameters
- path: string
Returns Keystore

Static mac

mac(derivedKey: Buffer, ciphertext: Buffer): HexStringWithoutPrefix

- Defined in packages/hd/src/keystore.ts:240
Parameters
- derivedKey: Buffer
- ciphertext: Buffer
Returns HexStringWithoutPrefix

Static scryptOptions

scryptOptions(kdfparams: KdfParams): ScryptOptions

- Defined in packages/hd/src/keystore.ts:246
Parameters
- kdfparams: KdfParams
Returns ScryptOptions

Generated using TypeDoc