Home Reference Source Test
public class | source

KeyPair

Extends:

Serializable → KeyPair

Static Method Summary

Static Public Methods
public static

derive(privateKey: PrivateKey): KeyPair

public static

async fromEncrypted(buf: SerialBuffer, key: Uint8Array): Promise<KeyPair>

public static

fromHex(hexBuf: string): KeyPair

public static
public static

Member Summary

Public Members
public get

encryptedSize: number

public get
public get

The unlocked private key.

public get
public get

serializedSize: number

Method Summary

Public Methods
public

equals(o: Serializable): boolean

public

exportEncrypted(key: Uint8Array): Promise<SerialBuffer>

public

async lock(key: Uint8Array, lockSalt: Uint8Array)

public

relock()

Destroy cached unlocked private key if the internal key is in locked state.

public
public

async unlock(key: Uint8Array)

Inherited Summary

From class Serializable
public

compare(o: Serializable): number

public

equals(o: Serializable): boolean

public

hashCode(): *

public abstract
public

toBase64(): string

public

toHex(): string

public

toString(): string

Static Public Methods

public static derive(privateKey: PrivateKey): KeyPair source

Params:

NameTypeAttributeDescription
privateKey PrivateKey

Return:

KeyPair

public static async fromEncrypted(buf: SerialBuffer, key: Uint8Array): Promise<KeyPair> source

Params:

NameTypeAttributeDescription
buf SerialBuffer
key Uint8Array

Return:

Promise<KeyPair>

public static fromHex(hexBuf: string): KeyPair source

Params:

NameTypeAttributeDescription
hexBuf string

Return:

KeyPair

public static generate(): KeyPair source

Return:

KeyPair

public static unserialize(buf: SerialBuffer): KeyPair source

Params:

NameTypeAttributeDescription
buf SerialBuffer

Return:

KeyPair

Public Members

public get encryptedSize: number source

public get isLocked: * source

public get privateKey: PrivateKey source

The unlocked private key.

public get publicKey: PublicKey source

public get serializedSize: number source

Public Methods

public equals(o: Serializable): boolean source

Override:

Serializable#equals

Params:

NameTypeAttributeDescription
o Serializable

Return:

boolean

public exportEncrypted(key: Uint8Array): Promise<SerialBuffer> source

Params:

NameTypeAttributeDescription
key Uint8Array

Return:

Promise<SerialBuffer>

public async lock(key: Uint8Array, lockSalt: Uint8Array) source

Params:

NameTypeAttributeDescription
key Uint8Array
lockSalt Uint8Array
  • optional

public relock() source

Destroy cached unlocked private key if the internal key is in locked state.

public serialize(buf: SerialBuffer): SerialBuffer source

Override:

Serializable#serialize

Params:

NameTypeAttributeDescription
buf SerialBuffer
  • optional

Return:

SerialBuffer

public async unlock(key: Uint8Array) source

Params:

NameTypeAttributeDescription
key Uint8Array