| title |
|---|
Constants |
The following sections contain the module constants, also known as parameter types. These can only be changed as part of a runtime upgrade. On the api, these are exposed via api.consts.<module>.<method>.
(NOTE: These were generated from a static/snapshot view of a recent Substrate master node. Some items may not be available in older nodes, or in any customized implementations.)
- interface:
api.consts.babe.epochDuration - summary: 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.
- interface:
api.consts.babe.expectedBlockTime - summary: 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(where1 - crepresents the probability of a slot being empty).
- interface:
api.consts.balances.existentialDeposit - summary: The minimum amount required to keep an account open.
- interface:
api.consts.bounties.bountyCuratorDeposit - summary: Percentage of the curator fee that will be reserved upfront as deposit for bounty curator.
- interface:
api.consts.bounties.bountyDepositBase - summary: The amount held on deposit for placing a bounty proposal.
- interface:
api.consts.bounties.bountyDepositPayoutDelay - summary: The delay period for which a bounty beneficiary need to wait before claim the payout.
- interface:
api.consts.bounties.bountyUpdatePeriod - summary: Bounty duration in blocks.
- interface:
api.consts.bounties.bountyValueMinimum - summary: Minimum value for a bounty.
- interface:
api.consts.bounties.dataDepositPerByte - summary: The amount held on deposit per byte within bounty description.
- interface:
api.consts.bounties.maximumReasonLength - summary: Maximum acceptable reason length.
- interface:
api.consts.contracts.deletionQueueDepth - summary: The maximum number of tries that can be queued for deletion.
- interface:
api.consts.contracts.deletionWeightLimit - summary: The maximum amount of weight that can be consumed per block for lazy trie removal.
-
interface:
api.consts.contracts.depositPerContract -
summary: The balance every contract needs to deposit to stay alive indefinitely.
This is different from the [
Self::TombstoneDeposit] because this only needs to be deposited while the contract is alive. Costs for additional storage are added to this base cost.This is a simple way to ensure that contracts with empty storage eventually get deleted by making them pay rent. This creates an incentive to remove them early in order to save rent.
-
interface:
api.consts.contracts.depositPerStorageByte -
summary: The balance a contract needs to deposit per storage byte to stay alive indefinitely.
Let's suppose the deposit is 1,000 BU (balance units)/byte and the rent is 1 BU/byte/day, then a contract with 1,000,000 BU that uses 1,000 bytes of storage would pay no rent. But if the balance reduced to 500,000 BU and the storage stayed the same at 1,000, then it would pay 500 BU/day.
-
interface:
api.consts.contracts.depositPerStorageItem -
summary: The balance a contract needs to deposit per storage item to stay alive indefinitely.
It works the same as [
Self::DepositPerStorageByte] but for storage items.
- interface:
api.consts.contracts.maxCodeSize - summary: The maximum length of a contract code in bytes. This limit applies to the instrumented version of the code. Therefore
instantiate_with_codecan fail even when supplying a wasm binary below this maximum size.
- interface:
api.consts.contracts.maxDepth - summary: The maximum nesting level of a call/instantiate stack.
- interface:
api.consts.contracts.maxValueSize - summary: The maximum size of a storage value and event payload in bytes.
-
interface:
api.consts.contracts.rentFraction -
summary: The fraction of the deposit that should be used as rent per block.
When a contract hasn't enough balance deposited to stay alive indefinitely it needs to pay per block for the storage it consumes that is not covered by the deposit. This determines how high this rent payment is per block as a fraction of the deposit.
-
interface:
api.consts.contracts.signedClaimHandicap -
summary: Number of block delay an extrinsic claim surcharge has.
When claim surcharge is called by an extrinsic the rent is checked for current_block - delay
- interface:
api.consts.contracts.surchargeReward - summary: Reward that is received by the party whose touch has led to removal of a contract.
- interface:
api.consts.contracts.tombstoneDeposit - summary: The minimum amount required to generate a tombstone.
- interface:
api.consts.democracy.cooloffPeriod - summary: Period in blocks where an external proposal may not be re-submitted after being vetoed.
-
interface:
api.consts.democracy.enactmentPeriod -
summary: The minimum period of locking and the period between a proposal being approved and enacted.
It should generally be a little more than the unstake period to ensure that voting stakers have an opportunity to remove themselves from the system in the case where they are on the losing side of a vote.
- interface:
api.consts.democracy.fastTrackVotingPeriod - summary: Minimum voting period allowed for an emergency referendum.
- interface:
api.consts.democracy.launchPeriod - summary: How often (in blocks) new public referenda are launched.
- interface:
api.consts.democracy.maxVotes - summary: The maximum number of votes for an account.
- interface:
api.consts.democracy.minimumDeposit - summary: The minimum amount to be used as a deposit for a public referendum proposal.
- interface:
api.consts.democracy.preimageByteDeposit - summary: The amount of balance that must be deposited per byte of preimage stored.
- interface:
api.consts.democracy.votingPeriod - summary: How often (in blocks) to check for new votes.
- interface:
api.consts.electionProviderMultiPhase.signedPhase - summary: Duration of the signed phase.
- interface:
api.consts.electionProviderMultiPhase.solutionImprovementThreshold - summary: The minimum amount of improvement to the solution score that defines a solution as "better" (in any phase).
- interface:
api.consts.electionProviderMultiPhase.unsignedPhase - summary: Duration of the unsigned phase.
- interface:
api.consts.elections.candidacyBond
- interface:
api.consts.elections.desiredMembers
- interface:
api.consts.elections.desiredRunnersUp
- interface:
api.consts.elections.palletId
- interface:
api.consts.elections.termDuration
- interface:
api.consts.elections.votingBondBase
- interface:
api.consts.elections.votingBondFactor
-
interface:
api.consts.gilt.fifoQueueLen -
summary: Portion of the queue which is free from ordering and just a FIFO.
Must be no greater than
MaxQueueLen.
-
interface:
api.consts.gilt.intakePeriod -
summary: The number of blocks between consecutive attempts to issue more gilts in an effort to get to the target amount to be frozen.
A larger value results in fewer storage hits each block, but a slower period to get to the target.
- interface:
api.consts.gilt.maxIntakeBids - summary: The maximum amount of bids that can be turned into issued gilts each block. A larger value here means less of the block available for transactions should there be a glut of bids to make into gilts to reach the target.
- interface:
api.consts.gilt.maxQueueLen - summary: Maximum number of items that may be in each duration queue.
-
interface:
api.consts.gilt.minFreeze -
summary: The minimum amount of funds that may be offered to freeze for a gilt. Note that this does not actually limit the amount which may be frozen in a gilt since gilts may be split up in order to satisfy the desired amount of funds under gilts.
It should be at least big enough to ensure that there is no possible storage spam attack or queue-filling attack.
- interface:
api.consts.gilt.period - summary: The base period for the duration queues. This is the common multiple across all supported freezing durations that can be bid upon.
- interface:
api.consts.gilt.queueCount - summary: Number of duration queues in total. This sets the maximum duration supported, which is this value multiplied by
Period.
- interface:
api.consts.identity.basicDeposit - summary: The amount held on deposit for a registered identity.
- interface:
api.consts.identity.fieldDeposit - summary: The amount held on deposit per additional field for a registered identity.
- interface:
api.consts.identity.maxAdditionalFields - summary: Maximum number of additional fields that may be stored in an ID. Needed to bound the I/O required to access an identity, but can be pretty high.
- interface:
api.consts.identity.maxRegistrars - summary: Maxmimum number of registrars allowed in the system. Needed to bound the complexity of, e.g., updating judgements.
- interface:
api.consts.identity.maxSubAccounts - summary: The maximum number of sub-accounts allowed per identified account.
- interface:
api.consts.identity.subAccountDeposit - summary: The amount held on deposit for a registered subaccount. This should account for the fact that one storage item's value will increase by the size of an account ID, and there will be another trie item whose value is the size of an account ID plus 32 bytes.
- interface:
api.consts.indices.deposit - summary: The deposit needed for reserving an index.
- interface:
api.consts.lottery.maxCalls
- interface:
api.consts.lottery.palletId
- interface:
api.consts.multisig.depositBase - summary: The base amount of currency needed to reserve for creating a multisig execution or to store a dispatch call for later.
- interface:
api.consts.multisig.depositFactor - summary: The amount of currency needed per unit threshold when creating a multisig execution.
- interface:
api.consts.multisig.maxSignatories - summary: The maximum amount of signatories allowed for a given multisig.
-
interface:
api.consts.proxy.announcementDepositBase -
summary: The base amount of currency needed to reserve for creating an announcement.
This is held when a new storage item holding a
Balanceis created (typically 16 bytes).
-
interface:
api.consts.proxy.announcementDepositFactor -
summary: The amount of currency needed per announcement made.
This is held for adding an
AccountId,HashandBlockNumber(typically 68 bytes) into a pre-existing storage value.
- interface:
api.consts.proxy.maxPending - summary: The maximum amount of time-delayed announcements that are allowed to be pending.
- interface:
api.consts.proxy.maxProxies - summary: The maximum amount of proxies allowed for a single account.
-
interface:
api.consts.proxy.proxyDepositBase -
summary: 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 issizeof(AccountId)bytes.
-
interface:
api.consts.proxy.proxyDepositFactor -
summary: The amount of currency needed per proxy added.
This is held for adding 32 bytes plus an instance of
ProxyTypemore into a pre-existing storage value. Thus, when configuringProxyDepositFactorone should take into account32 + proxy_type.encode().len()bytes of data.
- interface:
api.consts.recovery.configDepositBase - summary: The base amount of currency needed to reserve for creating a recovery configuration.
- interface:
api.consts.recovery.friendDepositFactor - summary: The amount of currency needed per additional user when creating a recovery configuration.
- interface:
api.consts.recovery.maxFriends - summary: The maximum amount of friends allowed in a recovery configuration.
- interface:
api.consts.recovery.recoveryDeposit - summary: The base amount of currency needed to reserve for starting a recovery.
- interface:
api.consts.society.candidateDeposit - summary: The minimum amount of a deposit required for a bid to be made.
- interface:
api.consts.society.challengePeriod - summary: The number of blocks between membership challenges.
- interface:
api.consts.society.maxCandidateIntake - summary: Maximum candidate intake per round.
- interface:
api.consts.society.maxStrikes - summary: The number of times a member may vote the wrong way (or not at all, when they are a skeptic) before they become suspended.
- interface:
api.consts.society.palletId - summary: The societies's module id
- interface:
api.consts.society.periodSpend - summary: The amount of incentive paid within each period. Doesn't include VoterTip.
- interface:
api.consts.society.rotationPeriod - summary: The number of blocks between candidate/membership rotation periods.
- interface:
api.consts.society.wrongSideDeduction - summary: The amount of the unpaid reward that gets deducted in the case that either a skeptic doesn't vote or someone votes in the wrong way.
- interface:
api.consts.staking.bondingDuration - summary: Number of eras that staked funds must remain bonded for.
- interface:
api.consts.staking.maxNominations - summary: Maximum number of nominations per nominator.
-
interface:
api.consts.staking.maxNominatorRewardedPerValidator -
summary: The maximum number of nominators rewarded for each validator.
For each validator only the
$MaxNominatorRewardedPerValidatorbiggest stakers can claim their reward. This used to limit the i/o cost for the nominator payout.
- interface:
api.consts.staking.sessionsPerEra - summary: Number of sessions per era.
-
interface:
api.consts.staking.slashDeferDuration -
summary: 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.
- interface:
api.consts.system.blockHashCount - summary: Maximum number of block number to block hash mappings to keep (oldest pruned first).
- interface:
api.consts.system.blockLength - summary: The maximum length of a block (in bytes).
- interface:
api.consts.system.blockWeights - summary: Block & extrinsics weights: base values and limits.
- interface:
api.consts.system.dbWeight - summary: The weight of runtime database operations the runtime can invoke.
-
interface:
api.consts.system.ss58Prefix -
summary: The designated SS85 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.
- interface:
api.consts.system.version - summary: Get the chain's current version.
- interface:
api.consts.timestamp.minimumPeriod - summary: The minimum period between blocks. Beware 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. e.g. For Aura, it will be double this period on default settings.
- interface:
api.consts.tips.dataDepositPerByte - summary: The amount held on deposit per byte within the tip report reason.
- interface:
api.consts.tips.maximumReasonLength - summary: Maximum acceptable reason length.
- interface:
api.consts.tips.tipCountdown - summary: The period for which a tip remains open after is has achieved threshold tippers.
- interface:
api.consts.tips.tipFindersFee - summary: The amount of the final tip which goes to the original reporter of the tip.
- interface:
api.consts.tips.tipReportDepositBase - summary: The amount held on deposit for placing a tip report.
- interface:
api.consts.transactionPayment.transactionByteFee - summary: The fee to be paid for making a transaction; the per-byte portion.
- interface:
api.consts.transactionPayment.weightToFee - summary: The polynomial that is applied in order to derive fee from weight.
- interface:
api.consts.treasury.burn - summary: Percentage of spare funds (if any) that are burnt per spend period.
- interface:
api.consts.treasury.palletId - summary: The treasury's module id, used for deriving its sovereign account ID.
- interface:
api.consts.treasury.proposalBond - summary: Fraction of a proposal's value that should be bonded in order to place the proposal. An accepted proposal gets these back. A rejected proposal does not.
- interface:
api.consts.treasury.proposalBondMinimum - summary: Minimum amount of funds that should be placed in a deposit for making a proposal.
- interface:
api.consts.treasury.spendPeriod - summary: Period between successive spends.
- interface:
api.consts.vesting.minVestedTransfer - summary: The minimum amount transferred to call
vested_transfer.