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

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

Defined in: @nimiq/core/lib/index.d.ts:206

## Extends

- [`Secret`](Secret)

## Constructors

### Constructor

> **new Entropy**(`arg`): `Entropy`

Defined in: @nimiq/core/lib/index.d.ts:213

Creates a new Entropy from a byte array.

#### Parameters

##### arg

`Uint8Array`

#### Returns

`Entropy`

#### Overrides

[`Secret`](Secret).[`constructor`](Secret#constructor)

## Properties

### ENCRYPTION_CHECKSUM_SIZE

> `static` **ENCRYPTION_CHECKSUM_SIZE**: `number`

Defined in: @nimiq/core/lib/index.d.ts:181

#### Inherited from

[`Secret`](Secret).[`ENCRYPTION_CHECKSUM_SIZE`](Secret#encryption_checksum_size)

---

### ENCRYPTION_CHECKSUM_SIZE_V3

> `static` **ENCRYPTION_CHECKSUM_SIZE_V3**: `number`

Defined in: @nimiq/core/lib/index.d.ts:182

#### Inherited from

[`Secret`](Secret).[`ENCRYPTION_CHECKSUM_SIZE_V3`](Secret#encryption_checksum_size_v3)

---

### ENCRYPTION_KDF_ROUNDS

> `static` **ENCRYPTION_KDF_ROUNDS**: `number`

Defined in: @nimiq/core/lib/index.d.ts:180

#### Inherited from

[`Secret`](Secret).[`ENCRYPTION_KDF_ROUNDS`](Secret#encryption_kdf_rounds)

---

### ENCRYPTION_SALT_SIZE

> `static` **ENCRYPTION_SALT_SIZE**: `number`

Defined in: @nimiq/core/lib/index.d.ts:179

#### Inherited from

[`Secret`](Secret).[`ENCRYPTION_SALT_SIZE`](Secret#encryption_salt_size)

---

### PURPOSE_ID

> `static` **PURPOSE_ID**: `number`

Defined in: @nimiq/core/lib/index.d.ts:208

---

### SIZE

> `static` **SIZE**: `number`

Defined in: @nimiq/core/lib/index.d.ts:207

#### Overrides

[`Secret`](Secret).[`SIZE`](Secret#size)

## Accessors

### encryptedSize

#### Get Signature

> **get** **encryptedSize**(): `number`

Defined in: @nimiq/core/lib/index.d.ts:196

Returns the serialized size of this object when encrypted.

##### Returns

`number`

#### Inherited from

[`Secret`](Secret).[`encryptedSize`](Secret#encryptedsize)

---

### serializedSize

#### Get Signature

> **get** **serializedSize**(): `number`

Defined in: @nimiq/core/lib/index.d.ts:241

Returns the serialized size of this Entropy.

##### Returns

`number`

## Methods

### compare()

> **compare**(`o`): `number`

Defined in: @nimiq/core/lib/index.d.ts:97

Compares this object to another object.

Returns a negative number if `this` is smaller than o, a positive number if `this` is larger than o, and zero if equal.

#### Parameters

##### o

`Serializable`

#### Returns

`number`

#### Inherited from

[`Secret`](Secret).[`compare`](Secret#compare)

---

### equals()

> **equals**(`o`): `boolean`

Defined in: @nimiq/core/lib/index.d.ts:249

Checks for equality with another Entropy.

#### Parameters

##### o

`unknown`

#### Returns

`boolean`

#### Overrides

[`Secret`](Secret).[`equals`](Secret#equals)

---

### exportEncrypted()

> **exportEncrypted**(`key`): `Promise`<[`SerialBuffer`](SerialBuffer)>

Defined in: @nimiq/core/lib/index.d.ts:192

Encrypts the Secret with a password.

#### Parameters

##### key

`Uint8Array`

#### Returns

`Promise`<[`SerialBuffer`](SerialBuffer)>

#### Inherited from

[`Secret`](Secret).[`exportEncrypted`](Secret#exportencrypted)

---

### overwrite()

> **overwrite**(`entropy`): `void`

Defined in: @nimiq/core/lib/index.d.ts:245

Overwrites this Entropy's bytes with a replacement in-memory

#### Parameters

##### entropy

`Entropy`

#### Returns

`void`

---

### serialize()

> **serialize**(`buf?`): [`SerialBuffer`](SerialBuffer)

Defined in: @nimiq/core/lib/index.d.ts:237

Serializes the Entropy to a byte array.

#### Parameters

##### buf?

[`SerialBuffer`](SerialBuffer)

#### Returns

[`SerialBuffer`](SerialBuffer)

#### Overrides

[`Secret`](Secret).[`serialize`](Secret#serialize)

---

### toBase64()

> **toBase64**(): `string`

Defined in: @nimiq/core/lib/index.d.ts:106

Formats the object into a base64 string.

#### Returns

`string`

#### Inherited from

[`Secret`](Secret).[`toBase64`](Secret#tobase64)

---

### toExtendedPrivateKey()

> **toExtendedPrivateKey**(`password?`, `wordlist?`): [`ExtendedPrivateKey`](ExtendedPrivateKey)

Defined in: @nimiq/core/lib/index.d.ts:221

Derives an ExtendedPrivateKey from the Entropy.

#### Parameters

##### password?

`string`

##### wordlist?

`string`<span>



</span>



#### Returns

[`ExtendedPrivateKey`](ExtendedPrivateKey)

---

### toHex()

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

Defined in: @nimiq/core/lib/index.d.ts:110

Formats the object into a hex string.

#### Returns

`string`

#### Inherited from

[`Secret`](Secret).[`toHex`](Secret#tohex)

---

### toMnemonic()

> **toMnemonic**(`wordlist?`): `string`<span>
> 
> 
> 
> </span>

Defined in: @nimiq/core/lib/index.d.ts:225

Converts the Entropy into a mnemonic.

#### Parameters

##### wordlist?

`string`<span>



</span>



#### Returns

`string`<span>



</span>



---

### toString()

> **toString**(): `string`

Defined in: @nimiq/core/lib/index.d.ts:102

Formats the object into a hex string.

#### Returns

`string`

#### Inherited from

[`Secret`](Secret).[`toString`](Secret#tostring)

---

### deserialize()

> `static` **deserialize**(`buf`): `Entropy`

Defined in: @nimiq/core/lib/index.d.ts:229

Deserializes an Entropy object from a byte array.

#### Parameters

##### buf

[`SerialBuffer`](SerialBuffer)

#### Returns

`Entropy`

---

### exportEncrypted()

> `static` **exportEncrypted**(`secret`, `key`): `Promise`<[`SerialBuffer`](SerialBuffer)>

Defined in: @nimiq/core/lib/index.d.ts:188

#### Parameters

##### secret

[`Secret`](Secret) | `PrivateKey`

##### key

`Uint8Array`

#### Returns

`Promise`<[`SerialBuffer`](SerialBuffer)>

#### Inherited from

[`Secret`](Secret).[`exportEncrypted`](Secret#exportencrypted-2)

---

### fromEncrypted()

> `static` **fromEncrypted**(`buf`, `key`): `Promise`<`Entropy` | `PrivateKey`>

Defined in: @nimiq/core/lib/index.d.ts:187

Decrypts a Secret from an encrypted byte array and its password.

#### Parameters

##### buf

[`SerialBuffer`](SerialBuffer)

##### key

`Uint8Array`

#### Returns

`Promise`<`Entropy` | `PrivateKey`>

#### Inherited from

[`Secret`](Secret).[`fromEncrypted`](Secret#fromencrypted)

---

### fromHex()

> `static` **fromHex**(`hex`): `Entropy`

Defined in: @nimiq/core/lib/index.d.ts:233

Deserializes an Entropy object from a hex string.

#### Parameters

##### hex

`string`

#### Returns

`Entropy`

---

### generate()

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

Defined in: @nimiq/core/lib/index.d.ts:217

Generates a new Entropy object from secure randomness.

#### Returns

`Entropy`


## Sitemap

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