Class Keystore

constructor

• new Keystore(theCrypto, id, origin?): Keystore

• Parameters

  • theCrypto: Crypto

  • id: string

  • Optional origin: string

  Returns Keystore

crypto

id

origin

version

checkPassword

• checkPassword(password): boolean

• Parameters

  • password: string

  Returns boolean

decrypt

• decrypt(password): string

• Parameters

  • password: string

  Returns string

derivedKey

• derivedKey(password): Buffer

• Parameters

  • password: string

  Returns Buffer

extendedPrivateKey

• extendedPrivateKey(password): ExtendedPrivateKey

• Parameters

  • password: string

  Returns ExtendedPrivateKey

isEmpty

• isEmpty(): boolean

• Returns boolean

isFromCkbCli

• isFromCkbCli(): boolean

• Returns boolean

save

• save(dir, options?): void

• Parameters

  • dir: string

  • options: {
        name?: string;
        overwrite?: boolean;
    } = {}

    If you are sure to overwrite existing keystore file, set overwrite to true.

    • Optional name?: string

    • Optional overwrite?: boolean

  Returns void

  Deprecated

  Keystore file default name is ${id}.json.

toJson

• toJson(): string

• Returns string

Static create

• create(extendedPrivateKey, password, options?): Keystore

• Parameters

  • extendedPrivateKey: ExtendedPrivateKey

  • password: string

  • options: {
        iv?: Buffer;
        salt?: Buffer;
    } = {}

    • Optional iv?: Buffer

    • Optional salt?: Buffer

  Returns Keystore

Static createEmpty

• createEmpty(): Keystore

• Returns Keystore

Static fromJson

• fromJson(json): Keystore

• Parameters

  • json: string

  Returns Keystore

Static load

• load(path): Keystore

• Parameters

  • path: string

  Returns Keystore

  Deprecated

  Load keystore file from path.

Static mac

• mac(derivedKey, ciphertext): string

• Parameters

  • derivedKey: Buffer

  • ciphertext: Buffer

  Returns string

Static scryptOptions

• scryptOptions(kdfparams): ScryptOptions

• Parameters

  • kdfparams: KdfParams

  Returns ScryptOptions