Constants
Reference
system
blockWeights
Block & extrinsics weights: base values and limits.
blockLength
The maximum length of a block (in bytes).
blockHashCount
Maximum number of block number to block hash mappings to keep (oldest pruned first).
dbWeight
The weight of runtime database operations the runtime can invoke.
version
Get the chain’s in-code version.
S58Prefix
The designated SS58 prefix of this chain. This replaces the “ss58Format” property declared in the chain spec. Reason is that the runtime should know about the prefix in order to make use of it as an identifier of the chain.
scheduler
maximumWeight
The maximum weight that may be scheduled per block for any dispatchables.
maxScheduledPerBlock
The maximum number of scheduled calls in the queue for a single block.
NOTE:
Dependent pallets’ benchmarks might require a higher limit for the setting. Set a
higher limit under runtime-benchmarks
feature.
babe
epochDuration
The amount of time, in slots, that each epoch should last. NOTE: Currently it is not possible to change the epoch duration after the chain has started. Attempting to do so will brick block production.
expectedBlockTime
The expected average block time at which BABE should be creating
blocks. Since BABE is probabilistic it is not trivial to figure out
what the expected average block time should be based on the slot
duration and the security parameter c
(where 1 - c
represents
the probability of a slot being empty).
maxAuthorities
Max number of authorities allowed
maxNominators
The maximum number of nominators for each validator.
timestamp
minimumPeriod
The minimum period between blocks. Be aware that this is different to the expected period that the block production apparatus provides. Your chosen consensus system will generally work with this to determine a sensible block time. For example, in the Aura pallet it will be double this period on default settings.
indices
deposit
The deposit needed for reserving an index.
balances
existentialDeposit
The minimum amount required to keep an account open. MUST BE GREATER THAN ZERO!
If you really need it to be zero, you can enable the feature insecure_zero_ed
for
this pallet. However, you do so at your own risk: this will open up a major DoS vector.
In case you have multiple sources of provider references, you may also get unexpected
behaviour if you set this to zero.
Bottom line: Do yourself a favour and make it at least one!
maxLocks
The maximum number of locks that should exist on an account.
Not strictly enforced, but used for weight estimation.
Use of locks is deprecated in favour of freezes. See https://github.com/paritytech/substrate/pull/12951/
maxReserves
The maximum number of named reserves that can exist on an account.
Use of reserves is deprecated in favour of holds. See https://github.com/paritytech/substrate/pull/12951/
maxFreezes
The maximum number of individual freeze locks that can exist on an account at any time.
transactionPayment
operationalFeeMultiplier
A fee multiplier for Operational
extrinsics to compute “virtual tip” to boost their
priority
This value is multiplied by the final_fee
to obtain a “virtual tip” that is later
added to a tip component in regular priority
calculations.
It means that a Normal
transaction can front-run a similarly-sized Operational
extrinsic (with no tip), by including a tip value greater than the virtual tip.
Note that since we use final_fee
the multiplier applies also to the regular tip
sent with the transaction. So, not only does the transaction get a priority bump based
on the inclusion_fee
, but we also amplify the impact of tips applied to Operational
transactions.
staking
historyDepth
Number of eras to keep in history.
Following information is kept for eras in [current_era - HistoryDepth, current_era]
: ErasStakers
, ErasStakersClipped
,
ErasValidatorPrefs
, ErasValidatorReward
, ErasRewardPoints
,
ErasTotalStake
, ErasStartSessionIndex
, ClaimedRewards
, ErasStakersPaged
,
ErasStakersOverview
.
Must be more than the number of eras delayed by session.
I.e. active era must always be in history. I.e. active_era > current_era - history_depth
must be guaranteed.
If migrating an existing pallet from storage value to config value,
this should be set to same value or greater as in storage.
Note: HistoryDepth
is used as the upper bound for the BoundedVec
item StakingLedger.legacy_claimed_rewards
. Setting this value lower than
the existing value can lead to inconsistencies in the
StakingLedger
and will need to be handled properly in a migration.
The test reducing_history_depth_abrupt
shows this effect.
sessionsPerEra
Number of sessions per era.
bondingDuration
Number of eras that staked funds must remain bonded for.
slashDeferDuration
Number of eras that slashes are deferred by, after computation. This should be less than the bonding duration. Set to 0 if slashes should be applied immediately, without opportunity for intervention.
maxExposurePageSize
The maximum size of each T::ExposurePage
.
An ExposurePage
is weakly bounded to a maximum of MaxExposurePageSize
nominators.
For older non-paged exposure, a reward payout was restricted to the top
MaxExposurePageSize
nominators. This is to limit the i/o cost for the
nominator payout.
Note: MaxExposurePageSize
is used to bound ClaimedRewards
and is unsafe to reduce
without handling it in a migration.
maxUnlockingChunks
The maximum number of unlocking
chunks a StakingLedger
can
have. Effectively determines how many unique eras a staker may be
unbonding in.
Note: MaxUnlockingChunks
is used as the upper bound for the
BoundedVec
item StakingLedger.unlocking
. Setting this value
lower than the existing value can lead to inconsistencies in the
StakingLedger
and will need to be handled properly in a runtime
migration. The test reducing_max_unlocking_chunks_abrupt
shows
this effect.
grandpa
maxAuthorities
Max Authorities in use
maxNominators
The maximum number of nominators for each validator.
maxSetIdSessionEntries
The maximum number of entries to keep in the set id to session index mapping.
Since the SetIdSession
map is only used for validating equivocations this
value should relate to the bonding duration of whatever staking system is
being used (if any). If equivocation handling is not enabled then this value
can be zero.
treasury
spendPeriod
Period between successive spends.
burn
Percentage of spare funds (if any) that are burnt per spend period.
palletId
The treasury’s pallet id, used for deriving its sovereign account ID.
maxApprovals
The maximum number of approvals that can wait in the spending queue. NOTE: This parameter is also used within the Bounties Pallet extension if enabled.
payoutPeriod
The period during which an approved treasury spend has to be claimed.
convictionVoting
maxVotes
The maximum number of concurrent votes an account may have.
Also used to compute weight, an overly large value can lead to extrinsics with large
weight estimation: see delegate
for instance.
voteLockingPeriod
The minimum period of vote locking. It should be no shorter than enactment period to ensure that in the case of an approval, those successful voters are locked into the consequences that their votes entail.
referenda
submissionDeposit
The minimum amount to be used as a deposit for a public referendum proposal.
maxQueued
Maximum size of the referendum queue for a single track.
undecidingTimeout
The number of blocks after submission that a referendum must begin being decided by. Once this passes, then anyone may cancel the referendum.
alarmInterval
Quantization level for the referendum wakeup scheduler. A higher number will result in fewer storage reads/writes needed for smaller voters, but also result in delays to the automatic referendum status changes. Explicit servicing instructions are unaffected.
tracks
Information concerning the different referendum tracks.
claims
prefix
vesting
minVestedTransfer
The minimum amount transferred to call vested_transfer
.
maxVestingSchedules
utility
batchedCallsLimit
The limit on the number of batched calls.
proxy
proxyDepositBase
The base amount of currency needed to reserve for creating a proxy.
This is held for an additional storage item whose value size is
sizeof(Balance)
bytes and whose key size is sizeof(AccountId)
bytes.
proxyDepositFactor
The amount of currency needed per proxy added.
This is held for adding 32 bytes plus an instance of ProxyType
more into a
pre-existing storage value. Thus, when configuring ProxyDepositFactor
one should take
into account 32 + proxy_type.encode().len()
bytes of data.
maxProxies
The maximum amount of proxies allowed for a single account.
maxPending
The maximum amount of time-delayed announcements that are allowed to be pending.
announcementDepositBase
The base amount of currency needed to reserve for creating an announcement.
This is held when a new storage item holding a Balance
is created (typically 16
bytes).
announcementDepositFactor
The amount of currency needed per announcement made.
This is held for adding an AccountId
, Hash
and BlockNumber
(typically 68 bytes)
into a pre-existing storage value.
multisig
depositBase
The base amount of currency needed to reserve for creating a multisig execution or to
store a dispatch call for later.
This is held for an additional storage item whose value size is
4 + sizeof((BlockNumber, Balance, AccountId))
bytes and whose key size is
32 + sizeof(AccountId)
bytes.
depositFactor
The amount of currency needed per unit threshold when creating a multisig execution. This is held for adding 32 bytes more into a pre-existing storage value.
maxSignatories
The maximum amount of signatories allowed in the multisig.
bounties
bountyDepositBase
The amount held on deposit for placing a bounty proposal.
bountyDepositPayoutDelay
The delay period for which a bounty beneficiary need to wait before claim the payout.
bountyUpdatePeriod
Bounty duration in blocks.
curatorDepositMultiplier
The curator deposit is calculated as a percentage of the curator fee.
This deposit has optional upper and lower bounds with CuratorDepositMax
and
CuratorDepositMin
.
curatorDepositMax
Maximum amount of funds that should be placed in a deposit for making a proposal.
curatorDepositMin
Minimum amount of funds that should be placed in a deposit for making a proposal.
bountyValueMinimum
Minimum value for a bounty.
dataDepositPerByte
The amount held on deposit per byte within the tip report reason or bounty description.
maximumReasonLength
Maximum acceptable reason length. Benchmarks depend on this value, be sure to update weights file when changing this value
childBounties
maxActiveChildBountyCount
Maximum number of child bounties that can be added to a parent bounty.
childBountyValueMinimum
Minimum value for a child-bounty.
electionProviderMultiPhase
betterSignedThreshold
The minimum amount of improvement to the solution score that defines a solution as “better” in the Signed phase.
offchainRepeat
The repeat threshold of the offchain worker. For example, if it is 5, that means that at least 5 blocks will elapse between attempts to submit the worker’s solution.
minerTxPriority
The priority of the unsigned transaction submitted in the unsigned-phase
signedMaxSubmissions
Maximum number of signed submissions that can be queued.
It is best to avoid adjusting this during an election, as it impacts downstream data
structures. In particular, SignedSubmissionIndices<T>
is bounded on this value. If you
update this value during an election, you must ensure that
SignedSubmissionIndices.len()
is less than or equal to the new value. Otherwise,
attempts to submit new solutions may cause a runtime panic.
signedMaxWeight
Maximum weight of a signed solution.
If Config::MinerConfig
is being implemented to submit signed solutions (outside of
this pallet), then MinerConfig::solution_weight
is used to compare against
this value.
signedMaxRefunds
The maximum amount of unchecked solutions to refund the call fee for.
signedRewardBase
Base reward for a signed solution
signedDepositByte
Per-byte deposit for a signed solution.
signedDepositWeight
final BigInt signedDepositWeight = BigInt.zero;
maxWinners
The maximum number of winners that can be elected by this ElectionProvider
implementation.
Note: This must always be greater or equal to T::DataProvider::desired_targets()
.
minerMaxLength
minerMaxWeight
minerMaxVotesPerVoter
minerMaxWinners
voterList
bagThresholds
The list of thresholds separating the various bags. Ids are separated into unsorted bags according to their score. This specifies the thresholds separating the bags. An id’s bag is the largest bag for which the id’s score is less than or equal to its upper threshold. When ids are iterated, higher bags are iterated completely before lower bags. This means that iteration is semi-sorted: ids of higher score tend to come before ids of lower score, but peer ids within a particular bag are sorted in insertion order.
- Expressing the constant
This constant must be sorted in strictly increasing order. Duplicate items are not
permitted.
There is an implied upper limit of
Score::MAX
; that value does not need to be specified within the bag. For any two threshold lists, if one ends withScore::MAX
, the other one does not, and they are otherwise equal, the two lists will behave identically. - Calculation
It is recommended to generate the set of thresholds in a geometric series, such that
there exists some constant ratio such that
threshold[k + 1] == (threshold[k] * constant_ratio).max(threshold[k] + 1)
for allk
. The helpers in the/utils/frame/generate-bags
module can simplify this calculation. - Examples
- If
BagThresholds::get().is_empty()
, then all ids are put into the same bag, and iteration is strictly in insertion order. - If
BagThresholds::get().len() == 64
, and the thresholds are determined according to the procedure given above, then the constant ratio is equal to 2. - If
BagThresholds::get().len() == 200
, and the thresholds are determined according to the procedure given above, then the constant ratio is approximately equal to 1.248. - If the threshold list begins
[1, 2, 3, ...]
, then an id with score 0 or 1 will fall into bag 0, an id with score 2 will fall into bag 1, etc. - Migration
In the event that this list ever changes, a copy of the old bags list must be retained.
With that
List::migrate
can be called, which will perform the appropriate migration.
nominationPools
palletId
The nomination pool’s pallet id.
maxPointsToBalance
The maximum pool points-to-balance ratio that an open
pool can have.
This is important in the event slashing takes place and the pool’s points-to-balance
ratio becomes disproportional.
Moreover, this relates to the RewardCounter
type as well, as the arithmetic operations
are a function of number of points, and by setting this value to e.g. 10, you ensure
that the total number of points in the system are at most 10 times the total_issuance of
the chain, in the absolute worse case.
For a value of 10, the threshold would be a pool points-to-balance ratio of 10:1.
Such a scenario would also be the equivalent of the pool being 90% slashed.
maxUnbonding
The maximum number of simultaneous unbonding chunks that can exist per member.
fastUnstake
deposit
Deposit to take for unstaking, to make sure we’re able to slash the it in order to cover the costs of resources on unsuccessful unstake.
paras
unsignedPriority
onDemand
trafficDefaultValue
The default value for the spot traffic multiplier.
maxHistoricalRevenue
The maximum number of blocks some historical revenue information stored for.
palletId
Identifier for the internal revenue balance.
registrar
paraDeposit
The deposit to be paid to run a on-demand parachain. This should include the cost for storing the genesis head and validation code.
dataDepositPerByte
The deposit to be paid per byte stored on chain.
slots
leasePeriod
The number of blocks over which a single period lasts.
leaseOffset
The number of blocks to offset each lease period by.
auctions
endingPeriod
The number of blocks over which an auction may be retroactively ended.
sampleLength
The length of each sample to take during the ending period.
EndingPeriod
/ SampleLength
= Total # of Samples
slotRangeCount
leasePeriodsPerSlot
crowdloan
palletId
PalletId
for the crowdloan pallet. An appropriate value could be
PalletId(*b"py/cfund")
minContribution
The minimum amount that may be contributed into a crowdloan. Should almost certainly be
at least ExistentialDeposit
.
removeKeysLimit
Max number of storage keys to remove per extrinsic call.
coretime
brokerId
The ParaId of the coretime chain.
brokerPotLocation
The coretime chain pot location.
stateTrieMigration
maxKeyLen
Maximal number of bytes that a key can have.
FRAME itself does not limit the key length.
The concrete value must therefore depend on your storage usage.
A frame_support::storage::StorageNMap
for example can have an arbitrary number of
keys which are then hashed and concatenated, resulting in arbitrarily long keys.
Use the state migration RPC to retrieve the length of the longest key in your
storage:
The migration will halt with a Halted
event if this value is too small.
Since there is no real penalty from over-estimating, it is advised to use a large
value. The default is 512 byte.
Some key lengths for reference:
frame_support::storage::StorageValue
: 32 byteframe_support::storage::StorageMap
: 64 byteframe_support::storage::StorageDoubleMap
: 96 byte
messageQueue
heapSize
The size of the page; this implies the maximum message size which can be sent.
A good value depends on the expected message sizes, their weights, the weight that is
available for processing them and the maximal needed message size. The maximal message
size is slightly lower than this as defined by MaxMessageLenOf
.
maxStale
The maximum number of stale pages (i.e. of overweight messages) allowed before culling can happen. Once there are more stale pages than this, then historical pages may be dropped, even if they contain unprocessed overweight messages.
serviceWeight
The amount of weight (if any) which should be provided to the message queue for
servicing enqueued items on_initialize
.
This may be legitimately None
in the case that you will call
ServiceQueues::service_queues
manually or set Self::IdleMaxServiceWeight
to have
it run in on_idle
.
idleMaxServiceWeight
The maximum amount of weight (if any) to be used from remaining weight on_idle
which
should be provided to the message queue for servicing enqueued items on_idle
.
Useful for parachains to process messages at the same block they are received.
If None
, it will not call ServiceQueues::service_queues
in on_idle
.
beefy
maxAuthorities
The maximum number of authorities that can be added.
maxNominators
The maximum number of nominators for each validator.
maxSetIdSessionEntries
The maximum number of entries to keep in the set id to session index mapping.
Since the SetIdSession
map is only used for validating equivocations this
value should relate to the bonding duration of whatever staking system is
being used (if any). If equivocation handling is not enabled then this value
can be zero.