@nimiq/core / KeyPair

Class: KeyPair ​

Defined in: @nimiq/core/types/wasm/web.d.ts:1340

A keypair represents a private key and its respective public key. It is used for signing data, usually transactions.

Constructors ​

Constructor ​

new KeyPair(private_key, public_key): KeyPair

Defined in: @nimiq/core/types/wasm/web.d.ts:1362

Parameters ​

private_key ​

PrivateKey

public_key ​

PublicKey

Returns ​

KeyPair

Properties ​

privateKey ​

readonly privateKey: PrivateKey

Defined in: @nimiq/core/types/wasm/web.d.ts:1386

Gets the keypair's private key.

publicKey ​

readonly publicKey: PublicKey

Defined in: @nimiq/core/types/wasm/web.d.ts:1390

Gets the keypair's public key.

Methods ​

free() ​

free(): void

Defined in: @nimiq/core/types/wasm/web.d.ts:1341

Returns ​

void

serialize() ​

serialize(): Uint8Array

Defined in: @nimiq/core/types/wasm/web.d.ts:1366

Serializes the keypair to a byte array.

Returns ​

Uint8Array

sign() ​

sign(data): Signature

Defined in: @nimiq/core/types/wasm/web.d.ts:1370

Signs arbitrary data, returns a signature object.

Parameters ​

data ​

Uint8Array

Returns ​

Signature

signTransaction() ​

signTransaction(transaction): void

Defined in: @nimiq/core/types/wasm/web.d.ts:1374

Signs a transaction and sets the signature proof on the transaction object.

Parameters ​

transaction ​

Transaction

Returns ​

void

toAddress() ​

toAddress(): Address

Defined in: @nimiq/core/types/wasm/web.d.ts:1378

Gets the keypair's address.

Returns ​

Address

toHex() ​

toHex(): string

Defined in: @nimiq/core/types/wasm/web.d.ts:1382

Formats the keypair into a hex string.

Returns ​

string

derive() ​

static derive(private_key): KeyPair

Defined in: @nimiq/core/types/wasm/web.d.ts:1349

Derives a keypair from an existing private key.

Parameters ​

private_key ​

PrivateKey

Returns ​

KeyPair

deserialize() ​

static deserialize(bytes): KeyPair

Defined in: @nimiq/core/types/wasm/web.d.ts:1361

Deserializes a keypair from a byte array.

Throws when the byte array contains less than 64 bytes.

Parameters ​

bytes ​

Uint8Array

Returns ​

KeyPair

fromHex() ​

static fromHex(hex): KeyPair

Defined in: @nimiq/core/types/wasm/web.d.ts:1355

Parses a keypair from its hex representation.

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

Parameters ​

hex ​

string

Returns ​

KeyPair

generate() ​

static generate(): KeyPair

Defined in: @nimiq/core/types/wasm/web.d.ts:1345

Generates a new keypair from secure randomness.

Returns ​

KeyPair