---
title: "Class: KeyPair"
canonical_url: "https://nimiq.dev/web-client/reference/classes/keypair"
---
# Class: KeyPair

[@nimiq/core](../globals) / KeyPair

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

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:1485

#### Parameters

##### private_key

[`PrivateKey`](PrivateKey)

##### public_key

[`PublicKey`](PublicKey)

#### Returns

`KeyPair`

## Properties

### privateKey

> `readonly` **privateKey**: [`PrivateKey`](PrivateKey)

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

Gets the keypair's private key.

---

### publicKey

> `readonly` **publicKey**: [`PublicKey`](PublicKey)

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

Gets the keypair's public key.

## Methods

### __getClassname()

> **__getClassname**(): `string`

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

#### Returns

`string`

---

### [dispose]()

> **[dispose]**(): `void`

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

#### Returns

`void`

---

### free()

> **free**(): `void`

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

#### Returns

`void`

---

### serialize()

> **serialize**(): `Uint8Array`

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

Serializes the keypair to a byte array.

#### Returns

`Uint8Array`

---

### sign()

> **sign**(`data`): [`Signature`](Signature)

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

Signs arbitrary data, returns a signature object.

#### Parameters

##### data

`Uint8Array`

#### Returns

[`Signature`](Signature)

---

### signTransaction()

> **signTransaction**(`transaction`): `void`

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

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

#### Parameters

##### transaction

[`Transaction`](Transaction)

#### Returns

`void`

---

### toAddress()

> **toAddress**(): [`Address`](Address)

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

Gets the keypair's address.

#### Returns

[`Address`](Address)

---

### toHex()

> **toHex**(): `string`

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

Formats the keypair into a hex string.

#### Returns

`string`

---

### derive()

> `static` **derive**(`private_key`): `KeyPair`

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

Derives a keypair from an existing private key.

#### Parameters

##### private_key

[`PrivateKey`](PrivateKey)

#### Returns

`KeyPair`

---

### deserialize()

> `static` **deserialize**(`bytes`): `KeyPair`

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

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:1480

Parses a keypair from its hex representation.

Throws when the string is not valid hex or does not represent a 64-byte keypair
(optionally followed by a 1-byte lock-state flag, as produced by `toHex`).

#### Parameters

##### hex

`string`

#### Returns

`KeyPair`

---

### generate()

> `static` **generate**(): `KeyPair`

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

Generates a new keypair from secure randomness.

#### Returns

`KeyPair`


## Sitemap

See the full [sitemap](https://nimiq.dev/sitemap.md) for all pages.