From b8097d82ad2f1f117f5d2141a0cc26ab906835e0 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 18 Dec 2023 12:02:45 +0000 Subject: [PATCH] [CI Skip] release/stable 0.0.282 skip-checks: true --- CONTRIBUTORS | 2 +- docs/kusama/storage.md | 2 +- docs/polkadot/storage.md | 2 +- docs/substrate/constants.md | 97 +++++++++++++++++++------ docs/substrate/errors.md | 97 +++++++++++++++++++++---- docs/substrate/events.md | 108 +++++++++++++++++++++++++--- docs/substrate/extrinsics.md | 81 +++++++++++++++++---- docs/substrate/storage.md | 136 ++++++++++++++++++++++++++++++----- package.json | 6 +- 9 files changed, 449 insertions(+), 82 deletions(-) diff --git a/CONTRIBUTORS b/CONTRIBUTORS index c11ab01a4f..bc847e055e 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -1,4 +1,4 @@ - 293 Jaco Bump yarn berry, bump deps (#457) + 294 Jaco Bump API (#458) 7 Kevin Veros Hamonangan Update ss58.md (#81) 5 brettkolodny Contract query subscriptions workaround in Contract FAQ (#60) 5 Jhon Update types.basics.md (#165) diff --git a/docs/kusama/storage.md b/docs/kusama/storage.md index 18780fcdf4..dab58e903f 100644 --- a/docs/kusama/storage.md +++ b/docs/kusama/storage.md @@ -1827,7 +1827,7 @@ _These are well-known keys that are always available to the runtime implementati - **interface**: `api.query.substrate.heapPages` - **summary**: Number of wasm linear memory pages required for execution of the runtime. -### intrablockEntropy(): `AccountId32` +### intrablockEntropy(): `[u8;32]` - **interface**: `api.query.substrate.intrablockEntropy` - **summary**: Current intra-block entropy (a universally unique `[u8; 32]` value) is stored here. diff --git a/docs/polkadot/storage.md b/docs/polkadot/storage.md index 4c72f03710..be76a2141a 100644 --- a/docs/polkadot/storage.md +++ b/docs/polkadot/storage.md @@ -1484,7 +1484,7 @@ _These are well-known keys that are always available to the runtime implementati - **interface**: `api.query.substrate.heapPages` - **summary**: Number of wasm linear memory pages required for execution of the runtime. -### intrablockEntropy(): `AccountId32` +### intrablockEntropy(): `[u8;32]` - **interface**: `api.query.substrate.intrablockEntropy` - **summary**: Current intra-block entropy (a universally unique `[u8; 32]` value) is stored here. diff --git a/docs/substrate/constants.md b/docs/substrate/constants.md index 972a11d4c9..4303eaaea8 100644 --- a/docs/substrate/constants.md +++ b/docs/substrate/constants.md @@ -52,6 +52,8 @@ The following sections contain the module constants, also known as parameter typ - **[messageQueue](#messagequeue)** +- **[mixnet](#mixnet)** + - **[multisig](#multisig)** - **[nftFractionalization](#nftfractionalization)** @@ -542,10 +544,6 @@ ___ For example, if it is 5, that means that at least 5 blocks will elapse between attempts to submit the worker's solution. -### signedDepositBase: `u128` -- **interface**: `api.consts.electionProviderMultiPhase.signedDepositBase` -- **summary**: Base deposit for a signed solution. - ### signedDepositByte: `u128` - **interface**: `api.consts.electionProviderMultiPhase.signedDepositByte` - **summary**: Per-byte deposit for a signed solution. @@ -676,13 +674,9 @@ ___ - **interface**: `api.consts.identity.basicDeposit` - **summary**: The amount held on deposit for a registered identity -### fieldDeposit: `u128` -- **interface**: `api.consts.identity.fieldDeposit` -- **summary**: The amount held on deposit per additional field for a registered identity. - -### maxAdditionalFields: `u32` -- **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. +### byteDeposit: `u128` +- **interface**: `api.consts.identity.byteDeposit` +- **summary**: The amount held on deposit per encoded byte for a registered identity. ### maxRegistrars: `u32` - **interface**: `api.consts.identity.maxRegistrars` @@ -757,6 +751,51 @@ ___ ___ +## mixnet + +### maxAuthorities: `u32` +- **interface**: `api.consts.mixnet.maxAuthorities` +- **summary**: The maximum number of authorities per session. + +### maxExternalAddressesPerMixnode: `u32` +- **interface**: `api.consts.mixnet.maxExternalAddressesPerMixnode` +- **summary**: The maximum number of external addresses for a mixnode. + +### maxExternalAddressSize: `u32` +- **interface**: `api.consts.mixnet.maxExternalAddressSize` +- **summary**: The maximum size of one of a mixnode's external addresses. + +### minMixnodes: `u32` +- **interface**: `api.consts.mixnet.minMixnodes` +- **summary**: Minimum number of mixnodes. If there are fewer than this many mixnodes registered for a session, the mixnet will not be active during the session. + +### numCoverToCurrentBlocks: `u32` +- **interface**: `api.consts.mixnet.numCoverToCurrentBlocks` +- **summary**: Length of the first phase of each session (`CoverToCurrent`), in blocks. + +### numCoverToPrevBlocks: `u32` +- **interface**: `api.consts.mixnet.numCoverToPrevBlocks` +- **summary**: Length of the third phase of each session (`CoverToPrev`), in blocks. + +### numRegisterEndSlackBlocks: `u32` +- **interface**: `api.consts.mixnet.numRegisterEndSlackBlocks` +- **summary**: The number of "slack" blocks at the end of each session. [`maybe_register`](Pallet::maybe_register) will try to register before this slack period, but may post registration transactions during the slack period as a last resort. + +### numRegisterStartSlackBlocks: `u32` +- **interface**: `api.consts.mixnet.numRegisterStartSlackBlocks` +- **summary**: The number of "slack" blocks at the start of each session, during which [`maybe_register`](Pallet::maybe_register) will not attempt to post registration transactions. + +### numRequestsToCurrentBlocks: `u32` +- **interface**: `api.consts.mixnet.numRequestsToCurrentBlocks` +- **summary**: Length of the second phase of each session (`RequestsToCurrent`), in blocks. + +### registrationPriority: `u64` +- **interface**: `api.consts.mixnet.registrationPriority` +- **summary**: Priority of unsigned transactions used to register mixnodes. + +___ + + ## multisig ### depositBase: `u128` @@ -929,6 +968,10 @@ ___ 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. @@ -1211,19 +1254,23 @@ ___ - **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]`: `ErasStakers`, `ErasStakersClipped`, `ErasValidatorPrefs`, `ErasValidatorReward`, `ErasRewardPoints`, `ErasTotalStake`, `ErasStartSessionIndex`, `StakingLedger.claimed_rewards`. + 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.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. + 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. -### maxNominatorRewardedPerValidator: `u32` -- **interface**: `api.consts.staking.maxNominatorRewardedPerValidator` -- **summary**: The maximum number of nominators rewarded for each validator. +### maxExposurePageSize: `u32` +- **interface**: `api.consts.staking.maxExposurePageSize` +- **summary**: The maximum size of each `T::ExposurePage`. - For each validator only the `$MaxNominatorRewardedPerValidator` biggest stakers can claim their reward. This used to limit the i/o cost for the nominator payout. + 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: `u32` - **interface**: `api.consts.staking.maxUnlockingChunks` @@ -1342,7 +1389,9 @@ ___ ### minimumPeriod: `u64` - **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. +- **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. ___ @@ -1359,6 +1408,10 @@ ___ Benchmarks depend on this value, be sure to update weights file when changing this value +### maxTipAmount: `u128` +- **interface**: `api.consts.tips.maxTipAmount` +- **summary**: The maximum amount for a single tip. + ### tipCountdown: `u32` - **interface**: `api.consts.tips.tipCountdown` - **summary**: The period for which a tip remains open after is has achieved threshold tippers. @@ -1378,9 +1431,9 @@ ___ ### operationalFeeMultiplier: `u8` - **interface**: `api.consts.transactionPayment.operationalFeeMultiplier` -- **summary**: A fee mulitplier for `Operational` extrinsics to compute "virtual tip" to boost their `priority` +- **summary**: A fee multiplier for `Operational` extrinsics to compute "virtual tip" to boost their `priority` - This value is multipled 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. + 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); @@ -1407,6 +1460,10 @@ ___ - **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. + ### proposalBond: `Permill` - **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. diff --git a/docs/substrate/errors.md b/docs/substrate/errors.md index b650679302..7af2f6fa5a 100644 --- a/docs/substrate/errors.md +++ b/docs/substrate/errors.md @@ -100,6 +100,8 @@ This page lists the errors that can be encountered in the different modules. - **[system](#system)** +- **[tasksExample](#tasksexample)** + - **[technicalCommittee](#technicalcommittee)** - **[technicalMembership](#technicalmembership)** @@ -220,8 +222,8 @@ ___ - **interface**: `api.errors.alliance.WithoutGoodIdentityJudgement.is` - **summary**: The account's identity has no good judgement. -### WithoutIdentityDisplayAndWebsite -- **interface**: `api.errors.alliance.WithoutIdentityDisplayAndWebsite.is` +### WithoutRequiredIdentityFields +- **interface**: `api.errors.alliance.WithoutRequiredIdentityFields.is` - **summary**: The account's identity does not have display field and website field. ___ @@ -879,6 +881,10 @@ ___ ### ValueTooLarge - **interface**: `api.errors.contracts.ValueTooLarge.is` - **summary**: The size defined in `T::MaxValueSize` was exceeded. + +### XCMDecodeFailed +- **interface**: `api.errors.contracts.XCMDecodeFailed.is` +- **summary**: Failed to decode the XCM program. ___ @@ -1402,10 +1408,6 @@ ___ - **interface**: `api.errors.identity.StickyJudgement.is` - **summary**: Sticky judgement. -### TooManyFields -- **interface**: `api.errors.identity.TooManyFields.is` -- **summary**: Too many additional fields. - ### TooManyRegistrars - **interface**: `api.errors.identity.TooManyRegistrars.is` - **summary**: Maximum amount of registrars reached. Cannot add any more. @@ -1520,6 +1522,10 @@ ___ This can change at any time and may resolve in the future by re-trying. +### RecursiveDisallowed +- **interface**: `api.errors.messageQueue.RecursiveDisallowed.is` +- **summary**: Another call is in progress and needs to finish before this call can happen. + ### TemporarilyUnprocessable - **interface**: `api.errors.messageQueue.TemporarilyUnprocessable.is` - **summary**: This message is temporarily unprocessable. @@ -1935,7 +1941,7 @@ ___ - **interface**: `api.errors.nominationPools.MinimumBondNotMet.is` - **summary**: The amount does not meet the minimum bond to either join or create a pool. - The depositor can never unbond to a value less than `Pallet::depositor_min_bond`. The caller does not have nominating permissions for the pool. Members can never unbond to a value below `MinJoinBond`. + The depositor can never unbond to a value less than `Pallet::depositor_min_bond`. The caller does not have nominating permissions for the pool. Members can never unbond to a value below `MinJoinBond`. ### NoCommissionCurrentSet - **interface**: `api.errors.nominationPools.NoCommissionCurrentSet.is` @@ -1949,6 +1955,10 @@ ___ - **interface**: `api.errors.nominationPools.NotDestroying.is` - **summary**: A pool must be in [`PoolState::Destroying`] in order for the depositor to unbond or for other members to be permissionlessly unbonded. +### NothingToAdjust +- **interface**: `api.errors.nominationPools.NothingToAdjust.is` +- **summary**: No imbalance in the ED deposit for the pool. + ### NotKickerOrDestroying - **interface**: `api.errors.nominationPools.NotKickerOrDestroying.is` - **summary**: Either a) the caller cannot make a valid kick or b) the pool is not destroying. @@ -2102,6 +2112,14 @@ ___ ### TooBig - **interface**: `api.errors.preimage.TooBig.is` - **summary**: Preimage is too large to store on-chain. + +### TooFew +- **interface**: `api.errors.preimage.TooFew.is` +- **summary**: Too few hashes were requested to be upgraded (i.e. zero). + +### TooMany +- **interface**: `api.errors.preimage.TooMany.is` +- **summary**: More than `MAX_HASH_UPGRADE_BULK_COUNT` hashes were requested to be upgraded at once. ___ @@ -2690,6 +2708,10 @@ ___ - **interface**: `api.errors.staking.CommissionTooLow.is` - **summary**: Commission is too low. Must be at least `MinCommission`. +### ControllerDeprecated +- **interface**: `api.errors.staking.ControllerDeprecated.is` +- **summary**: Used when attempting to use deprecated controller account logic. + ### DuplicateIndex - **interface**: `api.errors.staking.DuplicateIndex.is` - **summary**: Duplicate index. @@ -2722,6 +2744,10 @@ ___ - **interface**: `api.errors.staking.InvalidNumberOfNominations.is` - **summary**: Invalid number of nominations. +### InvalidPage +- **interface**: `api.errors.staking.InvalidPage.is` +- **summary**: No nominators exist on this page. + ### InvalidSlashIndex - **interface**: `api.errors.staking.InvalidSlashIndex.is` - **summary**: Slash record index out of bounds. @@ -2796,7 +2822,7 @@ ___ ### RequireSudo - **interface**: `api.errors.sudo.RequireSudo.is` -- **summary**: Sender must be the Sudo account +- **summary**: Sender must be the Sudo account. ___ @@ -2807,6 +2833,10 @@ ___ - **interface**: `api.errors.system.CallFiltered.is` - **summary**: The origin filter prevent the call to be dispatched. +### FailedTask +- **interface**: `api.errors.system.FailedTask.is` +- **summary**: The specified [`Task`] failed during execution. + ### FailedToExtractRuntimeVersion - **interface**: `api.errors.system.FailedToExtractRuntimeVersion.is` - **summary**: Failed to extract the runtime version from the new runtime. @@ -2817,6 +2847,10 @@ ___ - **interface**: `api.errors.system.InvalidSpecName.is` - **summary**: The name of specification does not match between the current runtime and the new runtime. +### InvalidTask +- **interface**: `api.errors.system.InvalidTask.is` +- **summary**: The specified [`Task`] is not valid. + ### NonDefaultComposite - **interface**: `api.errors.system.NonDefaultComposite.is` - **summary**: Suicide called when the account has non-default composite data. @@ -2832,6 +2866,15 @@ ___ ___ +## tasksExample + +### NotFound +- **interface**: `api.errors.tasksExample.NotFound.is` +- **summary**: The referenced task was not found. + +___ + + ## technicalCommittee ### AlreadyInitialized @@ -2904,6 +2947,10 @@ ___ - **interface**: `api.errors.tips.AlreadyKnown.is` - **summary**: The tip was already found/started. +### MaxTipAmountExceeded +- **interface**: `api.errors.tips.MaxTipAmountExceeded.is` +- **summary**: The tip given was too generous. + ### NotFinder - **interface**: `api.errors.tips.NotFinder.is` - **summary**: The account attempting to retract the tip is not the finder of the tip. @@ -2941,10 +2988,6 @@ ___ - **interface**: `api.errors.transactionStorage.EmptyTransaction.is` - **summary**: Attempting to store empty transaction -### InsufficientFunds -- **interface**: `api.errors.transactionStorage.InsufficientFunds.is` -- **summary**: Insufficient account balance. - ### InvalidProof - **interface**: `api.errors.transactionStorage.InvalidProof.is` - **summary**: Proof failed verification. @@ -2986,6 +3029,22 @@ ___ ## treasury +### AlreadyAttempted +- **interface**: `api.errors.treasury.AlreadyAttempted.is` +- **summary**: The payment has already been attempted. + +### EarlyPayout +- **interface**: `api.errors.treasury.EarlyPayout.is` +- **summary**: The spend is not yet eligible for payout. + +### FailedToConvertBalance +- **interface**: `api.errors.treasury.FailedToConvertBalance.is` +- **summary**: The balance of the asset kind is not convertible to the balance of the native asset. + +### Inconclusive +- **interface**: `api.errors.treasury.Inconclusive.is` +- **summary**: The payment has neither failed nor succeeded yet. + ### InsufficientPermission - **interface**: `api.errors.treasury.InsufficientPermission.is` - **summary**: The spend origin is valid but the amount it is allowed to spend is lower than the amount to be spent. @@ -2996,12 +3055,24 @@ ___ ### InvalidIndex - **interface**: `api.errors.treasury.InvalidIndex.is` -- **summary**: No proposal or bounty at that index. +- **summary**: No proposal, bounty or spend at that index. + +### NotAttempted +- **interface**: `api.errors.treasury.NotAttempted.is` +- **summary**: The payout was not yet attempted/claimed. + +### PayoutError +- **interface**: `api.errors.treasury.PayoutError.is` +- **summary**: There was some issue with the mechanism of payment. ### ProposalNotApproved - **interface**: `api.errors.treasury.ProposalNotApproved.is` - **summary**: Proposal has not been approved. +### SpendExpired +- **interface**: `api.errors.treasury.SpendExpired.is` +- **summary**: The spend has expired and cannot be claimed. + ### TooManyApprovals - **interface**: `api.errors.treasury.TooManyApprovals.is` - **summary**: Too many approvals in the queue. diff --git a/docs/substrate/events.md b/docs/substrate/events.md index 34463f2b68..5b0efa9f3a 100644 --- a/docs/substrate/events.md +++ b/docs/substrate/events.md @@ -88,6 +88,8 @@ Events are emitted for certain operations on the runtime. The following sections - **[remark](#remark)** +- **[rootTesting](#roottesting)** + - **[safeMode](#safemode)** - **[salary](#salary)** @@ -96,6 +98,8 @@ Events are emitted for certain operations on the runtime. The following sections - **[session](#session)** +- **[skipFeelessPayment](#skipfeelesspayment)** + - **[society](#society)** - **[staking](#staking)** @@ -479,6 +483,10 @@ ___ ## bounties +### BountyApproved(`u32`) +- **interface**: `api.events.bounties.BountyApproved.is` +- **summary**: A bounty is approved. + ### BountyAwarded(`u32`, `AccountId32`) - **interface**: `api.events.bounties.BountyAwarded.is` - **summary**: A bounty is awarded to a beneficiary. @@ -506,6 +514,18 @@ ___ ### BountyRejected(`u32`, `u128`) - **interface**: `api.events.bounties.BountyRejected.is` - **summary**: A bounty proposal was rejected; funds were slashed. + +### CuratorAccepted(`u32`, `AccountId32`) +- **interface**: `api.events.bounties.CuratorAccepted.is` +- **summary**: A bounty curator is accepted. + +### CuratorProposed(`u32`, `AccountId32`) +- **interface**: `api.events.bounties.CuratorProposed.is` +- **summary**: A bounty curator is proposed. + +### CuratorUnassigned(`u32`) +- **interface**: `api.events.bounties.CuratorUnassigned.is` +- **summary**: A bounty curator is unassigned. ___ @@ -1053,7 +1073,7 @@ ___ - **interface**: `api.events.imOnline.HeartbeatReceived.is` - **summary**: A new heartbeat was received from `AuthorityId`. -### SomeOffline(`Vec<(AccountId32,PalletStakingExposure)>`) +### SomeOffline(`Vec<(AccountId32,SpStakingExposure)>`) - **interface**: `api.events.imOnline.SomeOffline.is` - **summary**: At the end of the session, at least one validator was found to be offline. @@ -1108,11 +1128,11 @@ ___ - **interface**: `api.events.messageQueue.PageReaped.is` - **summary**: This page was reaped. -### Processed(`[u8;32]`, `u32`, `SpWeightsWeightV2Weight`, `bool`) +### Processed(`H256`, `u32`, `SpWeightsWeightV2Weight`, `bool`) - **interface**: `api.events.messageQueue.Processed.is` - **summary**: Message is processed. -### ProcessingFailed(`[u8;32]`, `u32`, `FrameSupportMessagesProcessMessageError`) +### ProcessingFailed(`H256`, `u32`, `FrameSupportMessagesProcessMessageError`) - **interface**: `api.events.messageQueue.ProcessingFailed.is` - **summary**: Message discarded due to an error in the `MessageProcessor` (usually a format error). @@ -1363,6 +1383,14 @@ ___ The removal can be voluntary (withdrawn all unbonded funds) or involuntary (kicked). +### MinBalanceDeficitAdjusted(`u32`, `u128`) +- **interface**: `api.events.nominationPools.MinBalanceDeficitAdjusted.is` +- **summary**: Topped up deficit in frozen ED of the reward pool. + +### MinBalanceExcessAdjusted(`u32`, `u128`) +- **interface**: `api.events.nominationPools.MinBalanceExcessAdjusted.is` +- **summary**: Claimed excess frozen ED of af the reward pool. + ### PaidOut(`AccountId32`, `u32`, `u128`) - **interface**: `api.events.nominationPools.PaidOut.is` - **summary**: A payout has been made to a member. @@ -1375,6 +1403,10 @@ ___ - **interface**: `api.events.nominationPools.PoolCommissionClaimed.is` - **summary**: Pool commission has been claimed. +### PoolCommissionClaimPermissionUpdated(`u32`, `Option`) +- **interface**: `api.events.nominationPools.PoolCommissionClaimPermissionUpdated.is` +- **summary**: Pool commission claim permission has been updated. + ### PoolCommissionUpdated(`u32`, `Option<(Perbill,AccountId32)>`) - **interface**: `api.events.nominationPools.PoolCommissionUpdated.is` - **summary**: A pool's commission setting has been changed. @@ -1635,7 +1667,7 @@ ___ ### DepositSlashed(`AccountId32`, `u128`) - **interface**: `api.events.rankedPolls.DepositSlashed.is` -- **summary**: A deposit has been slashaed. +- **summary**: A deposit has been slashed. ### Killed(`u32`, `PalletRankedCollectiveTally`) - **interface**: `api.events.rankedPolls.Killed.is` @@ -1731,7 +1763,7 @@ ___ ### DepositSlashed(`AccountId32`, `u128`) - **interface**: `api.events.referenda.DepositSlashed.is` -- **summary**: A deposit has been slashaed. +- **summary**: A deposit has been slashed. ### Killed(`u32`, `PalletConvictionVotingTally`) - **interface**: `api.events.referenda.Killed.is` @@ -1773,6 +1805,15 @@ ___ ___ +## rootTesting + +### DefensiveTestCall() +- **interface**: `api.events.rootTesting.DefensiveTestCall.is` +- **summary**: Event dispatched when the trigger_defensive extrinsic is called. + +___ + + ## safeMode ### CannotDeposit() @@ -1873,6 +1914,15 @@ ___ ___ +## skipFeelessPayment + +### FeeSkipped(`AccountId32`) +- **interface**: `api.events.skipFeelessPayment.FeeSkipped.is` +- **summary**: A transaction fee was skipped. + +___ + + ## society ### AutoUnbid(`AccountId32`) @@ -1978,9 +2028,9 @@ ___ - **interface**: `api.events.staking.PayoutStarted.is` - **summary**: The stakers' rewards are getting paid. -### Rewarded(`AccountId32`, `u128`) +### Rewarded(`AccountId32`, `PalletStakingRewardDestination`, `u128`) - **interface**: `api.events.staking.Rewarded.is` -- **summary**: The nominator has been rewarded by this amount. +- **summary**: The nominator has been rewarded by this amount to this destination. ### Slashed(`AccountId32`, `u128`) - **interface**: `api.events.staking.Slashed.is` @@ -2053,17 +2103,21 @@ ___ ## sudo -### KeyChanged(`Option`) +### KeyChanged(`Option`, `AccountId32`) - **interface**: `api.events.sudo.KeyChanged.is` -- **summary**: The \[sudoer\] just switched identity; the old key is supplied if one existed. +- **summary**: The sudo key has been updated. + +### KeyRemoved() +- **interface**: `api.events.sudo.KeyRemoved.is` +- **summary**: The key was permanently removed. ### Sudid(`Result`) - **interface**: `api.events.sudo.Sudid.is` -- **summary**: A sudo just took place. \[result\] +- **summary**: A sudo call just took place. ### SudoAsDone(`Result`) - **interface**: `api.events.sudo.SudoAsDone.is` -- **summary**: A sudo just took place. \[result\] +- **summary**: A [sudo_as](Pallet::sudo_as) call just took place. ___ @@ -2093,6 +2147,18 @@ ___ ### Remarked(`AccountId32`, `H256`) - **interface**: `api.events.system.Remarked.is` - **summary**: On on-chain remark happened. + +### TaskCompleted(`KitchensinkRuntimeRuntimeTask`) +- **interface**: `api.events.system.TaskCompleted.is` +- **summary**: A [`Task`] has finished executing. + +### TaskFailed(`KitchensinkRuntimeRuntimeTask`, `SpRuntimeDispatchError`) +- **interface**: `api.events.system.TaskFailed.is` +- **summary**: A [`Task`] failed during execution. + +### TaskStarted(`KitchensinkRuntimeRuntimeTask`) +- **interface**: `api.events.system.TaskStarted.is` +- **summary**: A [`Task`] has started executing ___ @@ -2212,6 +2278,14 @@ ___ ## treasury +### AssetSpendApproved(`u32`, `u32`, `u128`, `AccountId32`, `u32`, `u32`) +- **interface**: `api.events.treasury.AssetSpendApproved.is` +- **summary**: A new asset spend proposal has been approved. + +### AssetSpendVoided(`u32`) +- **interface**: `api.events.treasury.AssetSpendVoided.is` +- **summary**: An approved spend was voided. + ### Awarded(`u32`, `u128`, `AccountId32`) - **interface**: `api.events.treasury.Awarded.is` - **summary**: Some funds have been allocated. @@ -2224,6 +2298,14 @@ ___ - **interface**: `api.events.treasury.Deposit.is` - **summary**: Some funds have been deposited. +### Paid(`u32`, `Null`) +- **interface**: `api.events.treasury.Paid.is` +- **summary**: A payment happened. + +### PaymentFailed(`u32`, `Null`) +- **interface**: `api.events.treasury.PaymentFailed.is` +- **summary**: A payment failed and can be retried. + ### Proposed(`u32`) - **interface**: `api.events.treasury.Proposed.is` - **summary**: New proposal. @@ -2244,6 +2326,10 @@ ___ - **interface**: `api.events.treasury.Spending.is` - **summary**: We have ended a spend period and will now allocate funds. +### SpendProcessed(`u32`) +- **interface**: `api.events.treasury.SpendProcessed.is` +- **summary**: A spend was processed and removed from the storage. It might have been successfully paid or it may have expired. + ### UpdatedInactive(`u128`, `u128`) - **interface**: `api.events.treasury.UpdatedInactive.is` - **summary**: The inactive funds of the pallet have been updated. diff --git a/docs/substrate/extrinsics.md b/docs/substrate/extrinsics.md index feb97fe331..64ba4e3f7a 100644 --- a/docs/substrate/extrinsics.md +++ b/docs/substrate/extrinsics.md @@ -56,6 +56,8 @@ The following sections contain Extrinsics methods are part of the default Substr - **[messageQueue](#messagequeue)** +- **[mixnet](#mixnet)** + - **[multisig](#multisig)** - **[nftFractionalization](#nftfractionalization)** @@ -440,14 +442,6 @@ ___ - **interface**: `api.tx.balances.forceUnreserve` - **summary**: See [`Pallet::force_unreserve`]. -### setBalanceDeprecated(who: `MultiAddress`, new_free: `Compact`, old_reserved: `Compact`) -- **interface**: `api.tx.balances.setBalanceDeprecated` -- **summary**: See [`Pallet::set_balance_deprecated`]. - -### transfer(dest: `MultiAddress`, value: `Compact`) -- **interface**: `api.tx.balances.transfer` -- **summary**: See [`Pallet::transfer`]. - ### transferAll(dest: `MultiAddress`, keep_alive: `bool`) - **interface**: `api.tx.balances.transferAll` - **summary**: See [`Pallet::transfer_all`]. @@ -1002,11 +996,11 @@ ___ - **interface**: `api.tx.identity.setFee` - **summary**: See [`Pallet::set_fee`]. -### setFields(index: `Compact`, fields: `PalletIdentityBitFlags`) +### setFields(index: `Compact`, fields: `u64`) - **interface**: `api.tx.identity.setFields` - **summary**: See [`Pallet::set_fields`]. -### setIdentity(info: `PalletIdentityIdentityInfo`) +### setIdentity(info: `PalletIdentityLegacyIdentityInfo`) - **interface**: `api.tx.identity.setIdentity` - **summary**: See [`Pallet::set_identity`]. @@ -1085,6 +1079,15 @@ ___ ___ +## mixnet + +### register(registration: `PalletMixnetRegistration`, signature: `SpMixnetAppSignature`) +- **interface**: `api.tx.mixnet.register` +- **summary**: See `Pallet::register`. + +___ + + ## multisig ### approveAsMulti(threshold: `u16`, other_signatories: `Vec`, maybe_timepoint: `Option`, call_hash: `[u8;32]`, max_weight: `SpWeightsWeightV2Weight`) @@ -1315,6 +1318,10 @@ ___ ## nominationPools +### adjustPoolDeposit(pool_id: `u32`) +- **interface**: `api.tx.nominationPools.adjustPoolDeposit` +- **summary**: See [`Pallet::adjust_pool_deposit`]. + ### bondExtra(extra: `PalletNominationPoolsBondExtra`) - **interface**: `api.tx.nominationPools.bondExtra` - **summary**: See [`Pallet::bond_extra`]. @@ -1371,6 +1378,10 @@ ___ - **interface**: `api.tx.nominationPools.setCommissionChangeRate` - **summary**: See [`Pallet::set_commission_change_rate`]. +### setCommissionClaimPermission(pool_id: `u32`, permission: `Option`) +- **interface**: `api.tx.nominationPools.setCommissionClaimPermission` +- **summary**: See [`Pallet::set_commission_claim_permission`]. + ### setCommissionMax(pool_id: `u32`, max_commission: `Perbill`) - **interface**: `api.tx.nominationPools.setCommissionMax` - **summary**: See [`Pallet::set_commission_max`]. @@ -1550,6 +1561,10 @@ ___ ## preimage +### ensureUpdated(hashes: `Vec`) +- **interface**: `api.tx.preimage.ensureUpdated` +- **summary**: See [`Pallet::ensure_updated`]. + ### notePreimage(bytes: `Bytes`) - **interface**: `api.tx.preimage.notePreimage` - **summary**: See [`Pallet::note_preimage`]. @@ -1779,7 +1794,11 @@ ___ ### fillBlock(ratio: `Perbill`) - **interface**: `api.tx.rootTesting.fillBlock` -- **summary**: See [`Pallet::fill_block`]. +- **summary**: See `Pallet::fill_block`. + +### triggerDefensive() +- **interface**: `api.tx.rootTesting.triggerDefensive` +- **summary**: See `Pallet::trigger_defensive`. ___ @@ -1999,7 +2018,7 @@ ___ - **interface**: `api.tx.staking.chill` - **summary**: See [`Pallet::chill`]. -### chillOther(controller: `AccountId32`) +### chillOther(stash: `AccountId32`) - **interface**: `api.tx.staking.chillOther` - **summary**: See [`Pallet::chill_other`]. @@ -2039,6 +2058,10 @@ ___ - **interface**: `api.tx.staking.payoutStakers` - **summary**: See [`Pallet::payout_stakers`]. +### payoutStakersByPage(validator_stash: `AccountId32`, era: `u32`, page: `u32`) +- **interface**: `api.tx.staking.payoutStakersByPage` +- **summary**: See [`Pallet::payout_stakers_by_page`]. + ### reapStash(stash: `AccountId32`, num_slashing_spans: `u32`) - **interface**: `api.tx.staking.reapStash` - **summary**: See [`Pallet::reap_stash`]. @@ -2079,6 +2102,10 @@ ___ - **interface**: `api.tx.staking.unbond` - **summary**: See [`Pallet::unbond`]. +### updatePayee(controller: `AccountId32`) +- **interface**: `api.tx.staking.updatePayee` +- **summary**: See [`Pallet::update_payee`]. + ### validate(prefs: `PalletStakingValidatorPrefs`) - **interface**: `api.tx.staking.validate` - **summary**: See [`Pallet::validate`]. @@ -2121,6 +2148,10 @@ ___ ## sudo +### removeKey() +- **interface**: `api.tx.sudo.removeKey` +- **summary**: See [`Pallet::remove_key`]. + ### setKey(new: `MultiAddress`) - **interface**: `api.tx.sudo.setKey` - **summary**: See [`Pallet::set_key`]. @@ -2142,6 +2173,10 @@ ___ ## system +### doTask(task: `KitchensinkRuntimeRuntimeTask`) +- **interface**: `api.tx.system.doTask` +- **summary**: See [`Pallet::do_task`]. + ### killPrefix(prefix: `Bytes`, subkeys: `u32`) - **interface**: `api.tx.system.killPrefix` - **summary**: See [`Pallet::kill_prefix`]. @@ -2300,6 +2335,14 @@ ___ - **interface**: `api.tx.treasury.approveProposal` - **summary**: See [`Pallet::approve_proposal`]. +### checkStatus(index: `u32`) +- **interface**: `api.tx.treasury.checkStatus` +- **summary**: See [`Pallet::check_status`]. + +### payout(index: `u32`) +- **interface**: `api.tx.treasury.payout` +- **summary**: See [`Pallet::payout`]. + ### proposeSpend(value: `Compact`, beneficiary: `MultiAddress`) - **interface**: `api.tx.treasury.proposeSpend` - **summary**: See [`Pallet::propose_spend`]. @@ -2312,9 +2355,17 @@ ___ - **interface**: `api.tx.treasury.removeApproval` - **summary**: See [`Pallet::remove_approval`]. -### spend(amount: `Compact`, beneficiary: `MultiAddress`) +### spend(asset_kind: `u32`, amount: `Compact`, beneficiary: `MultiAddress`, valid_from: `Option`) - **interface**: `api.tx.treasury.spend` - **summary**: See [`Pallet::spend`]. + +### spendLocal(amount: `Compact`, beneficiary: `MultiAddress`) +- **interface**: `api.tx.treasury.spendLocal` +- **summary**: See [`Pallet::spend_local`]. + +### voidSpend(index: `u32`) +- **interface**: `api.tx.treasury.voidSpend` +- **summary**: See [`Pallet::void_spend`]. ___ @@ -2472,6 +2523,10 @@ ___ ## vesting +### forceRemoveVestingSchedule(target: `MultiAddress`, schedule_index: `u32`) +- **interface**: `api.tx.vesting.forceRemoveVestingSchedule` +- **summary**: See [`Pallet::force_remove_vesting_schedule`]. + ### forceVestedTransfer(source: `MultiAddress`, target: `MultiAddress`, schedule: `PalletVestingVestingInfo`) - **interface**: `api.tx.vesting.forceVestedTransfer` - **summary**: See [`Pallet::force_vested_transfer`]. diff --git a/docs/substrate/storage.md b/docs/substrate/storage.md index cf2a79d74c..17358cec6f 100644 --- a/docs/substrate/storage.md +++ b/docs/substrate/storage.md @@ -60,6 +60,8 @@ The following sections contain Storage methods are part of the default Substrate - **[messageQueue](#messagequeue)** +- **[mixnet](#mixnet)** + - **[mmr](#mmr)** - **[multisig](#multisig)** @@ -112,6 +114,8 @@ The following sections contain Storage methods are part of the default Substrate - **[system](#system)** +- **[tasksExample](#tasksexample)** + - **[technicalCommittee](#technicalcommittee)** - **[technicalMembership](#technicalmembership)** @@ -374,11 +378,11 @@ ___ But this comes with tradeoffs, storing account balances in the system pallet stores `frame_system` data alongside the account data contrary to storing account balances in the `Balances` pallet, which uses a `StorageMap` to store balances data only. NOTE: This is only used in the case that this pallet is used to store balances. -### freezes(`AccountId32`): `Vec` +### freezes(`AccountId32`): `Vec` - **interface**: `api.query.balances.freezes` - **summary**: Freeze locks on account balances. -### holds(`AccountId32`): `Vec<{"id":"KitchensinkRuntimeRuntimeHoldReason","amount":"u128"}>` +### holds(`AccountId32`): `Vec` - **interface**: `api.query.balances.holds` - **summary**: Holds on account balances. @@ -632,7 +636,7 @@ ___ ### metadataOf(`PalletDemocracyMetadataOwner`): `Option` - **interface**: `api.query.democracy.metadataOf` -- **summary**: General information concerning any proposal or referendum. The `PreimageHash` refers to the preimage of the `Preimages` provider which can be a JSON dump or IPFS hash of a JSON file. +- **summary**: General information concerning any proposal or referendum. The `Hash` refers to the preimage of the `Preimages` provider which can be a JSON dump or IPFS hash of a JSON file. Consider a garbage collection for a metadata of finished referendums to `unrequest` (remove) large preimages. @@ -833,6 +837,10 @@ ___ ## grandpa +### authorities(): `Vec<(SpConsensusGrandpaAppPublic,u64)>` +- **interface**: `api.query.grandpa.authorities` +- **summary**: The current list of authorities. + ### currentSetId(): `u64` - **interface**: `api.query.grandpa.currentSetId` - **summary**: The number of changes (both in terms of keys and underlying economic responsibilities) in the "set" of Grandpa validators from genesis. @@ -974,6 +982,29 @@ ___ ___ +## mixnet + +### currentSessionIndex(): `u32` +- **interface**: `api.query.mixnet.currentSessionIndex` +- **summary**: Index of the current session. This may be offset relative to the session index tracked by eg `pallet_session`; mixnet session indices are independent. + +### currentSessionStartBlock(): `u32` +- **interface**: `api.query.mixnet.currentSessionStartBlock` +- **summary**: Block in which the current session started. + +### mixnodes(`u32, u32`): `Option` +- **interface**: `api.query.mixnet.mixnodes` +- **summary**: Mixnode sets by session index. Only the mixnode sets for the previous, current, and next sessions are kept; older sets are discarded. + + The mixnodes in each set are keyed by authority index so we can easily check if an authority has registered a mixnode. The authority indices should only be used during registration; the authority indices for the very first session are made up. + +### nextAuthorityIds(`u32`): `Option` +- **interface**: `api.query.mixnet.nextAuthorityIds` +- **summary**: Authority list for the next session. + +___ + + ## mmr ### nodes(`u64`): `Option` @@ -1188,6 +1219,12 @@ ___ ### subPoolsStorage(`u32`): `Option` - **interface**: `api.query.nominationPools.subPoolsStorage` - **summary**: Groups of unbonding pools. Each group of unbonding pools belongs to a bonded pool, hence the name sub-pools. Keyed by the bonded pools account. + +### totalValueLocked(): `u128` +- **interface**: `api.query.nominationPools.totalValueLocked` +- **summary**: The sum of funds across all pools. + + This might be lower but never higher than the sum of `total_balance` of all [`PoolMembers`] because calling `pool_withdraw_unbonded` might decrease the total stake of the pool's `bonded_account` without adjusting the pallet-internal `UnbondingPool`'s. ___ @@ -1277,7 +1314,11 @@ ___ ### preimageFor(`(H256,u32)`): `Option` - **interface**: `api.query.preimage.preimageFor` -### statusFor(`H256`): `Option` +### requestStatusFor(`H256`): `Option` +- **interface**: `api.query.preimage.requestStatusFor` +- **summary**: The request status of a given hash. + +### statusFor(`H256`): `Option` - **interface**: `api.query.preimage.statusFor` - **summary**: The request status of a given hash. @@ -1342,7 +1383,7 @@ ___ ### metadataOf(`u32`): `Option` - **interface**: `api.query.rankedPolls.metadataOf` -- **summary**: The metadata is a general information concerning the referendum. The `PreimageHash` refers to the preimage of the `Preimages` provider which can be a JSON dump or IPFS hash of a JSON file. +- **summary**: The metadata is a general information concerning the referendum. The `Hash` refers to the preimage of the `Preimages` provider which can be a JSON dump or IPFS hash of a JSON file. Consider a garbage collection for a metadata of finished referendums to `unrequest` (remove) large preimages. @@ -1392,7 +1433,7 @@ ___ ### metadataOf(`u32`): `Option` - **interface**: `api.query.referenda.metadataOf` -- **summary**: The metadata is a general information concerning the referendum. The `PreimageHash` refers to the preimage of the `Preimages` provider which can be a JSON dump or IPFS hash of a JSON file. +- **summary**: The metadata is a general information concerning the referendum. The `Hash` refers to the preimage of the `Preimages` provider which can be a JSON dump or IPFS hash of a JSON file. Consider a garbage collection for a metadata of finished referendums to `unrequest` (remove) large preimages. @@ -1610,6 +1651,14 @@ ___ - **interface**: `api.query.staking.chillThreshold` - **summary**: The threshold for when users can start calling `chill_other` for other validators / nominators. The threshold is compared to the actual number of validators / nominators (`CountFor*`) in the system compared to the configured max (`Max*Count`). +### claimedRewards(`u32, AccountId32`): `Vec` +- **interface**: `api.query.staking.claimedRewards` +- **summary**: History of claimed paged rewards by era and validator. + + This is keyed by era and validator stash which maps to the set of page indexes which have been claimed. + + It is removed after [`Config::HistoryDepth`] eras. + ### counterForNominators(): `u32` - **interface**: `api.query.staking.counterForNominators` - **summary**: Counter for the related counted storage map @@ -1632,35 +1681,59 @@ ___ ### erasRewardPoints(`u32`): `PalletStakingEraRewardPoints` - **interface**: `api.query.staking.erasRewardPoints` -- **summary**: Rewards for the last `HISTORY_DEPTH` eras. If reward hasn't been set or has been removed then 0 reward is returned. +- **summary**: Rewards for the last [`Config::HistoryDepth`] eras. If reward hasn't been set or has been removed then 0 reward is returned. -### erasStakers(`u32, AccountId32`): `PalletStakingExposure` +### erasStakers(`u32, AccountId32`): `SpStakingExposure` - **interface**: `api.query.staking.erasStakers` - **summary**: Exposure of validator at era. This is keyed first by the era index to allow bulk deletion and then the stash account. - Is it removed after `HISTORY_DEPTH` eras. If stakers hasn't been set or has been removed then empty exposure is returned. + Is it removed after [`Config::HistoryDepth`] eras. If stakers hasn't been set or has been removed then empty exposure is returned. + + Note: Deprecated since v14. Use `EraInfo` instead to work with exposures. -### erasStakersClipped(`u32, AccountId32`): `PalletStakingExposure` +### erasStakersClipped(`u32, AccountId32`): `SpStakingExposure` - **interface**: `api.query.staking.erasStakersClipped` - **summary**: Clipped Exposure of validator at era. - This is similar to [`ErasStakers`] but number of nominators exposed is reduced to the `T::MaxNominatorRewardedPerValidator` biggest stakers. (Note: the field `total` and `own` of the exposure remains unchanged). This is used to limit the i/o cost for the nominator payout. + Note: This is deprecated, should be used as read-only and will be removed in the future. New `Exposure`s are stored in a paged manner in `ErasStakersPaged` instead. + + This is similar to [`ErasStakers`] but number of nominators exposed is reduced to the `T::MaxExposurePageSize` biggest stakers. (Note: the field `total` and `own` of the exposure remains unchanged). This is used to limit the i/o cost for the nominator payout. This is keyed fist by the era index to allow bulk deletion and then the stash account. - Is it removed after `HISTORY_DEPTH` eras. If stakers hasn't been set or has been removed then empty exposure is returned. + It is removed after [`Config::HistoryDepth`] eras. If stakers hasn't been set or has been removed then empty exposure is returned. + + Note: Deprecated since v14. Use `EraInfo` instead to work with exposures. + +### erasStakersOverview(`u32, AccountId32`): `Option` +- **interface**: `api.query.staking.erasStakersOverview` +- **summary**: Summary of validator exposure at a given era. + + This contains the total stake in support of the validator and their own stake. In addition, it can also be used to get the number of nominators backing this validator and the number of exposure pages they are divided into. The page count is useful to determine the number of pages of rewards that needs to be claimed. + + This is keyed first by the era index to allow bulk deletion and then the stash account. Should only be accessed through `EraInfo`. + + Is it removed after [`Config::HistoryDepth`] eras. If stakers hasn't been set or has been removed then empty overview is returned. + +### erasStakersPaged(`u32, AccountId32, u32`): `Option` +- **interface**: `api.query.staking.erasStakersPaged` +- **summary**: Paginated exposure of a validator at given era. + + This is keyed first by the era index to allow bulk deletion, then stash account and finally the page. Should only be accessed through `EraInfo`. + + This is cleared after [`Config::HistoryDepth`] eras. ### erasStartSessionIndex(`u32`): `Option` - **interface**: `api.query.staking.erasStartSessionIndex` -- **summary**: The session index at which the era start for the last `HISTORY_DEPTH` eras. +- **summary**: The session index at which the era start for the last [`Config::HistoryDepth`] eras. Note: This tracks the starting session (i.e. session index when era start being active) for the eras in `[CurrentEra - HISTORY_DEPTH, CurrentEra]`. ### erasTotalStake(`u32`): `u128` - **interface**: `api.query.staking.erasTotalStake` -- **summary**: The total amount staked for the last `HISTORY_DEPTH` eras. If total hasn't been set or has been removed then 0 stake is returned. +- **summary**: The total amount staked for the last [`Config::HistoryDepth`] eras. If total hasn't been set or has been removed then 0 stake is returned. ### erasValidatorPrefs(`u32, AccountId32`): `PalletStakingValidatorPrefs` - **interface**: `api.query.staking.erasValidatorPrefs` @@ -1668,11 +1741,11 @@ ___ This is keyed first by the era index to allow bulk deletion and then the stash account. - Is it removed after `HISTORY_DEPTH` eras. + Is it removed after [`Config::HistoryDepth`] eras. ### erasValidatorReward(`u32`): `Option` - **interface**: `api.query.staking.erasValidatorReward` -- **summary**: The total validator era payout for the last `HISTORY_DEPTH` eras. +- **summary**: The total validator era payout for the last [`Config::HistoryDepth`] eras. Eras that haven't finished yet or has been removed doesn't have reward. @@ -1687,6 +1760,8 @@ ___ ### ledger(`AccountId32`): `Option` - **interface**: `api.query.staking.ledger` - **summary**: Map from all (unlocked) "controller" accounts to the info regarding the staking. + + Note: All the reads and mutations to this storage *MUST* be done through the methods exposed by [`StakingLedger`] to ensure data and lock consistency. ### maxNominatorsCount(): `Option` - **interface**: `api.query.staking.maxNominatorsCount` @@ -1832,7 +1907,7 @@ _These are well-known keys that are always available to the runtime implementati - **interface**: `api.query.substrate.heapPages` - **summary**: Number of wasm linear memory pages required for execution of the runtime. -### intrablockEntropy(): `AccountId32` +### intrablockEntropy(): `[u8;32]` - **interface**: `api.query.substrate.intrablockEntropy` - **summary**: Current intra-block entropy (a universally unique `[u8; 32]` value) is stored here. @@ -1925,6 +2000,19 @@ ___ ___ +## tasksExample + +### numbers(`u32`): `Option` +- **interface**: `api.query.tasksExample.numbers` +- **summary**: Numbers to be added into the total. + +### total(): `(u32,u32)` +- **interface**: `api.query.tasksExample.total` +- **summary**: Some running total. + +___ + + ## technicalCommittee ### members(): `Vec` @@ -1971,11 +2059,13 @@ ___ ### didUpdate(): `bool` - **interface**: `api.query.timestamp.didUpdate` -- **summary**: Did the timestamp get updated in this block? +- **summary**: Whether the timestamp has been updated in this block. + + This value is updated to `true` upon successful submission of a timestamp by a node. It is then checked at the end of each block execution in the `on_finalize` hook. ### now(): `u64` - **interface**: `api.query.timestamp.now` -- **summary**: Current time for the current block. +- **summary**: The current time for the current block. ___ @@ -2053,6 +2143,14 @@ ___ ### proposals(`u32`): `Option` - **interface**: `api.query.treasury.proposals` - **summary**: Proposals that have been made. + +### spendCount(): `u32` +- **interface**: `api.query.treasury.spendCount` +- **summary**: The count of spends that have been made. + +### spends(`u32`): `Option` +- **interface**: `api.query.treasury.spends` +- **summary**: Spends that have been approved and being processed. ___ diff --git a/package.json b/package.json index 2577ff924f..a69ded67ae 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "polkadot-js", - "version": "0.0.281", + "version": "0.0.282", "engine-strict": true, "engines": { "node": ">=18.14" @@ -46,7 +46,7 @@ "@cmfcmf/docusaurus-search-local": "^1.1.0" }, "versions": { - "git": "0.0.281", - "npm": "0.0.281" + "git": "0.0.282", + "npm": "0.0.282" } }