Skip to content

Commit 2b4c167

Browse files
[CI Skip] release/stable 0.0.277
skip-checks: true
1 parent 6e792c5 commit 2b4c167

20 files changed

+1786
-1603
lines changed

CONTRIBUTORS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
290 Jaco Bump dev deps (#450)
1+
291 Jaco Bump API (#453)
22
7 Kevin Veros Hamonangan Update ss58.md (#81)
33
5 brettkolodny Contract query subscriptions workaround in Contract FAQ (#60)
44
5 Jhon Update types.basics.md (#165)

docs/kusama/constants.md

Lines changed: 76 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ The following sections contain the module constants, also known as parameter typ
1212

1313
- **[balances](#balances)**
1414

15+
- **[beefy](#beefy)**
16+
1517
- **[bounties](#bounties)**
1618

1719
- **[childBounties](#childbounties)**
@@ -64,6 +66,8 @@ The following sections contain the module constants, also known as parameter typ
6466

6567
- **[staking](#staking)**
6668

69+
- **[stateTrieMigration](#statetriemigration)**
70+
6771
- **[system](#system)**
6872

6973
- **[timestamp](#timestamp)**
@@ -116,6 +120,10 @@ ___
116120
### maxAuthorities: `u32`
117121
- **interface**: `api.consts.babe.maxAuthorities`
118122
- **summary**: Max number of authorities allowed
123+
124+
### maxNominators: `u32`
125+
- **interface**: `api.consts.babe.maxNominators`
126+
- **summary**: The maximum number of nominators for each validator.
119127

120128
___
121129

@@ -149,6 +157,25 @@ ___
149157
___
150158

151159

160+
## beefy
161+
162+
### maxAuthorities: `u32`
163+
- **interface**: `api.consts.beefy.maxAuthorities`
164+
- **summary**: The maximum number of authorities that can be added.
165+
166+
### maxNominators: `u32`
167+
- **interface**: `api.consts.beefy.maxNominators`
168+
- **summary**: The maximum number of nominators for each validator.
169+
170+
### maxSetIdSessionEntries: `u64`
171+
- **interface**: `api.consts.beefy.maxSetIdSessionEntries`
172+
- **summary**: The maximum number of entries to keep in the set id to session index mapping.
173+
174+
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.
175+
176+
___
177+
178+
152179
## bounties
153180

154181
### bountyDepositBase: `u128`
@@ -236,11 +263,11 @@ ___
236263

237264
### minContribution: `u128`
238265
- **interface**: `api.consts.crowdloan.minContribution`
239-
- **summary**: The minimum amount that may be contributed into a crowdloan. Should almost certainly be at least `ExistentialDeposit`.
266+
- **summary**: The minimum amount that may be contributed into a crowdloan. Should almost certainly be at least `ExistentialDeposit`.
240267

241268
### palletId: `FrameSupportPalletId`
242269
- **interface**: `api.consts.crowdloan.palletId`
243-
- **summary**: `PalletId` for the crowdloan pallet. An appropriate value could be `PalletId(*b"py/cfund")`
270+
- **summary**: `PalletId` for the crowdloan pallet. An appropriate value could be `PalletId(*b"py/cfund")`
244271

245272
### removeKeysLimit: `u32`
246273
- **interface**: `api.consts.crowdloan.removeKeysLimit`
@@ -259,14 +286,6 @@ ___
259286
- **interface**: `api.consts.electionProviderMultiPhase.betterUnsignedThreshold`
260287
- **summary**: The minimum amount of improvement to the solution score that defines a solution as "better" in the Unsigned phase.
261288

262-
### maxElectableTargets: `u16`
263-
- **interface**: `api.consts.electionProviderMultiPhase.maxElectableTargets`
264-
- **summary**: The maximum number of electable targets to put in the snapshot.
265-
266-
### maxElectingVoters: `u32`
267-
- **interface**: `api.consts.electionProviderMultiPhase.maxElectingVoters`
268-
- **summary**: The maximum number of electing voters to put in the snapshot. At the moment, snapshots are only over a single block, but once multi-block elections are introduced they will take place over multiple blocks.
269-
270289
### maxWinners: `u32`
271290
- **interface**: `api.consts.electionProviderMultiPhase.maxWinners`
272291
- **summary**: The maximum number of winners that can be elected by this `ElectionProvider` implementation.
@@ -378,6 +397,10 @@ ___
378397
- **interface**: `api.consts.grandpa.maxAuthorities`
379398
- **summary**: Max Authorities in use
380399

400+
### maxNominators: `u32`
401+
- **interface**: `api.consts.grandpa.maxNominators`
402+
- **summary**: The maximum number of nominators for each validator.
403+
381404
### maxSetIdSessionEntries: `u64`
382405
- **interface**: `api.consts.grandpa.maxSetIdSessionEntries`
383406
- **summary**: The maximum number of entries to keep in the set id to session index mapping.
@@ -686,7 +709,7 @@ ___
686709

687710
### paraDeposit: `u128`
688711
- **interface**: `api.consts.registrar.paraDeposit`
689-
- **summary**: The deposit to be paid to run a parathread. This should include the cost for storing the genesis head and validation code.
712+
- **summary**: The deposit to be paid to run a on-demand parachain. This should include the cost for storing the genesis head and validation code.
690713

691714
___
692715

@@ -721,25 +744,29 @@ ___
721744

722745
## society
723746

724-
### candidateDeposit: `u128`
725-
- **interface**: `api.consts.society.candidateDeposit`
726-
- **summary**: The minimum amount of a deposit required for a bid to be made.
727-
728747
### challengePeriod: `u32`
729748
- **interface**: `api.consts.society.challengePeriod`
730749
- **summary**: The number of blocks between membership challenges.
731750

732-
### maxCandidateIntake: `u32`
733-
- **interface**: `api.consts.society.maxCandidateIntake`
734-
- **summary**: The maximum number of candidates that we accept per round.
751+
### claimPeriod: `u32`
752+
- **interface**: `api.consts.society.claimPeriod`
753+
- **summary**: The number of blocks on which new candidates can claim their membership and be the named head.
754+
755+
### graceStrikes: `u32`
756+
- **interface**: `api.consts.society.graceStrikes`
757+
- **summary**: The maximum number of strikes before a member gets funds slashed.
758+
759+
### maxBids: `u32`
760+
- **interface**: `api.consts.society.maxBids`
761+
- **summary**: The maximum number of bids at once.
735762

736763
### maxLockDuration: `u32`
737764
- **interface**: `api.consts.society.maxLockDuration`
738765
- **summary**: The maximum duration of the payout lock.
739766

740-
### maxStrikes: `u32`
741-
- **interface**: `api.consts.society.maxStrikes`
742-
- **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.
767+
### maxPayouts: `u32`
768+
- **interface**: `api.consts.society.maxPayouts`
769+
- **summary**: The maximum number of payouts a member may have waiting unclaimed.
743770

744771
### palletId: `FrameSupportPalletId`
745772
- **interface**: `api.consts.society.palletId`
@@ -749,13 +776,9 @@ ___
749776
- **interface**: `api.consts.society.periodSpend`
750777
- **summary**: The amount of incentive paid within each period. Doesn't include VoterTip.
751778

752-
### rotationPeriod: `u32`
753-
- **interface**: `api.consts.society.rotationPeriod`
754-
- **summary**: The number of blocks between candidate/membership rotation periods.
755-
756-
### wrongSideDeduction: `u128`
757-
- **interface**: `api.consts.society.wrongSideDeduction`
758-
- **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.
779+
### votingPeriod: `u32`
780+
- **interface**: `api.consts.society.votingPeriod`
781+
- **summary**: The number of blocks on which new candidates should be voted on. Together with `ClaimPeriod`, this sums to the number of blocks between candidate intake periods.
759782

760783
___
761784

@@ -778,10 +801,6 @@ ___
778801

779802
Note: `HistoryDepth` is used as the upper bound for the `BoundedVec` item `StakingLedger.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.
780803

781-
### maxNominations: `u32`
782-
- **interface**: `api.consts.staking.maxNominations`
783-
- **summary**: Maximum number of nominations per nominator.
784-
785804
### maxNominatorRewardedPerValidator: `u32`
786805
- **interface**: `api.consts.staking.maxNominatorRewardedPerValidator`
787806
- **summary**: The maximum number of nominators rewarded for each validator.
@@ -807,6 +826,31 @@ ___
807826
___
808827

809828

829+
## stateTrieMigration
830+
831+
### maxKeyLen: `u32`
832+
- **interface**: `api.consts.stateTrieMigration.maxKeyLen`
833+
- **summary**: Maximal number of bytes that a key can have.
834+
835+
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.
836+
837+
Use the *state migration RPC* to retrieve the length of the longest key in your storage: <https://github.com/paritytech/substrate/issues/11642>
838+
839+
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.
840+
841+
Some key lengths for reference:
842+
843+
- [`frame_support::storage::StorageValue`]: 32 byte
844+
845+
- [`frame_support::storage::StorageMap`]: 64 byte
846+
847+
- [`frame_support::storage::StorageDoubleMap`]: 96 byte
848+
849+
For more info see <https://www.shawntabrizi.com/substrate/querying-substrate-storage-via-rpc/>
850+
851+
___
852+
853+
810854
## system
811855

812856
### blockHashCount: `u32`

0 commit comments

Comments
 (0)