Skip to main content

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 default asset-hub-kusama runtime. Some items may not be available in older nodes, or in any customized implementations.)

assetConversion​

liquidityWithdrawalFee: Permill​

  • interface: api.consts.assetConversion.liquidityWithdrawalFee
  • summary: A fee to withdraw the liquidity.

lpFee: u32​

  • interface: api.consts.assetConversion.lpFee
  • summary: A % the liquidity providers will take of every swap. Represents 10ths of a percent.

maxSwapPathLength: u32​

  • interface: api.consts.assetConversion.maxSwapPathLength
  • summary: The max number of hops in a swap.

mintMinLiquidity: u128​

  • interface: api.consts.assetConversion.mintMinLiquidity
  • summary: The minimum LP token amount that could be minted. Ameliorates rounding errors.

palletId: FrameSupportPalletId​

  • interface: api.consts.assetConversion.palletId
  • summary: The pallet's id, used for deriving its sovereign account ID.

poolSetupFee: u128​

  • interface: api.consts.assetConversion.poolSetupFee
  • summary: A one-time fee to setup the pool.

poolSetupFeeAsset: StagingXcmV5Location​

  • interface: api.consts.assetConversion.poolSetupFeeAsset
  • summary: Asset class from [Config::Assets] used to pay the [Config::PoolSetupFee].

assets​

approvalDeposit: u128​

  • interface: api.consts.assets.approvalDeposit
  • summary: The amount of funds that must be reserved when creating a new approval.

assetAccountDeposit: u128​

  • interface: api.consts.assets.assetAccountDeposit
  • summary: The amount of funds that must be reserved for a non-provider asset account to be maintained.

assetDeposit: u128​

  • interface: api.consts.assets.assetDeposit
  • summary: The basic amount of funds that must be reserved for an asset.

metadataDepositBase: u128​

  • interface: api.consts.assets.metadataDepositBase
  • summary: The basic amount of funds that must be reserved when adding metadata to your asset.

metadataDepositPerByte: u128​

  • interface: api.consts.assets.metadataDepositPerByte
  • summary: The additional funds that must be reserved for the number of bytes you store in your metadata.

removeItemsLimit: u32​

  • interface: api.consts.assets.removeItemsLimit

  • summary: Max number of items to destroy per destroy_accounts and destroy_approvals call.

    Must be configured to result in a weight that makes each call fit in a block.

stringLimit: u32​

  • interface: api.consts.assets.stringLimit
  • summary: The maximum length of a name or symbol stored on-chain.

aura​

slotDuration: u64​

  • interface: api.consts.aura.slotDuration

  • summary: The slot duration Aura should run with, expressed in milliseconds. The effective value of this type should not change while the chain is running.

    For backwards compatibility either use [MinimumPeriodTimesTwo] or a const.

balances​

existentialDeposit: u128​

  • interface: api.consts.balances.existentialDeposit

  • summary: 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!

maxFreezes: u32​

  • interface: api.consts.balances.maxFreezes
  • summary: The maximum number of individual freeze locks that can exist on an account at any time.

maxLocks: u32​

  • interface: api.consts.balances.maxLocks

  • summary: 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: u32​

  • interface: api.consts.balances.maxReserves

  • summary: 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/

bounties​

bountyDepositBase: u128​

  • interface: api.consts.bounties.bountyDepositBase
  • summary: The amount held on deposit for placing a bounty proposal.

bountyDepositPayoutDelay: u32​

  • interface: api.consts.bounties.bountyDepositPayoutDelay
  • summary: The delay period for which a bounty beneficiary need to wait before claim the payout.

bountyUpdatePeriod: u32​

  • interface: api.consts.bounties.bountyUpdatePeriod

  • summary: The time limit for a curator to act before a bounty expires.

    The period that starts when a curator is approved, during which they must execute or update the bounty via extend_bounty_expiry. If missed, the bounty expires, and the curator may be slashed. If BlockNumberFor::MAX, bounties stay active indefinitely, removing the need for extend_bounty_expiry.

bountyValueMinimum: u128​

  • interface: api.consts.bounties.bountyValueMinimum
  • summary: Minimum value for a bounty.

curatorDepositMax: Option<u128>​

  • interface: api.consts.bounties.curatorDepositMax
  • summary: Maximum amount of funds that should be placed in a deposit for making a proposal.

curatorDepositMin: Option<u128>​

  • interface: api.consts.bounties.curatorDepositMin
  • summary: Minimum amount of funds that should be placed in a deposit for making a proposal.

curatorDepositMultiplier: Permill​

  • interface: api.consts.bounties.curatorDepositMultiplier

  • summary: The curator deposit is calculated as a percentage of the curator fee.

    This deposit has optional upper and lower bounds with CuratorDepositMax and CuratorDepositMin.

dataDepositPerByte: u128​

  • interface: api.consts.bounties.dataDepositPerByte
  • summary: The amount held on deposit per byte within the tip report reason or bounty description.

maximumReasonLength: u32​

  • interface: api.consts.bounties.maximumReasonLength

  • summary: Maximum acceptable reason length.

    Benchmarks depend on this value, be sure to update weights file when changing this value

childBounties​

childBountyValueMinimum: u128​

  • interface: api.consts.childBounties.childBountyValueMinimum
  • summary: Minimum value for a child-bounty.

maxActiveChildBountyCount: u32​

  • interface: api.consts.childBounties.maxActiveChildBountyCount
  • summary: Maximum number of child bounties that can be added to a parent bounty.

claims​

prefix: Bytes​

  • interface: api.consts.claims.prefix

collatorSelection​

kickThreshold: u32​

  • interface: api.consts.collatorSelection.kickThreshold

maxCandidates: u32​

  • interface: api.consts.collatorSelection.maxCandidates

  • summary: Maximum number of candidates that we should have.

    This does not take into account the invulnerables.

maxInvulnerables: u32​

  • interface: api.consts.collatorSelection.maxInvulnerables
  • summary: Maximum number of invulnerables.

minEligibleCollators: u32​

  • interface: api.consts.collatorSelection.minEligibleCollators
  • summary: Minimum number eligible collators. Should always be greater than zero. This includes Invulnerable collators. This ensures that there will always be one collator who can produce a block.

potAccount: AccountId32​

  • interface: api.consts.collatorSelection.potAccount
  • summary: Gets this pallet's derived pot account.

potId: FrameSupportPalletId​

  • interface: api.consts.collatorSelection.potId
  • summary: Account Identifier from which the internal Pot is generated.

convictionVoting​

maxVotes: u32​

  • interface: api.consts.convictionVoting.maxVotes

  • summary: 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: u32​

  • interface: api.consts.convictionVoting.voteLockingPeriod

  • summary: 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.

delegatedStaking​

palletId: FrameSupportPalletId​

  • interface: api.consts.delegatedStaking.palletId
  • summary: Injected identifier for the pallet.

slashRewardFraction: Perbill​

  • interface: api.consts.delegatedStaking.slashRewardFraction
  • summary: Fraction of the slash that is rewarded to the caller of pending slash to the agent.

foreignAssets​

approvalDeposit: u128​

  • interface: api.consts.foreignAssets.approvalDeposit
  • summary: The amount of funds that must be reserved when creating a new approval.

assetAccountDeposit: u128​

  • interface: api.consts.foreignAssets.assetAccountDeposit
  • summary: The amount of funds that must be reserved for a non-provider asset account to be maintained.

assetDeposit: u128​

  • interface: api.consts.foreignAssets.assetDeposit
  • summary: The basic amount of funds that must be reserved for an asset.

metadataDepositBase: u128​

  • interface: api.consts.foreignAssets.metadataDepositBase
  • summary: The basic amount of funds that must be reserved when adding metadata to your asset.

metadataDepositPerByte: u128​

  • interface: api.consts.foreignAssets.metadataDepositPerByte
  • summary: The additional funds that must be reserved for the number of bytes you store in your metadata.

removeItemsLimit: u32​

  • interface: api.consts.foreignAssets.removeItemsLimit

  • summary: Max number of items to destroy per destroy_accounts and destroy_approvals call.

    Must be configured to result in a weight that makes each call fit in a block.

stringLimit: u32​

  • interface: api.consts.foreignAssets.stringLimit
  • summary: The maximum length of a name or symbol stored on-chain.

indices​

deposit: u128​

  • interface: api.consts.indices.deposit
  • summary: The deposit needed for reserving an index.

messageQueue​

heapSize: u32​

  • interface: api.consts.messageQueue.heapSize

  • summary: 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].

idleMaxServiceWeight: Option<SpWeightsWeightV2Weight>​

  • interface: api.consts.messageQueue.idleMaxServiceWeight

  • summary: 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.

maxStale: u32​

  • interface: api.consts.messageQueue.maxStale
  • summary: 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: Option<SpWeightsWeightV2Weight>​

  • interface: api.consts.messageQueue.serviceWeight

  • summary: 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.

multiBlockElection​

pages: u32​

  • interface: api.consts.multiBlockElection.pages

  • summary: The number of pages.

    The snapshot is created with this many keys in the storage map.

    The solutions may contain at MOST this many pages, but less pages are acceptable as well.

signedPhase: u32​

  • interface: api.consts.multiBlockElection.signedPhase
  • summary: Duration of the signed phase.

signedValidationPhase: u32​

  • interface: api.consts.multiBlockElection.signedValidationPhase

  • summary: Duration of the singed validation phase.

    The duration of this should not be less than T::Pages, and there is no point in it being more than SignedPhase::MaxSubmission::get() * T::Pages. TODO: integrity test for it.

targetSnapshotPerBlock: u32​

  • interface: api.consts.multiBlockElection.targetSnapshotPerBlock
  • summary: The number of snapshot targets to fetch per block.

unsignedPhase: u32​

  • interface: api.consts.multiBlockElection.unsignedPhase
  • summary: Duration of the unsigned phase.

voterSnapshotPerBlock: u32​

  • interface: api.consts.multiBlockElection.voterSnapshotPerBlock
  • summary: The number of snapshot voters to fetch per block.

multiBlockElectionVerifier​

maxBackersPerWinner: u32​

  • interface: api.consts.multiBlockElectionVerifier.maxBackersPerWinner
  • summary: Maximum number of backers, per winner, per page.

maxBackersPerWinnerFinal: u32​

  • interface: api.consts.multiBlockElectionVerifier.maxBackersPerWinnerFinal

  • summary: Maximum number of backers, per winner, among all pages of an election.

    This can only be checked at the very final step of verification.

    NOTE: at the moment, we don't check this, and it is in place for future compatibility.

maxWinnersPerPage: u32​

  • interface: api.consts.multiBlockElectionVerifier.maxWinnersPerPage
  • summary: Maximum number of supports (aka. winners/validators/targets) that can be represented in a page of results.

solutionImprovementThreshold: Perbill​

  • interface: api.consts.multiBlockElectionVerifier.solutionImprovementThreshold
  • summary: The minimum amount of improvement to the solution score that defines a solution as "better".

multiBlockMigrations​

cursorMaxLen: u32​

  • interface: api.consts.multiBlockMigrations.cursorMaxLen

  • summary: The maximal length of an encoded cursor.

    A good default needs to selected such that no migration will ever have a cursor with MEL above this limit. This is statically checked in integrity_test.

identifierMaxLen: u32​

  • interface: api.consts.multiBlockMigrations.identifierMaxLen

  • summary: The maximal length of an encoded identifier.

    A good default needs to selected such that no migration will ever have an identifier with MEL above this limit. This is statically checked in integrity_test.

multisig​

depositBase: u128​

  • 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.

    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: u128​

  • interface: api.consts.multisig.depositFactor

  • summary: 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: u32​

  • interface: api.consts.multisig.maxSignatories
  • summary: The maximum amount of signatories allowed in the multisig.

nftFractionalization​

deposit: u128​

  • interface: api.consts.nftFractionalization.deposit
  • summary: The deposit paid by the user locking an NFT. The deposit is returned to the original NFT owner when the asset is unified and the NFT is unlocked.

newAssetName: Bytes​

  • interface: api.consts.nftFractionalization.newAssetName
  • summary: The newly created asset's name.

newAssetSymbol: Bytes​

  • interface: api.consts.nftFractionalization.newAssetSymbol
  • summary: The newly created asset's symbol.

palletId: FrameSupportPalletId​

  • interface: api.consts.nftFractionalization.palletId
  • summary: The pallet's id, used for deriving its sovereign account ID.

stringLimit: u32​

  • interface: api.consts.nftFractionalization.stringLimit
  • summary: The maximum length of a name or symbol stored on-chain.

nfts​

approvalsLimit: u32​

  • interface: api.consts.nfts.approvalsLimit
  • summary: The maximum approvals an item could have.

attributeDepositBase: u128​

  • interface: api.consts.nfts.attributeDepositBase
  • summary: The basic amount of funds that must be reserved when adding an attribute to an item.

collectionDeposit: u128​

  • interface: api.consts.nfts.collectionDeposit
  • summary: The basic amount of funds that must be reserved for collection.

depositPerByte: u128​

  • interface: api.consts.nfts.depositPerByte
  • summary: The additional funds that must be reserved for the number of bytes store in metadata, either "normal" metadata or attribute metadata.

features: u64​

  • interface: api.consts.nfts.features
  • summary: Disables some of pallet's features.

itemAttributesApprovalsLimit: u32​

  • interface: api.consts.nfts.itemAttributesApprovalsLimit
  • summary: The maximum attributes approvals an item could have.

itemDeposit: u128​

  • interface: api.consts.nfts.itemDeposit
  • summary: The basic amount of funds that must be reserved for an item.

keyLimit: u32​

  • interface: api.consts.nfts.keyLimit
  • summary: The maximum length of an attribute key.

maxAttributesPerCall: u32​

  • interface: api.consts.nfts.maxAttributesPerCall
  • summary: The max number of attributes a user could set per call.

maxDeadlineDuration: u32​

  • interface: api.consts.nfts.maxDeadlineDuration
  • summary: The max duration in blocks for deadlines.

maxTips: u32​

  • interface: api.consts.nfts.maxTips
  • summary: The max number of tips a user could send.

metadataDepositBase: u128​

  • interface: api.consts.nfts.metadataDepositBase
  • summary: The basic amount of funds that must be reserved when adding metadata to your item.

stringLimit: u32​

  • interface: api.consts.nfts.stringLimit
  • summary: The maximum length of data stored on-chain.

valueLimit: u32​

  • interface: api.consts.nfts.valueLimit
  • summary: The maximum length of an attribute value.

nominationPools​

maxPointsToBalance: u8​

  • interface: api.consts.nominationPools.maxPointsToBalance

  • summary: 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: u32​

  • interface: api.consts.nominationPools.maxUnbonding
  • summary: The maximum number of simultaneous unbonding chunks that can exist per member.

palletId: FrameSupportPalletId​

  • interface: api.consts.nominationPools.palletId
  • summary: The nomination pool's pallet id.

parachainSystem​

selfParaId: u32​

  • interface: api.consts.parachainSystem.selfParaId
  • summary: Returns the parachain ID we are running with.

polkadotXcm​

advertisedXcmVersion: u32​

  • interface: api.consts.polkadotXcm.advertisedXcmVersion
  • summary: The latest supported version that we advertise. Generally just set it to pallet_xcm::CurrentXcmVersion.

maxLockers: u32​

  • interface: api.consts.polkadotXcm.maxLockers
  • summary: The maximum number of local XCM locks that a single account may have.

maxRemoteLockConsumers: u32​

  • interface: api.consts.polkadotXcm.maxRemoteLockConsumers
  • summary: The maximum number of consumers a single remote lock may have.

universalLocation: StagingXcmV5Junctions​

  • interface: api.consts.polkadotXcm.universalLocation
  • summary: This chain's Universal Location.

poolAssets​

approvalDeposit: u128​

  • interface: api.consts.poolAssets.approvalDeposit
  • summary: The amount of funds that must be reserved when creating a new approval.

assetAccountDeposit: u128​

  • interface: api.consts.poolAssets.assetAccountDeposit
  • summary: The amount of funds that must be reserved for a non-provider asset account to be maintained.

assetDeposit: u128​

  • interface: api.consts.poolAssets.assetDeposit
  • summary: The basic amount of funds that must be reserved for an asset.

metadataDepositBase: u128​

  • interface: api.consts.poolAssets.metadataDepositBase
  • summary: The basic amount of funds that must be reserved when adding metadata to your asset.

metadataDepositPerByte: u128​

  • interface: api.consts.poolAssets.metadataDepositPerByte
  • summary: The additional funds that must be reserved for the number of bytes you store in your metadata.

removeItemsLimit: u32​

  • interface: api.consts.poolAssets.removeItemsLimit

  • summary: Max number of items to destroy per destroy_accounts and destroy_approvals call.

    Must be configured to result in a weight that makes each call fit in a block.

stringLimit: u32​

  • interface: api.consts.poolAssets.stringLimit
  • summary: The maximum length of a name or symbol stored on-chain.

proxy​

announcementDepositBase: u128​

  • 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 Balance is created (typically 16 bytes).

announcementDepositFactor: u128​

  • interface: api.consts.proxy.announcementDepositFactor

  • summary: 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.

maxPending: u32​

  • interface: api.consts.proxy.maxPending
  • summary: The maximum amount of time-delayed announcements that are allowed to be pending.

maxProxies: u32​

  • interface: api.consts.proxy.maxProxies
  • summary: The maximum amount of proxies allowed for a single account.

proxyDepositBase: u128​

  • 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 is sizeof(AccountId) bytes.

proxyDepositFactor: u128​

  • 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 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.

recovery​

configDepositBase: u128​

  • interface: api.consts.recovery.configDepositBase

  • summary: The base amount of currency needed to reserve for creating a recovery configuration.

    This is held for an additional storage item whose value size is 2 + sizeof(BlockNumber, Balance) bytes.

friendDepositFactor: u128​

  • interface: api.consts.recovery.friendDepositFactor

  • summary: The amount of currency needed per additional user when creating a recovery configuration.

    This is held for adding sizeof(AccountId) bytes more into a pre-existing storage value.

maxFriends: u32​

  • interface: api.consts.recovery.maxFriends

  • summary: The maximum amount of friends allowed in a recovery configuration.

    NOTE: The threshold programmed in this Pallet uses u16, so it does not really make sense to have a limit here greater than u16::MAX. But also, that is a lot more than you should probably set this value to anyway...

recoveryDeposit: u128​

  • interface: api.consts.recovery.recoveryDeposit

  • summary: The base amount of currency needed to reserve for starting a recovery.

    This is primarily held for deterring malicious recovery attempts, and should have a value large enough that a bad actor would choose not to place this deposit. It also acts to fund additional storage item whose value size is sizeof(BlockNumber, Balance + T * AccountId) bytes. Where T is a configurable threshold.

referenda​

alarmInterval: u32​

  • interface: api.consts.referenda.alarmInterval
  • summary: 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.

maxQueued: u32​

  • interface: api.consts.referenda.maxQueued
  • summary: Maximum size of the referendum queue for a single track.

submissionDeposit: u128​

  • interface: api.consts.referenda.submissionDeposit
  • summary: The minimum amount to be used as a deposit for a public referendum proposal.

tracks: Vec<(u16,PalletReferendaTrackDetails)>​

  • interface: api.consts.referenda.tracks

  • summary: A list of tracks.

    Note: if the tracks are dynamic, the value in the static metadata might be inaccurate.

undecidingTimeout: u32​

  • interface: api.consts.referenda.undecidingTimeout
  • summary: The number of blocks after submission that a referendum must begin being decided by. Once this passes, then anyone may cancel the referendum.

revive​

chainId: u64​

  • interface: api.consts.revive.chainId

  • summary: The EIP-155 chain ID.

    This is a unique identifier assigned to each blockchain network, preventing replay attacks.

codeHashLockupDepositPercent: Perbill​

  • interface: api.consts.revive.codeHashLockupDepositPercent
  • summary: The percentage of the storage deposit that should be held for using a code hash. Instantiating a contract, protects the code from being removed. In order to prevent abuse these actions are protected with a percentage of the code deposit.

depositPerByte: u128​

  • interface: api.consts.revive.depositPerByte

  • summary: The amount of balance a caller has to pay for each byte of storage.

    Note​

    It is safe to change this value on a live chain as all refunds are pro rata.

depositPerItem: u128​

  • interface: api.consts.revive.depositPerItem

  • summary: The amount of balance a caller has to pay for each storage item.

    Note​

    It is safe to change this value on a live chain as all refunds are pro rata.

nativeToEthRatio: u32​

  • interface: api.consts.revive.nativeToEthRatio
  • summary: The ratio between the decimal representation of the native token and the ETH token.

unsafeUnstableInterface: bool​

  • interface: api.consts.revive.unsafeUnstableInterface

  • summary: Make contract callable functions marked as #[unstable] available.

    Contracts that use #[unstable] functions won't be able to be uploaded unless this is set to true. This is only meant for testnets and dev nodes in order to experiment with new features.

    Warning​

    Do not set to true on productions chains.

scheduler​

maximumWeight: SpWeightsWeightV2Weight​

  • interface: api.consts.scheduler.maximumWeight
  • summary: The maximum weight that may be scheduled per block for any dispatchables.

maxScheduledPerBlock: u32​

  • interface: api.consts.scheduler.maxScheduledPerBlock

  • summary: 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.

session​

keyDeposit: u128​

  • interface: api.consts.session.keyDeposit
  • summary: The amount to be held when setting keys.

society​

challengePeriod: u32​

  • interface: api.consts.society.challengePeriod
  • summary: The number of [Config::BlockNumberProvider] blocks between membership challenges.

claimPeriod: u32​

  • interface: api.consts.society.claimPeriod
  • summary: The number of [Config::BlockNumberProvider] blocks on which new candidates can claim their membership and be the named head.

graceStrikes: u32​

  • interface: api.consts.society.graceStrikes
  • summary: The maximum number of strikes before a member gets funds slashed.

maxBids: u32​

  • interface: api.consts.society.maxBids
  • summary: The maximum number of bids at once.

maxLockDuration: u32​

  • interface: api.consts.society.maxLockDuration
  • summary: The maximum duration of the payout lock.

maxPayouts: u32​

  • interface: api.consts.society.maxPayouts
  • summary: The maximum number of payouts a member may have waiting unclaimed.

palletId: FrameSupportPalletId​

  • interface: api.consts.society.palletId
  • summary: The societies's pallet id

periodSpend: u128​

  • interface: api.consts.society.periodSpend
  • summary: The amount of incentive paid within each period. Doesn't include VoterTip.

votingPeriod: u32​

  • interface: api.consts.society.votingPeriod
  • summary: The number of [Config::BlockNumberProvider] blocks on which new candidates should be voted on. Together with ClaimPeriod, this sums to the number of blocks between candidate intake periods.

staking​

bondingDuration: u32​

  • interface: api.consts.staking.bondingDuration
  • summary: Number of eras that staked funds must remain bonded for.

historyDepth: u32​

  • interface: api.consts.staking.historyDepth

  • summary: Number of eras to keep in history.

    Following information is kept for eras in [current_era - HistoryDepth, current_era]: ErasValidatorPrefs, ErasValidatorReward, ErasRewardPoints, ErasTotalStake, 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.

maxEraDuration: u64​

  • interface: api.consts.staking.maxEraDuration

  • summary: Maximum allowed era duration in milliseconds.

    This provides a defensive upper bound to cap the effective era duration, preventing excessively long eras from causing runaway inflation (e.g., due to bugs). If the actual era duration exceeds this value, it will be clamped to this maximum.

    Example: For an ideal era duration of 24 hours (86,400,000 ms), this can be set to 604,800,000 ms (7 days).

maxExposurePageSize: u32​

  • interface: api.consts.staking.maxExposurePageSize

  • summary: 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.

maxInvulnerables: u32​

  • interface: api.consts.staking.maxInvulnerables
  • summary: Maximum number of invulnerable validators.

maxPruningItems: u32​

  • interface: api.consts.staking.maxPruningItems

  • summary: Maximum number of storage items that can be pruned in a single call.

    This controls how many storage items can be deleted in each call to prune_era_step. This should be set to a conservative value (e.g., 100-500 items) to ensure pruning doesn't consume too much block space. The actual weight is determined by benchmarks.

maxUnlockingChunks: u32​

  • interface: api.consts.staking.maxUnlockingChunks

  • summary: 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.

maxValidatorSet: u32​

  • interface: api.consts.staking.maxValidatorSet

  • summary: The absolute maximum of winner validators this pallet should return.

    As this pallet supports multi-block election, the set of winner validators per election is bounded by this type.

planningEraOffset: u32​

  • interface: api.consts.staking.planningEraOffset

  • summary: Number of sessions before the end of an era when the election for the next era will start.

    • This determines how many sessions before the last session of the era the staking election process should begin.

    • The value is bounded between 1 (election starts at the beginning of the last session) and SessionsPerEra (election starts at the beginning of the first session of the era).

      Example:​

    • If SessionsPerEra = 6 and PlanningEraOffset = 1, the election starts at the beginning of session 6 - 1 = 5.

    • If PlanningEraOffset = 6, the election starts at the beginning of session 6 - 6 = 0, meaning it starts at the very beginning of the era.

sessionsPerEra: u32​

  • interface: api.consts.staking.sessionsPerEra
  • summary: Number of sessions per era, as per the preferences of the relay chain.

slashDeferDuration: u32​

  • 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.

stateTrieMigration​

maxKeyLen: u32​

  • interface: api.consts.stateTrieMigration.maxKeyLen

  • summary: 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: https://github.com/paritytech/substrate/issues/11642

    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:

system​

blockHashCount: u32​

  • interface: api.consts.system.blockHashCount
  • summary: Maximum number of block number to block hash mappings to keep (oldest pruned first).

blockLength: FrameSystemLimitsBlockLength​

  • interface: api.consts.system.blockLength
  • summary: The maximum length of a block (in bytes).

blockWeights: FrameSystemLimitsBlockWeights​

  • interface: api.consts.system.blockWeights
  • summary: Block & extrinsics weights: base values and limits.

dbWeight: SpWeightsRuntimeDbWeight​

  • interface: api.consts.system.dbWeight
  • summary: The weight of runtime database operations the runtime can invoke.

ss58Prefix: u16​

  • interface: api.consts.system.ss58Prefix

  • summary: 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.

version: SpVersionRuntimeVersion​

  • interface: api.consts.system.version
  • summary: Get the chain's in-code version.

timestamp​

minimumPeriod: u64​

  • interface: api.consts.timestamp.minimumPeriod

  • summary: 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.

transactionPayment​

operationalFeeMultiplier: u8​

  • interface: api.consts.transactionPayment.operationalFeeMultiplier

  • summary: 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.

    ``rust,ignore // For Normal` let priority = priority_calc(tip);

    // For Operational let virtual_tip = (inclusion_fee + tip) * OperationalFeeMultiplier; let priority = priority_calc(tip + 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.

treasury​

burn: Permill​

  • interface: api.consts.treasury.burn
  • summary: Percentage of spare funds (if any) that are burnt per spend period.

maxApprovals: u32​

  • interface: api.consts.treasury.maxApprovals

  • summary: DEPRECATED: associated with spend_local call and will be removed in May 2025. Refer to https://github.com/paritytech/polkadot-sdk/pull/5961 for migration to spend.

    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.

palletId: FrameSupportPalletId​

  • interface: api.consts.treasury.palletId
  • summary: The treasury's pallet id, used for deriving its sovereign account ID.

payoutPeriod: u32​

  • interface: api.consts.treasury.payoutPeriod
  • summary: The period during which an approved treasury spend has to be claimed.

potAccount: AccountId32​

  • interface: api.consts.treasury.potAccount
  • summary: Gets this pallet's derived pot account.

spendPeriod: u32​

  • interface: api.consts.treasury.spendPeriod
  • summary: Period between successive spends.

uniques​

attributeDepositBase: u128​

  • interface: api.consts.uniques.attributeDepositBase
  • summary: The basic amount of funds that must be reserved when adding an attribute to an item.

collectionDeposit: u128​

  • interface: api.consts.uniques.collectionDeposit
  • summary: The basic amount of funds that must be reserved for collection.

depositPerByte: u128​

  • interface: api.consts.uniques.depositPerByte
  • summary: The additional funds that must be reserved for the number of bytes store in metadata, either "normal" metadata or attribute metadata.

itemDeposit: u128​

  • interface: api.consts.uniques.itemDeposit
  • summary: The basic amount of funds that must be reserved for an item.

keyLimit: u32​

  • interface: api.consts.uniques.keyLimit
  • summary: The maximum length of an attribute key.

metadataDepositBase: u128​

  • interface: api.consts.uniques.metadataDepositBase
  • summary: The basic amount of funds that must be reserved when adding metadata to your item.

stringLimit: u32​

  • interface: api.consts.uniques.stringLimit
  • summary: The maximum length of data stored on-chain.

valueLimit: u32​

  • interface: api.consts.uniques.valueLimit
  • summary: The maximum length of an attribute value.

utility​

batchedCallsLimit: u32​

  • interface: api.consts.utility.batchedCallsLimit
  • summary: The limit on the number of batched calls.

vesting​

maxVestingSchedules: u32​

  • interface: api.consts.vesting.maxVestingSchedules

minVestedTransfer: u128​

  • interface: api.consts.vesting.minVestedTransfer
  • summary: The minimum amount transferred to call vested_transfer.

voterList​

bagThresholds: Vec<u64>​

  • interface: api.consts.voterList.bagThresholds

  • summary: 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 with Score::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 all k.

    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.

maxAutoRebagPerBlock: u32​

  • interface: api.consts.voterList.maxAutoRebagPerBlock

  • summary: Maximum number of accounts that may be re-bagged automatically in on_idle.

    A value of 0 (obtained by configuring type MaxAutoRebagPerBlock = ();) disables the feature.

xcmpQueue​

maxActiveOutboundChannels: u32​

  • interface: api.consts.xcmpQueue.maxActiveOutboundChannels

  • summary: Maximal number of outbound XCMP channels that can have messages queued at the same time.

    If this is reached, then no further messages can be sent to channels that do not yet have a message queued. This should be set to the expected maximum of outbound channels which is determined by [Self::ChannelInfo]. It is important to set this large enough, since otherwise the congestion control protocol will not work as intended and messages may be dropped. This value increases the PoV and should therefore not be picked too high. Governance needs to pay attention to not open more channels than this value.

maxInboundSuspended: u32​

  • interface: api.consts.xcmpQueue.maxInboundSuspended

  • summary: The maximum number of inbound XCMP channels that can be suspended simultaneously.

    Any further channel suspensions will fail and messages may get dropped without further notice. Choosing a high value (1000) is okay; the trade-off that is described in [InboundXcmpSuspended] still applies at that scale.

maxPageSize: u32​

  • interface: api.consts.xcmpQueue.maxPageSize

  • summary: The maximal page size for HRMP message pages.

    A lower limit can be set dynamically, but this is the hard-limit for the PoV worst case benchmarking. The limit for the size of a message is slightly below this, since some overhead is incurred for encoding the format.