From b0f80572f3eaff5f1836c8864dbd46488fc695c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bastian=20K=C3=B6cher?= Date: Fri, 2 Oct 2020 17:02:55 +0200 Subject: [PATCH] Split block announce processing into two parts (#6958) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Split block announce processing into two parts This pull requests splits the block announce processing into two parts. Into a phase that is called pre-validation that will be async and call the block announce validator and into a second phase that processes the result of the pre-validation. The important change here is that the pre-validation phase is async. This will be required by Cumulus/parachains. When a parachain announces a block, it adds the candidate message send by the relay chain as extra data into the block announcement. To verify this candidate message, the relay chain parent is required that was used when building this message. Now it can happen that we first receive the block announcement before fully importing the relay chain block and this leads to the parachain block not being imported. By making the pre-validation async, we will be able to wait for the relay chain block to be imported to verify the candidate message. * Apply suggestions from code review Co-authored-by: Pierre Krieger * Update client/network/src/protocol/sync.rs Co-authored-by: Pierre Krieger * client/authority-discovery: Append PeerId to Multiaddr at most once (#6933) * client/authority-discovery/worker: Extract address getter * client/authority-discovery: Test for no duplicate p2p components * client/authority-discovery: Append PeerId to Multiaddr at most once When collecting the addresses to be published for the local node, `addresses_to_publish` adds the local nodes `PeerId` to each `Multiaddr`. Before doing so, ensure the `Multiaddr` does not already contain one. * client/authority-discovery: Remove explicit return * expose Deposit (#6943) * Add a `LightSyncState` field to the chain spec (#6894) * Reset code, almost ready for PR * Improved build_hardcoded_spec * Fix line widths * Fix tests * Fix sc-service-test * Suggestions from code review * Rename to LightSyncState * It's not syncing :^( * It syncs! * Remove rpc call * Convert spaces to tabs * Moved sc-service things to export_sync_state.rs * Fix tests * Wait for syncing with network_status_sinks * Remove sc-network from node-template * Apply suggestions from code review Co-authored-by: Bastian Köcher * Various changes, split the flag up into 2 pieces to make testing easier. * Update client/cli/src/commands/build_spec_cmd.rs Co-authored-by: Bastian Köcher * Revert a lot of changes Co-authored-by: Bastian Köcher * Dynamically generate CHT roots on a full client (#6944) * Generate CHT roots on a full client * add changes_trie_root function * Add a test * Line widths * Fix sc-service-test * Clarify comments * Revert comments * Enable verification logic when executing benchmarks (#6929) * Add `--verify` flag to benchmark execution * make it so `--verify` can be used for getting the actual benchmarks * undo manual testing * oops * use benchmark config struct * verify is default on, docs update * remove clone * improve formatting * fix test * bump impl for ci * grandpa: always create and send justification if there are any subscribers (#6935) * grandpa: use bytes type for justification rpc notification * grandpa: always create justification if there are rpc subscribers * grandpa: wording * grandpa: replace notify_justification macro with function * grandpa: prefer Option<&T> over &Option * .maintain/monitoring/alerting-rules: Add fd alert (#6946) Alert on high file descriptor allocation. * Fix benchmark read/write key tracker for keys in child storages. (#6905) * WIP: read child trie and write child trie * add test * refactor a bit + improve log * better naming * trigger CI * Revert "trigger CI" This reverts commit d0aadaeb6a12fc6c39f01b3c1b5725d19f085865. * client/authority-discovery: Limit number of addresses per authority (#6947) * client/authority-discovery: Test addresses per authority limit * client/authority-discovery: Limit number of addresses per authority * ⛓ ✨Add ShiftNrg Network SS58 address type (#6942) * update tracing attribute (#6950) * Fix unwraps and other issues with benchmarks (#6957) * Fix unwraps and other issues with benchmarks * undo changes to contracts pallet * Remove implementation of `Randomness for ()` (#6959) * Fix staking fuzzer. (#6954) * Enforce that ProtocolId is a string (#6953) * Enforce that ProtocolId is a string * Fix test * Support Staking Payout to Any Account (#6832) * Support staking payout to any account * fix offences benchmarks * Better prime election. (#6939) * Better prime election. * improve docs * more sensible variable names * link to Borda count wiki Co-authored-by: Shawn Tabrizi * babe: fix report_equivocation weight (#6936) * babe: fix report_equivocation weight * node: bump spec_version * babe: fix floor in report_equivocation weight calculation Co-authored-by: Gavin Wood * grandpa: fix floor in report_equivocation weight calculation * babe, grandpa: add test for weight_for::report_equivocation Co-authored-by: Gavin Wood * fix bench db wipe (#6965) * Implement request-responses protocols (#6634) * Implement request-responses protocols * Add tests * Fix sc-cli * Apply suggestions from code review Co-authored-by: Max Inden * Fix naming * Fix other issues * Other naming fix * Fix error logging * Max sizes to u64 * Don't kill connections on refusal to process * Adjust comment Co-authored-by: Max Inden * add generated weight info for pallet-collective (#6789) * add benchmark for disapprove_proposal * use generated WeightInfo for pallet-collective weights * order collective benchmark params alphabetically to get a consistent ordering * address review comments * remove default impl of WeightInfo for () * remove comments about weight changes * add default weights * Apply suggestions from code review Co-authored-by: Guillaume Thiolliere * whitelist voter account in benchmark * update weights * MaxMembers configurable * remove base weight comment * add weight to technical collective * another DB whitelist optimization Co-authored-by: Shawn Tabrizi Co-authored-by: Guillaume Thiolliere * client/*: Treat protocol name as str and not [u8] (#6967) * client/*: Treat protocol name as str and not [u8] Notification protocol names are in practice always valid utf8 strings. Instead of treating them as such in the type system, thus far they were casted to a [u8] at creation time. With this commit protocol names are instead treated as valid utf8 strings throughout the codebase and passed as `Cow<'static, str>` instead of `Cow<'static, [u8]>`. Among other things this eliminates the need for string casting when logging. * client/network: Don't allocate when protocol name is borrowed * update kvdb-rocksdb to 0.9.1 and rocksdb to 6.11.4 (#6963) * Use AsyncReadExt::read_exact, not just read (#6977) * client/cli/src/config: Warn on low file descriptor limit (#6956) * client/cli/src/config: Warn on low file descriptor limit Substrate sets the soft file descriptor limit to the hard limit at startup. In the case of the latter being low already (< 10_000) a Substrate node under high demand might run into issues e.g. when opening up new TCP connections or persisting data to the database. With this commit a warn message is printed to stderr. * client/cli/Cargo.toml: Update to fdlimit 0.2.0 * Update substrate bip39 version. (#6955) * update bip39 version * and lock * Inverting events set and changed in nicks pallet (#6989) Fixing #6988 * Silence the error about non-registered protocols (#6987) * Silence the error about non-registered protocols * Silence the other two locations as well * Change browser-demo build.sh to use python 3 again (#6992) * fix pallet-evm features (#6995) * Move subcommands from sc-cli to nodes (#6948) * ci: deploy alerting rules: fix run on changes (#6998) * ci: deploy alerting rules: fix run on changes Co-authored-by: Max Inden * *: Update to Prometheus v0.10.0 (#6964) * *: Update to Prometheus v0.10.0-rc.1 * *: Update to Prometheus v0.10.0 * Ensure that handshake is sent back even in case of back-pressure (#6979) * Ensure that handshake is sent back even in case of back-pressure * Update client/network/src/protocol/generic_proto/handler/group.rs Co-authored-by: Max Inden * Also process OpenRequest and Closed * Fix bad merge * God I'm so lost with all these merges * Immediately return Closed Co-authored-by: Max Inden * frame/authority-discovery: Have authorities() return both current and next (#6788) * frame/authority-discovery: Have authorities() return both current and next Authority address lookups on the DHT happen periodically (every 10 mintues) and are rather slow (~10 seconds). In order to smooth the transition period between two sessions, have the runtime module return both the current as well as the next authority set. Thereby the client authority module will: 1. Publish its addresses one session in advance. 2. Prefetch the addresses of authorities of the next session in advance. * frame/authority-discovery: Deduplicate authority ids * frame/authority-discovery: Don't dedup on_genesis authorities * frame/authority-discovery: Remove mut and sort on comparison in tests * frame/authority-discovery: Use BTreeSet for deduplication * Stop sending messages on legacy substream altogether (#6975) * Stop sending messages on legacy substream altogether * Ensure that handshake is sent back even in case of back-pressure * Update client/network/src/protocol/generic_proto/handler/group.rs Co-authored-by: Max Inden * Also process OpenRequest and Closed * Also process OpenRequest and Closed * Fix bad merge * God I'm so lost with all these merges * Immediately return Closed * Add warning for sending on non-registered protocol * Register GrandPa protocol in tests * Update client/network/src/protocol/generic_proto/handler/group.rs Co-authored-by: Max Inden Co-authored-by: Max Inden * manual seal is now consensus agnostic (#7010) * manual seal is now consensus agnostic * pr grumbles * grandpa: report metrics on prevotes and precommits cast (#6970) * grandpa: report metrics on prevotes and precommits cast * Update client/finality-grandpa/src/environment.rs Co-authored-by: Max Inden * Update client/finality-grandpa/src/environment.rs Co-authored-by: Max Inden Co-authored-by: Max Inden * Fix compact npos solution edge count calculation (#7021) This edge count is used for weighing, and it is somewhat trivial to review and verify that the current implementation was ignoring `votes16` field of the struct. As reminder, the struct is like this: ```rust struct Compact { votes1: ... , votes2: ..., ..., votes16: ..., } ``` I already will fix this in https://github.com/paritytech/substrate/pull/7007, but since it might take a while, this one can go in asap and make it to the very next runtime. * Refactor & detach network metrics. (#6986) * Refactor sc-network/service metrics. 1. Aggregate sc-network metrics into a submodule, introducing two more sourced metrics to avoid duplicate atomics. 2. Decouple periodic sc-service network metrics from other metrics, so that they can be updated independently. * Update client/service/src/metrics.rs * Update client/service/src/metrics.rs * Node template complete import pipeline (#7014) * Use complete import pipeline * Line length Co-authored-by: Dan Forbes * client/authority-discovery: Throttle DHT requests (#7018) * client/authority-discovery: Throttle DHT requests Instead of passing one DHT query for each authority down to the network every query interval, only pass MAX_IN_FLIGHT_LOOKUPS at a given point in time, triggering new ones when previous ones return. * client/authority-discovery/worker/test: Fix wrong constant * Update Nicks docs to clarify that it is not production-ready (#6990) * Ignore wasm_gc for debug build. (#6962) * Ignore gc for debug build. * alternate implementation * Update utils/wasm-builder/src/lib.rs Co-authored-by: Bastian Köcher * fix Co-authored-by: Bastian Köcher * Make `--file` optional for `generate-node-key` (#7043) This pr makes the `--file` argument optional to `generate-node-key`. If the argument is not given, the secret node key will be printed to `stdout`. The public node key will always be printed to `stderr`. * Downgrade wabt = 0.9.1 (#7042) * Add metadata shadows to multisig pallet (#7029) * Add metadata shadows to multisig pallet * Update frame/multisig/src/lib.rs Co-authored-by: Bastian Köcher * Fix broken link to democracy pallet. (#7026) Old link was broken, and I put a new one. * Revert "Fix broken link to democracy pallet. (#7026)" (#7047) This reverts commit 008cb24c50f8b1d0b6f66dc5d90182cd1e501da2. * Update the service tasks Grafana dashboard (#7038) * babe, grandpa: waive fees on valid equivocation report (#6981) * babe: waive fees on report_equivocation * grandpa: waive fees on report_equivocation * babe: add test for fee waiving on valid equivocation report * grandpa: add test for fee waiving on valid equivocation report * grandpa: remove stray comment * Clarify Nicks docs (#7049) * Improves EVM gas price check (#7051) * Change wabt to wat (#7050) * Add Dock network id for address generation (#6714) Taking 21 and 22 for testnet and mainnet Signed-off-by: lovesh * Partial fix for transaction priority (#7034) * Partial fix for priority stuff. * Small fix * Fix tests. * Update frame/transaction-payment/src/lib.rs Co-authored-by: Tomasz Drwięga * Better doc Co-authored-by: Tomasz Drwięga * What happens if we remove wat? (#7056) * What happens if we remove wat? * Update Cargo.lock * Make SlashingSpans Public (#6961) * Make SlashingSpans Public Offchain Applications will often need to inspect this type because it is directly used in staking election, thus worthy of being `pub`. Rest of the slashing api can remain private, only this and the `fn last_non_zero_slash()` of `SlashingSpans` are of interest. * Update frame/staking/src/lib.rs * client/authority-discovery/src/service: Improve docs (#7059) * Decrease poll interval (#7063) * Remove unused code (#7027) Signed-off-by: Jimmy Chu * Disambiguate `BlockNumber` type in `decl_module` (#7061) * Disambiguate `BlockNumber` type in `decl_module` * fix `frame-support-tests` * fix ui tests * fix trait order * Implement `FromStr` for `Ss58AddressFormat` (#7068) * Implement `FromStr` for `Ss58AddressFormat` * Update primitives/core/src/crypto.rs Co-authored-by: Shawn Tabrizi Co-authored-by: Shawn Tabrizi * Set reserved nodes with offchain worker. (#6996) * add offchain worker api to set reserved nodes. * new offchain api to get node public key. * node public key from converter * refactor set reserved nodes ocw api. * new ndoe authorization pallet * remove unnecessary clone and more. * more * tests for node authorization pallet * remove dependency * fix build * more tests. * refactor * Update primitives/core/src/offchain/testing.rs Co-authored-by: Tomasz Drwięga * Update frame/node-authorization/src/lib.rs Co-authored-by: Tomasz Drwięga * Update frame/node-authorization/src/lib.rs Co-authored-by: Tomasz Drwięga * Update frame/node-authorization/src/lib.rs Co-authored-by: Tomasz Drwięga * format code * expose NetworkService * remove NetworkStateInfo in offchain * replace NodePublicKey with PeerId. * set max length of peer id. * clear more * use BTreeSet for set of peers. * decode opaque peer id. * extract NetworkProvider for client offchain. * use OpaquePeerId in node authorization pallet. * fix test * better documentation * fix test * doc * more fix * Update primitives/core/src/offchain/mod.rs Co-authored-by: Pierre Krieger * Update client/offchain/src/api.rs Co-authored-by: Pierre Krieger * derive serialize and deserialize Co-authored-by: Tomasz Drwięga Co-authored-by: Pierre Krieger * Rename `TRIGGER_WASM_BUILD` to `FORCE_WASM_BUILD` (#7080) Because apparently I can not speak properly ;) * Make decoding of `compact` saturating instead of invalid (#7062) * make decoding of cmopact saturating * fix stable build * Update primitives/arithmetic/src/per_things.rs Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> * Update primitives/arithmetic/src/per_things.rs Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> * state_machine no_std witness externalities (#6934) * checkpoint before removing CT from change trie * before trie backend without tx * undo * Started no transaction, but would need using a different root calculation method, out of the scope of this pr, will roll back. * Remove NoTransaction. * partially address review. dummy stats implementation for no_std. * Remove ChangeTrieOverlay. * modified function * Remove witness_ext * need noops changes root * update from cumulus branch * line break * remove warning * line break * From review: renamings and stats active in no std (except time). * include cache, exclude change trie cache with individual temporary bad looking no_std check * little test * fuse imports and filter_map prepare_extrinsics_input_inner fold. * put back ExtInner into Ext, awkward double proto for new function. * Apply suggestions from code review * Update primitives/state-machine/Cargo.toml Co-authored-by: Bastian Köcher * Support hex encoded secret key for `--node-key` (#7052) * Support hex encoded secret key for `--node-key` Adds support for reading a hex encoded secret key when being passed as file via `--node-key`. * Make the key loading uniform * Switch to `hex::decode` * Add a `build-sync-spec` subcommand and remove the CHT roots from the light sync state. (#6999) * Move subcommands from sc-cli to nodes * Add --build-sync-spec subcommand * Remove CHTs from snapshots * Keep ProvideChtRoots * Fix build sync spec (#7086) * Fail docs on warnings (#5923) * change (ci): docs job optimized; runs every commit; fails on warnings * change (ci): rename jobs; temporary allow failing * change (ci): better warnings filtering * fix (ci): hotfix Docker release * test (ci): run docs job with flags * test (ci): pwd fails * change (ci): pass just //doc dir as an artifact; debug * change (ci): return to the previous structure; undebug * change (ci): typo * rebase on upstream 2 * fix the jobname * Fix some warnings (#7079) * Partial fix for transaction priority (#7034) * Partial fix for priority stuff. * Small fix * Fix tests. * Update frame/transaction-payment/src/lib.rs Co-authored-by: Tomasz Drwięga * Better doc Co-authored-by: Tomasz Drwięga * What happens if we remove wat? (#7056) * What happens if we remove wat? * Update Cargo.lock * Make SlashingSpans Public (#6961) * Make SlashingSpans Public Offchain Applications will often need to inspect this type because it is directly used in staking election, thus worthy of being `pub`. Rest of the slashing api can remain private, only this and the `fn last_non_zero_slash()` of `SlashingSpans` are of interest. * Update frame/staking/src/lib.rs * client/authority-discovery/src/service: Improve docs (#7059) * Decrease poll interval (#7063) * Remove unused code (#7027) Signed-off-by: Jimmy Chu * Disambiguate `BlockNumber` type in `decl_module` (#7061) * Disambiguate `BlockNumber` type in `decl_module` * fix `frame-support-tests` * fix ui tests * fix trait order * Implement `FromStr` for `Ss58AddressFormat` (#7068) * Implement `FromStr` for `Ss58AddressFormat` * Update primitives/core/src/crypto.rs Co-authored-by: Shawn Tabrizi Co-authored-by: Shawn Tabrizi * Set reserved nodes with offchain worker. (#6996) * add offchain worker api to set reserved nodes. * new offchain api to get node public key. * node public key from converter * refactor set reserved nodes ocw api. * new ndoe authorization pallet * remove unnecessary clone and more. * more * tests for node authorization pallet * remove dependency * fix build * more tests. * refactor * Update primitives/core/src/offchain/testing.rs Co-authored-by: Tomasz Drwięga * Update frame/node-authorization/src/lib.rs Co-authored-by: Tomasz Drwięga * Update frame/node-authorization/src/lib.rs Co-authored-by: Tomasz Drwięga * Update frame/node-authorization/src/lib.rs Co-authored-by: Tomasz Drwięga * format code * expose NetworkService * remove NetworkStateInfo in offchain * replace NodePublicKey with PeerId. * set max length of peer id. * clear more * use BTreeSet for set of peers. * decode opaque peer id. * extract NetworkProvider for client offchain. * use OpaquePeerId in node authorization pallet. * fix test * better documentation * fix test * doc * more fix * Update primitives/core/src/offchain/mod.rs Co-authored-by: Pierre Krieger * Update client/offchain/src/api.rs Co-authored-by: Pierre Krieger * derive serialize and deserialize Co-authored-by: Tomasz Drwięga Co-authored-by: Pierre Krieger * Fix some warnings Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> Co-authored-by: Tomasz Drwięga Co-authored-by: Sergei Shulepov Co-authored-by: Max Inden Co-authored-by: s3krit Co-authored-by: Jimmy Chu Co-authored-by: Shawn Tabrizi Co-authored-by: Bastian Köcher Co-authored-by: kaichao Co-authored-by: Pierre Krieger * Fix more doc errors * More doc fixes * Remove subdb to make `rustdoc` happy * Make the line length check happy * Fix compilation error * Another try * Allow unused Co-authored-by: Dan Forbes Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> Co-authored-by: Tomasz Drwięga Co-authored-by: Sergei Shulepov Co-authored-by: Max Inden Co-authored-by: s3krit Co-authored-by: Jimmy Chu Co-authored-by: Shawn Tabrizi Co-authored-by: Bastian Köcher Co-authored-by: kaichao Co-authored-by: Pierre Krieger Co-authored-by: Bastian Köcher * Fix `storage::read` (#7084) * Fix `storage::read` It should return the length of the storage item after the given offset. Before it returned always the length of the full storage item. * Fix tests * Add fuzzer for the compact custom codec implementation from PR #6720 (#7091) * Add fuzzer for the compact custom codec implementation introduced in PR #6720. This commit adds a fuzzing harness for the custom compact encoding/decoding introduced in PR #6720. * Update primitives/npos-elections/fuzzer/src/compact.rs Co-authored-by: Bastian Köcher * Update Cargo.lock: Add changes in elections-fuzzer * Change indentation from spaces to tabs Co-authored-by: Vincent Ulitzsch Co-authored-by: Bastian Köcher * add instantiable support for treasury pallet (#7058) * add instantiable support for treasury pallet * update treasury pallet benchmarking code to support multi-instance * use benchmark_intance! macro; fix hard coded treasury identity string; fix over characters line width limitation error * fix line return style * grandpa-rpc don't share subscription manager, only executor (#7039) * service builder: fix todo about jsonrpc Option workaround * grandpa-rpc: only share executor instead of sub manager * grandpa-rpc: fix compilation * grandpa-rpc: rename to subscription_executor * node/cli: remove another unused jsonrpc dependency * grandpa: apply style fixes from code review Co-authored-by: André Silva <123550+andresilva@users.noreply.github.com> * pallet-collective: allow customized default vote (#6984) * collective: add DefaultVote trait * Fix test and node compile * Expose the whole prime_vote * Add test for MoreThanMajorityThenPrimeDefaultVote * Docs fix * Upgrade to libp2p-0.28. (#7077) * Upgrade to libp2p-0.28 * Clean up test imports. * CI * CI * CI? * CI once more. * One more. * CI * CI * CI * pow: support uniform tie breaking in fork choice (#7073) * pow: support uniform tie breaking in fork choice * Update client/consensus/pow/src/lib.rs Co-authored-by: Bastian Köcher * Refactor fetch seal Co-authored-by: Bastian Köcher * Allow remotes to not open a legacy substream (#7075) * Allow remotes to not open a legacy substream * Misc fixes * Special case first protocol as the one bearing the handshake * Use diener for Polkadot companion prs (#7102) * Use diener for Polkadot companion prs * Fix script * Use gitlab env variable * Update .maintain/gitlab/check_polkadot_companion_build.sh Co-authored-by: André Silva <123550+andresilva@users.noreply.github.com> Co-authored-by: André Silva <123550+andresilva@users.noreply.github.com> * Update ui tests for rust 1.46.0 (#7106) * client/network: Expose number of entries per Kademlia bucket (#7104) Extend `sub_libp2p_kbuckets_num_nodes` Prometheus metric to expose the number of nodes per bucket per Kademlia instance instead of only per Kademlia instance. * Improve error output of wasm-builder when wasm ins't installed (#7105) This improves the error message of wasm-builder when the wasm toolchain isn't installed. Currently we print that the wasm toolchain is not installed, but the actual problem is that there is a bug in the packaging in rust. This will now be much easier to debug, by printing the full error message of the compiler. * Add ss58 address for Dark network (#6982) Hello, This PR adds a new ss58 address 17 for Dark network. Thanks! * Frame-support storage: make iterations and translate consistent (#5470) * implementation and factorisation * factorize test * doc * fix bug and improve test * address suggestions * fix js dependancy alert, bumping bl version (#7110) * fix js dependancy alert, bumping bl version * fix low severity modules * Make `transactional` attribute less scope dependent (#7112) * Make `transactional` attribute less scope dependent The old implementation expected that `frame-support` wasn't imported under a different name. Besides that the pr removes some whitespaces. * Update frame/support/procedural/src/lib.rs Co-authored-by: Guillaume Thiolliere * Add SS58 Registry (#7020) * add SS58 registry * formatting * description -> displayName * Update ss58-registry.json Co-authored-by: Jaco Greeff * make numbers literal, tokens can have different denominations * add dock * add dark * add websites and tokens * add KLP decimals * add acala and laminar info Co-authored-by: Jaco Greeff * Move Staking Weights to T::WeightInfo (#7007) * Fix the benchmarks * Migrate staking to weightInfo * Fix global benchmarks * re-calculate the submit solution weight. * Fix some refund. * Get rid of all the extra parameters. * Fix staking tests. * new values from the bench machine. * Fix some grumbles * better macro * Some better doc * Move to interpreted wasm * Make it work temporarily * Final fix of default ones. * Fix payout benchmarks * Fix payout stuff * One last fix * use benchmarking machine for numbers * update weight docs Co-authored-by: Shawn Tabrizi * Send import notification always for re-orgs (#7118) * Send import notification always for re-orgs This pr changes the behavior of sending import notifications. Before we only send notifications when importing blocks on the tip of the chain or on similar conditions. However we did not send a notification when we for example being in a state where we import multiple blocks to catch up. If we re-org in this process, systems like the transaction pool would not be notified about this re-org. This means, that we would also not resubmit transactions of these retracted blocks. This pr fixes this, by always sending a notification on a re-org. See https://github.com/substrate-developer-hub/substrate-node-template/issues/82 for some context about the bug. * Update client/service/src/client/client.rs Co-authored-by: André Silva <123550+andresilva@users.noreply.github.com> Co-authored-by: André Silva <123550+andresilva@users.noreply.github.com> * WeightInfo for Vesting Pallet (#7103) * WeightInfo for Vesting Pallet * clean up weight docs * Update lib.rs * try to pipe max locks * Update for new type * add warning when locks > MaxLocks * Update lib.rs * fix compile * remove aliasing, fix trait def * Update * Add benchmarking pipeline to node-template (#7122) * Use tracing-based subscriber logging (#6825) * init_logger: switch from log-based to tracing-based and add compatibility layer * Move tracing profiling subscriber related config realization * sp-tracing: change profiling to be a layer instead of a subscriber * Enable profiling layer in cli * Change all test env_logger init to sp_tracing::try_init_simple * Remove all local env_logger dependency * Add missing tracing-subscriber dependency * frame-sudo: fix tests * frame-support: fix tests * Fix frame/pallet and executor tests * Fix the remaining tests * Use subscriber's try_init as recommended by @davidbarsky * Be explict that the tracing-log feature is needed * Set subscriber writer to stderr * Shorter line width * Update cargo lock tracing version * Fix sc_tracing crate compile * Fix sc_authority_discovery crate test * unremove default-features * Leave enabled to default true * Warn if global default cannot be set * Fix unused import * Remove unused PROXY_TARGET * Change all reference from rc5 to rc6 * Change all reference of rc2 to rc6 * Fix styling * Fix typo * make logger init error'ing * re-fixing the test issue Co-authored-by: Benjamin Kampmann * Typo in error text (#7126) * WeightInfo for ImOnline (#7128) * Add WeightInfo, not final weights * benchmark machine weights * fix the new staking weight in substrate-node (#7131) * Remove warning about deprecated PeerIds (#7132) * Fix db initialization for light client (#7130) * Fix db initialization for light client * Fix cache distribution * WeightInfo for Identity Pallet (#7107) * update benchmarks * add automated weights * Update benchmarking.rs * use underscores for file out * update some weights * more weights * finish weights * add basic verification to benchmarks * patch benchmarks * Update benchmarking.rs * final weights * update for new type * add weightinfo to node * Make sure we update the `Cargo.lock` in the polkadot companion (#7135) * Tracing for wasm with bridging to native (#6916) * implement events handling, implement parent_id for spans & events * add events to sp_io::storage * update test * add tests * adjust limit * let tracing crate handle parent_ids * re-enable current-id tracking * add test for threads with CurrentSpan * fix log level * remove redundant check for non wasm traces * remove duplicate definition in test * Adding conditional events API * prefer explicit parent_id over current, enhance test * limit changes to client::tracing event implementation * remove From impl due to fallback required on parent_id * make tracing codecable * replace with global tracing * new tracing interface * impl TracingSubscriber in client * implement access to global TracingSubscriber from primitives * span for wasm * increment towards Wasm Tracing Subscriber implementation * increment, remove sp-tracing from runtime-interface * increment, it compiles * attained original functionality with new mechanism * implement remaining TracingSubscriber functions * remove spans from decl_module * add handling for encoded values * Revert "replace with global tracing" This reverts commit 8824a60deea54d9b437407a21c8ceaf6a1902ee5. * Wasm Side Tracing * tracing on wasm * enable tracing wasm on node-runtime * export all the macros in std * tracing subscriber on wasm-side only * pass spans and events over and record them * reactivate previous code and cleanup * further cleaning up * extend the span macros, activate through executive * tracking the actual extrinsic, too * style * fixing tests * spaces -> tabs * attempting to reactivate params * activate our tests in CI * some passing * tests passing * with core lazy * global tracer for wasm side with pass over * fixing metadata referencing * remove const_fn feature requirement * reenable dispatch traces * reset client tracing * further cleaning up * fixing runtime-test * move tracing-build setup into runtime-test * Merge DebugWriter from tracing and frame-support, move to sp-std * remove dangling fixme * Docs for tracing primitives * cleaning up a bit more * Wasm interface docs * optimise docs.rs setup * adding tracing flags to uncomment * remove brace * fixing imports * fixing broken syntax * add required modules * nicer formatting * better target management * adding low level storage tracing events into frame * add custom Debug impl for WasmMetadata * cloning profiler * adding info about cloning profiler * using in-scope for within calls * proper time tracing, cleaning up println * allow to disable tracing on runtime_interface-macro * disable tracing for wasm-tracing-interface * simplify wasm-tracing-api * update client to new interface * fixing docs and tests for sp-tracing * update integration tests * re-activating enter_span * dropping FIXME, it's documented * fix formatting * fix formatting * fix imports * more debug info * inform wasm about it being disabled by returning 1 * only one tracer, but enabled multi-all support * make trait pub again for tests * Apply suggestions from code review Co-authored-by: Niklas Adolfsson * fixing wasm doc tests for proper usage * remove unnecessary import * fixing formatting * minor style fixes * downgrading wabt * update error message for UI * Fix interface test * next attempt to fix macros * geee * revert tracing on hashed for future PR * remove local macros, use originals * we are able to convert to static items * implement more WasmValue types * adding support to convert str, debug and encoded values * more minor fixes * revert unsafe 'static making * fix indentation * remove commented lines * bump all them tracing versions * cleaning up docs and info * document new flag * the new layered system handles span cloning better * Apply suggestions from code review Co-authored-by: David Co-authored-by: Matt Rutherford Co-authored-by: Niklas Adolfsson Co-authored-by: David * Pallet Indices (#7137) * pow: replace the thread-base mining loop with a future-based mining worker (#7060) * New worker design * Remove unused thread import * Add back missing inherent data provider registration * Add function to get a Cloned metadata * Add some docs * Derive Eq and PartialEq for MiningMetadata * Fix cargo lock * Fix line width * Add docs and fix issues in UntilImportedOrTimeout * Update client/consensus/pow/src/lib.rs Co-authored-by: David * Add back comments Co-authored-by: Bastian Köcher Co-authored-by: David * Bounties (#5715) * add some compact annotation * implement bounties for treasury * fix test build * remove some duplicated code * fix build * add tests * fix build * fix tests * rename * merge deposit byte fee * add comments * refactor storage * support sub bounty * emit BountyBecameActive when sub bounty is created * able to contribute bounty * allow curator to cancel bounty * remove bounty contribution * implement bounty expiry * Able to extend bounty * fix build and update tests * create sub bounty test * add more tests * add benchmarks for bounties * fix build * line width * fix benchmarking test * update trait * fix typo * Update lib.rs Missing documentation on Bounties added on this change. Please check the definitions of `propose_bounty` and `create_bounty`. * update docs * add MaximumSubBountyDepth * put BountyValueMinimum into storage * rework bount depth * split on_initialize benchmarks * remove components from constant functions * Update weight integration into treasury * Update reject proposal read/writes * fix weight calculation * Ignore weights with 0 factor * Remove 0 multipliers * add some docs * allow unused for generated code * line width * allow RejectOrigin to cancel a pending payout bounty * require BountyValueMinimum > ED * make BountyValueMinimum configurable by chain spec * remove sub-bounty features * update curator * accept curator * unassign and cancel * fix tests * new tests * Update lib.rs - Include on `Assign_curator`, `accept_curator` and `unassign_curator` on Bounties Protocol Section - Include curator fee and curator deposit definitions on Terminology - Update intro. * fix test * update extend_bounty_expiry * fix benchmarking * add new benchmarking code * add docs * fix tests * Update benchmarking.rs * Make BountyValueMinimum a trait config instead of stroage value * fix runtime build * Update weights * Update default_weights.rs * update weights * update * update comments * unreserve curator fee * update tests * update benchmarks * fix curator deposit handling * trigger CI * fix benchmarking * use append instead of mutate push * additional noop tests * improve fee hanlding. update event docs * RejectOrigin to unassign * update bounty cancel logic * use Zero::zero() over 0.into() * fix tests * fix benchmarks * proposed fixes to bounties * fix tests * fix benchmarks * update weightinfo * use closure * fix compile * update weights Co-authored-by: RRTTI Co-authored-by: Shawn Tabrizi * Update SS58 configuration for Bifrost (#7142) * Add 6 as address type of ss58 for Bifrost Network * Update SS58 configuration for Bifrost * Prometheus metrics for RPC calls (#7088) * WS and HTTP middlewares added * Prometheus endpoint added * Counters renamed * Proper style for inc * Metrics initialization re-written * Rework to handler middleware * Introduce transport prefix for metrics * String shortened * Commented code removed, new line inserted * One more string shortened * Wasm build fixed * Wasm build fixed once again * Rework to shared metrics * Added collectors label * Tilde removed from cargo * Switch to owned metrics in parameters * WeightInfo for Scheduler (#7138) * initial scheduler stuff * integrate weightinfo * Update pallet_scheduler.rs * grandpa-rpc: use FinalityProofProvider to check finality for rpc (#6215) * grandpa-rpc: use FinalityProofProvider to check finality for rpc * grandpa-rpc: minor tidy * grandpa-rpc: remove dyn FinalityProofProvider * grandpa-rpc: remove unused dependencies * node: move finality_proof_provider setup * grandpa-rpc: print error reported by finality_proof_provider * grandpa-rpc: add note about unnecessary encode/decode * grandpa-rpc: dont encode/decode and use correct hash * grandpa-rpc: set_id is optional * grandpa-rpc: create test for prove_finality * grandpa-rpc: set visibility back to how it was * grandpa-rpc: remove unused dependency * grandpa-rpc: minor tidy * grandpa: doc strings * grandpa-rpc: rename to prove_finality * grandpa-rpc: use current set id if none is provided * grandpa-rpc: remove unnecessary check in test * node: group finality_proof_provider in rpc_setup * grandpa: make prove_finality concrete in FinalityProofProvider * grandpa-rpc: wrap finality output in struct and store as Bytes * grandpa-rpc: exhaustive error codes and wrap * grandpa-rpc: let prove_finality take a range instead of a starting point * grandpa-rpc: fix test for changed API * grandpa-rpc: fix line length * grandpa: fix reviewer nits * node/rpc: fix reviewer comments * Make it compile * Rework the implementation and decrease the peer reputation on invalid block announcement * Implement limits for block announce validation * Remove accidentally added file * Apply suggestions from code review Co-authored-by: Max Inden * Rename `BlockAnnounceResult` to `PollBlockAnnounceValidation` * Always return result using the internal future * Move the polling and make sure all validation futures are registered * Ignore the future in the legacy stuff * Remove leftover stuff * Update client/network/src/protocol/sync.rs Co-authored-by: Pierre Krieger Co-authored-by: Max Inden Co-authored-by: Xiliang Chen Co-authored-by: Ashley Co-authored-by: Shawn Tabrizi Co-authored-by: André Silva <123550+andresilva@users.noreply.github.com> Co-authored-by: Guillaume Thiolliere Co-authored-by: Swezey Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> Co-authored-by: Gavin Wood Co-authored-by: Alexander Popiak Co-authored-by: Andronik Ordian Co-authored-by: cheme Co-authored-by: Gerben van de Wiel Co-authored-by: gabriel klawitter Co-authored-by: Seun Lanlege Co-authored-by: Roman Borschel Co-authored-by: Joshy Orndorff Co-authored-by: Dan Forbes Co-authored-by: Benjamin Kampmann Co-authored-by: joshua-mir Co-authored-by: Nikita Puzankov Co-authored-by: Alan Sapede Co-authored-by: Sergei Shulepov Co-authored-by: Lovesh Harchandani Co-authored-by: Tomasz Drwięga Co-authored-by: s3krit Co-authored-by: Jimmy Chu Co-authored-by: kaichao Co-authored-by: Denis Pisarev Co-authored-by: Vincent Ulitzsch Co-authored-by: Vincent Ulitzsch Co-authored-by: Kerwin Zhu Co-authored-by: Jon Häggblad Co-authored-by: Wei Tang Co-authored-by: DarkPay <42247799+DarkPayCoin@users.noreply.github.com> Co-authored-by: HarryHong Co-authored-by: joe petrowski <25483142+joepetrowski@users.noreply.github.com> Co-authored-by: Jaco Greeff Co-authored-by: Benjamin Kampmann Co-authored-by: Bruno Škvorc Co-authored-by: Arkadiy Paronyan Co-authored-by: Matt Rutherford Co-authored-by: Niklas Adolfsson Co-authored-by: David Co-authored-by: RRTTI Co-authored-by: Jianping Deng Co-authored-by: Anton Gavrilov --- client/network/src/protocol.rs | 111 ++++-- client/network/src/protocol/sync.rs | 318 +++++++++++++++--- client/network/test/src/sync.rs | 51 ++- .../consensus/common/src/block_validation.rs | 22 +- 4 files changed, 422 insertions(+), 80 deletions(-) diff --git a/client/network/src/protocol.rs b/client/network/src/protocol.rs index 630471414b223..70621d8f0392e 100644 --- a/client/network/src/protocol.rs +++ b/client/network/src/protocol.rs @@ -135,6 +135,8 @@ mod rep { pub const BAD_ROLE: Rep = Rep::new_fatal("Unsupported role"); /// Peer response data does not have requested bits. pub const BAD_RESPONSE: Rep = Rep::new(-(1 << 12), "Incomplete response"); + /// Peer send us a block announcement that failed at validation. + pub const BAD_BLOCK_ANNOUNCEMENT: Rep = Rep::new(-(1 << 12), "Bad block announcement"); } struct Metrics { @@ -564,7 +566,9 @@ impl Protocol { pub fn update_chain(&mut self) { let info = self.context_data.chain.info(); self.sync.update_chain_info(&info.best_hash, info.best_number); - self.behaviour.set_legacy_handshake_message(build_status_message(&self.config, &self.context_data.chain)); + self.behaviour.set_legacy_handshake_message( + build_status_message(&self.config, &self.context_data.chain), + ); self.behaviour.set_notif_protocol_handshake( &self.block_announces_protocol, BlockAnnouncesHandshake::build(&self.config, &self.context_data.chain).encode() @@ -590,16 +594,21 @@ impl Protocol { self.context_data.peers.iter().map(|(id, peer)| (id, &peer.info)) } - pub fn on_custom_message( + fn on_custom_message( &mut self, who: PeerId, data: BytesMut, ) -> CustomMessageOutcome { - let message = match as Decode>::decode(&mut &data[..]) { Ok(message) => message, Err(err) => { - debug!(target: "sync", "Couldn't decode packet sent by {}: {:?}: {}", who, data, err.what()); + debug!( + target: "sync", + "Couldn't decode packet sent by {}: {:?}: {}", + who, + data, + err.what(), + ); self.peerset_handle.report_peer(who, rep::BAD_MESSAGE); return CustomMessageOutcome::None; } @@ -612,7 +621,7 @@ impl Protocol { match message { GenericMessage::Status(_) => debug!(target: "sub-libp2p", "Received unexpected Status"), - GenericMessage::BlockRequest(r) => self.on_block_request(who, r), +/* GenericMessage::BlockRequest(r) => self.on_block_request(who, r), GenericMessage::BlockResponse(r) => { let outcome = self.on_block_response(who.clone(), r); self.update_peer_info(&who); @@ -622,7 +631,9 @@ impl Protocol { let outcome = self.on_block_announce(who.clone(), announce); self.update_peer_info(&who); return outcome; - }, + },*/ + GenericMessage::BlockAnnounce(announce) => + self.push_block_announce_validation(who.clone(), announce), GenericMessage::Transactions(m) => self.on_transactions(who, m), GenericMessage::RemoteCallRequest(request) => self.on_remote_call_request(who, request), @@ -1305,42 +1316,73 @@ impl Protocol { } } - fn on_block_announce( + /// Push a block announce validation. + /// + /// It is required that [`ChainSync::poll_block_announce_validation`] is + /// called later to check for finished validations. The result of the validation + /// needs to be passed to [`Protocol::process_block_announce_validation_result`] + /// to finish the processing. + /// + /// # Note + /// + /// This will internally create a future, but this future will not be registered + /// in the task before being polled once. So, it is required to call + /// [`ChainSync::poll_block_announce_validation`] to ensure that the future is + /// registered properly and will wake up the task when being ready. + fn push_block_announce_validation( &mut self, who: PeerId, announce: BlockAnnounce, - ) -> CustomMessageOutcome { + ) { let hash = announce.header.hash(); - let number = *announce.header.number(); if let Some(ref mut peer) = self.context_data.peers.get_mut(&who) { peer.known_blocks.insert(hash.clone()); } - let is_their_best = match announce.state.unwrap_or(message::BlockState::Best) { + let is_best = match announce.state.unwrap_or(message::BlockState::Best) { message::BlockState::Best => true, message::BlockState::Normal => false, }; - match self.sync.on_block_announce(&who, hash, &announce, is_their_best) { - sync::OnBlockAnnounce::Nothing => { + self.sync.push_block_announce_validation(who, hash, announce, is_best); + } + + /// Process the result of the block announce validation. + fn process_block_announce_validation_result( + &mut self, + validation_result: sync::PollBlockAnnounceValidation, + ) -> CustomMessageOutcome { + let (header, is_best, who) = match validation_result { + sync::PollBlockAnnounceValidation::Nothing { is_best, who, header } => { + self.update_peer_info(&who); + // `on_block_announce` returns `OnBlockAnnounce::ImportHeader` // when we have all data required to import the block // in the BlockAnnounce message. This is only when: // 1) we're on light client; // AND // 2) parent block is already imported and not pruned. - if is_their_best { - return CustomMessageOutcome::PeerNewBest(who, number); + if is_best { + return CustomMessageOutcome::PeerNewBest(who, *header.number()) } else { - return CustomMessageOutcome::None; + return CustomMessageOutcome::None } } - sync::OnBlockAnnounce::ImportHeader => () // We proceed with the import. - } + sync::PollBlockAnnounceValidation::ImportHeader { header, is_best, who } => { + self.update_peer_info(&who); + (header, is_best, who) + } + sync::PollBlockAnnounceValidation::Failure { who } => { + self.report_peer(who, rep::BAD_BLOCK_ANNOUNCEMENT); + return CustomMessageOutcome::None + } + }; + + let number = *header.number(); - // to import header from announced block let's construct response to request that normally would have - // been sent over network (but it is not in our case) + // to import header from announced block let's construct response to request that normally + // would have been sent over network (but it is not in our case) let blocks_to_import = self.sync.on_block_data( &who, None, @@ -1348,8 +1390,8 @@ impl Protocol { id: 0, blocks: vec![ message::generic::BlockData { - hash: hash, - header: Some(announce.header), + hash: header.hash(), + header: Some(header), body: None, receipt: None, message_queue: None, @@ -1359,8 +1401,10 @@ impl Protocol { }, ); - if is_their_best { - self.pending_messages.push_back(CustomMessageOutcome::PeerNewBest(who, number)); + if is_best { + self.pending_messages.push_back( + CustomMessageOutcome::PeerNewBest(who, number), + ); } match blocks_to_import { @@ -2012,6 +2056,15 @@ impl NetworkBehaviour for Protocol { warn!(target: "sub-libp2p", "Inconsistent state, no peers for pending transaction!"); } } + + // Check if there is any block announcement validation finished. + while let Poll::Ready(result) = self.sync.poll_block_announce_validation(cx) { + match self.process_block_announce_validation_result(result) { + CustomMessageOutcome::None => {}, + outcome => self.pending_messages.push_back(outcome), + } + } + if let Some(message) = self.pending_messages.pop_front() { return Poll::Ready(NetworkBehaviourAction::GenerateEvent(message)); } @@ -2087,9 +2140,15 @@ impl NetworkBehaviour for Protocol { } Some(Fallback::BlockAnnounce) => { if let Ok(announce) = message::BlockAnnounce::decode(&mut message.as_ref()) { - let outcome = self.on_block_announce(peer_id.clone(), announce); - self.update_peer_info(&peer_id); - outcome + self.push_block_announce_validation(peer_id, announce); + + // Make sure that the newly added block announce validation future was + // polled once to be registered in the task. + if let Poll::Ready(res) = self.sync.poll_block_announce_validation(cx) { + self.process_block_announce_validation_result(res) + } else { + CustomMessageOutcome::None + } } else { warn!(target: "sub-libp2p", "Failed to decode block announce"); CustomMessageOutcome::None diff --git a/client/network/src/protocol/sync.rs b/client/network/src/protocol/sync.rs index bfd8c4fe218de..9866dc0568a8e 100644 --- a/client/network/src/protocol/sync.rs +++ b/client/network/src/protocol/sync.rs @@ -49,7 +49,11 @@ use sp_runtime::{ traits::{Block as BlockT, Header, NumberFor, Zero, One, CheckedSub, SaturatedConversion, Hash, HashFor} }; use sp_arithmetic::traits::Saturating; -use std::{fmt, ops::Range, collections::{HashMap, HashSet, VecDeque}, sync::Arc}; +use std::{ + fmt, ops::Range, collections::{HashMap, hash_map::Entry, HashSet, VecDeque}, + sync::Arc, pin::Pin, +}; +use futures::{task::Poll, Future, stream::FuturesUnordered, FutureExt, StreamExt}; mod blocks; mod extra_requests; @@ -63,6 +67,17 @@ const MAX_IMPORTING_BLOCKS: usize = 2048; /// Maximum blocks to download ahead of any gap. const MAX_DOWNLOAD_AHEAD: u32 = 2048; +/// Maximum number of concurrent block announce validations. +/// +/// If the queue reaches the maximum, we drop any new block +/// announcements. +const MAX_CONCURRENT_BLOCK_ANNOUNCE_VALIDATIONS: usize = 256; + +/// Maximum number of concurrent block announce validations per peer. +/// +/// See [`MAX_CONCURRENT_BLOCK_ANNOUNCE_VALIDATIONS`] for more information. +const MAX_CONCURRENT_BLOCK_ANNOUNCE_VALIDATIONS_PER_PEER: usize = 4; + /// We use a heuristic that with a high likelihood, by the time /// `MAJOR_SYNC_BLOCKS` have been imported we'll be on the same /// chain as (or at least closer to) the peer so we want to delay @@ -192,6 +207,12 @@ pub struct ChainSync { max_parallel_downloads: u32, /// Total number of downloaded blocks. downloaded_blocks: usize, + /// All block announcement that are currently being validated. + block_announce_validation: FuturesUnordered< + Pin> + Send>> + >, + /// Stats per peer about the number of concurrent block announce validations. + block_announce_validation_per_peer_stats: HashMap, } /// All the data we have about a Peer that we are trying to sync with @@ -306,13 +327,65 @@ pub enum OnBlockData { Request(PeerId, BlockRequest) } -/// Result of [`ChainSync::on_block_announce`]. +/// Result of [`ChainSync::poll_block_announce_validation`]. #[derive(Debug, Clone, PartialEq, Eq)] -pub enum OnBlockAnnounce { +pub enum PollBlockAnnounceValidation { + /// The announcement failed at validation. + /// + /// The peer reputation should be decreased. + Failure { + /// Who sent the processed block announcement? + who: PeerId, + }, /// The announcement does not require further handling. - Nothing, + Nothing { + /// Who sent the processed block announcement? + who: PeerId, + /// Was this their new best block? + is_best: bool, + /// The header of the announcement. + header: H, + }, /// The announcement header should be imported. - ImportHeader, + ImportHeader { + /// Who sent the processed block announcement? + who: PeerId, + /// Was this their new best block? + is_best: bool, + /// The header of the announcement. + header: H, + }, +} + +/// Result of [`ChainSync::block_announce_validation`]. +#[derive(Debug, Clone, PartialEq, Eq)] +enum PreValidateBlockAnnounce { + /// The announcement failed at validation. + /// + /// The peer reputation should be decreased. + Failure { + /// Who sent the processed block announcement? + who: PeerId, + }, + /// The announcement does not require further handling. + Nothing { + /// Who sent the processed block announcement? + who: PeerId, + /// Was this their new best block? + is_best: bool, + /// The announcement. + announce: BlockAnnounce, + }, + /// The pre-validation was sucessful and the announcement should be + /// further processed. + Process { + /// Is this the new best block of the peer? + is_new_best: bool, + /// The id of the peer that send us the announcement. + who: PeerId, + /// The announcement. + announce: BlockAnnounce, + }, } /// Result of [`ChainSync::on_block_justification`]. @@ -343,6 +416,16 @@ pub enum OnBlockFinalityProof { } } +/// Result of [`ChainSync::has_slot_for_block_announce_validation`]. +enum HasSlotForBlockAnnounceValidation { + /// Yes, there is a slot for the block announce validation. + Yes, + /// We reached the total maximum number of validation slots. + TotalMaximumSlotsReached, + /// We reached the maximum number of validation slots for the given peer. + MaximumPeerSlotsReached, +} + impl ChainSync { /// Create a new instance. pub fn new( @@ -377,6 +460,8 @@ impl ChainSync { block_announce_validator, max_parallel_downloads, downloaded_blocks: 0, + block_announce_validation: Default::default(), + block_announce_validation_per_peer_stats: Default::default(), } } @@ -1156,60 +1241,215 @@ impl ChainSync { self.pending_requests.set_all(); } - /// Call when a node announces a new block. + /// Checks if there is a slot for a block announce validation. /// - /// If `OnBlockAnnounce::ImportHeader` is returned, then the caller MUST try to import passed - /// header (call `on_block_data`). The network request isn't sent - /// in this case. Both hash and header is passed as an optimization - /// to avoid rehashing the header. - pub fn on_block_announce(&mut self, who: &PeerId, hash: B::Hash, announce: &BlockAnnounce, is_best: bool) - -> OnBlockAnnounce - { + /// The total number and the number per peer of concurrent block announce validations + /// is capped. + /// + /// Returns [`HasSlotForBlockAnnounceValidation`] to inform about the result. + fn has_slot_for_block_announce_validation(&mut self, peer: &PeerId) -> HasSlotForBlockAnnounceValidation { + if self.block_announce_validation.len() >= MAX_CONCURRENT_BLOCK_ANNOUNCE_VALIDATIONS { + return HasSlotForBlockAnnounceValidation::TotalMaximumSlotsReached + } + + match self.block_announce_validation_per_peer_stats.entry(peer.clone()) { + Entry::Vacant(entry) => { + entry.insert(1); + HasSlotForBlockAnnounceValidation::Yes + }, + Entry::Occupied(mut entry) => { + if *entry.get() < MAX_CONCURRENT_BLOCK_ANNOUNCE_VALIDATIONS_PER_PEER { + *entry.get_mut() += 1; + HasSlotForBlockAnnounceValidation::Yes + } else { + HasSlotForBlockAnnounceValidation::MaximumPeerSlotsReached + } + }, + } + } + + /// Push a block announce validation. + /// + /// It is required that [`ChainSync::poll_block_announce_validation`] is called + /// to check for finished block announce validations. + pub fn push_block_announce_validation( + &mut self, + who: PeerId, + hash: B::Hash, + announce: BlockAnnounce, + is_best: bool, + ) { let header = &announce.header; let number = *header.number(); - debug!(target: "sync", "Received block announcement {:?} with number {:?} from {}", hash, number, who); + debug!( + target: "sync", + "Pre-validating received block announcement {:?} with number {:?} from {}", + hash, + number, + who, + ); + if number.is_zero() { - warn!(target: "sync", "💔 Ignored genesis block (#0) announcement from {}: {}", who, hash); - return OnBlockAnnounce::Nothing + self.block_announce_validation.push(async move { + warn!( + target: "sync", + "💔 Ignored genesis block (#0) announcement from {}: {}", + who, + hash, + ); + PreValidateBlockAnnounce::Nothing { is_best, who, announce } + }.boxed()); + return + } + + // Check if there is a slot for this block announce validation. + match self.has_slot_for_block_announce_validation(&who) { + HasSlotForBlockAnnounceValidation::Yes => {}, + HasSlotForBlockAnnounceValidation::TotalMaximumSlotsReached => { + self.block_announce_validation.push(async move { + warn!( + target: "sync", + "💔 Ignored block (#{} -- {}) announcement from {} because all validation slots are occupied.", + number, + hash, + who, + ); + PreValidateBlockAnnounce::Nothing { is_best, who, announce } + }.boxed()); + return + } + HasSlotForBlockAnnounceValidation::MaximumPeerSlotsReached => { + self.block_announce_validation.push(async move { + warn!( + target: "sync", + "💔 Ignored block (#{} -- {}) announcement from {} because all validation slots for this peer are occupied.", + number, + hash, + who, + ); + PreValidateBlockAnnounce::Nothing { is_best, who, announce } + }.boxed()); + return + } } - let parent_status = self.block_status(header.parent_hash()).ok().unwrap_or(BlockStatus::Unknown); + + // Let external validator check the block announcement. + let assoc_data = announce.data.as_ref().map_or(&[][..], |v| v.as_slice()); + let future = self.block_announce_validator.validate(&header, assoc_data); + let hash = hash.clone(); + + self.block_announce_validation.push(async move { + match future.await { + Ok(Validation::Success { is_new_best }) => PreValidateBlockAnnounce::Process { + is_new_best: is_new_best || is_best, + announce, + who, + }, + Ok(Validation::Failure) => { + debug!( + target: "sync", + "Block announcement validation of block {} from {} failed", + hash, + who, + ); + PreValidateBlockAnnounce::Failure { who } + } + Err(e) => { + error!(target: "sync", "💔 Block announcement validation errored: {}", e); + PreValidateBlockAnnounce::Nothing { is_best, who, announce } + } + } + }.boxed()); + } + + /// Poll block announce validation. + /// + /// Block announce validations can be pushed by using + /// [`ChainSync::push_block_announce_validation`]. + /// + /// This should be polled until it returns [`Poll::Pending`]. + /// + /// If [`PollBlockAnnounceValidation::ImportHeader`] is returned, then the caller MUST try to import passed + /// header (call `on_block_data`). The network request isn't sent in this case. + pub fn poll_block_announce_validation( + &mut self, + cx: &mut std::task::Context, + ) -> Poll> { + match self.block_announce_validation.poll_next_unpin(cx) { + Poll::Ready(Some(res)) => Poll::Ready(self.finish_block_announce_validation(res)), + _ => Poll::Pending, + } + } + + /// Should be called when a block announce validation was finished, to update the stats + /// of the given peer. + fn peer_block_announce_validation_finished(&mut self, peer: &PeerId) { + match self.block_announce_validation_per_peer_stats.entry(peer.clone()) { + Entry::Vacant(_) => { + error!( + target: "sync", + "💔 Block announcement validation from peer {} finished for that no slot was allocated!", + peer, + ); + }, + Entry::Occupied(mut entry) => { + if entry.get_mut().saturating_sub(1) == 0 { + entry.remove(); + } + } + } + } + + /// This will finish processing of the block announcement. + fn finish_block_announce_validation( + &mut self, + pre_validation_result: PreValidateBlockAnnounce, + ) -> PollBlockAnnounceValidation { + let (announce, is_best, who) = match pre_validation_result { + PreValidateBlockAnnounce::Nothing { is_best, who, announce } => { + self.peer_block_announce_validation_finished(&who); + return PollBlockAnnounceValidation::Nothing { is_best, who, header: announce.header } + }, + PreValidateBlockAnnounce::Failure { who } => { + self.peer_block_announce_validation_finished(&who); + return PollBlockAnnounceValidation::Failure { who } + }, + PreValidateBlockAnnounce::Process { announce, is_new_best, who } => { + self.peer_block_announce_validation_finished(&who); + (announce, is_new_best, who) + }, + }; + + let header = announce.header; + let number = *header.number(); + let hash = header.hash(); + let parent_status = self.block_status(header.parent_hash()).unwrap_or(BlockStatus::Unknown); let known_parent = parent_status != BlockStatus::Unknown; let ancient_parent = parent_status == BlockStatus::InChainPruned; let known = self.is_known(&hash); - let peer = if let Some(peer) = self.peers.get_mut(who) { + let peer = if let Some(peer) = self.peers.get_mut(&who) { peer } else { error!(target: "sync", "💔 Called on_block_announce with a bad peer ID"); - return OnBlockAnnounce::Nothing + return PollBlockAnnounceValidation::Nothing { is_best, who, header } }; + while peer.recently_announced.len() >= ANNOUNCE_HISTORY_SIZE { peer.recently_announced.pop_front(); } peer.recently_announced.push_back(hash.clone()); - // Let external validator check the block announcement. - let assoc_data = announce.data.as_ref().map_or(&[][..], |v| v.as_slice()); - let is_best = match self.block_announce_validator.validate(&header, assoc_data) { - Ok(Validation::Success { is_new_best }) => is_new_best || is_best, - Ok(Validation::Failure) => { - debug!(target: "sync", "Block announcement validation of block {} from {} failed", hash, who); - return OnBlockAnnounce::Nothing - } - Err(e) => { - error!(target: "sync", "💔 Block announcement validation errored: {}", e); - return OnBlockAnnounce::Nothing - } - }; - if is_best { // update their best block peer.best_number = number; peer.best_hash = hash; } + if let PeerSyncState::AncestorSearch {..} = peer.state { - return OnBlockAnnounce::Nothing + return PollBlockAnnounceValidation::Nothing { is_best, who, header } } + // If the announced block is the best they have and is not ahead of us, our common number // is either one further ahead or it's the one they just announced, if we know about it. if is_best { @@ -1221,7 +1461,7 @@ impl ChainSync { peer.common_number = number - One::one(); } } - self.pending_requests.add(who); + self.pending_requests.add(&who); // known block case if known || self.is_already_downloading(&hash) { @@ -1229,18 +1469,18 @@ impl ChainSync { if let Some(target) = self.fork_targets.get_mut(&hash) { target.peers.insert(who.clone()); } - return OnBlockAnnounce::Nothing + return PollBlockAnnounceValidation::Nothing { is_best, who, header } } if ancient_parent { trace!(target: "sync", "Ignored ancient block announced from {}: {} {:?}", who, hash, header); - return OnBlockAnnounce::Nothing + return PollBlockAnnounceValidation::Nothing { is_best, who, header } } let requires_additional_data = !self.role.is_light() || !known_parent; if !requires_additional_data { trace!(target: "sync", "Importing new header announced from {}: {} {:?}", who, hash, header); - return OnBlockAnnounce::ImportHeader + return PollBlockAnnounceValidation::ImportHeader { is_best, header, who } } if number <= self.best_queued_number { @@ -1258,7 +1498,7 @@ impl ChainSync { .peers.insert(who.clone()); } - OnBlockAnnounce::Nothing + PollBlockAnnounceValidation::Nothing { is_best, who, header } } /// Call when a peer has disconnected. diff --git a/client/network/test/src/sync.rs b/client/network/test/src/sync.rs index 86e274aae10eb..64985871d85e0 100644 --- a/client/network/test/src/sync.rs +++ b/client/network/test/src/sync.rs @@ -18,7 +18,7 @@ use sp_consensus::BlockOrigin; use std::time::Duration; -use futures::executor::block_on; +use futures::{Future, executor::block_on}; use super::*; use sp_consensus::block_validation::Validation; use substrate_test_runtime::Header; @@ -693,14 +693,7 @@ fn can_sync_to_peers_with_wrong_common_block() { let fork_hash = net.peer(0).push_blocks_at(BlockId::Number(0), 2, false); net.peer(1).push_blocks_at(BlockId::Number(0), 2, false); // wait for connection - block_on(futures::future::poll_fn::<(), _>(|cx| { - net.poll(cx); - if net.peer(0).num_peers() == 0 || net.peer(1).num_peers() == 0 { - Poll::Pending - } else { - Poll::Ready(()) - } - })); + net.block_until_connected(); // both peers re-org to the same fork without notifying each other net.peer(0).client().finalize_block(BlockId::Hash(fork_hash), Some(Vec::new()), true).unwrap(); @@ -720,8 +713,8 @@ impl BlockAnnounceValidator for NewBestBlockAnnounceValidator { &mut self, _: &Header, _: &[u8], - ) -> Result> { - Ok(Validation::Success { is_new_best: true }) + ) -> Pin>> + Send>> { + async { Ok(Validation::Success { is_new_best: true }) }.boxed() } } @@ -750,3 +743,39 @@ fn sync_blocks_when_block_announce_validator_says_it_is_new_best() { // that flags all blocks as `is_new_best` and thus, it should have synced the blocks. assert!(!net.peer(1).has_block(&block_hash)); } + +/// Waits for some time until the validation is successfull. +struct DeferredBlockAnnounceValidator; + +impl BlockAnnounceValidator for DeferredBlockAnnounceValidator { + fn validate( + &mut self, + _: &Header, + _: &[u8], + ) -> Pin>> + Send>> { + async { + futures_timer::Delay::new(std::time::Duration::from_millis(500)).await; + Ok(Validation::Success { is_new_best: false }) + }.boxed() + } +} + +#[test] +fn wait_until_deferred_block_announce_validation_is_ready() { + sp_tracing::try_init_simple(); + log::trace!(target: "sync", "Test"); + let mut net = TestNet::with_fork_choice(ForkChoiceStrategy::Custom(false)); + net.add_full_peer_with_config(Default::default()); + net.add_full_peer_with_config(FullPeerConfig { + block_announce_validator: Some(Box::new(NewBestBlockAnnounceValidator)), + ..Default::default() + }); + + net.block_until_connected(); + + let block_hash = net.peer(0).push_blocks(1, true); + + while !net.peer(1).has_block(&block_hash) { + net.block_until_idle(); + } +} diff --git a/primitives/consensus/common/src/block_validation.rs b/primitives/consensus/common/src/block_validation.rs index 66f960f16fff3..f8255130e6416 100644 --- a/primitives/consensus/common/src/block_validation.rs +++ b/primitives/consensus/common/src/block_validation.rs @@ -18,7 +18,8 @@ use crate::BlockStatus; use sp_runtime::{generic::BlockId, traits::Block}; -use std::{error::Error, sync::Arc}; +use std::{error::Error, future::Future, pin::Pin, sync::Arc}; +use futures::FutureExt as _; /// A type which provides access to chain information. pub trait Chain { @@ -47,7 +48,16 @@ pub enum Validation { /// Type which checks incoming block announcements. pub trait BlockAnnounceValidator { /// Validate the announced header and its associated data. - fn validate(&mut self, header: &B::Header, data: &[u8]) -> Result>; + /// + /// # Note + /// + /// Returning [`Validation::Failure`] will lead to a decrease of the + /// peers reputation as it sent us invalid data. + fn validate( + &mut self, + header: &B::Header, + data: &[u8], + ) -> Pin>> + Send>>; } /// Default implementation of `BlockAnnounceValidator`. @@ -55,7 +65,11 @@ pub trait BlockAnnounceValidator { pub struct DefaultBlockAnnounceValidator; impl BlockAnnounceValidator for DefaultBlockAnnounceValidator { - fn validate(&mut self, _h: &B::Header, _d: &[u8]) -> Result> { - Ok(Validation::Success { is_new_best: false }) + fn validate( + &mut self, + _: &B::Header, + _: &[u8], + ) -> Pin>> + Send>> { + async { Ok(Validation::Success { is_new_best: false }) }.boxed() } }