Class: PrivateKey ​

The secret (private) part of an asymmetric key pair that is typically used to digitally sign or decrypt data.

Constructors ​

new PrivateKey() ​

new PrivateKey(bytes): PrivateKey

Creates a new private key from a byte array.

Throws when the byte array is not exactly 32 bytes long.

Parameters ​

• bytes: Uint8Array

Returns ​

PrivateKey

Defined in ​

web.d.ts:1634

Methods ​

free() ​

free(): void

Returns ​

void

Defined in ​

web.d.ts:1614

serialize() ​

serialize(): Uint8Array

Serializes the private key to a byte array.

Returns ​

Uint8Array

Defined in ​

web.d.ts:1639

toHex() ​

toHex(): string

Formats the private key into a hex string.

Returns ​

string

Defined in ​

web.d.ts:1652

fromHex() ​

static fromHex(hex): PrivateKey

Parses a private key from its hex representation.

Throws when the string is not valid hex format or when it represents less than 32 bytes.

Parameters ​

• hex: string

Returns ​

PrivateKey

Defined in ​

web.d.ts:1647

generate() ​

static generate(): PrivateKey

Generates a new private key from secure randomness.

Returns ​

PrivateKey

Defined in ​

web.d.ts:1619

unserialize() ​

static unserialize(bytes): PrivateKey

Deserializes a private key from a byte array.

Throws when the byte array contains less than 32 bytes.

Parameters ​

• bytes: Uint8Array

Returns ​

PrivateKey

Defined in ​

web.d.ts:1627