Skip to content

Commit e2e1d25

Browse files
committed
[CI Skip] release/stable 0.0.74
skip-checks: true
1 parent 8073af3 commit e2e1d25

File tree

6 files changed

+319
-62
lines changed

6 files changed

+319
-62
lines changed

docs/substrate/constants.md

+182-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ The following sections contain the module constants, also known as parameter typ
66

77
(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.)
88

9+
- **[assets](#assets)**
10+
11+
- **[authorship](#authorship)**
12+
913
- **[babe](#babe)**
1014

1115
- **[balances](#balances)**
@@ -24,6 +28,8 @@ The following sections contain the module constants, also known as parameter typ
2428

2529
- **[identity](#identity)**
2630

31+
- **[imOnline](#imonline)**
32+
2733
- **[indices](#indices)**
2834

2935
- **[lottery](#lottery)**
@@ -34,6 +40,8 @@ The following sections contain the module constants, also known as parameter typ
3440

3541
- **[recovery](#recovery)**
3642

43+
- **[scheduler](#scheduler)**
44+
3745
- **[society](#society)**
3846

3947
- **[staking](#staking)**
@@ -48,12 +56,48 @@ The following sections contain the module constants, also known as parameter typ
4856

4957
- **[treasury](#treasury)**
5058

59+
- **[uniques](#uniques)**
60+
5161
- **[vesting](#vesting)**
5262

5363

5464
___
5565

5666

67+
## assets
68+
69+
### approvalDeposit: `DepositBalanceOf`
70+
- **interface**: `api.consts.assets.approvalDeposit`
71+
- **summary**: The amount of funds that must be reserved when creating a new approval.
72+
73+
### assetDeposit: `DepositBalanceOf`
74+
- **interface**: `api.consts.assets.assetDeposit`
75+
- **summary**: The basic amount of funds that must be reserved for an asset.
76+
77+
### metadataDepositBase: `DepositBalanceOf`
78+
- **interface**: `api.consts.assets.metadataDepositBase`
79+
- **summary**: The basic amount of funds that must be reserved when adding metadata to your asset.
80+
81+
### metadataDepositPerByte: `DepositBalanceOf`
82+
- **interface**: `api.consts.assets.metadataDepositPerByte`
83+
- **summary**: The additional funds that must be reserved for the number of bytes you store in your metadata.
84+
85+
### stringLimit: `u32`
86+
- **interface**: `api.consts.assets.stringLimit`
87+
- **summary**: The maximum length of a name or symbol stored on-chain.
88+
89+
___
90+
91+
92+
## authorship
93+
94+
### uncleGenerations: `BlockNumber`
95+
- **interface**: `api.consts.authorship.uncleGenerations`
96+
- **summary**: The number of blocks back we should accept uncles. This means that we will deal with uncle-parents that are `UncleGenerations + 1` before `now`.
97+
98+
___
99+
100+
57101
## babe
58102

59103
### epochDuration: `u64`
@@ -72,6 +116,14 @@ ___
72116
### existentialDeposit: `Balance`
73117
- **interface**: `api.consts.balances.existentialDeposit`
74118
- **summary**: The minimum amount required to keep an account open.
119+
120+
### maxLocks: `u32`
121+
- **interface**: `api.consts.balances.maxLocks`
122+
- **summary**: The maximum number of locks that should exist on an account. Not strictly enforced, but used for weight estimation.
123+
124+
### maxReserves: `u32`
125+
- **interface**: `api.consts.balances.maxReserves`
126+
- **summary**: The maximum number of named reserves that can exist on an account.
75127

76128
___
77129

@@ -182,10 +234,18 @@ ___
182234
- **interface**: `api.consts.democracy.fastTrackVotingPeriod`
183235
- **summary**: Minimum voting period allowed for a fast-track referendum.
184236

237+
### instantAllowed: `bool`
238+
- **interface**: `api.consts.democracy.instantAllowed`
239+
- **summary**: Indicator for whether an emergency origin is even allowed to happen. Some chains may want to set this permanently to `false`, others may want to condition it on things such as an upgrade having happened recently.
240+
185241
### launchPeriod: `BlockNumber`
186242
- **interface**: `api.consts.democracy.launchPeriod`
187243
- **summary**: How often (in blocks) new public referenda are launched.
188244

245+
### maxProposals: `u32`
246+
- **interface**: `api.consts.democracy.maxProposals`
247+
- **summary**: The maximum number of public proposals that can exist at any time.
248+
189249
### maxVotes: `u32`
190250
- **interface**: `api.consts.democracy.maxVotes`
191251
- **summary**: The maximum number of votes for an account.
@@ -209,16 +269,64 @@ ___
209269

210270
## electionProviderMultiPhase
211271

272+
### minerMaxIterations: `u32`
273+
- **interface**: `api.consts.electionProviderMultiPhase.minerMaxIterations`
274+
- **summary**: Maximum number of iteration of balancing that will be executed in the embedded miner of the pallet.
275+
276+
### minerMaxLength: `u32`
277+
- **interface**: `api.consts.electionProviderMultiPhase.minerMaxLength`
278+
- **summary**: Maximum length (bytes) that the mined solution should consume.
279+
280+
The miner will ensure that the total length of the unsigned solution will not exceed this value.
281+
282+
### minerMaxWeight: `Weight`
283+
- **interface**: `api.consts.electionProviderMultiPhase.minerMaxWeight`
284+
- **summary**: Maximum weight that the miner should consume.
285+
286+
The miner will ensure that the total weight of the unsigned solution will not exceed this value, based on [`WeightInfo::submit_unsigned`].
287+
288+
### minerTxPriority: `TransactionPriority`
289+
- **interface**: `api.consts.electionProviderMultiPhase.minerTxPriority`
290+
- **summary**: The priority of the unsigned transaction submitted in the unsigned-phase
291+
212292
### offchainRepeat: `BlockNumber`
213293
- **interface**: `api.consts.electionProviderMultiPhase.offchainRepeat`
214294
- **summary**: The repeat threshold of the offchain worker.
215295

216296
For example, if it is 5, that means that at least 5 blocks will elapse between attempts to submit the worker's solution.
217297

298+
### signedDepositBase: `BalanceOf`
299+
- **interface**: `api.consts.electionProviderMultiPhase.signedDepositBase`
300+
- **summary**: Base deposit for a signed solution.
301+
302+
### signedDepositByte: `BalanceOf`
303+
- **interface**: `api.consts.electionProviderMultiPhase.signedDepositByte`
304+
- **summary**: Per-byte deposit for a signed solution.
305+
306+
### signedDepositWeight: `BalanceOf`
307+
- **interface**: `api.consts.electionProviderMultiPhase.signedDepositWeight`
308+
- **summary**: Per-weight deposit for a signed solution.
309+
310+
### signedMaxSubmissions: `u32`
311+
- **interface**: `api.consts.electionProviderMultiPhase.signedMaxSubmissions`
312+
- **summary**: Maximum number of signed submissions that can be queued.
313+
314+
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.
315+
316+
### signedMaxWeight: `Weight`
317+
- **interface**: `api.consts.electionProviderMultiPhase.signedMaxWeight`
318+
- **summary**: Maximum weight of a signed solution.
319+
320+
This should probably be similar to [`Config::MinerMaxWeight`].
321+
218322
### signedPhase: `BlockNumber`
219323
- **interface**: `api.consts.electionProviderMultiPhase.signedPhase`
220324
- **summary**: Duration of the signed phase.
221325

326+
### signedRewardBase: `BalanceOf`
327+
- **interface**: `api.consts.electionProviderMultiPhase.signedRewardBase`
328+
- **summary**: Base reward for a signed solution
329+
222330
### solutionImprovementThreshold: `Perbill`
223331
- **interface**: `api.consts.electionProviderMultiPhase.solutionImprovementThreshold`
224332
- **summary**: The minimum amount of improvement to the solution score that defines a solution as "better" (in any phase).
@@ -273,6 +381,10 @@ ___
273381

274382
Must be no greater than `MaxQueueLen`.
275383

384+
### ignoredIssuance: `BalanceOf`
385+
- **interface**: `api.consts.gilt.ignoredIssuance`
386+
- **summary**: The issuance to ignore. This is subtracted from the `Currency`'s `total_issuance` to get the issuance by which we inflate or deflate the gilt.
387+
276388
### intakePeriod: `BlockNumber`
277389
- **interface**: `api.consts.gilt.intakePeriod`
278390
- **summary**: The number of blocks between consecutive attempts to issue more gilts in an effort to get to the target amount to be frozen.
@@ -333,6 +445,17 @@ ___
333445
___
334446

335447

448+
## imOnline
449+
450+
### unsignedPriority: `TransactionPriority`
451+
- **interface**: `api.consts.imOnline.unsignedPriority`
452+
- **summary**: A configuration for base priority of unsigned transactions.
453+
454+
This is exposed so that it can be tuned for particular runtime, when multiple pallets send unsigned transactions.
455+
456+
___
457+
458+
336459
## indices
337460

338461
### deposit: `BalanceOf`
@@ -348,6 +471,10 @@ ___
348471
- **interface**: `api.consts.lottery.maxCalls`
349472
- **summary**: The max number of calls available in a single lottery.
350473

474+
### maxGenerateRandom: `u32`
475+
- **interface**: `api.consts.lottery.maxGenerateRandom`
476+
- **summary**: Number of time we should try to generate a random number that has no modulo bias. The larger this number, the more potential computation is used for picking the winner, but also the more likely that the chosen winner is done fairly.
477+
351478
### palletId: `PalletId`
352479
- **interface**: `api.consts.lottery.palletId`
353480
- **summary**: The Lottery's pallet id
@@ -440,6 +567,19 @@ ___
440567
___
441568

442569

570+
## scheduler
571+
572+
### maximumWeight: `Weight`
573+
- **interface**: `api.consts.scheduler.maximumWeight`
574+
- **summary**: The maximum weight that may be scheduled per block for any dispatchables of less priority than `schedule::HARD_DEADLINE`.
575+
576+
### maxScheduledPerBlock: `u32`
577+
- **interface**: `api.consts.scheduler.maxScheduledPerBlock`
578+
- **summary**: The maximum number of scheduled calls in the queue for a single block. Not strictly enforced, but used for weight estimation.
579+
580+
___
581+
582+
443583
## society
444584

445585
### candidateDeposit: `BalanceOf`
@@ -589,9 +729,13 @@ ___
589729
- **interface**: `api.consts.treasury.burn`
590730
- **summary**: Percentage of spare funds (if any) that are burnt per spend period.
591731

732+
### maxApprovals: `u32`
733+
- **interface**: `api.consts.treasury.maxApprovals`
734+
- **summary**: The maximum number of approvals that can wait in the spending queue.
735+
592736
### palletId: `PalletId`
593737
- **interface**: `api.consts.treasury.palletId`
594-
- **summary**: The treasury's module id, used for deriving its sovereign account ID.
738+
- **summary**: The treasury's pallet id, used for deriving its sovereign account ID.
595739

596740
### proposalBond: `Permill`
597741
- **interface**: `api.consts.treasury.proposalBond`
@@ -608,6 +752,43 @@ ___
608752
___
609753

610754

755+
## uniques
756+
757+
### attributeDepositBase: `DepositBalanceOf`
758+
- **interface**: `api.consts.uniques.attributeDepositBase`
759+
- **summary**: The basic amount of funds that must be reserved when adding an attribute to an asset.
760+
761+
### classDeposit: `DepositBalanceOf`
762+
- **interface**: `api.consts.uniques.classDeposit`
763+
- **summary**: The basic amount of funds that must be reserved for an asset class.
764+
765+
### depositPerByte: `DepositBalanceOf`
766+
- **interface**: `api.consts.uniques.depositPerByte`
767+
- **summary**: The additional funds that must be reserved for the number of bytes store in metadata, either "normal" metadata or attribute metadata.
768+
769+
### instanceDeposit: `DepositBalanceOf`
770+
- **interface**: `api.consts.uniques.instanceDeposit`
771+
- **summary**: The basic amount of funds that must be reserved for an asset instance.
772+
773+
### keyLimit: `u32`
774+
- **interface**: `api.consts.uniques.keyLimit`
775+
- **summary**: The maximum length of an attribute key.
776+
777+
### metadataDepositBase: `DepositBalanceOf`
778+
- **interface**: `api.consts.uniques.metadataDepositBase`
779+
- **summary**: The basic amount of funds that must be reserved when adding metadata to your asset.
780+
781+
### stringLimit: `u32`
782+
- **interface**: `api.consts.uniques.stringLimit`
783+
- **summary**: The maximum length of data stored on-chain.
784+
785+
### valueLimit: `u32`
786+
- **interface**: `api.consts.uniques.valueLimit`
787+
- **summary**: The maximum length of an attribute value.
788+
789+
___
790+
791+
611792
## vesting
612793

613794
### minVestedTransfer: `BalanceOf`

docs/substrate/errors.md

+24
Original file line numberDiff line numberDiff line change
@@ -596,6 +596,14 @@ ___
596596
- **interface**: `api.errors.electionProviderMultiPhase.CallNotAllowed.is`
597597
- **summary**: The call is not allowed at this point.
598598

599+
### InvalidSubmissionIndex
600+
- **interface**: `api.errors.electionProviderMultiPhase.InvalidSubmissionIndex.is`
601+
- **summary**: `Self::insert_submission` returned an invalid index.
602+
603+
### MissingSnapshotMetadata
604+
- **interface**: `api.errors.electionProviderMultiPhase.MissingSnapshotMetadata.is`
605+
- **summary**: Snapshot metadata should exist but didn't.
606+
599607
### OcwCallWrongEra
600608
- **interface**: `api.errors.electionProviderMultiPhase.OcwCallWrongEra.is`
601609
- **summary**: OCW submitted solution for wrong round
@@ -611,6 +619,22 @@ ___
611619
### PreDispatchWrongWinnerCount
612620
- **interface**: `api.errors.electionProviderMultiPhase.PreDispatchWrongWinnerCount.is`
613621
- **summary**: Wrong number of winners presented.
622+
623+
### SignedCannotPayDeposit
624+
- **interface**: `api.errors.electionProviderMultiPhase.SignedCannotPayDeposit.is`
625+
- **summary**: The origin failed to pay the deposit.
626+
627+
### SignedInvalidWitness
628+
- **interface**: `api.errors.electionProviderMultiPhase.SignedInvalidWitness.is`
629+
- **summary**: Witness data to dispatchable is invalid.
630+
631+
### SignedQueueFull
632+
- **interface**: `api.errors.electionProviderMultiPhase.SignedQueueFull.is`
633+
- **summary**: The queue was full, and the solution was not better than any of the existing ones.
634+
635+
### SignedTooMuchWeight
636+
- **interface**: `api.errors.electionProviderMultiPhase.SignedTooMuchWeight.is`
637+
- **summary**: The signed submission consumes too much weight
614638

615639
___
616640

0 commit comments

Comments
 (0)