This is a port (and hopefully a small improvement) of @kianenigma's PR
from the old Substrate repo:
https://github.com/paritytech/substrate/pull/13987. Following #1689 I
moved the documentation of all macros relevant to this PR from
`frame_support_procedural` to `pallet_macros` while including a hint for
RA users.
Question: Again with respect to #1689: Is there a good reason why we
should *not* enhance paths with links to our current rustdocs? For
example, instead of
```rust
/// **Rust-Analyzer users**: See the documentation of the Rust item in
/// `frame_support::pallet_macros::storage`.
```
we could write
```rust
/// **Rust-Analyzer users**: See the documentation of the Rust item in
/// [`frame_support::pallet_macros::storage`](https://paritytech.github.io/polkadot-sdk/master/frame_support/pallet_macros/attr.storage.html).
```
This results in a clickable link like this:
<img width="674" alt="image"
src="https://github.com/paritytech/polkadot-sdk/assets/10713977/c129e622-3942-4eeb-8acf-93ee4efdc99d">
I don't really expect the links to become outdated any time soon, but I
think this would be a great UX improvement over just having paths.
TODOs:
- [ ] Add documentation for `constant_name` macro
- [x] Add proper documentation for different `QueryKinds`, i.e.
`OptionQuery`, `ValueQuery`, `ResultQuery`. One example for each. Custom
`OnEmpty` should be moved to `QueryKinds` trait doc page.
- [ ] Rework `type_value` docs
---------
Co-authored-by: kianenigma <kian@parity.io>
Updates `docify` to 0.2.6, which fixes a bug that was preventing nesting
`#[docify::export]` within sub-items of items that already have
`#[docify::export]` attached to them from working properly.
Release notes here:
https://github.com/sam0x17/docify/releases/tag/v0.2.6
cc @ggwpez @kianenigma
Updates `docify` to 0.2.5, which fixes some indentation bugs and adds
the new `#[docify::export_content]` attribute which can be used like
regular `#[docify::export]` but will only export the _underlying
contents_ of the item it is attached to, if applicable (otherwise it
just behaves exactly like `#[docify::export]`).
Release notes here:
https://github.com/sam0x17/docify/releases/tag/v0.2.5
cc @kianenigma
The `xcm` crate was renamed to `staging-xcm` to be able to publish it to
crates.io as someone as squatted `xcm`. The problem with this rename is
that the `TypeInfo` includes the crate name which ultimately lands in
the metadata. The metadata is consumed by downstream users like
`polkadot-js` or people building on top of `polkadot-js`. These people
are using the entire `path` to find the type in the type registry. Thus,
their code would break as the type path would now be [`staging_xcm`,
`VersionedXcm`] instead of [`xcm`, `VersionedXcm`]. This pull request
fixes this by renaming the path segment `staging_xcm` to `xcm`.
This requires: https://github.com/paritytech/scale-info/pull/197
---------
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
* Fix std, runtime-benchmarks and try-runtime features
zepter lint propagate-feature --feature try-runtime --left-side-feature-missing=ignore --workspace --fix --feature-enables-dep="try-runtime:frame-try-runtime"
zepter lint propagate-feature --feature runtime-benchmarks --left-side-feature-missing=ignore --workspace --fix --feature-enables-dep="runtime-benchmarks:frame-benchmarking"
zepter lint propagate-feature --feature std --left-side-feature-missing=ignore --workspace --fix
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Add propagate feature CI check
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Test CI by adding an error
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Use --locked
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Add help msg
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Revert "Test CI by adding an error"
This reverts commit cf4ff6cc0632269b0a109e547686e5e3314b02de.
* Test CI by adding an error
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* No newline in help msg
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Revert "Test CI by adding an error"
This reverts commit 5daa06ada8e01f5bebafb9d1c76804dd79bc1006.
* Test CI by adding an error
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Revert "Test CI by adding an error"
This reverts commit ca15de5729507a564f140a10ec2e87b19516ec4c.
* Fix msg
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Revert back to master
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Re-do with Zepter v0.7.4
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Update Zepter to 0.7.4
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Disable rococo try-runtime check
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Apply suggestions from code review
Co-authored-by: Bastian Köcher <git@kchr.de>
* More review fixes
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
---------
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
Co-authored-by: Bastian Köcher <git@kchr.de>
* [Fix] Try-state feature-gated for BagsList
* fix comment
* fix try_state remote-tests
* feature-gate try-state remote test for bags-list
* remove try-state from a migration
* more SortedListProvider fixes
* more fixes
* more fixes to allow do_try_state usage in other crates
* do-try-state for fuzz
* more fixes
* more fixes
* remove feature-flag
* do-try-state
* fix review comments
* Update frame/bags-list/src/mock.rs
Co-authored-by: Anton <anton.kalyaev@gmail.com>
---------
Co-authored-by: parity-processbot <>
Co-authored-by: Anton <anton.kalyaev@gmail.com>
* implement crate publishing from CI
* fix indentation
* use resource_group for job exclusivity
ensure that at most one instance of the publish-crates job is running at any given time to prevent race conditions
* correct publish = false
* Remove YAML anchors as GitLab's `extends:` doesn't need it
* Temporarily force cache upload for the new jobs
* Revert `RUSTY_CACHIER_FORCE_UPLOAD`
* pin libp2p-tcp=0.37.0 for sc-telemetry
* Revert "pin libp2p-tcp=0.37.0 for sc-telemetry"
This reverts commit 29146bfad6c31e8cf0e2f17ad92a71bb81a373af.
* always collect generated crates
* increase timeout for publish-crates-template
* Force upload the new job cache again
* Revert "Force upload the new job cache again"
This reverts commit 5a5feee1b2c51fdef768b25a76be4c3949ec1c99.
* reformat
* improve timeout explanation
* s/usual/average
Co-authored-by: Vladimir Istyufeev <vladimir@parity.io>
* Upgraded dependencies
* Adapting code to scale v3
* Empty commit to trigger CI
* Triggering CI
* Fixing UI test
* Remove superfluous dev-dep added by #9228
* Cryout for CI
* Introduce `SecretUri`
* `inspect-key`: Adds support for `expect-public`
`expect-public` can be used to check that a given secret uri corresponds to the given public key.
This is mainly useful when the secret uri is protected by a password and a new derived account
should be generated. With `--expect-public` the user can pass the public key/account-id of the
"base" secret uri aka the one without any derivation to ensure the correct password was inserted.
* Fixes
* 🤦
* Apply suggestions from code review
Co-authored-by: André Silva <123550+andresilva@users.noreply.github.com>
* Review feedback
* FMT
* Bump the versions
Co-authored-by: André Silva <123550+andresilva@users.noreply.github.com>
* use CountedMap in pallet-bags-list
* Fix build
* Update frame/bags-list/src/list/mod.rs
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* add a check as well
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* Fuzzer for Pallet Bags List
* Some small updates
* Fuzzer for Pallet Bags List
This PR adds a fuzzer for the `SortedListProvider` API exposed by pallet-bags-list.
* Feature gate code NOT used by fuzz feature
* Create Enum for list actions
* fix some small mistakes
* try and make CI happy
* fmt
* Do not insert before updating
* clean up some misc. comments
* marginally improve Node::sanity_check
* Change ID_RANGE to 25_000
* comma
* try improve correct feature gating so no unused code
Co-authored-by: thiolliere <gui.thiolliere@gmail.com>
* remove extra whitespace
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
* only emit rebag event on success
* add doc explaining the term voter
* revamp/simplify rebag test
* ensure genesis accounts are placed into the correct nodes/bags
* bond_extra implicitly rebags
* types at top; doc public type
* start sketching out adjustable thresholds
* add integrity test for voter bag threshold requirements
* get rid of BagIdx
This reorganizes bag storage such that bags are always referred to
by their upper threshold. This in turn means that adding and removing
bags is cheaper; you only need to migrate certain voters, not all of them.
* implement migration logic for when the threshold list changes
* start sketching out threshold proc macros
* further refine macro signatures
* WIP: implement make_ratio macro
* start rethinking the process of producing threshold lists
The macro approach seems to be a non-starter; that only really works
if we're throwing around numeric literals everywhere, and that's just
not nice in this case.
Instead, let's write helper functions and make it really easy to
generate the tables in separate, permanent files, which humans
can then edit.
* write helper functions to emit voter bags module
* WIP: demo generating voter bags for a realistic runtime
This isn't yet done, becuase it seems to take a Very Long Time to run,
and it really shouldn't. Need to look into that.
Still, it's a lot closer than it was this morning.
* rm unnecessary arg_enum
* fix voter bags math
Turns out that when you're working in exponential space, you need
to divide, not subtract, in order to keep the math working properly.
Also neaten up the output a little bit to make it easier to read.
* add computed voter bags thresholds to node
* fixup some docs
* iter from large bags to small, fulfuilling the contract
* make tests compile
* add VoterBagThresholds to some configs
* ensure that iteration covers all voters even with implied final bag
* use sp_std::boxed::Box;
* fix unused import
* add some more voter bags tests
* file_header.txt
* integrity test to ensure min bag exceeds existential weight
* add more debug assertions about node list length
* rm unused imports
* Kian enters
* Update frame/election-provider-support/src/onchain.rs
Co-authored-by: Zeke Mostov <32168567+emostov@users.noreply.github.com>
* Suggestions for #9081 (Store voters in unsorted bags) (#9328)
* Add some debug asserts to node::get and remove_node
* Improve the debug asserts in remove_node
* improve debug asserts
* Space
* Remove bad assertions
* Tests: WIP take_works
* Take test
* Doc comment
* Apply suggestions from code review
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
* Test storage is cleaned up;
* formatting
* Switch to simpler thresholds
* Update the storage cleanup test
* Remove hardcoded values from benchmark to make it more robust
* Fix tests to acces bags properly
* Sanity check WIP; tests failing
* Update sanity checks to be more correct
* Improve storage cleanup tests
* WIP remote_ext_tests
* Some notes on next steps
* Remove some stuff that was for remote-ext tests
* Some more cleanup to reduce diff
* More :clean:
* Mo cleanin
* small fix
* A lot of changes from kian
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
Co-authored-by: kianenigma <kian@parity.io>
* merge fallout
* Run cargo +nightly fmt
* Fix a bunch of stuff, remove not needed runtime arg of make-bags
* add logs
* Glue the new staking bags to the election snapshot (#9415)
* Glue the new staking bags to the election snapshot
* add CheckedRem (#9412)
* add CheckedRem
* fix
* Run fmt
* Test comment
Co-authored-by: Xiliang Chen <xlchen1291@gmail.com>
Co-authored-by: emostov <32168567+emostov@users.noreply.github.com>
* Update node runtime with VoterSnapshotPerBlock
* Unit test for pallet-staking unsorted bags feature (targets #9081) (#9422)
* impl notional_bag_for_works
* Add tests: insert_as_works & insert_works
* Impl test: remove_works
* Trivial cleaning
* Add test: update_position_for_works
* Write out edge case; probably can delete later
* Add test: bags::get_works
* Add test: remove_node_happy_path_works
* Add test: remove_node_bad_paths_documented
* WIP: voting_data_works
* done
* Improve test voting_data_works
* Add comment
* Fill out test basic_setup_works
* Update: iteration_is_semi_sorted
* Improve remove_works
* Update update_position_for_works; create set_ledger_and_free_balance
* Improve get_works
* Improve storage clean up checks in remove test
* Test: impl rebag_works + insert_and_remove_works
* forgot file - Test: impl rebag_works + insert_and_remove_works
* Small tweak
* Update voter_bags test to reflect unused bags are removed
* Unbond & Rebond: do_rebag
* Prevent infinite loops with duplicate tail insert
* Check iter.count on voter list in pre-migrate
* undo strang fmt comment stuff
* Add in todo
Co-authored-by: kianenigma <kian@parity.io>
* Try prepare for master merge
* Reduce diff
* Add comment for test to add
* Add in code TODO for update_position efficiency updates
* Initial impl compiles
* impl StakingVoterListStub
* Sample impl<T: Config> VoterListProvider<T> for VoterList<T>
* impl VoterListProvider for voter-bags
* WIP integrate pallet-voter-bags to staking mock
* the trait `pallet_staking::pallet::pallet::Config` is not implemented for `mock::Test`
* random
* pushing my stuff
* Mock working
* WIP voter list tests
* Add bag insert, remove tests
* Add test for bag insert and remove
* Add remaining tests for VoterList
* Add tests for node
* Add rebag works
* Add rebag extrinsic tests
* Rename to bags-list and name the list .. list!
* Rename VoterBagThresholds => BagThresholds
* Add test count_works
* Test on_update_works
* test sanity check
* a round of test fixes
* push a lot of changes
* my last changes
* all bags-list test work; fmt
* Beautify some tests
* Doc comment for bags-list
* Add insert warnings
* Setup initial benchmark
* Wire up WeightInfo
* is_terminal wip; everything broken!
* Is terminal working
* add TODOs for remove_node
* clean up remoe_node
* Fix all staking tests
* retire VoterBagFor
* commit
* bring in stashed changes
* save
* bench pipeline works now, but I can't run stuff
* sabe
* benchmarks now run, but we have a failure
* WIP: Wire up make_bags
* bags-thresholds compiles
* Fix most build issues
* This will fix all the tests
* move bag thresholds to bags-list
* Move bag-thresholds bin to within pallet-bags
* Remove some unnescary TODOs
* Impl tets wrong_rebag_is_noop
* assert remove is a noop with bad data
* Assert integrity test panics
* Return an error when inserting duplicates
* Update to handle error in staking pallet when inserting to list
* Test contains and on_insert error
* Test re-nominate does not mess up list or count
* Everything builds and works, only the benchmark...
* fuck yeah benchmarks
* more cleanup, more hardening.
* use the bags list again
* fix benhc
* Some questions and changs for List::migration
* Fix migration removed_bags and new_bags usage
* Some trivial aesthetic changes
* Some more trivial changes
* tiny changes/
* mega rename
* fix all tests and ci build
* nit
* Test and fix migration
* nit
* fmt
* cargo run --quiet --release --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark --chain=dev --steps=50 --repeat=20 --pallet=pallet_staking --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/staking/src/weights.rs --template=./.maintain/frame-weight-template.hbs
* fmt
* remove unused
* make a few things pub
* make node also pub.. for remote-ext test
* Fix all tests again
* Force bag changes in relevant benchmarks (targets #9507) (#9529)
* force rebag for unbond, rebond, and bond_extra
* nit
* Improve utils
* fmt
* nits
* Move generate_bags to its own pallet
* Get runtime-benchmarks feature setup with prepare_on_update_benchmark
* Withdraw unbonded kill working
* Nominate bench working
* some cleanup
* WIP
* update to check head pre & post conditions
* Add some post condition verification stuff for on_remove
* Update nominate
* fmt
* Improvements
* Fix build
* fix build with polkadot companion
* Update frame/bags-list/src/list/tests.rs
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
* move generate-bag from frame to utils
* wip
* refactor WIP
* WIP save
* Refactor working
* some variable renaming
* WIP: prepare to remove head checks
* Finish MvP refactor
* Some cleanup
* Soem more cleanup
* save
* fix a lot of stuff
* Update client/db/src/bench.rs
Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com>
* Apply suggestions from code review
* Apply suggestions from code review
* Fix some issues that came from trying to merge comments on github
* some small changes
* simplify it
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
Co-authored-by: kianenigma <kian@parity.io>
Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com>
* Build works
* Apply suggestions from code review
Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com>
* Apply suggestions from code review
Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com>
* Remove commented out debug assert
* Remove some unused deps and some unused benchmarking stuff
* Fix stakings ElectionDataProvider clear
* cargo run --quiet --release --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark --chain=dev --steps=50 --repeat=20 --pallet=pallet_bags_list --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/bags-list/src/weights.rs --template=./.maintain/frame-weight-template.hbs
* cargo run --quiet --release --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark --chain=dev --steps=50 --repeat=20 --pallet=pallet_bags_list --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/bags-list/src/weights.rs --template=./.maintain/frame-weight-template.hbs
* cargo run --quiet --release --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark --chain=dev --steps=50 --repeat=20 --pallet=pallet_bags_list --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/bags-list/src/weights.rs --template=./.maintain/frame-weight-template.hbs
* cargo run --quiet --release --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark --chain=dev --steps=50 --repeat=20 --pallet=pallet_bags_list --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/bags-list/src/weights.rs --template=./.maintain/frame-weight-template.hbs
* Improving staking pallet-bags-list migration
* fix build and some comments;
* comment
* Reduce visibility in bags list components
* make node.bag_upper only accesible to benchmarks
* Address some feedback; comments updates
* use nominator map comment
* fix vec capacity debug assert
* Apply suggestions from code review
Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com>
* clarify VoterSnapshotPerBlock
* Reduce diff on create_validators by wrapping with_seed
* Some small improvements to staking benches
* Soem comment updates
* fix vec capacity debug assert ... for real this time
* Reduce ListBags viz
* cargo run --quiet --release --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark --chain=dev --steps=50 --repeat=20 --pallet=pallet_staking --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/staking/src/weights.rs --template=./.maintain/frame-weight-template.hbs
* cargo run --quiet --release --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark --chain=dev --steps=50 --repeat=20 --pallet=pallet_staking --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/staking/src/weights.rs --template=./.maintain/frame-weight-template.hbs
* Remove supports_eq_unordered & Support eq_unordered
* Update utils/frame/generate-bags/src/lib.rs
Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com>
* Make total-issuance & minimium-balance CLI args; Dont use emptry ext
* Improve docs for generate bags CLI args
* Apply suggestions from code review
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
* Apply suggestions from code review
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
* Don't use default bags weight in node runtime
* Feature gating sanity_check not working
* Feature gate sanity check by creating duplicate fns
* Fix line wrapping
* Document VoteWeightProvider
* Make bags ext-builder not a module
* Apply suggestions from code review
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
* use pallet_bags_list instead of crate in mock
* Make get_bags test helper fn live in List
* use remove_from_storage_unchecked for node removal
* Remove count of ids removed in remove_many
* Add node sanity check, improve list sanity check
* Do a list sanity check after on_update
* List::migrate: clean up debug assert, exit early when no change in thresholds
* Improve public doc comments for pallet_bags_list::list::List
* Improve public doc comments for pallet_bags_list::list::List
* Update generate bags docs
* Fix grammar in bags-list benchmark
* Add benchmark case for `rebag` extrinsic
* Add count parameter to List::clear; WIP adding MaxEncodedLen to list'
* MaxEncodeLen + generate_storage_info not working for Bag or Node
* Get MaxEncodeLen derive to work
* Try to correctly feature gate SortedListProvider::clear
* Use u32::MAX, not u32::max_value
* Get up to nominators_quota noms
* SortedListProvider::clear takes an Option
* Eplicitly ignore SortedListProvider return value
* Fix doc comment
* Update node-runtime voter snapshot per block
* Add test get_max_len_voters_even_if_some_nominators_are_slashed
* Add test only_iterates_max_2_times_nominators_quota
* Fix generate bags cargo.toml
* use sp_std vec
* Remove v8 migration hooks from pallet-staking
* Update npos trait
* Try respect line width
* cargo run --quiet --release --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark --chain=dev --steps=50 --repeat=20 --pallet=pallet_bags_list --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/bags-list/src/weights.rs --template=./.maintain/frame-weight-template.hbs
* Update frame/bags-list/src/benchmarks.rs
* Unwrap try-runtime error; remove sortedlistprovider pre upgrade len check
* trigger ci
* restore
* trigger ci
* restore
* trigger ci
* revert
* trigger ci
* revert
Co-authored-by: Peter Goodspeed-Niklaus <coriolinus@users.noreply.github.com>
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
Co-authored-by: Peter Goodspeed-Niklaus <peter.r.goodspeedniklaus@gmail.com>
Co-authored-by: kianenigma <kian@parity.io>
Co-authored-by: Xiliang Chen <xlchen1291@gmail.com>
Co-authored-by: Parity Benchmarking Bot <admin@parity.io>
Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com>
Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com>
Oliver Tale-Yazdi