274 lines
9.4 KiB
Nim
274 lines
9.4 KiB
Nim
# Nimbus
|
|
# Copyright (c) 2018 Status Research & Development GmbH
|
|
# Licensed under either of
|
|
# * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
|
|
# http://www.apache.org/licenses/LICENSE-2.0)
|
|
# * MIT license ([LICENSE-MIT](LICENSE-MIT) or
|
|
# http://opensource.org/licenses/MIT)
|
|
# at your option. This file may not be copied, modified, or distributed except
|
|
# according to those terms.
|
|
|
|
##
|
|
## Clique PoA Constants & Types
|
|
## ============================
|
|
##
|
|
## Constants used by Clique proof-of-authority consensus protocol, see
|
|
## `EIP-225 <https://github.com/ethereum/EIPs/blob/master/EIPS/eip-225.md>`_
|
|
## and
|
|
## `go-ethereum <https://github.com/ethereum/EIPs/blob/master/EIPS/eip-225.md>`_
|
|
##
|
|
|
|
import
|
|
std/[times],
|
|
eth/common,
|
|
stew/results,
|
|
stint
|
|
|
|
{.push raises: [].}
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Constants copied from eip-225 specs & implementation
|
|
# ------------------------------------------------------------------------------
|
|
|
|
# clique/clique.go(48): const ( [..]
|
|
const
|
|
CHECKPOINT_INTERVAL* = ##\
|
|
## Number of blocks after which to save the vote snapshot to the database
|
|
1024
|
|
|
|
INMEMORY_SNAPSHOTS* = ##\
|
|
## Number of recent vote snapshots to keep in memory
|
|
128
|
|
|
|
INMEMORY_SIGNATURES* = ##\
|
|
## Number of recent block signatures to keep in memory
|
|
4096
|
|
|
|
WIGGLE_TIME* = ##\
|
|
## Random delay (per signer) to allow concurrent signers
|
|
initDuration(seconds = 0, milliseconds = 500)
|
|
|
|
# clique/clique.go(57): var ( [..]
|
|
const
|
|
BLOCK_PERIOD* = ##\
|
|
## Minimum difference in seconds between two consecutive block's
|
|
## timestamps. Suggested 15s for the testnet to remain analogous to the
|
|
## mainnet ethash target.
|
|
initDuration(seconds = 15)
|
|
|
|
EXTRA_VANITY* = ##\
|
|
## Fixed number of extra-data prefix bytes reserved for signer vanity.
|
|
## Suggested 32 bytes to retain the current extra-data allowance and/or use.
|
|
32
|
|
|
|
EXTRA_SEAL* = ##\
|
|
## Fixed number of extra-data suffix bytes reserved for signer seal.
|
|
## 65 bytes fixed as signatures are based on the standard secp256k1 curve.
|
|
65
|
|
|
|
NONCE_AUTH* = ##\
|
|
## Magic nonce number 0xffffffffffffffff to vote on adding a new signer.
|
|
0xffffffffffffffffu64.toBlockNonce
|
|
|
|
NONCE_DROP* = ##\
|
|
## Magic nonce number 0x0000000000000000 to vote on removing a signer.
|
|
0x0000000000000000u64.toBlockNonce
|
|
|
|
DIFF_NOTURN* = ##\
|
|
## Block score (difficulty) for blocks containing out-of-turn signatures.
|
|
## Suggested 1 since it just needs to be an arbitrary baseline constant.
|
|
1.u256
|
|
|
|
DIFF_INTURN* = ##\
|
|
## Block score (difficulty) for blocks containing in-turn signatures.
|
|
## Suggested 2 to show a slight preference over out-of-turn signatures.
|
|
2.u256
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Additional constants copied from eip-225 go implementation
|
|
# ------------------------------------------------------------------------------
|
|
|
|
const
|
|
# params/network_params.go(60): FullImmutabilityThreshold = 90000
|
|
FULL_IMMUTABILITY_THRESHOLD* = ##\
|
|
## Number of blocks after which a chain segment is considered immutable (ie.
|
|
## soft finality). It is used by the downloader as a hard limit against
|
|
## deep ancestors, by the blockchain against deep reorgs, by the freezer as
|
|
## the cutoff threshold and by clique as the snapshot trust limit.
|
|
90000
|
|
|
|
# params/protocol_params.go(121): BaseFeeChangeDenominator = 8 [..]
|
|
EIP1559_BASE_FEE_CHANGE_DENOMINATOR* = ##\
|
|
## Bounds the amount the base fee can change between blocks.
|
|
8
|
|
|
|
# params/protocol_params.go(122): ElasticityMultiplier = 2 [..]
|
|
EIP1559_ELASTICITY_MULTIPLIER* = ##\
|
|
## Bounds the maximum gas limit an EIP-1559 block may have.
|
|
2
|
|
|
|
# params/protocol_params.go(123): InitialBaseFee = 1000000000 [..]
|
|
EIP1559_INITIAL_BASE_FEE* = ##\
|
|
## Initial base fee for Eip1559 blocks.
|
|
1000000000i64
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Error tokens
|
|
# ------------------------------------------------------------------------------
|
|
|
|
# clique/clique.go(76): var ( [..]
|
|
type
|
|
CliqueErrorType* = enum
|
|
noCliqueError = 0 ##\
|
|
## Default/reset value
|
|
|
|
errUnknownBlock = ##\
|
|
## is returned when the list of signers is requested for a block that is
|
|
## not part of the local blockchain.
|
|
"unknown block"
|
|
|
|
errInvalidCheckpointBeneficiary = ##\
|
|
## is returned if a checkpoint/epoch transition block has a beneficiary
|
|
## set to non-zeroes.
|
|
"beneficiary in checkpoint block non-zero"
|
|
|
|
errInvalidVote = ##\
|
|
## is returned if a nonce value is something else that the two allowed
|
|
## constants of 0x00..0 or 0xff..f.
|
|
"vote nonce not 0x00..0 or 0xff..f"
|
|
|
|
errInvalidCheckpointVote = ##\
|
|
## is returned if a checkpoint/epoch transition block has a vote nonce
|
|
## set to non-zeroes.
|
|
"vote nonce in checkpoint block non-zero"
|
|
|
|
errMissingVanity = ##\
|
|
## is returned if a block's extra-data section is shorter than 32 bytes,
|
|
## which is required to store the signer vanity.
|
|
"extra-data 32 byte vanity prefix missing"
|
|
|
|
errMissingSignature = ##\
|
|
## is returned if a block's extra-data section doesn't seem to contain a
|
|
## 65 byte secp256k1 signature.
|
|
"extra-data 65 byte signature suffix missing"
|
|
|
|
errExtraSigners = ##\
|
|
## is returned if non-checkpoint block contain signer data in their
|
|
## extra-data fields.
|
|
"non-checkpoint block contains extra signer list"
|
|
|
|
errInvalidCheckpointSigners = ##\
|
|
## is returned if a checkpoint block contains an invalid list of signers
|
|
## (i.e. non divisible by 20 bytes).
|
|
"invalid signer list on checkpoint block"
|
|
|
|
errMismatchingCheckpointSigners = ##\
|
|
## is returned if a checkpoint block contains a list of signers different
|
|
## than the one the local node calculated.
|
|
"mismatching signer list on checkpoint block"
|
|
|
|
errInvalidMixDigest = ##\
|
|
## is returned if a block's mix digest is non-zero.
|
|
"non-zero mix digest"
|
|
|
|
errInvalidUncleHash = ##\
|
|
## is returned if a block contains an non-empty uncle list.
|
|
"non empty uncle hash"
|
|
|
|
errInvalidDifficulty = ##\
|
|
## is returned if the difficulty of a block neither 1 or 2.
|
|
"invalid difficulty"
|
|
|
|
errWrongDifficulty = ##\
|
|
## is returned if the difficulty of a block doesn't match the turn of
|
|
## the signer.
|
|
"wrong difficulty"
|
|
|
|
errInvalidTimestamp = ##\
|
|
## is returned if the timestamp of a block is lower than the previous
|
|
## block's timestamp + the minimum block period.
|
|
"invalid timestamp"
|
|
|
|
errInvalidVotingChain = ##\
|
|
## is returned if an authorization list is attempted to be modified via
|
|
## out-of-range or non-contiguous headers.
|
|
"invalid voting chain"
|
|
|
|
errUnauthorizedSigner = ##\
|
|
## is returned if a header is signed by a non-authorized entity.
|
|
"unauthorized signer"
|
|
|
|
errRecentlySigned = ##\
|
|
## is returned if a header is signed by an authorized entity that
|
|
## already signed a header recently, thus is temporarily not allowed to.
|
|
"recently signed"
|
|
|
|
|
|
# additional errors sources elsewhere
|
|
# -----------------------------------
|
|
|
|
errPublicKeyToShort = ##\
|
|
## Cannot retrieve public key
|
|
"cannot retrieve public key: too short"
|
|
|
|
# imported from consensus/errors.go
|
|
errUnknownAncestor = ##\
|
|
## is returned when validating a block requires an ancestor that is
|
|
## unknown.
|
|
"unknown ancestor"
|
|
|
|
# errPrunedAncestor = ##\
|
|
# ## is returned when validating a block requires an ancestor that is
|
|
# ## known, but the state of which is not available.
|
|
# "pruned ancestor"
|
|
|
|
errFutureBlock = ##\
|
|
## is returned when a block's timestamp is in the future according to
|
|
## the current node.
|
|
"block in the future"
|
|
|
|
# errInvalidNumber = ##\
|
|
# ## is returned if a block's number doesn't equal its parent's plus one.
|
|
# "invalid block number"
|
|
|
|
|
|
# additional/bespoke errors, manually added
|
|
# -----------------------------------------
|
|
|
|
errZeroBlockNumberRejected = "Block number must not be Zero"
|
|
|
|
errSkSigResult ## eth/keys subsytem error: signature
|
|
errSkPubKeyResult ## eth/keys subsytem error: public key
|
|
|
|
errSnapshotLoad ## DB subsytem error
|
|
errSnapshotStore ## ..
|
|
errSnapshotClone
|
|
|
|
errCliqueExceedsGasLimit
|
|
errCliqueUnsupportedBaseFee
|
|
errCliqueBaseFeeError
|
|
errCliqueGasRepriceFork
|
|
errCliqueSealSigFn
|
|
|
|
errCliqueStopped = "process was interrupted"
|
|
errCliqueExpectedBaseFee = "header is missing baseFee"
|
|
errCliqueGasLimitTooLow = "gas limit is too low"
|
|
errCliqueGasLimitTooHigh = "gas limit is too high"
|
|
errCliqueUnclesNotAllowed = "uncles not allowed"
|
|
|
|
# not really an error
|
|
nilCliqueSealNoBlockYet = "Sealing paused, waiting for transactions"
|
|
nilCliqueSealSignedRecently = "Signed recently, must wait for others"
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# More types
|
|
# ------------------------------------------------------------------------------
|
|
|
|
type
|
|
CliqueError* = (CliqueErrorType,string)
|
|
CliqueResult* = Result[void,CliqueError]
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# End
|
|
# ------------------------------------------------------------------------------
|