derive-syn-parse v0.2.0 came out recently which (finally) adds support
for syn 2x.
Upgrading to this will remove many of the places where syn 1x was still
compiling alongside syn 2x in the polkadot-sdk workspace.
This also upgrades `docify` to 0.2.8 which is the version that upgrades
derive-syn-pasre to 0.2.0.
Additionally, this consolidates the `docify` versions in the repo to all
use the latest, and in one case upgrades to the 0.2x syntax where 0.1.x
was still being used.
---------
Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>
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
# Description
Upgrades `macro_magic` to 0.4.3, which introduces the ability to have
`export_tokens` use the same name as the underlying item for its
auto-generated macro name. Ultimately this will allow for better dev ux
in our derive_impl feature.
* globally upgrade syn to 1.0.109
* globally upgrade quote to 1.0.26
* globally upgrade proc-macro2 to 1.0.56
* globally bump syn to v2.0.13
* update expander to v1.0.0
* temporary commit to prove new version of expander works
(new version hasn't been released yet so using git)
* use expander 2.0.0
* upgrade to syn 2.0.14
* update lock file
* globally upgrade quote to latest 1.0.x (1.0.26)
* globally upgrade syn to final 1.0.x version (1.0.109)
* globally upgrade proc-macro2 to 1.0.56
* upgrade to syn v2.0.13 and fix everything except NestedMeta
* fix parse nested metadata code in decl_runtime_apis.rs
* Port more stuff to syn 2.0
* Make the rest compile
* Ignore error
* update to syn 2.0.14
---------
Co-authored-by: Bastian Köcher <info@kchr.de>
* function generation with _name working, need to modify signature
* WIP
* support custom BenchmarkResult<T> type
* full support for BenchmarkResult<T> on benchmark function defs
* support () return type for benchmark function defs that don't use ?
* uncomment
* fix where clause handling
* fix benchmark function call bodies
* proper parsing of return type
* add UI tests for bad return type
* fix detection of missing last_stmt with defined return type
* UI tests covering missing last_stmt
* properly detect and complain about empty benchmark function defs
* fix missing Comma in Result<T, BenchmarkError> parsing + test
* add additional UI test
* allow complex path for BenchmarkResult and BenchmarkError in fn defs
* add UI tests covering complex path for BenchmarkResult, BenchmarkError
* retain doc comments and attributes
* also add attributes to struct
* add docs for benchmark function definition support
* fix imports on benchmark example
* fix issue with unused variables in extrinsic call fn def
* fix up docs
* remove support for v2::BenchmarkResult because it was confusing
* fix typo
* remove ability to use custom T for Result<T, BenchmarkError> in v2
* use missing call error instead of empty_fn()
* remove unneeded match statement
* Add a proper QED
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* fix other QED
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* cargo fmt
* add an explicit error for non TypePath as return type
* tweak error warning and add a UI test for non TypePath return
* remove comment
* add docs about T and I generic params
* improve docs referring to section "below"
* pull out return type checking logic into its own function
* pull out params parsing into its own function
* pull out call_def parsing into its own function
* add doc comment for missing_call()
* replace spaces with tabs
* add a result-based example to the benchmarking examples
---------
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* add stub for new benchmark macro
* benchmark syntax
* add #[extrinsic call] separator
* parse #[benchmark] item as a function
* proper emission of error when #[extrinsic_call] annotation is missing
* clean up
* enclosing module via benchmarks! { } working
* use an attribute macro on the module instead of benchmarks! { }
* cargo fmt
* working component implementation
* WIP
* working
* add syntax for Linear<A, B>
* parsing of param ranges (still need to build tuple though)
* params parsing WIP
* clean up (don't need extrinsic call name)
* use proper Result syntax for BenchmarkDef parsing
* proper parsing of Linear<0, 1> style args
* successfully parse and make use of linear component ranges 💥
* rename support variable => home because eventually will be moved
* compile-time check that param range types implement ParamRange
* switch to using balances as example, failing on instance pallet
* successfully set up __origin and __call with balances 💥
* clean up
* use a module
* don't need a variable for transfer
* rename benchmark_transfer -> transfer because no longer conflicts
* clean up
* working with transfer_increasing_users as well 💥
* re-add BareBlock
* add comments for undocumented structs+functions+traits
* refactor in preparation for removing module requirements
* switch to a block instead of a module
* use the outer macro pattern to to enable #[benchmarks] aggregation
* successfully generate SelectedBenchmark 💥
* implement components for SelectedBenchmark
* implement instance for SelectedBenchmark
* properly track #[extra]
* working impl for fn benchmarks()
* run_benchmarks WIP
* finish run_benchmark! impl 💥
* import balances transfer_best_case benchmark
* import transfer_keep_alive balances pallet benchmark
* import set_balance_creating balances pallet benchmark
* import set_balance_killing balances pallet benchmark
* import force_transfer balances pallet benchmark
* add #[extra] annotation and docs to transfer_increasing_users
* import transfer_all balances pallet benchmark
* import force_unreserve balances pallet benchmark
* prepare to implement impl_benchmark_test_suite!
* ensure tests cover #[extra] before and after #[benchmark] tag
* refactor
* clean up
* fix
* move to outer
* switch to benchmarks/instance_benchmarks
* test impl almost done, strange compiler error
* benchmark test suites working 💥
* clean up
* add stub and basic parsing for where_clause
* working except where clause and extrinsic calls containing method chains
* assume option (2) for now wrt https://github.com/paritytech/substrate/pull/12924#issuecomment-1372938718
* clean up
* switch to attribute-style
* properly handle where clauses
* fix subtle missing where clause, now just MessageQueue issues
* fix block formatting in message-queue pallet
* switch to block vs non-block parsing of extrinsic call
* working now but some benchmark tests failing
* message-queue tests working (run order issue fixed) 🎉
* add comments and internal docs for fame_support_procedural::benchmark
* fix license years
* docs for lib.rs
* add docs to new support procedural macros
* don't allow #[benchmark] outside of benchmarking module
* add docs
* use benchmark(extra, skip_meta) style args
* update docs accordingly
* appease clippy
* bump ci
* add notes about `extra` and `skip_meta`
* fix doc tests
* re-run CI
* use `ignore` instead of `no_run` on doc examples
* bump CI
* replace some if-lets with if-elses
* more refactoring of if-let statements
* fix remaining if-lets in BenchmarkDef::from()
* fix if-lets in benchmarks()
* fix remaining if-lets, use nested find_map for extrinsic call
* switch to use #[extrinsic_call] or #[block] situationally
* refactor ExtrinsicCallDef => BenchmarkCallDef
* update docs with info about #[block]
* add macro stub for #[extrinsic_call]
* fix docs and add stub for #[block] as well
* remove unused extern crate line
* fix clippy nits
* Use V2 bench syntax in pallet-example-basic
Just testing the dev-ex...
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* carry over comment
* use curly-brace style for impl_benchmark_test_suite!
* remove unneeded parenthesis
* proper handling of _() extrinsic call style
* add docs for _() syntax
* fix crate access
* simplify keyword access
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* simplify module content destructuring
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* fix crate access "frame_benchmarking" => "frame-benchmarking", compiles
* use _() extrinsic call syntax where possible in balances
* simplify attr.path.segments.last()
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* fix compile error being suppressed
* simplify extrinsic call keyword parsing
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* use ? operator instead of return None
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* rename generics => type_use_generics
rename full_generics => type_impl_generics
* simplify extrinsic call extraction with transpose
* bump CI
* nit
* proper handling of too many + too few block/extrinsic call annotations
* change to B >= A
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* remove unneeded ignore
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* remove another ignore
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* add ui tests
* use _() style extrinsic call on accumulate_dummy
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* add range check to ParamRange
* ui test for bad param ranges
* fix failing example
* add ignore back to other failing example
* tweak expr_call span
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* fix typo
* eliminate a match
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* change pub fn benchmarks to return Result<TokenStream>
* fix origin error span
* more informative error for invalid benchmark parameter name
* fix spans on a few benchmark errors
* remove unneeded clone
* refactor inner loop of benchmark function parsing
* preserve mod attributes
* refactor outer loop of benchmark def parsing code, greatly simplified
* simplify to use a ? operator when parsing benchmark attr path
* fix another ? operator
* further simplify benchmark function attr parsing with more ? ops
* refactor extrinsic call handling to use if let rather than match
* replace is_ok => is_err
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* re-use name during expansion of benchmark def
* remove unneeded clone
* fix span for origin missing error
* fix missing semi
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
Co-authored-by: parity-processbot <>
* stub for construct_dev_runtime!
* revert
* stub for dev_mode proc macro
* preliminary docs for pallet::dev_mode (attribute) proc macro
* add dev_mode to pallet_macros module
* add docs item for dev_mode to frame_support
* parsing of #[pallet(dev_mode)]
* strip out dev_mode stub since it will be an arg for pallet instead
* make pallet Def struct aware of dev mode
* WIP
* revert changes to call.rs
* pass dev_mode to pallet parsing code
* auto-specify default weights when in dev mode if not specified
* add proof / expect for syn::parse in dev mode weight processing
* set all storages to unbounded when in dev mode
* just use 0
Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com>
* add invalid pallet arg test
* add passing dev mode pallet test
* add test confirming that dev mode features only work in dev mode
* cargo fmt + clean up
* bump CI
* fix pallet ui test
* add docs for dev mode
* add warning about using dev mode in production circumstances
* remove comment about no other attributes being supported
* fix unneeded assignment
* make warning more explicit
* more explicit warning about using dev mode in production
* simpler assignment for dev_mode boolean
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* add note about MEL requirement
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* add comment specifying why weights can be omitted in example
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* tweak wording of comments
* bump ci
Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com>
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* proof of concept working for pallet::whitelist_storage
* fix comments
* pallet macros docs rewrite WIP
* fix issue with cargo fmt cobbling links
* tweak capitalization
* fix docs for storage_version
* fix docs for pallet::hooks
* fix several comments
* fix invalid link
* fix wrapping and add missing links for pallet::hooks docs
* run rewrap on all text blocks in frame_support::pallet docs
* cargo fmt
* fix up pallet::call_index docs
* fix docs for pallet::extra_constants
* fix docs for pallet::error
* fix docs for pallet::event
* fix docs for pallet::event
* * fix docs for pallet::storage
* fix docs for pallet::getter
* fix docs for pallet::storage_prefix
* fix docs for pallet::unbounded
* fix docs for pallet::whitelist_storage
* fix docs for #[cfg(..)] (for storage items and attributes)
* fix docs for pallet::storage macro expansion
* fix docs for pallet::type_value
* fix docs for pallet::genesis_config
* fix docs for pallet::genesis_build
* fix docs for pallet::inherent
* fix docs for pallet::validate_unsigned
* fix docs for pallet::origin
* fix docs for general notes on instantiable pallets
* fix docs for example of a non-instantiable pallet
* fix docs for example of an instantiable pallet
* fix docs for upgrade guidelines
* fix docs for upgrade guidelines
* fix docs for upgrade checking and final notes
* fix some examples near the beginning
* extract docs for `pallet::whitelist_storage`
* add docs for pallet_macro_stub
* fix order of pallet::config and pallet::constant
* set up stub for pallet::config
* set up stub for pallet::constant
* fix
* set up stub for pallet::disable_frame_system_supertrait_check
* set up stub for pallet::generate_storage_info
* set up stub for pallet::storage_version
* set up stub for pallet::hooks
* set up stub for pallet::weight
* set up stub for pallet::compact
* set up stub for pallet::call_index
* set up stub for pallet::extra_constants
* set up stub for pallet::error
* set up stub for pallet::event
* set up stub for pallet::generate_deposit
* set up stub for pallet::storage
* set up stub for pallet::getter
* set up stub for pallet::storage_prefix
* set up stub for pallet::unbounded
* set up stub for pallet::type_value
* set up stub for pallet::genesis_config
* set up stub for pallet::genesis_build
* set up stub for pallet::inherent
* set up stub for pallet::validate_unsigned
* set up stub for pallet::origin
* fix comment
* cargo fmt
* tweak error message
* Update frame/support/procedural/src/lib.rs
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* Update frame/support/procedural/src/lib.rs
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* switch order of derives
Co-authored-by: Squirrel <gilescope@gmail.com>
* tweak wording
Co-authored-by: Squirrel <gilescope@gmail.com>
* add more context info about `MAX_MODULE_ERROR_ENCODED_SIZE`
Co-authored-by: Squirrel <gilescope@gmail.com>
* tweak wording about where clause
Co-authored-by: Squirrel <gilescope@gmail.com>
* clarify wording about system/events key
Co-authored-by: Squirrel <gilescope@gmail.com>
* use "The Event enum" instead of "item"
Co-authored-by: Squirrel <gilescope@gmail.com>
* fix bad wording
Co-authored-by: Squirrel <gilescope@gmail.com>
* use enum instead of type
Co-authored-by: Squirrel <gilescope@gmail.com>
* expect => expects
Co-authored-by: Squirrel <gilescope@gmail.com>
* add additional note about storage prefix
Co-authored-by: Squirrel <gilescope@gmail.com>
* clearer note about GenesisConfig
Co-authored-by: Squirrel <gilescope@gmail.com>
* Use "The impl" instead of "The item"
Co-authored-by: Squirrel <gilescope@gmail.com>
* add note and link to tight-coupling docs
Co-authored-by: Squirrel <gilescope@gmail.com>
* cargo fmt
* remove spaces around parenthesis
* fix missing text for pallet::config
* fix issue with pallet::constant intro
* fix wording about codec index
* fix pallet::error wording
* fix comment about 1 byte => 256 errors
* fix where clause comment
* fix comment about where pallet events are stored
* rewrap some text
* fix pallet::storage docs
* fix pallet::storage_prefix docs
* tweak docs for pallet::genesis_build
* tweak docs for pallet::config
* specify that pallet::event must be present if pallet::config is present
* add note about why we would want to bypass the supertrait check
* mention that pallet::generate_store attribute is only valid on pallet struct
* add note about adding new calls to the end to maintain existing order
* add note about pallet::type_value and pallet::storage
Co-authored-by: Squirrel <gilescope@gmail.com>
* add note about using pallet::type_value alongside pallet::storage
* include warning about modifying disaptchables on other pallet::call_index docs page
* fix incorrect comment
* add much more information for pallet::inherent
* move pallet::pallet macro expansion notes back to their rightful place
* re-run CI
* fix macro expansion appearing in wrong place for pallet::pallet
* replicate pallet::pallet docs on the pallet::pallet macro stub
* force CI re-run
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
Co-authored-by: Squirrel <gilescope@gmail.com>
Co-authored-by: parity-processbot <>
* initial setup
* add WhitelistedStorageKeys trait
* add (A, B) tuple implementation for whitelisted_storage_keys()
* fix formatting
* implement WhitelistedStorageKeys for all tuple combinations
* impl_for_tuples up to 128 for WhitelistedStorageKeys
* refactor to #[benchmarking(cached)]
* tweak error message and mark BlockNumber as cached
* add benchmarking(cached) to the other default types
* add docs for benchmarking(cached)
* properly parse storage type declaration
* make storage_alias structs public so we can use them in this macro
* use BTreeMap since TrackedStorageKey missing Ord outside of std
* make WhitelistedStorageKeys accessible
* basic detection of benchmarking(cached) 💥
* proper parsing of #[benchmarking(cached)] from pallet parse macro
* store presence of #[benchmarking(cached)] macro on StorageDef
* will be used for later expansion
* compiling blank impl for WhitelistedStorageKeys
* move impl to expand_pallet_struct
* use frame_support::sp_std::vec::Vec properly
* successfully compiling with storage info loaded into a variable 💥
* plausible implementation for whitelisted_storage_keys()
* depends on the assumption that storage_info.encode() can be loaded
into TrackedStorageKey::new(..)
* use Pallet::whitelisted_storage_keys() instead of hard-coded list
* AllPallets::whitelisted_storage_keys() properly working 💥
* collect storage names
* whitelisted_storage_keys() impl working 💥
* clean up
* fix compiler error
* just one compiler error
* fix doc compiler error
* use better import path
* fix comment
* whoops
* whoops again
* fix macro import issue
* cargo fmt
* mark example as ignore
* use keyword tokens instead of string parsing
* fix keyword-based parsing of benchmarking(cached)
* preliminary spec for check_whitelist()
* add additional test for benchmarking whitelist
* add TODO note
* remove irrelevant line from example
* use filter_map instead of filter and map
* simplify syntax
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* clean up
* fix test
* fix tests
* use keyword parsing instead of string parsing
* use collect() instead of a for loop
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
* fix compiler error
* clean up benchmarking(cached) marking code
* use cloned()
* refactor to not use panic! and remove need for pub types in storage_alias
* remove unneeded use
Co-authored-by: Bastian Köcher <info@kchr.de>
* remove unneeded visibility changes
* don't manually hard code hash for treasury account as hex
* proper Ord, PartialOrd, and Hash impls for TrackedStorageKey
* now based just on key, and available in no-std
* use BTreeSet instead of BTreeMap
* fix comments
* cargo fmt
* switch to pallet::whitelist and re-do it basti's way :D
* make PartialOrd for TrackedStorageKey consistent with Ord
* more correct implementation of hash-related traits for TrackedStorageKey
* fix integration test
* update TODO
* remove unused keyword
* remove more unused keywords
* use into_iter()
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* Update frame/support/procedural/src/pallet/parse/mod.rs
Co-authored-by: Bastian Köcher <info@kchr.de>
* add docs for whitelisted
* fix comment
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
Co-authored-by: Bastian Köcher <info@kchr.de>