Class: Policy ​

Constructors ​

new Policy() ​

new Policy(): Policy

Returns ​

Policy

Properties ​

BATCHES_PER_EPOCH ​

readonly static BATCHES_PER_EPOCH: number

How many batches constitute an epoch

Defined in ​

web.d.ts:1472

BLOCKS_DELAY_DECAY ​

readonly static BLOCKS_DELAY_DECAY: number

The slope of the exponential decay used to punish validators for not producing block in time

Defined in ​

web.d.ts:1476

BLOCKS_PER_BATCH ​

readonly static BLOCKS_PER_BATCH: number

Length of a batch including the macro block

Defined in ​

web.d.ts:1480

BLOCKS_PER_EPOCH ​

readonly static BLOCKS_PER_EPOCH: number

Length of an epoch including the election block

Defined in ​

web.d.ts:1484

BLOCK_PRODUCER_TIMEOUT ​

readonly static BLOCK_PRODUCER_TIMEOUT: bigint

The timeout in milliseconds for a validator to produce a block (2s)

Defined in ​

web.d.ts:1488

BLOCK_SEPARATION_TIME ​

readonly static BLOCK_SEPARATION_TIME: bigint

The optimal time in milliseconds between blocks (1s)

Defined in ​

web.d.ts:1492

BLS_CACHE_MAX_CAPACITY ​

readonly static BLS_CACHE_MAX_CAPACITY: number

The maximum size of the BLS public key cache.

Defined in ​

web.d.ts:1496

COINBASE_ADDRESS ​

readonly static COINBASE_ADDRESS: string

This is the address for the coinbase. Note that this is not a real account, it is just the address we use to denote that some coins originated from a coinbase event.

Defined in ​

web.d.ts:1501

F_PLUS_ONE ​

readonly static F_PLUS_ONE: number

Calculates f+1 slots which is the minimum number of slots necessary to be guaranteed to have at least one honest slots. That's because from a total of 3f+1 slots at most f will be malicious. It is calculated as ceil(SLOTS/3) and we use the formula ceil(x/y) = (x+y-1)/y for the ceiling division.

Defined in ​

web.d.ts:1508

GENESIS_BLOCK_NUMBER ​

readonly static GENESIS_BLOCK_NUMBER: number

Genesis block number

Defined in ​

web.d.ts:1512

HISTORY_CHUNKS_MAX_SIZE ​

readonly static HISTORY_CHUNKS_MAX_SIZE: bigint

Maximum size of history chunks. 25 MB.

Defined in ​

web.d.ts:1517

INITIAL_SUPPLY_VELOCITY ​

readonly static INITIAL_SUPPLY_VELOCITY: number

This is the number of Lunas (1 NIM = 100,000 Lunas) created by millisecond at the genesis of the Nimiq 2.0 chain. The velocity then decreases following the formula: Supply_velocity (t) = Initial_supply_velocity * e^(- Supply_decay * t) Where e is the exponential function and t is the time in milliseconds since the genesis block.

Defined in ​

web.d.ts:1524

JAIL_EPOCHS ​

readonly static JAIL_EPOCHS: number

The number of epochs a validator is put in jail for. The jailing only happens for severe offenses.

Defined in ​

web.d.ts:1528

MAX_SIZE_MICRO_BODY ​

readonly static MAX_SIZE_MICRO_BODY: number

The maximum allowed size, in bytes, for a micro block body.

Defined in ​

web.d.ts:1532

MINIMUM_REWARDS_PERCENTAGE ​

readonly static MINIMUM_REWARDS_PERCENTAGE: number

The minimum rewards percentage that we allow

Defined in ​

web.d.ts:1536

MIN_EPOCHS_STORED ​

readonly static MIN_EPOCHS_STORED: number

Minimum number of epochs that the ChainStore will store fully

Defined in ​

web.d.ts:1540

SLOTS ​

readonly static SLOTS: number

Number of available validator slots. Note that a single validator may own several validator slots.

Defined in ​

web.d.ts:1544

STAKING_CONTRACT_ADDRESS ​

readonly static STAKING_CONTRACT_ADDRESS: string

This is the address for the staking contract.

Defined in ​

web.d.ts:1548

STATE_CHUNKS_MAX_SIZE ​

readonly static STATE_CHUNKS_MAX_SIZE: number

Maximum size of accounts trie chunks.

Defined in ​

web.d.ts:1552

SUPPLY_DECAY ​

readonly static SUPPLY_DECAY: number

The supply decay is a constant that is calculated so that the supply velocity decreases at a steady 1.47% per year.

Defined in ​

web.d.ts:1557

TENDERMINT_TIMEOUT_DELTA ​

readonly static TENDERMINT_TIMEOUT_DELTA: bigint

Tendermint's timeout delta, in milliseconds.

See https://arxiv.org/abs/1807.04938v3 for more information.

Defined in ​

web.d.ts:1563

TENDERMINT_TIMEOUT_INIT ​

readonly static TENDERMINT_TIMEOUT_INIT: bigint

Tendermint's initial timeout, in milliseconds.

See https://arxiv.org/abs/1807.04938v3 for more information.

Defined in ​

web.d.ts:1569

TIMESTAMP_MAX_DRIFT ​

readonly static TIMESTAMP_MAX_DRIFT: bigint

The maximum drift, in milliseconds, that is allowed between any block's timestamp and the node's system time. We only care about drifting to the future.

Defined in ​

web.d.ts:1574

TOTAL_SUPPLY ​

readonly static TOTAL_SUPPLY: bigint

Total supply in units.

Defined in ​

web.d.ts:1578

TRANSACTION_VALIDITY_WINDOW ​

readonly static TRANSACTION_VALIDITY_WINDOW: number

Number of batches a transaction is valid with Albatross consensus.

Defined in ​

web.d.ts:1582

TRANSACTION_VALIDITY_WINDOW_BLOCKS ​

readonly static TRANSACTION_VALIDITY_WINDOW_BLOCKS: number

Number of blocks a transaction is valid with Albatross consensus.

Defined in ​

web.d.ts:1586

TWO_F_PLUS_ONE ​

readonly static TWO_F_PLUS_ONE: number

Calculates 2f+1 slots which is the minimum number of slots necessary to produce a macro block, a skip block and other actions. It is also the minimum number of slots necessary to be guaranteed to have a majority of honest slots. That's because from a total of 3f+1 slots at most f will be malicious. If in a group of 2f+1 slots we have f malicious ones (which is the worst case scenario), that still leaves us with f+1 honest slots. Which is more than the f slots that are not in this group (which must all be honest). It is calculated as ceil(SLOTS*2/3) and we use the formula ceil(x/y) = (x+y-1)/y for the ceiling division.

Defined in ​

web.d.ts:1598

VALIDATOR_DEPOSIT ​

readonly static VALIDATOR_DEPOSIT: bigint

The deposit necessary to create a validator in Lunas (1 NIM = 100,000 Lunas). A validator is someone who actually participates in block production. They are akin to miners in proof-of-work.

Defined in ​

web.d.ts:1604

VERSION ​

readonly static VERSION: number

The current version number of the protocol. Changing this always results in a hard fork.

Defined in ​

web.d.ts:1608

Methods ​

free() ​

free(): void

Returns ​

void

Defined in ​

web.d.ts:1307

batchAt() ​

static batchAt(block_number): number

Returns the batch number at a given block_number (height)

Parameters ​

• block_number: number

Returns ​

number

Defined in ​

web.d.ts:1326

batchDelayPenalty() ​

static batchDelayPenalty(delay): number

Returns the percentage reduction that should be applied to the rewards due to a delayed batch. This function returns a float in the range [0, 1] I.e 1 means that the full rewards should be given, whereas 0.5 means that half of the rewards should be given The input to this function is the batch delay, in milliseconds The function is: [(1 - MINIMUM_REWARDS_PERCENTAGE) * e ^(-BLOCKS_DELAY_DECAY * t^2)] + MINIMUM_REWARDS_PERCENTAGE

Parameters ​

• delay: bigint

Returns ​

number

Defined in ​

web.d.ts:1468

batchIndexAt() ​

static batchIndexAt(block_number): number

Returns the batch index at a given block number. The batch index is the number of a block relative to the batch it is in. For example, the first block of any batch always has an batch index of 0.

Parameters ​

• block_number: number

Returns ​

number

Defined in ​

web.d.ts:1333

blockAfterJail() ​

static blockAfterJail(block_number): number

Returns the first block after the jail period of a given block number has ended.

Parameters ​

• block_number: number

Returns ​

number

Defined in ​

web.d.ts:1446

blockAfterReportingWindow() ​

static blockAfterReportingWindow(block_number): number

Returns the first block after the reporting window of a given block number has ended.

Parameters ​

• block_number: number

Returns ​

number

Defined in ​

web.d.ts:1440

electionBlockAfter() ​

static electionBlockAfter(block_number): number

Returns the number (height) of the next election macro block after a given block number (height).

Parameters ​

• block_number: number

Returns ​

number

Defined in ​

web.d.ts:1339

electionBlockBefore() ​

static electionBlockBefore(block_number): number

Returns the block number (height) of the preceding election macro block before a given block number (height). If the given block number is an election macro block, it returns the election macro block before it.

Parameters ​

• block_number: number

Returns ​

number

Defined in ​

web.d.ts:1346

electionBlockOf() ​

static electionBlockOf(epoch): number

Returns the block number of the election macro block of the given epoch (which is always the last block). If the index is out of bounds, None is returned

Parameters ​

• epoch: number

Returns ​

number

Defined in ​

web.d.ts:1412

epochAt() ​

static epochAt(block_number): number

Returns the epoch number at a given block number (height).

Parameters ​

• block_number: number

Returns ​

number

Defined in ​

web.d.ts:1313

epochIndexAt() ​

static epochIndexAt(block_number): number

Returns the epoch index at a given block number. The epoch index is the number of a block relative to the epoch it is in. For example, the first block of any epoch always has an epoch index of 0.

Parameters ​

• block_number: number

Returns ​

number

Defined in ​

web.d.ts:1320

firstBatchOfEpoch() ​

static firstBatchOfEpoch(block_number): boolean

Returns a boolean expressing if the batch at a given block number (height) is the first batch of the epoch.

Parameters ​

• block_number: number

Returns ​

boolean

Defined in ​

web.d.ts:1427

firstBlockOf() ​

static firstBlockOf(epoch): number

Returns the block number of the first block of the given epoch (which is always a micro block). If the index is out of bounds, None is returned

Parameters ​

• epoch: number

Returns ​

number

Defined in ​

web.d.ts:1398

firstBlockOfBatch() ​

static firstBlockOfBatch(batch): number

Returns the block number of the first block of the given batch (which is always a micro block). If the index is out of bounds, None is returned

Parameters ​

• batch: number

Returns ​

number

Defined in ​

web.d.ts:1405

isElectionBlockAt() ​

static isElectionBlockAt(block_number): boolean

Returns a boolean expressing if the block at a given block number (height) is an election macro block.

Parameters ​

• block_number: number

Returns ​

boolean

Defined in ​

web.d.ts:1359

isMacroBlockAt() ​

static isMacroBlockAt(block_number): boolean

Returns a boolean expressing if the block at a given block number (height) is a macro block.

Parameters ​

• block_number: number

Returns ​

boolean

Defined in ​

web.d.ts:1385

isMicroBlockAt() ​

static isMicroBlockAt(block_number): boolean

Returns a boolean expressing if the block at a given block number (height) is a micro block.

Parameters ​

• block_number: number

Returns ​

boolean

Defined in ​

web.d.ts:1391

lastBlockOfReportingWindow() ​

static lastBlockOfReportingWindow(block_number): number

Returns the block height for the last block of the reporting window of a given block number. Note: This window is meant for reporting malicious behaviour (aka jailable behaviour).

Parameters ​

• block_number: number

Returns ​

number

Defined in ​

web.d.ts:1434

lastElectionBlock() ​

static lastElectionBlock(block_number): number

Returns the block number (height) of the last election macro block at a given block number (height). If the given block number is an election macro block, then it returns that block number.

Parameters ​

• block_number: number

Returns ​

number

Defined in ​

web.d.ts:1353

lastMacroBlock() ​

static lastMacroBlock(block_number): number

Returns the block number (height) of the last macro block at a given block number (height). If the given block number is a macro block, then it returns that block number.

Parameters ​

• block_number: number

Returns ​

number

Defined in ​

web.d.ts:1379

macroBlockAfter() ​

static macroBlockAfter(block_number): number

Returns the block number (height) of the next macro block after a given block number (height).

Parameters ​

• block_number: number

Returns ​

number

Defined in ​

web.d.ts:1365

macroBlockBefore() ​

static macroBlockBefore(block_number): number

Returns the block number (height) of the preceding macro block before a given block number (height). If the given block number is a macro block, it returns the macro block before it.

Parameters ​

• block_number: number

Returns ​

number

Defined in ​

web.d.ts:1372

macroBlockOf() ​

static macroBlockOf(batch): number

Returns the block number of the macro block (checkpoint or election) of the given batch (which is always the last block). If the index is out of bounds, None is returned

Parameters ​

• batch: number

Returns ​

number

Defined in ​

web.d.ts:1420

supplyAt() ​

static supplyAt(genesis_supply, genesis_time, current_time): bigint

Returns the supply at a given time (as Unix time) in Lunas (1 NIM = 100,000 Lunas). It is calculated using the following formula: Supply (t) = Genesis_supply + Initial_supply_velocity / Supply_decay * (1 - e^(- Supply_decay * t)) Where e is the exponential function, t is the time in milliseconds since the genesis block and Genesis_supply is the supply at the genesis of the Nimiq 2.0 chain.

Parameters ​

• genesis_supply: bigint

• genesis_time: bigint

• current_time: bigint

Returns ​

bigint

Defined in ​

web.d.ts:1458