diff --git a/Cargo.lock b/Cargo.lock
index ee12ffeaf1c6..57c59c25b0fa 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -506,16 +506,28 @@ version = "1.3.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a"
+[[package]]
+name = "bitvec"
+version = "0.20.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7774144344a4faa177370406a7ff5f1da24303817368584c6206c8303eb07848"
+dependencies = [
+ "funty 1.1.0",
+ "radium 0.6.2",
+ "tap",
+ "wyz 0.2.0",
+]
+
[[package]]
name = "bitvec"
version = "1.0.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1bc2832c24239b0141d5674bb9174f9d68a8b5b3f2753311927c172ca46f7e9c"
dependencies = [
- "funty",
- "radium",
+ "funty 2.0.0",
+ "radium 0.7.0",
"tap",
- "wyz",
+ "wyz 0.5.0",
]
[[package]]
@@ -625,7 +637,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a071c348a5ef6da1d3a87166b408170b46002382b1dda83992b5c2208cefb370"
dependencies = [
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
]
@@ -2214,7 +2226,7 @@ dependencies = [
"futures-timer",
"log",
"num-traits",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"scale-info",
]
@@ -2297,7 +2309,7 @@ name = "fork-tree"
version = "3.0.0"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
]
[[package]]
@@ -2325,7 +2337,7 @@ dependencies = [
"frame-system",
"linregress",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"paste",
"scale-info",
"serde",
@@ -2359,7 +2371,7 @@ dependencies = [
"lazy_static",
"linked-hash-map",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"rand 0.8.5",
"rand_pcg",
"sc-block-builder",
@@ -2406,7 +2418,7 @@ dependencies = [
"frame-election-provider-solution-type",
"frame-support",
"frame-system",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-arithmetic",
"sp-core",
@@ -2423,7 +2435,7 @@ dependencies = [
"frame-support",
"frame-system",
"frame-try-runtime",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-io",
@@ -2439,7 +2451,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "df6bb8542ef006ef0de09a5c4420787d79823c0ed7924225822362fd2bf2ff2d"
dependencies = [
"cfg-if",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
]
@@ -2451,7 +2463,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"futures",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"serde",
"sp-core",
"sp-io",
@@ -2473,7 +2485,7 @@ dependencies = [
"k256",
"log",
"once_cell",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"paste",
"scale-info",
"serde",
@@ -2539,7 +2551,7 @@ dependencies = [
"frame-support",
"frame-support-test-pallet",
"frame-system",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"pretty_assertions",
"rustversion",
"scale-info",
@@ -2561,7 +2573,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"frame-support",
"frame-system",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
]
@@ -2572,7 +2584,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"frame-support",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"sp-core",
@@ -2591,7 +2603,7 @@ dependencies = [
"frame-benchmarking",
"frame-support",
"frame-system",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-runtime",
@@ -2603,7 +2615,7 @@ name = "frame-system-rpc-runtime-api"
version = "4.0.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sp-api",
]
@@ -2613,7 +2625,7 @@ version = "0.10.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
"frame-support",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sp-api",
"sp-runtime",
"sp-std",
@@ -2652,6 +2664,12 @@ version = "1.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2022715d62ab30faffd124d40b76f4134a550a87792276512b18d63272333394"
+[[package]]
+name = "funty"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fed34cd105917e91daa4da6b3728c47b068749d6a62c59811f06ed2ac71d9da7"
+
[[package]]
name = "funty"
version = "2.0.0"
@@ -3284,7 +3302,7 @@ version = "0.6.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ba6a270039626615617f3f36d15fc827041df3b78c439da2cadfa47455a77f2f"
dependencies = [
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
]
[[package]]
@@ -3586,7 +3604,7 @@ checksum = "67c21572b4949434e4fc1e1978b99c5f77064153c59d998bf13ecd96fb5ecba7"
name = "kusama-runtime"
version = "0.9.39"
dependencies = [
- "bitvec",
+ "bitvec 1.0.1",
"frame-benchmarking",
"frame-election-provider-support",
"frame-executive",
@@ -3646,7 +3664,7 @@ dependencies = [
"pallet-whitelist",
"pallet-xcm",
"pallet-xcm-benchmarks",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-primitives",
"polkadot-runtime-common",
"polkadot-runtime-parachains",
@@ -4575,7 +4593,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"futures",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sc-client-api",
"sc-offchain",
"sp-api",
@@ -4594,7 +4612,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"anyhow",
"jsonrpsee",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"serde",
"sp-api",
"sp-blockchain",
@@ -5157,7 +5175,7 @@ dependencies = [
"frame-benchmarking",
"frame-support",
"frame-system",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-runtime",
@@ -5172,7 +5190,7 @@ dependencies = [
"frame-support",
"frame-system",
"pallet-session",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-application-crypto",
"sp-authority-discovery",
@@ -5188,7 +5206,7 @@ dependencies = [
"frame-support",
"frame-system",
"impl-trait-for-tuples",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-runtime",
"sp-std",
@@ -5206,7 +5224,7 @@ dependencies = [
"pallet-authorship",
"pallet-session",
"pallet-timestamp",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-application-crypto",
"sp-consensus-babe",
@@ -5229,7 +5247,7 @@ dependencies = [
"frame-system",
"log",
"pallet-balances",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-io",
@@ -5266,7 +5284,7 @@ dependencies = [
"frame-support",
"frame-system",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-runtime",
"sp-std",
@@ -5281,7 +5299,7 @@ dependencies = [
"frame-system",
"pallet-authorship",
"pallet-session",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"sp-consensus-beefy",
@@ -5304,7 +5322,7 @@ dependencies = [
"pallet-beefy",
"pallet-mmr",
"pallet-session",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"sp-api",
@@ -5325,7 +5343,7 @@ dependencies = [
"frame-system",
"log",
"pallet-treasury",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-io",
@@ -5344,7 +5362,7 @@ dependencies = [
"log",
"pallet-bounties",
"pallet-treasury",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-io",
@@ -5361,7 +5379,7 @@ dependencies = [
"frame-support",
"frame-system",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-io",
@@ -5378,7 +5396,7 @@ dependencies = [
"frame-benchmarking",
"frame-support",
"frame-system",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"sp-io",
@@ -5395,7 +5413,7 @@ dependencies = [
"frame-support",
"frame-system",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"sp-core",
@@ -5415,7 +5433,7 @@ dependencies = [
"frame-system",
"log",
"pallet-election-provider-support-benchmarking",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"rand 0.8.5",
"scale-info",
"sp-arithmetic",
@@ -5435,7 +5453,7 @@ dependencies = [
"frame-benchmarking",
"frame-election-provider-support",
"frame-system",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sp-npos-elections",
"sp-runtime",
]
@@ -5449,7 +5467,7 @@ dependencies = [
"frame-support",
"frame-system",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-io",
@@ -5468,7 +5486,7 @@ dependencies = [
"frame-support",
"frame-system",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-io",
"sp-runtime",
@@ -5487,7 +5505,7 @@ dependencies = [
"log",
"pallet-authorship",
"pallet-session",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-application-crypto",
"sp-consensus-grandpa",
@@ -5508,7 +5526,7 @@ dependencies = [
"frame-benchmarking",
"frame-support",
"frame-system",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-io",
"sp-runtime",
@@ -5525,7 +5543,7 @@ dependencies = [
"frame-system",
"log",
"pallet-authorship",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-application-crypto",
"sp-core",
@@ -5543,7 +5561,7 @@ dependencies = [
"frame-benchmarking",
"frame-support",
"frame-system",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-io",
@@ -5561,7 +5579,7 @@ dependencies = [
"frame-support",
"frame-system",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-io",
@@ -5577,7 +5595,7 @@ dependencies = [
"frame-benchmarking",
"frame-support",
"frame-system",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-io",
@@ -5595,7 +5613,7 @@ dependencies = [
"frame-support",
"frame-system",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-io",
"sp-runtime",
@@ -5610,7 +5628,7 @@ dependencies = [
"frame-benchmarking",
"frame-support",
"frame-system",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-arithmetic",
"sp-core",
@@ -5626,7 +5644,7 @@ dependencies = [
"frame-support",
"frame-system",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-io",
@@ -5647,7 +5665,7 @@ dependencies = [
"pallet-bags-list",
"pallet-nomination-pools",
"pallet-staking",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-runtime",
"sp-runtime-interface",
@@ -5661,7 +5679,7 @@ version = "1.0.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
"pallet-nomination-pools",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sp-api",
"sp-std",
]
@@ -5675,7 +5693,7 @@ dependencies = [
"frame-system",
"log",
"pallet-balances",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"sp-runtime",
@@ -5700,7 +5718,7 @@ dependencies = [
"pallet-offences",
"pallet-session",
"pallet-staking",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-runtime",
"sp-staking",
@@ -5716,7 +5734,7 @@ dependencies = [
"frame-support",
"frame-system",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-io",
@@ -5732,7 +5750,7 @@ dependencies = [
"frame-benchmarking",
"frame-support",
"frame-system",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-io",
"sp-runtime",
@@ -5748,7 +5766,7 @@ dependencies = [
"frame-support",
"frame-system",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-arithmetic",
"sp-core",
@@ -5765,7 +5783,7 @@ dependencies = [
"frame-benchmarking",
"frame-support",
"frame-system",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-io",
"sp-runtime",
@@ -5782,7 +5800,7 @@ dependencies = [
"frame-support",
"frame-system",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"sp-arithmetic",
@@ -5800,7 +5818,7 @@ dependencies = [
"frame-support",
"frame-system",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-io",
"sp-runtime",
@@ -5818,7 +5836,7 @@ dependencies = [
"impl-trait-for-tuples",
"log",
"pallet-timestamp",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-io",
@@ -5852,7 +5870,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"frame-support",
"frame-system",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"rand_chacha 0.2.2",
"scale-info",
"sp-runtime",
@@ -5871,7 +5889,7 @@ dependencies = [
"log",
"pallet-authorship",
"pallet-session",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"rand_chacha 0.2.2",
"scale-info",
"serde",
@@ -5907,7 +5925,7 @@ name = "pallet-staking-runtime-api"
version = "4.0.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sp-api",
]
@@ -5920,7 +5938,7 @@ dependencies = [
"frame-support",
"frame-system",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-io",
@@ -5935,7 +5953,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"frame-support",
"frame-system",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-io",
"sp-runtime",
@@ -5951,7 +5969,7 @@ dependencies = [
"frame-support",
"frame-system",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-inherents",
"sp-io",
@@ -5970,7 +5988,7 @@ dependencies = [
"frame-system",
"log",
"pallet-treasury",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"sp-core",
@@ -5986,7 +6004,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"frame-support",
"frame-system",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"sp-core",
@@ -6002,7 +6020,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"jsonrpsee",
"pallet-transaction-payment-rpc-runtime-api",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sp-api",
"sp-blockchain",
"sp-core",
@@ -6017,7 +6035,7 @@ version = "4.0.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
"pallet-transaction-payment",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sp-api",
"sp-runtime",
"sp-weights",
@@ -6033,7 +6051,7 @@ dependencies = [
"frame-system",
"impl-trait-for-tuples",
"pallet-balances",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"sp-runtime",
@@ -6049,7 +6067,7 @@ dependencies = [
"frame-support",
"frame-system",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-runtime",
"sp-std",
@@ -6063,7 +6081,7 @@ dependencies = [
"frame-benchmarking",
"frame-support",
"frame-system",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-io",
@@ -6080,7 +6098,7 @@ dependencies = [
"frame-support",
"frame-system",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-runtime",
"sp-std",
@@ -6094,7 +6112,7 @@ dependencies = [
"frame-benchmarking",
"frame-support",
"frame-system",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-api",
"sp-runtime",
@@ -6111,7 +6129,7 @@ dependencies = [
"frame-system",
"log",
"pallet-balances",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-parachain",
"polkadot-runtime-parachains",
"scale-info",
@@ -6136,7 +6154,7 @@ dependencies = [
"pallet-assets",
"pallet-balances",
"pallet-xcm",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-primitives",
"polkadot-runtime-common",
"scale-info",
@@ -6170,6 +6188,19 @@ dependencies = [
"snap",
]
+[[package]]
+name = "parity-scale-codec"
+version = "2.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "373b1a4c1338d9cd3d1fa53b3a11bdab5ab6bd80a20f7f7becd76953ae2be909"
+dependencies = [
+ "arrayvec 0.7.2",
+ "bitvec 0.20.4",
+ "byte-slice-cast",
+ "impl-trait-for-tuples",
+ "serde",
+]
+
[[package]]
name = "parity-scale-codec"
version = "3.3.0"
@@ -6177,7 +6208,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c3840933452adf7b3b9145e27086a5a3376c619dca1a21b1e5a5af0d54979bed"
dependencies = [
"arrayvec 0.7.2",
- "bitvec",
+ "bitvec 1.0.1",
"byte-slice-cast",
"bytes",
"impl-trait-for-tuples",
@@ -6476,8 +6507,9 @@ dependencies = [
name = "polkadot-availability-bitfield-distribution"
version = "0.9.39"
dependencies = [
+ "always-assert",
"assert_matches",
- "bitvec",
+ "bitvec 1.0.1",
"env_logger 0.9.0",
"futures",
"log",
@@ -6507,7 +6539,7 @@ dependencies = [
"futures",
"futures-timer",
"lru 0.9.0",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-erasure-coding",
"polkadot-node-network-protocol",
"polkadot-node-primitives",
@@ -6537,7 +6569,7 @@ dependencies = [
"futures-timer",
"log",
"lru 0.9.0",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-erasure-coding",
"polkadot-node-network-protocol",
"polkadot-node-primitives",
@@ -6633,13 +6665,13 @@ version = "0.9.39"
dependencies = [
"always-assert",
"assert_matches",
- "bitvec",
+ "bitvec 1.0.1",
"env_logger 0.9.0",
"fatality",
"futures",
"futures-timer",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-node-network-protocol",
"polkadot-node-primitives",
"polkadot-node-subsystem",
@@ -6647,6 +6679,7 @@ dependencies = [
"polkadot-node-subsystem-util",
"polkadot-primitives",
"polkadot-primitives-test-helpers",
+ "sc-keystore",
"sc-network",
"sp-core",
"sp-keyring",
@@ -6660,7 +6693,7 @@ dependencies = [
name = "polkadot-core-primitives"
version = "0.9.39"
dependencies = [
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-runtime",
@@ -6680,7 +6713,7 @@ dependencies = [
"indexmap",
"lazy_static",
"lru 0.9.0",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-erasure-coding",
"polkadot-node-network-protocol",
"polkadot-node-primitives",
@@ -6704,7 +6737,7 @@ name = "polkadot-erasure-coding"
version = "0.9.39"
dependencies = [
"criterion",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-node-primitives",
"polkadot-primitives",
"reed-solomon-novelpoly",
@@ -6751,7 +6784,7 @@ dependencies = [
"fatality",
"futures",
"futures-timer",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"polkadot-node-metrics",
"polkadot-node-network-protocol",
@@ -6774,7 +6807,7 @@ name = "polkadot-node-collation-generation"
version = "0.9.39"
dependencies = [
"futures",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-erasure-coding",
"polkadot-node-primitives",
"polkadot-node-subsystem",
@@ -6794,7 +6827,7 @@ version = "0.9.39"
dependencies = [
"assert_matches",
"async-trait",
- "bitvec",
+ "bitvec 1.0.1",
"derive_more",
"futures",
"futures-timer",
@@ -6802,7 +6835,7 @@ dependencies = [
"kvdb-memorydb",
"lru 0.9.0",
"merlin",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"polkadot-node-jaeger",
"polkadot-node-primitives",
@@ -6832,14 +6865,14 @@ name = "polkadot-node-core-av-store"
version = "0.9.39"
dependencies = [
"assert_matches",
- "bitvec",
+ "bitvec 1.0.1",
"env_logger 0.9.0",
"futures",
"futures-timer",
"kvdb",
"kvdb-memorydb",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"polkadot-erasure-coding",
"polkadot-node-primitives",
@@ -6861,7 +6894,7 @@ name = "polkadot-node-core-backing"
version = "0.9.39"
dependencies = [
"assert_matches",
- "bitvec",
+ "bitvec 1.0.1",
"fatality",
"futures",
"polkadot-erasure-coding",
@@ -6906,7 +6939,7 @@ dependencies = [
"async-trait",
"futures",
"futures-timer",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-node-core-pvf",
"polkadot-node-metrics",
"polkadot-node-primitives",
@@ -6928,7 +6961,7 @@ version = "0.9.39"
dependencies = [
"futures",
"maplit",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-node-metrics",
"polkadot-node-primitives",
"polkadot-node-subsystem",
@@ -6950,7 +6983,7 @@ dependencies = [
"futures-timer",
"kvdb",
"kvdb-memorydb",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"polkadot-node-primitives",
"polkadot-node-subsystem",
@@ -6973,7 +7006,7 @@ dependencies = [
"kvdb",
"kvdb-memorydb",
"lru 0.9.0",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-node-primitives",
"polkadot-node-subsystem",
"polkadot-node-subsystem-test-helpers",
@@ -7006,11 +7039,36 @@ dependencies = [
"tracing-gum",
]
+[[package]]
+name = "polkadot-node-core-prospective-parachains"
+version = "0.9.16"
+dependencies = [
+ "assert_matches",
+ "bitvec 1.0.1",
+ "fatality",
+ "futures",
+ "parity-scale-codec 2.3.1",
+ "polkadot-node-primitives",
+ "polkadot-node-subsystem",
+ "polkadot-node-subsystem-test-helpers",
+ "polkadot-node-subsystem-types",
+ "polkadot-node-subsystem-util",
+ "polkadot-primitives",
+ "polkadot-primitives-test-helpers",
+ "sc-keystore",
+ "sp-application-crypto",
+ "sp-core",
+ "sp-keyring",
+ "sp-keystore",
+ "thiserror",
+ "tracing-gum",
+]
+
[[package]]
name = "polkadot-node-core-provisioner"
version = "0.9.39"
dependencies = [
- "bitvec",
+ "bitvec 1.0.1",
"fatality",
"futures",
"futures-timer",
@@ -7038,7 +7096,7 @@ dependencies = [
"futures-timer",
"hex-literal",
"libc",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"pin-project",
"polkadot-core-primitives",
"polkadot-node-metrics",
@@ -7116,7 +7174,7 @@ dependencies = [
"lazy_static",
"log",
"mick-jaeger",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"polkadot-node-primitives",
"polkadot-primitives",
@@ -7136,7 +7194,7 @@ dependencies = [
"futures-timer",
"hyper",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-primitives",
"polkadot-test-service",
"prioritized-metered-channel",
@@ -7158,11 +7216,12 @@ name = "polkadot-node-network-protocol"
version = "0.9.39"
dependencies = [
"async-trait",
+ "bitvec 1.0.1",
"derive_more",
"fatality",
"futures",
"hex",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-node-jaeger",
"polkadot-node-primitives",
"polkadot-primitives",
@@ -7181,7 +7240,7 @@ version = "0.9.39"
dependencies = [
"bounded-vec",
"futures",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-erasure-coding",
"polkadot-parachain",
"polkadot-primitives",
@@ -7266,7 +7325,7 @@ dependencies = [
"log",
"lru 0.9.0",
"parity-db",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.11.2",
"pin-project",
"polkadot-node-jaeger",
@@ -7321,7 +7380,7 @@ dependencies = [
"bounded-collections",
"derive_more",
"frame-support",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-core-primitives",
"scale-info",
"serde",
@@ -7349,9 +7408,9 @@ dependencies = [
name = "polkadot-primitives"
version = "0.9.39"
dependencies = [
- "bitvec",
+ "bitvec 1.0.1",
"hex-literal",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-core-primitives",
"polkadot-parachain",
"scale-info",
@@ -7417,7 +7476,7 @@ dependencies = [
name = "polkadot-runtime"
version = "0.9.39"
dependencies = [
- "bitvec",
+ "bitvec 1.0.1",
"frame-benchmarking",
"frame-election-provider-support",
"frame-executive",
@@ -7469,7 +7528,7 @@ dependencies = [
"pallet-utility",
"pallet-vesting",
"pallet-xcm",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-primitives",
"polkadot-runtime-common",
"polkadot-runtime-constants",
@@ -7514,7 +7573,7 @@ dependencies = [
name = "polkadot-runtime-common"
version = "0.9.39"
dependencies = [
- "bitvec",
+ "bitvec 1.0.1",
"frame-benchmarking",
"frame-election-provider-support",
"frame-support",
@@ -7536,7 +7595,7 @@ dependencies = [
"pallet-transaction-payment",
"pallet-treasury",
"pallet-vesting",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-primitives",
"polkadot-primitives-test-helpers",
"polkadot-runtime-parachains",
@@ -7578,7 +7637,7 @@ name = "polkadot-runtime-metrics"
version = "0.9.39"
dependencies = [
"bs58",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-primitives",
"sp-std",
"sp-tracing",
@@ -7590,7 +7649,7 @@ version = "0.9.39"
dependencies = [
"assert_matches",
"bitflags",
- "bitvec",
+ "bitvec 1.0.1",
"derive_more",
"frame-benchmarking",
"frame-support",
@@ -7607,7 +7666,7 @@ dependencies = [
"pallet-staking",
"pallet-timestamp",
"pallet-vesting",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-parachain",
"polkadot-primitives",
"polkadot-primitives-test-helpers",
@@ -7680,6 +7739,7 @@ dependencies = [
"polkadot-node-core-chain-selection",
"polkadot-node-core-dispute-coordinator",
"polkadot-node-core-parachains-inherent",
+ "polkadot-node-core-prospective-parachains",
"polkadot-node-core-provisioner",
"polkadot-node-core-pvf-checker",
"polkadot-node-core-runtime-api",
@@ -7759,18 +7819,21 @@ version = "0.9.39"
dependencies = [
"arrayvec 0.5.2",
"assert_matches",
+ "bitvec 1.0.1",
"fatality",
"futures",
"futures-timer",
"indexmap",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-node-network-protocol",
"polkadot-node-primitives",
"polkadot-node-subsystem",
"polkadot-node-subsystem-test-helpers",
+ "polkadot-node-subsystem-types",
"polkadot-node-subsystem-util",
"polkadot-primitives",
"polkadot-primitives-test-helpers",
+ "rand_chacha 0.3.1",
"sc-keystore",
"sc-network",
"sp-application-crypto",
@@ -7788,7 +7851,7 @@ dependencies = [
name = "polkadot-statement-table"
version = "0.9.39"
dependencies = [
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-primitives",
"sp-core",
]
@@ -7798,7 +7861,7 @@ name = "polkadot-test-client"
version = "0.9.39"
dependencies = [
"futures",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-node-subsystem",
"polkadot-primitives",
"polkadot-test-runtime",
@@ -7851,7 +7914,7 @@ dependencies = [
name = "polkadot-test-runtime"
version = "0.9.39"
dependencies = [
- "bitvec",
+ "bitvec 1.0.1",
"frame-election-provider-support",
"frame-executive",
"frame-support",
@@ -7875,7 +7938,7 @@ dependencies = [
"pallet-transaction-payment-rpc-runtime-api",
"pallet-vesting",
"pallet-xcm",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-parachain",
"polkadot-primitives",
"polkadot-runtime-common",
@@ -8351,6 +8414,12 @@ dependencies = [
"proc-macro2",
]
+[[package]]
+name = "radium"
+version = "0.6.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "643f8f41a8ebc4c5dc4515c82bb8abd397b527fc20fd681b7c011c2aee5d44fb"
+
[[package]]
name = "radium"
version = "0.7.0"
@@ -8759,7 +8828,7 @@ dependencies = [
"pallet-vesting",
"pallet-xcm",
"pallet-xcm-benchmarks",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-parachain",
"polkadot-primitives",
"polkadot-runtime-common",
@@ -9035,7 +9104,7 @@ dependencies = [
"ip_network",
"libp2p",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"prost",
"prost-build",
"rand 0.8.5",
@@ -9060,7 +9129,7 @@ dependencies = [
"futures",
"futures-timer",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sc-block-builder",
"sc-client-api",
"sc-proposer-metrics",
@@ -9080,7 +9149,7 @@ name = "sc-block-builder"
version = "0.10.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sc-client-api",
"sp-api",
"sp-block-builder",
@@ -9133,7 +9202,7 @@ dependencies = [
"libp2p",
"log",
"names",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"rand 0.8.5",
"regex",
"rpassword",
@@ -9168,7 +9237,7 @@ dependencies = [
"fnv",
"futures",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"sc-executor",
"sc-transaction-pool-api",
@@ -9198,7 +9267,7 @@ dependencies = [
"linked-hash-map",
"log",
"parity-db",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"sc-client-api",
"sc-state-db",
@@ -9250,7 +9319,7 @@ dependencies = [
"num-bigint",
"num-rational",
"num-traits",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"sc-client-api",
"sc-consensus",
@@ -9308,7 +9377,7 @@ dependencies = [
"fnv",
"futures",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"sc-client-api",
"sc-consensus",
@@ -9341,7 +9410,7 @@ dependencies = [
"futures",
"jsonrpsee",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"sc-consensus-beefy",
"sc-rpc",
@@ -9358,7 +9427,7 @@ version = "0.10.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
"fork-tree",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sc-client-api",
"sc-consensus",
"sp-blockchain",
@@ -9379,7 +9448,7 @@ dependencies = [
"futures",
"futures-timer",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"rand 0.8.5",
"sc-block-builder",
@@ -9414,7 +9483,7 @@ dependencies = [
"futures",
"jsonrpsee",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sc-client-api",
"sc-consensus-grandpa",
"sc-rpc",
@@ -9434,7 +9503,7 @@ dependencies = [
"futures",
"futures-timer",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sc-client-api",
"sc-consensus",
"sc-telemetry",
@@ -9454,7 +9523,7 @@ version = "0.10.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
"lru 0.8.1",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"sc-executor-common",
"sc-executor-wasmi",
@@ -9567,7 +9636,7 @@ dependencies = [
"log",
"lru 0.8.1",
"mockall",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"pin-project",
"rand 0.8.5",
@@ -9623,7 +9692,7 @@ dependencies = [
"futures",
"futures-timer",
"libp2p",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"prost-build",
"sc-consensus",
"sc-peerset",
@@ -9667,7 +9736,7 @@ dependencies = [
"futures",
"libp2p",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"prost",
"prost-build",
"sc-client-api",
@@ -9694,7 +9763,7 @@ dependencies = [
"log",
"lru 0.8.1",
"mockall",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"prost",
"prost-build",
"sc-client-api",
@@ -9723,7 +9792,7 @@ dependencies = [
"futures",
"libp2p",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"pin-project",
"sc-network",
"sc-network-common",
@@ -9749,7 +9818,7 @@ dependencies = [
"libp2p",
"num_cpus",
"once_cell",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"rand 0.8.5",
"sc-client-api",
@@ -9795,7 +9864,7 @@ dependencies = [
"futures",
"jsonrpsee",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"sc-block-builder",
"sc-chain-spec",
@@ -9823,7 +9892,7 @@ version = "0.10.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
"jsonrpsee",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sc-chain-spec",
"sc-transaction-pool-api",
"scale-info",
@@ -9862,7 +9931,7 @@ dependencies = [
"hex",
"jsonrpsee",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"sc-chain-spec",
"sc-client-api",
@@ -9889,7 +9958,7 @@ dependencies = [
"futures-timer",
"jsonrpsee",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"pin-project",
"rand 0.8.5",
@@ -9949,7 +10018,7 @@ version = "0.10.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"sp-core",
]
@@ -9976,7 +10045,7 @@ version = "0.10.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
"jsonrpsee",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sc-chain-spec",
"sc-client-api",
"sc-consensus-babe",
@@ -10080,7 +10149,7 @@ dependencies = [
"linked-hash-map",
"log",
"num-traits",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"sc-client-api",
"sc-transaction-pool-api",
@@ -10131,10 +10200,10 @@ version = "2.1.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c46be926081c9f4dd5dd9b6f1d3e3229f2360bc6502dd8836f84a93b7c75e99a"
dependencies = [
- "bitvec",
+ "bitvec 1.0.1",
"cfg-if",
"derive_more",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info-derive",
"serde",
]
@@ -10554,7 +10623,7 @@ name = "slot-range-helper"
version = "0.9.39"
dependencies = [
"enumn",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"paste",
"sp-runtime",
"sp-std",
@@ -10632,7 +10701,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"hash-db",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sp-api-proc-macro",
"sp-core",
"sp-runtime",
@@ -10662,7 +10731,7 @@ name = "sp-application-crypto"
version = "7.0.0"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"sp-core",
@@ -10677,7 +10746,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"integer-sqrt",
"num-traits",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"sp-std",
@@ -10689,7 +10758,7 @@ name = "sp-authority-discovery"
version = "4.0.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-api",
"sp-application-crypto",
@@ -10702,7 +10771,7 @@ name = "sp-block-builder"
version = "4.0.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sp-api",
"sp-inherents",
"sp-runtime",
@@ -10717,7 +10786,7 @@ dependencies = [
"futures",
"log",
"lru 0.8.1",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"sp-api",
"sp-consensus",
@@ -10748,7 +10817,7 @@ version = "0.10.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
"async-trait",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-api",
"sp-application-crypto",
@@ -10767,7 +10836,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"async-trait",
"merlin",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"sp-api",
@@ -10789,7 +10858,7 @@ version = "4.0.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
"lazy_static",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"sp-api",
@@ -10809,7 +10878,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"finality-grandpa",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"sp-api",
@@ -10825,7 +10894,7 @@ name = "sp-consensus-slots"
version = "0.10.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"sp-std",
@@ -10837,7 +10906,7 @@ name = "sp-consensus-vrf"
version = "0.10.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"schnorrkel",
"sp-core",
@@ -10865,7 +10934,7 @@ dependencies = [
"libsecp256k1",
"log",
"merlin",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"primitive-types",
"rand 0.8.5",
@@ -10938,7 +11007,7 @@ version = "0.13.0"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
"environmental",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sp-std",
"sp-storage",
]
@@ -10950,7 +11019,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"async-trait",
"impl-trait-for-tuples",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-runtime",
@@ -10969,7 +11038,7 @@ dependencies = [
"futures",
"libsecp256k1",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"secp256k1",
"sp-core",
"sp-externalities",
@@ -11001,7 +11070,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"futures",
"merlin",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"schnorrkel",
"serde",
@@ -11026,7 +11095,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"ckb-merkle-mountain-range",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"sp-api",
@@ -11042,7 +11111,7 @@ name = "sp-npos-elections"
version = "4.0.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"sp-arithmetic",
@@ -11090,7 +11159,7 @@ dependencies = [
"hash256-std-hasher",
"impl-trait-for-tuples",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"paste",
"rand 0.8.5",
"scale-info",
@@ -11110,7 +11179,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"bytes",
"impl-trait-for-tuples",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"primitive-types",
"sp-externalities",
"sp-runtime-interface-proc-macro",
@@ -11138,7 +11207,7 @@ name = "sp-session"
version = "4.0.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-api",
"sp-core",
@@ -11152,7 +11221,7 @@ name = "sp-staking"
version = "4.0.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-runtime",
@@ -11166,7 +11235,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"hash-db",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"rand 0.8.5",
"smallvec",
@@ -11190,7 +11259,7 @@ version = "7.0.0"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
"impl-serde",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"ref-cast",
"serde",
"sp-debug-derive",
@@ -11205,7 +11274,7 @@ dependencies = [
"async-trait",
"futures-timer",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sp-inherents",
"sp-runtime",
"sp-std",
@@ -11217,7 +11286,7 @@ name = "sp-tracing"
version = "6.0.0"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sp-std",
"tracing",
"tracing-core",
@@ -11240,7 +11309,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"async-trait",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"sp-core",
"sp-inherents",
@@ -11260,7 +11329,7 @@ dependencies = [
"lazy_static",
"memory-db",
"nohash-hasher",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parking_lot 0.12.1",
"scale-info",
"schnellru",
@@ -11278,7 +11347,7 @@ version = "5.0.0"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
"impl-serde",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"parity-wasm",
"scale-info",
"serde",
@@ -11294,7 +11363,7 @@ name = "sp-version-proc-macro"
version = "4.0.0-dev"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"proc-macro2",
"quote",
"syn",
@@ -11308,7 +11377,7 @@ dependencies = [
"anyhow",
"impl-trait-for-tuples",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sp-std",
"wasmi",
"wasmtime",
@@ -11319,7 +11388,7 @@ name = "sp-weights"
version = "4.0.0"
source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134d8c7870396cb04bca63a674abfd5"
dependencies = [
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"smallvec",
@@ -11385,7 +11454,7 @@ dependencies = [
"pallet-election-provider-multi-phase",
"pallet-staking",
"pallet-transaction-payment",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"paste",
"polkadot-core-primitives",
"polkadot-runtime",
@@ -11551,7 +11620,7 @@ dependencies = [
"futures",
"jsonrpsee",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sc-rpc-api",
"sc-transaction-pool-api",
"sp-api",
@@ -11593,7 +11662,7 @@ source = "git+https://github.com/paritytech/substrate?branch=master#9d2d020c5134
dependencies = [
"jsonrpsee",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sc-client-api",
"sc-rpc-api",
"scale-info",
@@ -11613,7 +11682,7 @@ dependencies = [
"array-bytes",
"async-trait",
"futures",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sc-client-api",
"sc-client-db",
"sc-consensus",
@@ -11806,7 +11875,7 @@ name = "test-parachain-adder"
version = "0.9.39"
dependencies = [
"dlmalloc",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-parachain",
"sp-io",
"sp-std",
@@ -11822,7 +11891,7 @@ dependencies = [
"futures",
"futures-timer",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-cli",
"polkadot-node-core-pvf",
"polkadot-node-primitives",
@@ -11853,7 +11922,7 @@ version = "0.9.39"
dependencies = [
"dlmalloc",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-parachain",
"sp-io",
"sp-std",
@@ -11869,7 +11938,7 @@ dependencies = [
"futures",
"futures-timer",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-cli",
"polkadot-node-core-pvf",
"polkadot-node-primitives",
@@ -11891,7 +11960,7 @@ dependencies = [
name = "test-parachains"
version = "0.9.39"
dependencies = [
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sp-core",
"test-parachain-adder",
"test-parachain-halt",
@@ -12464,7 +12533,7 @@ dependencies = [
"frame-try-runtime",
"hex",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sc-cli",
"sc-executor",
"sc-service",
@@ -13400,7 +13469,7 @@ dependencies = [
name = "westend-runtime"
version = "0.9.39"
dependencies = [
- "bitvec",
+ "bitvec 1.0.1",
"frame-benchmarking",
"frame-election-provider-support",
"frame-executive",
@@ -13454,7 +13523,7 @@ dependencies = [
"pallet-vesting",
"pallet-xcm",
"pallet-xcm-benchmarks",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-parachain",
"polkadot-primitives",
"polkadot-runtime-common",
@@ -13725,6 +13794,12 @@ dependencies = [
"winapi",
]
+[[package]]
+name = "wyz"
+version = "0.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "85e60b0d1b5f99db2556934e21937020776a5d31520bf169e851ac44e6420214"
+
[[package]]
name = "wyz"
version = "0.5.0"
@@ -13803,7 +13878,7 @@ dependencies = [
"hex-literal",
"impl-trait-for-tuples",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"scale-info",
"serde",
"sp-io",
@@ -13823,7 +13898,7 @@ dependencies = [
"pallet-balances",
"pallet-transaction-payment",
"pallet-xcm",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-parachain",
"polkadot-runtime-parachains",
"primitive-types",
@@ -13845,7 +13920,7 @@ dependencies = [
"frame-support",
"impl-trait-for-tuples",
"log",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"sp-arithmetic",
"sp-core",
"sp-io",
@@ -13890,7 +13965,7 @@ name = "xcm-simulator"
version = "0.9.39"
dependencies = [
"frame-support",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"paste",
"polkadot-core-primitives",
"polkadot-parachain",
@@ -13911,7 +13986,7 @@ dependencies = [
"pallet-balances",
"pallet-uniques",
"pallet-xcm",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-core-primitives",
"polkadot-parachain",
"polkadot-runtime-parachains",
@@ -13937,7 +14012,7 @@ dependencies = [
"honggfuzz",
"pallet-balances",
"pallet-xcm",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"polkadot-core-primitives",
"polkadot-parachain",
"polkadot-runtime-parachains",
@@ -14002,7 +14077,7 @@ version = "0.9.39"
dependencies = [
"futures-util",
"lazy_static",
- "parity-scale-codec",
+ "parity-scale-codec 3.3.0",
"reqwest",
"serde",
"serde_json",
diff --git a/Cargo.toml b/Cargo.toml
index 5ec0a74d5cac..b3b081fbe853 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -78,6 +78,7 @@ members = [
"node/core/chain-selection",
"node/core/dispute-coordinator",
"node/core/parachains-inherent",
+ "node/core/prospective-parachains",
"node/core/provisioner",
"node/core/pvf",
"node/core/pvf-checker",
@@ -207,6 +208,7 @@ fast-runtime = [ "polkadot-cli/fast-runtime" ]
runtime-metrics = [ "polkadot-cli/runtime-metrics" ]
pyroscope = ["polkadot-cli/pyroscope"]
jemalloc-allocator = ["polkadot-node-core-pvf/jemalloc-allocator", "polkadot-overseer/jemalloc-allocator"]
+network-protocol-staging = ["polkadot-cli/network-protocol-staging"]
# Configuration for building a .deb package - for use with `cargo-deb`
[package.metadata.deb]
diff --git a/cli/Cargo.toml b/cli/Cargo.toml
index 01247bbc996f..0edf56d90cef 100644
--- a/cli/Cargo.toml
+++ b/cli/Cargo.toml
@@ -75,3 +75,4 @@ rococo-native = ["service/rococo-native"]
malus = ["full-node", "service/malus"]
runtime-metrics = ["service/runtime-metrics", "polkadot-node-metrics/runtime-metrics"]
+network-protocol-staging = ["service/network-protocol-staging"]
diff --git a/node/collation-generation/src/lib.rs b/node/collation-generation/src/lib.rs
index b3d728f70a48..7e5605b46a92 100644
--- a/node/collation-generation/src/lib.rs
+++ b/node/collation-generation/src/lib.rs
@@ -15,6 +15,19 @@
// along with Polkadot. If not, see .
//! The collation generation subsystem is the interface between polkadot and the collators.
+//!
+//! # Protocol
+//!
+//! On every `ActiveLeavesUpdate`:
+//!
+//! * If there is no collation generation config, ignore.
+//! * Otherwise, for each `activated` head in the update:
+//! * Determine if the para is scheduled on any core by fetching the `availability_cores` Runtime API.
+//! * Determine an occupied core assumption to make about the para. Scheduled cores can make [`OccupiedCoreAssumption::Free`].
+//! * TODO: What does this mean?
+//! * Use the Runtime API subsystem to fetch the full validation data.
+//! * Invoke the `collator`, and use its outputs to produce a [`CandidateReceipt`], signed with the configuration's `key`.
+//! * Dispatch a [`CollatorProtocolMessage::DistributeCollation`](receipt, pov)`.
#![deny(missing_docs)]
@@ -198,15 +211,15 @@ async fn handle_new_activations(
let (scheduled_core, assumption) = match core {
CoreState::Scheduled(scheduled_core) =>
(scheduled_core, OccupiedCoreAssumption::Free),
- CoreState::Occupied(_occupied_core) => {
- // TODO: https://github.com/paritytech/polkadot/issues/1573
- gum::trace!(
- target: LOG_TARGET,
- core_idx = %core_idx,
- relay_parent = ?relay_parent,
- "core is occupied. Keep going.",
- );
- continue
+ CoreState::Occupied(occupied_core) => {
+ // TODO [now]: this assumes that next up == current.
+ // in practice we should only set `OccupiedCoreAssumption::Included`
+ // when the candidate occupying the core is also of the same para.
+ if let Some(scheduled) = occupied_core.next_up_on_available {
+ (scheduled, OccupiedCoreAssumption::Included)
+ } else {
+ continue
+ }
},
CoreState::Free => {
gum::trace!(
@@ -286,6 +299,7 @@ async fn handle_new_activations(
"collation-builder",
Box::pin(async move {
let persisted_validation_data_hash = validation_data.hash();
+ let parent_head_data_hash = validation_data.parent_head.hash();
let (collation, result_sender) =
match (task_config.collator)(relay_parent, &validation_data).await {
@@ -385,8 +399,13 @@ async fn handle_new_activations(
if let Err(err) = task_sender
.send(
- CollatorProtocolMessage::DistributeCollation(ccr, pov, result_sender)
- .into(),
+ CollatorProtocolMessage::DistributeCollation(
+ ccr,
+ parent_head_data_hash,
+ pov,
+ result_sender,
+ )
+ .into(),
)
.await
{
diff --git a/node/core/approval-voting/src/criteria.rs b/node/core/approval-voting/src/criteria.rs
index 3b76941fde40..b9fb686a3063 100644
--- a/node/core/approval-voting/src/criteria.rs
+++ b/node/core/approval-voting/src/criteria.rs
@@ -274,7 +274,7 @@ pub(crate) fn compute_assignments(
// Ignore any cores where the assigned group is our own.
let leaving_cores = leaving_cores
.into_iter()
- .filter(|&(_, _, ref g)| !is_in_backing_group(&config.validator_groups, index, *g))
+ .filter(|(_, _, g)| !is_in_backing_group(&config.validator_groups, index, *g))
.map(|(c_hash, core, _)| (c_hash, core))
.collect::>();
@@ -496,7 +496,7 @@ pub(crate) fn check_assignment_cert(
return Err(InvalidAssignment(Reason::IsInBackingGroup))
}
- let &(ref vrf_output, ref vrf_proof) = &assignment.vrf;
+ let (vrf_output, vrf_proof) = &assignment.vrf;
match assignment.kind {
AssignmentCertKind::RelayVRFModulo { sample } => {
if sample >= config.relay_vrf_modulo_samples {
diff --git a/node/core/approval-voting/src/lib.rs b/node/core/approval-voting/src/lib.rs
index 59db8732a429..7793a3c58bb1 100644
--- a/node/core/approval-voting/src/lib.rs
+++ b/node/core/approval-voting/src/lib.rs
@@ -486,7 +486,7 @@ impl Wakeups {
.collect();
let mut pruned_wakeups = BTreeMap::new();
- self.reverse_wakeups.retain(|&(ref h, ref c_h), tick| {
+ self.reverse_wakeups.retain(|(h, c_h), tick| {
let live = !pruned_blocks.contains(h);
if !live {
pruned_wakeups.entry(*tick).or_insert_with(HashSet::new).insert((*h, *c_h));
diff --git a/node/core/approval-voting/src/ops.rs b/node/core/approval-voting/src/ops.rs
index 37f564c34f71..c0d6ce0e6054 100644
--- a/node/core/approval-voting/src/ops.rs
+++ b/node/core/approval-voting/src/ops.rs
@@ -62,7 +62,7 @@ fn visit_and_remove_block_entry(
};
overlayed_db.delete_block_entry(&block_hash);
- for &(_, ref candidate_hash) in block_entry.candidates() {
+ for (_, candidate_hash) in block_entry.candidates() {
let candidate = match visited_candidates.entry(*candidate_hash) {
Entry::Occupied(e) => e.into_mut(),
Entry::Vacant(e) => {
@@ -227,7 +227,7 @@ pub fn add_block_entry(
// read and write all updated entries.
{
- for &(_, ref candidate_hash) in entry.candidates() {
+ for (_, candidate_hash) in entry.candidates() {
let NewCandidateInfo { candidate, backing_group, our_assignment } =
match candidate_info(candidate_hash) {
None => return Ok(Vec::new()),
diff --git a/node/core/backing/src/error.rs b/node/core/backing/src/error.rs
index 36d4f859a0a8..fbb4c0ef1be3 100644
--- a/node/core/backing/src/error.rs
+++ b/node/core/backing/src/error.rs
@@ -17,9 +17,9 @@
use fatality::Nested;
use futures::channel::{mpsc, oneshot};
-use polkadot_node_subsystem::{messages::ValidationFailed, SubsystemError};
-use polkadot_node_subsystem_util::Error as UtilError;
-use polkadot_primitives::BackedCandidate;
+use polkadot_node_subsystem::{messages::ValidationFailed, RuntimeApiError, SubsystemError};
+use polkadot_node_subsystem_util::{runtime, Error as UtilError};
+use polkadot_primitives::{BackedCandidate, ValidationCodeHash};
use crate::LOG_TARGET;
@@ -30,6 +30,18 @@ pub type FatalResult = std::result::Result;
#[allow(missing_docs)]
#[fatality::fatality(splitable)]
pub enum Error {
+ #[fatal]
+ #[error("Failed to spawn background task")]
+ FailedToSpawnBackgroundTask,
+
+ #[fatal(forward)]
+ #[error("Error while accessing runtime information")]
+ Runtime(#[from] runtime::Error),
+
+ #[fatal]
+ #[error(transparent)]
+ BackgroundValidationMpsc(#[from] mpsc::SendError),
+
#[error("Candidate is not found")]
CandidateNotFound,
@@ -42,16 +54,27 @@ pub enum Error {
#[error("FetchPoV failed")]
FetchPoV,
- #[fatal]
- #[error("Failed to spawn background task")]
- FailedToSpawnBackgroundTask,
+ #[error("Fetching validation code by hash failed {0:?}, {1:?}")]
+ FetchValidationCode(ValidationCodeHash, RuntimeApiError),
+
+ #[error("Fetching Runtime API version failed {0:?}")]
+ FetchRuntimeApiVersion(RuntimeApiError),
+
+ #[error("No validation code {0:?}")]
+ NoValidationCode(ValidationCodeHash),
+
+ #[error("Candidate rejected by prospective parachains subsystem")]
+ RejectedByProspectiveParachains,
- #[error("ValidateFromChainState channel closed before receipt")]
- ValidateFromChainState(#[source] oneshot::Canceled),
+ #[error("ValidateFromExhaustive channel closed before receipt")]
+ ValidateFromExhaustive(#[source] oneshot::Canceled),
#[error("StoreAvailableData channel closed before receipt")]
StoreAvailableData(#[source] oneshot::Canceled),
+ #[error("RuntimeAPISubsystem channel closed before receipt")]
+ RuntimeApiUnavailable(#[source] oneshot::Canceled),
+
#[error("a channel was closed before receipt in try_join!")]
JoinMultiple(#[source] oneshot::Canceled),
@@ -61,10 +84,6 @@ pub enum Error {
#[error(transparent)]
ValidationFailed(#[from] ValidationFailed),
- #[fatal]
- #[error(transparent)]
- BackgroundValidationMpsc(#[from] mpsc::SendError),
-
#[error(transparent)]
UtilError(#[from] UtilError),
diff --git a/node/core/backing/src/lib.rs b/node/core/backing/src/lib.rs
index 32a6bb79037b..7a32a633d380 100644
--- a/node/core/backing/src/lib.rs
+++ b/node/core/backing/src/lib.rs
@@ -14,43 +14,98 @@
// You should have received a copy of the GNU General Public License
// along with Polkadot. If not, see .
-//! Implements a `CandidateBackingSubsystem`.
+//! Implements the `CandidateBackingSubsystem`.
+//!
+//! This subsystem maintains the entire responsibility of tracking parachain
+//! candidates which can be backed, as well as the issuance of statements
+//! about candidates when run on a validator node.
+//!
+//! There are two types of statements: `Seconded` and `Valid`.
+//! `Seconded` implies `Valid`, and nothing should be stated as
+//! `Valid` unless its already been `Seconded`.
+//!
+//! Validators may only second candidates which fall under their own group
+//! assignment, and they may only second one candidate per depth per active leaf.
+//! Candidates which are stated as either `Second` or `Valid` by a majority of the
+//! assigned group of validators may be backed on-chain and proceed to the availability
+//! stage.
+//!
+//! Depth is a concept relating to asynchronous backing, by which validators
+//! short sub-chains of candidates are backed and extended off-chain, and then placed
+//! asynchronously into blocks of the relay chain as those are authored and as the
+//! relay-chain state becomes ready for them. Asynchronous backing allows parachains to
+//! grow mostly independently from the state of the relay chain, which gives more time for
+//! parachains to be validated and thereby increases performance.
+//!
+//! Most of the work of asynchronous backing is handled by the Prospective Parachains
+//! subsystem. The 'depth' of a parachain block with respect to a relay chain block is
+//! a measure of how many parachain blocks are between the most recent included parachain block
+//! in the post-state of the relay-chain block and the candidate. For instance,
+//! a candidate that descends directly from the most recent parachain block in the relay-chain
+//! state has depth 0. The child of that candidate would have depth 1. And so on.
+//!
+//! The candidate backing subsystem keeps track of a set of 'active leaves' which are the
+//! most recent blocks in the relay-chain (which is in fact a tree) which could be built
+//! upon. Depth is always measured against active leaves, and the valid relay-parent that
+//! each candidate can have is determined by the active leaves. The Prospective Parachains
+//! subsystem enforces that the relay-parent increases monotonically, so that logic
+//! is not handled here. By communicating with the Prospective Parachains subsystem,
+//! this subsystem extrapolates an "implicit view" from the set of currently active leaves,
+//! which determines the set of all recent relay-chain block hashes which could be relay-parents
+//! for candidates backed in children of the active leaves.
+//!
+//! In fact, this subsystem relies on the Statement Distribution subsystem to prevent spam
+//! by enforcing the rule that each validator may second at most one candidate per depth per
+//! active leaf. This bounds the number of candidates that the system needs to consider and
+//! is not handled within this subsystem, except for candidates seconded locally.
+//!
+//! This subsystem also handles relay-chain heads which don't support asynchronous backing.
+//! For such active leaves, the only valid relay-parent is the leaf hash itself and the only
+//! allowed depth is 0.
#![deny(unused_crate_dependencies)]
use std::{
- collections::{HashMap, HashSet},
+ collections::{BTreeMap, HashMap, HashSet},
sync::Arc,
};
use bitvec::vec::BitVec;
use futures::{
channel::{mpsc, oneshot},
- FutureExt, SinkExt, StreamExt,
+ future::BoxFuture,
+ stream::FuturesOrdered,
+ FutureExt, SinkExt, StreamExt, TryFutureExt,
};
use error::{Error, FatalResult};
use polkadot_node_primitives::{
- AvailableData, InvalidCandidate, PoV, SignedFullStatement, Statement, ValidationResult,
+ minimum_votes, AvailableData, InvalidCandidate, PoV, SignedFullStatementWithPVD,
+ StatementWithPVD, ValidationResult,
};
use polkadot_node_subsystem::{
- jaeger,
messages::{
- AvailabilityDistributionMessage, AvailabilityStoreMessage, CandidateBackingMessage,
- CandidateValidationMessage, CollatorProtocolMessage, ProvisionableData, ProvisionerMessage,
+ AvailabilityDistributionMessage, AvailabilityStoreMessage, CanSecondRequest,
+ CandidateBackingMessage, CandidateValidationMessage, CollatorProtocolMessage,
+ HypotheticalCandidate, HypotheticalFrontierRequest, IntroduceCandidateRequest,
+ ProspectiveParachainsMessage, ProvisionableData, ProvisionerMessage, RuntimeApiMessage,
RuntimeApiRequest, StatementDistributionMessage,
},
- overseer, ActiveLeavesUpdate, FromOrchestra, OverseerSignal, PerLeafSpan, SpawnedSubsystem,
- Stage, SubsystemError,
+ overseer, ActiveLeavesUpdate, FromOrchestra, OverseerSignal, SpawnedSubsystem, SubsystemError,
};
use polkadot_node_subsystem_util::{
- self as util, request_from_runtime, request_session_index_for_child, request_validator_groups,
- request_validators, Validator,
+ self as util,
+ backing_implicit_view::{FetchError as ImplicitViewFetchError, View as ImplicitView},
+ request_from_runtime, request_session_index_for_child, request_validator_groups,
+ request_validators,
+ runtime::{prospective_parachains_mode, ProspectiveParachainsMode},
+ Validator,
};
use polkadot_primitives::{
- BackedCandidate, CandidateCommitments, CandidateHash, CandidateReceipt, CollatorId,
- CommittedCandidateReceipt, CoreIndex, CoreState, Hash, Id as ParaId, PvfExecTimeoutKind,
- SigningContext, ValidatorId, ValidatorIndex, ValidatorSignature, ValidityAttestation,
+ BackedCandidate, CandidateCommitments, CandidateHash, CandidateReceipt,
+ CommittedCandidateReceipt, CoreIndex, CoreState, Hash, Id as ParaId, PersistedValidationData,
+ PvfExecTimeoutKind, SigningContext, ValidationCode, ValidatorId, ValidatorIndex,
+ ValidatorSignature, ValidityAttestation,
};
use sp_keystore::KeystorePtr;
use statement_table::{
@@ -59,7 +114,7 @@ use statement_table::{
SignedStatement as TableSignedStatement, Statement as TableStatement,
Summary as TableSummary,
},
- Context as TableContextTrait, Table,
+ Config as TableConfig, Context as TableContextTrait, Table,
};
mod error;
@@ -107,9 +162,9 @@ impl std::fmt::Debug for ValidatedCandidateCommand {
impl ValidatedCandidateCommand {
fn candidate_hash(&self) -> CandidateHash {
match *self {
- ValidatedCandidateCommand::Second(Ok((ref candidate, _, _))) => candidate.hash(),
+ ValidatedCandidateCommand::Second(Ok(ref outputs)) => outputs.candidate.hash(),
ValidatedCandidateCommand::Second(Err(ref candidate)) => candidate.hash(),
- ValidatedCandidateCommand::Attest(Ok((ref candidate, _, _))) => candidate.hash(),
+ ValidatedCandidateCommand::Attest(Ok(ref outputs)) => outputs.candidate.hash(),
ValidatedCandidateCommand::Attest(Err(ref candidate)) => candidate.hash(),
ValidatedCandidateCommand::AttestNoPoV(candidate_hash) => candidate_hash,
}
@@ -146,6 +201,98 @@ where
}
}
+struct PerRelayParentState {
+ prospective_parachains_mode: ProspectiveParachainsMode,
+ /// The hash of the relay parent on top of which this job is doing it's work.
+ parent: Hash,
+ /// The `ParaId` assigned to the local validator at this relay parent.
+ assignment: Option,
+ /// The candidates that are backed by enough validators in their group, by hash.
+ backed: HashSet,
+ /// The table of candidates and statements under this relay-parent.
+ table: Table,
+ /// The table context, including groups.
+ table_context: TableContext,
+ /// We issued `Seconded` or `Valid` statements on about these candidates.
+ issued_statements: HashSet,
+ /// These candidates are undergoing validation in the background.
+ awaiting_validation: HashSet,
+ /// Data needed for retrying in case of `ValidatedCandidateCommand::AttestNoPoV`.
+ fallbacks: HashMap,
+}
+
+struct PerCandidateState {
+ persisted_validation_data: PersistedValidationData,
+ seconded_locally: bool,
+ para_id: ParaId,
+ relay_parent: Hash,
+}
+
+struct ActiveLeafState {
+ prospective_parachains_mode: ProspectiveParachainsMode,
+ /// The candidates seconded at various depths under this active
+ /// leaf with respect to parachain id. A candidate can only be
+ /// seconded when its hypothetical frontier under every active leaf
+ /// has an empty entry in this map.
+ ///
+ /// When prospective parachains are disabled, the only depth
+ /// which is allowed is 0.
+ seconded_at_depth: HashMap>,
+}
+
+/// The state of the subsystem.
+struct State {
+ /// The utility for managing the implicit and explicit views in a consistent way.
+ ///
+ /// We only feed leaves which have prospective parachains enabled to this view.
+ implicit_view: ImplicitView,
+ /// State tracked for all active leaves, whether or not they have prospective parachains
+ /// enabled.
+ per_leaf: HashMap,
+ /// State tracked for all relay-parents backing work is ongoing for. This includes
+ /// all active leaves.
+ ///
+ /// relay-parents fall into one of 3 categories.
+ /// 1. active leaves which do support prospective parachains
+ /// 2. active leaves which do not support prospective parachains
+ /// 3. relay-chain blocks which are ancestors of an active leaf and
+ /// do support prospective parachains.
+ ///
+ /// Relay-chain blocks which don't support prospective parachains are
+ /// never included in the fragment trees of active leaves which do.
+ ///
+ /// While it would be technically possible to support such leaves in
+ /// fragment trees, it only benefits the transition period when asynchronous
+ /// backing is being enabled and complicates code complexity.
+ per_relay_parent: HashMap,
+ /// State tracked for all candidates relevant to the implicit view.
+ ///
+ /// This is guaranteed to have an entry for each candidate with a relay parent in the implicit
+ /// or explicit view for which a `Seconded` statement has been successfully imported.
+ per_candidate: HashMap,
+ /// A cloneable sender which is dispatched to background candidate validation tasks to inform
+ /// the main task of the result.
+ background_validation_tx: mpsc::Sender<(Hash, ValidatedCandidateCommand)>,
+ /// The handle to the keystore used for signing.
+ keystore: KeystorePtr,
+}
+
+impl State {
+ fn new(
+ background_validation_tx: mpsc::Sender<(Hash, ValidatedCandidateCommand)>,
+ keystore: KeystorePtr,
+ ) -> Self {
+ State {
+ implicit_view: ImplicitView::default(),
+ per_leaf: HashMap::default(),
+ per_relay_parent: HashMap::default(),
+ per_candidate: HashMap::new(),
+ background_validation_tx,
+ keystore,
+ }
+ }
+}
+
#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
async fn run(
mut ctx: Context,
@@ -153,18 +300,11 @@ async fn run(
metrics: Metrics,
) -> FatalResult<()> {
let (background_validation_tx, mut background_validation_rx) = mpsc::channel(16);
- let mut jobs = HashMap::new();
+ let mut state = State::new(background_validation_tx, keystore);
loop {
- let res = run_iteration(
- &mut ctx,
- keystore.clone(),
- &metrics,
- &mut jobs,
- background_validation_tx.clone(),
- &mut background_validation_rx,
- )
- .await;
+ let res =
+ run_iteration(&mut ctx, &mut state, &metrics, &mut background_validation_rx).await;
match res {
Ok(()) => break,
@@ -178,10 +318,8 @@ async fn run(
#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
async fn run_iteration(
ctx: &mut Context,
- keystore: KeystorePtr,
+ state: &mut State,
metrics: &Metrics,
- jobs: &mut HashMap>,
- background_validation_tx: mpsc::Sender<(Hash, ValidatedCandidateCommand)>,
background_validation_rx: &mut mpsc::Receiver<(Hash, ValidatedCandidateCommand)>,
) -> Result<(), Error> {
loop {
@@ -190,9 +328,10 @@ async fn run_iteration(
if let Some((relay_parent, command)) = validated_command {
handle_validated_candidate_command(
&mut *ctx,
- jobs,
+ state,
relay_parent,
command,
+ metrics,
).await?;
} else {
panic!("background_validation_tx always alive at this point; qed");
@@ -200,240 +339,24 @@ async fn run_iteration(
}
from_overseer = ctx.recv().fuse() => {
match from_overseer? {
- FromOrchestra::Signal(OverseerSignal::ActiveLeaves(update)) => handle_active_leaves_update(
- &mut *ctx,
- update,
- jobs,
- &keystore,
- &background_validation_tx,
- &metrics,
- ).await?,
+ FromOrchestra::Signal(OverseerSignal::ActiveLeaves(update)) => {
+ handle_active_leaves_update(
+ &mut *ctx,
+ update,
+ state,
+ ).await?;
+ }
FromOrchestra::Signal(OverseerSignal::BlockFinalized(..)) => {}
FromOrchestra::Signal(OverseerSignal::Conclude) => return Ok(()),
- FromOrchestra::Communication { msg } => handle_communication(&mut *ctx, jobs, msg).await?,
+ FromOrchestra::Communication { msg } => {
+ handle_communication(&mut *ctx, state, msg, metrics).await?;
+ }
}
}
)
}
}
-#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
-async fn handle_validated_candidate_command(
- ctx: &mut Context,
- jobs: &mut HashMap>,
- relay_parent: Hash,
- command: ValidatedCandidateCommand,
-) -> Result<(), Error> {
- if let Some(job) = jobs.get_mut(&relay_parent) {
- job.job.handle_validated_candidate_command(&job.span, ctx, command).await?;
- } else {
- // simple race condition; can be ignored - this relay-parent
- // is no longer relevant.
- }
-
- Ok(())
-}
-
-#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
-async fn handle_communication(
- ctx: &mut Context,
- jobs: &mut HashMap>,
- message: CandidateBackingMessage,
-) -> Result<(), Error> {
- match message {
- CandidateBackingMessage::Second(relay_parent, candidate, pov) => {
- if let Some(job) = jobs.get_mut(&relay_parent) {
- job.job.handle_second_msg(&job.span, ctx, candidate, pov).await?;
- }
- },
- CandidateBackingMessage::Statement(relay_parent, statement) => {
- if let Some(job) = jobs.get_mut(&relay_parent) {
- job.job.handle_statement_message(&job.span, ctx, statement).await?;
- }
- },
- CandidateBackingMessage::GetBackedCandidates(relay_parent, requested_candidates, tx) =>
- if let Some(job) = jobs.get_mut(&relay_parent) {
- job.job.handle_get_backed_candidates_message(requested_candidates, tx)?;
- },
- }
-
- Ok(())
-}
-
-#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
-async fn handle_active_leaves_update(
- ctx: &mut Context,
- update: ActiveLeavesUpdate,
- jobs: &mut HashMap>,
- keystore: &KeystorePtr,
- background_validation_tx: &mpsc::Sender<(Hash, ValidatedCandidateCommand)>,
- metrics: &Metrics,
-) -> Result<(), Error> {
- for deactivated in update.deactivated {
- jobs.remove(&deactivated);
- }
-
- let leaf = match update.activated {
- None => return Ok(()),
- Some(a) => a,
- };
-
- macro_rules! try_runtime_api {
- ($x: expr) => {
- match $x {
- Ok(x) => x,
- Err(e) => {
- gum::warn!(
- target: LOG_TARGET,
- err = ?e,
- "Failed to fetch runtime API data for job",
- );
-
- // We can't do candidate validation work if we don't have the
- // requisite runtime API data. But these errors should not take
- // down the node.
- return Ok(());
- }
- }
- }
- }
-
- let parent = leaf.hash;
- let span = PerLeafSpan::new(leaf.span, "backing");
- let _span = span.child("runtime-apis");
-
- let (validators, groups, session_index, cores) = futures::try_join!(
- request_validators(parent, ctx.sender()).await,
- request_validator_groups(parent, ctx.sender()).await,
- request_session_index_for_child(parent, ctx.sender()).await,
- request_from_runtime(parent, ctx.sender(), |tx| {
- RuntimeApiRequest::AvailabilityCores(tx)
- },)
- .await,
- )
- .map_err(Error::JoinMultiple)?;
-
- let validators: Vec<_> = try_runtime_api!(validators);
- let (validator_groups, group_rotation_info) = try_runtime_api!(groups);
- let session_index = try_runtime_api!(session_index);
- let cores = try_runtime_api!(cores);
-
- drop(_span);
- let _span = span.child("validator-construction");
-
- let signing_context = SigningContext { parent_hash: parent, session_index };
- let validator =
- match Validator::construct(&validators, signing_context.clone(), keystore.clone()) {
- Ok(v) => Some(v),
- Err(util::Error::NotAValidator) => None,
- Err(e) => {
- gum::warn!(
- target: LOG_TARGET,
- err = ?e,
- "Cannot participate in candidate backing",
- );
-
- return Ok(())
- },
- };
-
- drop(_span);
- let mut assignments_span = span.child("compute-assignments");
-
- let mut groups = HashMap::new();
-
- let n_cores = cores.len();
-
- let mut assignment = None;
-
- for (idx, core) in cores.into_iter().enumerate() {
- // Ignore prospective assignments on occupied cores for the time being.
- if let CoreState::Scheduled(scheduled) = core {
- let core_index = CoreIndex(idx as _);
- let group_index = group_rotation_info.group_for_core(core_index, n_cores);
- if let Some(g) = validator_groups.get(group_index.0 as usize) {
- if validator.as_ref().map_or(false, |v| g.contains(&v.index())) {
- assignment = Some((scheduled.para_id, scheduled.collator));
- }
- groups.insert(scheduled.para_id, g.clone());
- }
- }
- }
-
- let table_context = TableContext { groups, validators, validator };
-
- let (assignment, required_collator) = match assignment {
- None => {
- assignments_span.add_string_tag("assigned", "false");
- (None, None)
- },
- Some((assignment, required_collator)) => {
- assignments_span.add_string_tag("assigned", "true");
- assignments_span.add_para_id(assignment);
- (Some(assignment), required_collator)
- },
- };
-
- drop(assignments_span);
- let _span = span.child("wait-for-job");
-
- let job = CandidateBackingJob {
- parent,
- assignment,
- required_collator,
- issued_statements: HashSet::new(),
- awaiting_validation: HashSet::new(),
- fallbacks: HashMap::new(),
- seconded: None,
- unbacked_candidates: HashMap::new(),
- backed: HashSet::new(),
- keystore: keystore.clone(),
- table: Table::default(),
- table_context,
- background_validation_tx: background_validation_tx.clone(),
- metrics: metrics.clone(),
- _marker: std::marker::PhantomData,
- };
-
- jobs.insert(parent, JobAndSpan { job, span });
-
- Ok(())
-}
-
-struct JobAndSpan {
- job: CandidateBackingJob,
- span: PerLeafSpan,
-}
-
-/// Holds all data needed for candidate backing job operation.
-struct CandidateBackingJob {
- /// The hash of the relay parent on top of which this job is doing it's work.
- parent: Hash,
- /// The `ParaId` assigned to this validator
- assignment: Option,
- /// The collator required to author the candidate, if any.
- required_collator: Option,
- /// Spans for all candidates that are not yet backable.
- unbacked_candidates: HashMap,
- /// We issued `Seconded`, `Valid` or `Invalid` statements on about these candidates.
- issued_statements: HashSet,
- /// These candidates are undergoing validation in the background.
- awaiting_validation: HashSet,
- /// Data needed for retrying in case of `ValidatedCandidateCommand::AttestNoPoV`.
- fallbacks: HashMap)>,
- /// `Some(h)` if this job has already issued `Seconded` statement for some candidate with `h` hash.
- seconded: Option,
- /// The candidates that are includable, by hash. Each entry here indicates
- /// that we've sent the provisioner the backed candidate.
- backed: HashSet,
- keystore: KeystorePtr,
- table: Table,
- table_context: TableContext,
- background_validation_tx: mpsc::Sender<(Hash, ValidatedCandidateCommand)>,
- metrics: Metrics,
- _marker: std::marker::PhantomData,
-}
-
/// In case a backing validator does not provide a PoV, we need to retry with other backing
/// validators.
///
@@ -451,13 +374,6 @@ struct AttestingData {
backing: Vec,
}
-/// How many votes we need to consider a candidate backed.
-///
-/// WARNING: This has to be kept in sync with the runtime check in the inclusion module.
-fn minimum_votes(n_validators: usize) -> usize {
- std::cmp::min(2, n_validators)
-}
-
#[derive(Default)]
struct TableContext {
validator: Option,
@@ -493,10 +409,10 @@ struct InvalidErasureRoot;
// It looks like it's not possible to do an `impl From` given the current state of
// the code. So this does the necessary conversion.
-fn primitive_statement_to_table(s: &SignedFullStatement) -> TableSignedStatement {
+fn primitive_statement_to_table(s: &SignedFullStatementWithPVD) -> TableSignedStatement {
let statement = match s.payload() {
- Statement::Seconded(c) => TableStatement::Seconded(c.clone()),
- Statement::Valid(h) => TableStatement::Valid(*h),
+ StatementWithPVD::Seconded(c, _) => TableStatement::Seconded(c.clone()),
+ StatementWithPVD::Valid(h) => TableStatement::Valid(*h),
};
TableSignedStatement {
@@ -580,21 +496,17 @@ async fn store_available_data(
//
// This will compute the erasure root internally and compare it to the expected erasure root.
// This returns `Err()` iff there is an internal error. Otherwise, it returns either `Ok(Ok(()))` or `Ok(Err(_))`.
-
async fn make_pov_available(
sender: &mut impl overseer::CandidateBackingSenderTrait,
n_validators: usize,
pov: Arc,
candidate_hash: CandidateHash,
- validation_data: polkadot_primitives::PersistedValidationData,
+ validation_data: PersistedValidationData,
expected_erasure_root: Hash,
- span: Option<&jaeger::Span>,
) -> Result, Error> {
let available_data = AvailableData { pov, validation_data };
{
- let _span = span.as_ref().map(|s| s.child("erasure-coding").with_candidate(candidate_hash));
-
let chunks = erasure_coding::obtain_chunks_v1(n_validators, &available_data)?;
let branches = erasure_coding::branches(chunks.as_ref());
@@ -606,8 +518,6 @@ async fn make_pov_available(
}
{
- let _span = span.as_ref().map(|s| s.child("store-data").with_candidate(candidate_hash));
-
store_available_data(sender, n_validators as u32, candidate_hash, available_data).await?;
}
@@ -640,13 +550,17 @@ async fn request_pov(
async fn request_candidate_validation(
sender: &mut impl overseer::CandidateBackingSenderTrait,
+ pvd: PersistedValidationData,
+ code: ValidationCode,
candidate_receipt: CandidateReceipt,
pov: Arc,
) -> Result {
let (tx, rx) = oneshot::channel();
sender
- .send_message(CandidateValidationMessage::ValidateFromChainState(
+ .send_message(CandidateValidationMessage::ValidateFromExhaustive(
+ pvd,
+ code,
candidate_receipt,
pov,
PvfExecTimeoutKind::Backing,
@@ -657,21 +571,26 @@ async fn request_candidate_validation(
match rx.await {
Ok(Ok(validation_result)) => Ok(validation_result),
Ok(Err(err)) => Err(Error::ValidationFailed(err)),
- Err(err) => Err(Error::ValidateFromChainState(err)),
+ Err(err) => Err(Error::ValidateFromExhaustive(err)),
}
}
-type BackgroundValidationResult =
- Result<(CandidateReceipt, CandidateCommitments, Arc), CandidateReceipt>;
+struct BackgroundValidationOutputs {
+ candidate: CandidateReceipt,
+ commitments: CandidateCommitments,
+ persisted_validation_data: PersistedValidationData,
+}
+
+type BackgroundValidationResult = Result;
struct BackgroundValidationParams {
sender: S,
tx_command: mpsc::Sender<(Hash, ValidatedCandidateCommand)>,
candidate: CandidateReceipt,
relay_parent: Hash,
+ persisted_validation_data: PersistedValidationData,
pov: PoVData,
n_validators: usize,
- span: Option,
make_command: F,
}
@@ -686,16 +605,33 @@ async fn validate_and_make_available(
mut tx_command,
candidate,
relay_parent,
+ persisted_validation_data,
pov,
n_validators,
- span,
make_command,
} = params;
+ let validation_code = {
+ let validation_code_hash = candidate.descriptor().validation_code_hash;
+ let (tx, rx) = oneshot::channel();
+ sender
+ .send_message(RuntimeApiMessage::Request(
+ relay_parent,
+ RuntimeApiRequest::ValidationCodeByHash(validation_code_hash, tx),
+ ))
+ .await;
+
+ let code = rx.await.map_err(Error::RuntimeApiUnavailable)?;
+ match code {
+ Err(e) => return Err(Error::FetchValidationCode(validation_code_hash, e)),
+ Ok(None) => return Err(Error::NoValidationCode(validation_code_hash)),
+ Ok(Some(c)) => c,
+ }
+ };
+
let pov = match pov {
PoVData::Ready(pov) => pov,
- PoVData::FetchFromValidator { from_validator, candidate_hash, pov_hash } => {
- let _span = span.as_ref().map(|s| s.child("request-pov"));
+ PoVData::FetchFromValidator { from_validator, candidate_hash, pov_hash } =>
match request_pov(
&mut sender,
relay_parent,
@@ -718,17 +654,18 @@ async fn validate_and_make_available(
},
Err(err) => return Err(err),
Ok(pov) => pov,
- }
- },
+ },
};
let v = {
- let _span = span.as_ref().map(|s| {
- s.child("request-validation")
- .with_pov(&pov)
- .with_para_id(candidate.descriptor().para_id)
- });
- request_candidate_validation(&mut sender, candidate.clone(), pov.clone()).await?
+ request_candidate_validation(
+ &mut sender,
+ persisted_validation_data,
+ validation_code,
+ candidate.clone(),
+ pov.clone(),
+ )
+ .await?
};
let res = match v {
@@ -744,14 +681,17 @@ async fn validate_and_make_available(
n_validators,
pov.clone(),
candidate.hash(),
- validation_data,
+ validation_data.clone(),
candidate.descriptor.erasure_root,
- span.as_ref(),
)
.await?;
match erasure_valid {
- Ok(()) => Ok((candidate, commitments, pov.clone())),
+ Ok(()) => Ok(BackgroundValidationOutputs {
+ candidate,
+ commitments,
+ persisted_validation_data: validation_data,
+ }),
Err(InvalidErasureRoot) => {
gum::debug!(
target: LOG_TARGET,
@@ -787,556 +727,1283 @@ async fn validate_and_make_available(
}
#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
-impl CandidateBackingJob {
- async fn handle_validated_candidate_command(
- &mut self,
- root_span: &jaeger::Span,
- ctx: &mut Context,
- command: ValidatedCandidateCommand,
- ) -> Result<(), Error> {
- let candidate_hash = command.candidate_hash();
- self.awaiting_validation.remove(&candidate_hash);
-
- match command {
- ValidatedCandidateCommand::Second(res) => {
- match res {
- Ok((candidate, commitments, _)) => {
- // sanity check.
- if self.seconded.is_none() &&
- !self.issued_statements.contains(&candidate_hash)
- {
- self.seconded = Some(candidate_hash);
- self.issued_statements.insert(candidate_hash);
- self.metrics.on_candidate_seconded();
-
- let statement = Statement::Seconded(CommittedCandidateReceipt {
- descriptor: candidate.descriptor.clone(),
- commitments,
- });
- if let Some(stmt) = self
- .sign_import_and_distribute_statement(ctx, statement, root_span)?
- {
- // Break cycle - bounded as there is only one candidate to
- // second per block.
- ctx.send_unbounded_message(CollatorProtocolMessage::Seconded(
- self.parent,
- stmt,
- ));
- }
- }
- },
- Err(candidate) => {
- // Break cycle - bounded as there is only one candidate to
- // second per block.
- ctx.send_unbounded_message(CollatorProtocolMessage::Invalid(
- self.parent,
- candidate,
- ));
- },
- }
- },
- ValidatedCandidateCommand::Attest(res) => {
- // We are done - avoid new validation spawns:
- self.fallbacks.remove(&candidate_hash);
- // sanity check.
- if !self.issued_statements.contains(&candidate_hash) {
- if res.is_ok() {
- let statement = Statement::Valid(candidate_hash);
- self.sign_import_and_distribute_statement(ctx, statement, &root_span)?;
- }
- self.issued_statements.insert(candidate_hash);
- }
- },
- ValidatedCandidateCommand::AttestNoPoV(candidate_hash) => {
- if let Some((attesting, span)) = self.fallbacks.get_mut(&candidate_hash) {
- if let Some(index) = attesting.backing.pop() {
- attesting.from_validator = index;
- // Ok, another try:
- let c_span = span.as_ref().map(|s| s.child("try"));
- let attesting = attesting.clone();
- self.kick_off_validation_work(ctx, attesting, c_span).await?
- }
- } else {
- gum::warn!(
- target: LOG_TARGET,
- "AttestNoPoV was triggered without fallback being available."
- );
- debug_assert!(false);
- }
+async fn handle_communication(
+ ctx: &mut Context,
+ state: &mut State,
+ message: CandidateBackingMessage,
+ metrics: &Metrics,
+) -> Result<(), Error> {
+ match message {
+ CandidateBackingMessage::Second(_relay_parent, candidate, pvd, pov) => {
+ handle_second_message(ctx, state, candidate, pvd, pov, metrics).await?;
+ },
+ CandidateBackingMessage::Statement(relay_parent, statement) => {
+ handle_statement_message(ctx, state, relay_parent, statement, metrics).await?;
+ },
+ CandidateBackingMessage::GetBackedCandidates(relay_parent, requested_candidates, tx) =>
+ if let Some(rp_state) = state.per_relay_parent.get(&relay_parent) {
+ handle_get_backed_candidates_message(rp_state, requested_candidates, tx, metrics)?;
+ } else {
+ gum::debug!(
+ target: LOG_TARGET,
+ ?relay_parent,
+ "Received `GetBackedCandidates` for an unknown relay parent."
+ );
},
- }
-
- Ok(())
+ CandidateBackingMessage::CanSecond(request, tx) =>
+ handle_can_second_request(ctx, state, request, tx).await,
}
- async fn background_validate_and_make_available(
- &mut self,
- ctx: &mut Context,
- params: BackgroundValidationParams<
- impl overseer::CandidateBackingSenderTrait,
- impl Fn(BackgroundValidationResult) -> ValidatedCandidateCommand + Send + 'static + Sync,
- >,
- ) -> Result<(), Error> {
- let candidate_hash = params.candidate.hash();
- if self.awaiting_validation.insert(candidate_hash) {
- // spawn background task.
- let bg = async move {
- if let Err(e) = validate_and_make_available(params).await {
- if let Error::BackgroundValidationMpsc(error) = e {
- gum::debug!(
- target: LOG_TARGET,
- ?error,
- "Mpsc background validation mpsc died during validation- leaf no longer active?"
- );
- } else {
- gum::error!(
- target: LOG_TARGET,
- "Failed to validate and make available: {:?}",
- e
- );
- }
- }
- };
+ Ok(())
+}
- ctx.spawn("backing-validation", bg.boxed())
- .map_err(|_| Error::FailedToSpawnBackgroundTask)?;
- }
+#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
+async fn handle_active_leaves_update(
+ ctx: &mut Context,
+ update: ActiveLeavesUpdate,
+ state: &mut State,
+) -> Result<(), Error> {
+ enum LeafHasProspectiveParachains {
+ Enabled(Result),
+ Disabled,
+ }
+
+ // Activate in implicit view before deactivate, per the docs
+ // on ImplicitView, this is more efficient.
+ let res = if let Some(leaf) = update.activated {
+ // Only activate in implicit view if prospective
+ // parachains are enabled.
+ let mode = prospective_parachains_mode(ctx.sender(), leaf.hash).await?;
+
+ let leaf_hash = leaf.hash;
+ Some((
+ leaf,
+ match mode {
+ ProspectiveParachainsMode::Disabled => LeafHasProspectiveParachains::Disabled,
+ ProspectiveParachainsMode::Enabled { .. } => LeafHasProspectiveParachains::Enabled(
+ state.implicit_view.activate_leaf(ctx.sender(), leaf_hash).await.map(|_| mode),
+ ),
+ },
+ ))
+ } else {
+ None
+ };
- Ok(())
+ for deactivated in update.deactivated {
+ state.per_leaf.remove(&deactivated);
+ state.implicit_view.deactivate_leaf(deactivated);
}
- /// Kick off background validation with intent to second.
- async fn validate_and_second(
- &mut self,
- parent_span: &jaeger::Span,
- root_span: &jaeger::Span,
- ctx: &mut Context,
- candidate: &CandidateReceipt,
- pov: Arc,
- ) -> Result<(), Error> {
- // Check that candidate is collated by the right collator.
- if self
- .required_collator
- .as_ref()
- .map_or(false, |c| c != &candidate.descriptor().collator)
- {
- // Break cycle - bounded as there is only one candidate to
- // second per block.
- ctx.send_unbounded_message(CollatorProtocolMessage::Invalid(
- self.parent,
- candidate.clone(),
- ));
+ // clean up `per_relay_parent` according to ancestry
+ // of leaves. we do this so we can clean up candidates right after
+ // as a result.
+ //
+ // when prospective parachains are disabled, the implicit view is empty,
+ // which means we'll clean up everything. This is correct.
+ {
+ let remaining: HashSet<_> = state.implicit_view.all_allowed_relay_parents().collect();
+ state.per_relay_parent.retain(|r, _| remaining.contains(&r));
+ }
+
+ // clean up `per_candidate` according to which relay-parents
+ // are known.
+ //
+ // when prospective parachains are disabled, we clean up all candidates
+ // because we've cleaned up all relay parents. this is correct.
+ state
+ .per_candidate
+ .retain(|_, pc| state.per_relay_parent.contains_key(&pc.relay_parent));
+
+ // Get relay parents which might be fresh but might be known already
+ // that are explicit or implicit from the new active leaf.
+ let (fresh_relay_parents, leaf_mode) = match res {
+ None => return Ok(()),
+ Some((leaf, LeafHasProspectiveParachains::Disabled)) => {
+ // defensive in this case - for enabled, this manifests as an error.
+ if state.per_leaf.contains_key(&leaf.hash) {
+ return Ok(())
+ }
+
+ state.per_leaf.insert(
+ leaf.hash,
+ ActiveLeafState {
+ prospective_parachains_mode: ProspectiveParachainsMode::Disabled,
+ // This is empty because the only allowed relay-parent and depth
+ // when prospective parachains are disabled is the leaf hash and 0,
+ // respectively. We've just learned about the leaf hash, so we cannot
+ // have any candidates seconded with it as a relay-parent yet.
+ seconded_at_depth: HashMap::new(),
+ },
+ );
+
+ (vec![leaf.hash], ProspectiveParachainsMode::Disabled)
+ },
+ Some((leaf, LeafHasProspectiveParachains::Enabled(Ok(prospective_parachains_mode)))) => {
+ let fresh_relay_parents =
+ state.implicit_view.known_allowed_relay_parents_under(&leaf.hash, None);
+
+ // At this point, all candidates outside of the implicit view
+ // have been cleaned up. For all which remain, which we've seconded,
+ // we ask the prospective parachains subsystem where they land in the fragment
+ // tree for the given active leaf. This comprises our `seconded_at_depth`.
+
+ let remaining_seconded = state
+ .per_candidate
+ .iter()
+ .filter(|(_, cd)| cd.seconded_locally)
+ .map(|(c_hash, cd)| (*c_hash, cd.para_id));
+
+ // one-to-one correspondence to remaining_seconded
+ let mut membership_answers = FuturesOrdered::new();
+
+ for (candidate_hash, para_id) in remaining_seconded {
+ let (tx, rx) = oneshot::channel();
+ membership_answers
+ .push_back(rx.map_ok(move |membership| (para_id, candidate_hash, membership)));
+
+ ctx.send_message(ProspectiveParachainsMessage::GetTreeMembership(
+ para_id,
+ candidate_hash,
+ tx,
+ ))
+ .await;
+ }
+
+ let mut seconded_at_depth = HashMap::new();
+ if let Some(response) = membership_answers.next().await {
+ match response {
+ Err(oneshot::Canceled) => {
+ gum::warn!(
+ target: LOG_TARGET,
+ "Prospective parachains subsystem unreachable for membership request",
+ );
+ },
+ Ok((para_id, candidate_hash, membership)) => {
+ // This request gives membership in all fragment trees. We have some
+ // wasted data here, and it can be optimized if it proves
+ // relevant to performance.
+ if let Some((_, depths)) =
+ membership.into_iter().find(|(leaf_hash, _)| leaf_hash == &leaf.hash)
+ {
+ let para_entry: &mut BTreeMap =
+ seconded_at_depth.entry(para_id).or_default();
+ for depth in depths {
+ para_entry.insert(depth, candidate_hash);
+ }
+ }
+ },
+ }
+ }
+
+ state.per_leaf.insert(
+ leaf.hash,
+ ActiveLeafState { prospective_parachains_mode, seconded_at_depth },
+ );
+
+ let fresh_relay_parent = match fresh_relay_parents {
+ Some(f) => f.to_vec(),
+ None => {
+ gum::warn!(
+ target: LOG_TARGET,
+ leaf_hash = ?leaf.hash,
+ "Implicit view gave no relay-parents"
+ );
+
+ vec![leaf.hash]
+ },
+ };
+ (fresh_relay_parent, prospective_parachains_mode)
+ },
+ Some((leaf, LeafHasProspectiveParachains::Enabled(Err(e)))) => {
+ gum::debug!(
+ target: LOG_TARGET,
+ leaf_hash = ?leaf.hash,
+ err = ?e,
+ "Failed to load implicit view for leaf."
+ );
+
return Ok(())
+ },
+ };
+
+ // add entries in `per_relay_parent`. for all new relay-parents.
+ for maybe_new in fresh_relay_parents {
+ if state.per_relay_parent.contains_key(&maybe_new) {
+ continue
}
- let candidate_hash = candidate.hash();
- let mut span = self.get_unbacked_validation_child(
- root_span,
- candidate_hash,
- candidate.descriptor().para_id,
- );
+ let mode = match state.per_leaf.get(&maybe_new) {
+ None => {
+ // If the relay-parent isn't a leaf itself,
+ // then it is guaranteed by the prospective parachains
+ // subsystem that it is an ancestor of a leaf which
+ // has prospective parachains enabled and that the
+ // block itself did.
+ leaf_mode
+ },
+ Some(l) => l.prospective_parachains_mode,
+ };
- span.as_mut().map(|span| span.add_follows_from(parent_span));
+ // construct a `PerRelayParent` from the runtime API
+ // and insert it.
+ let per = construct_per_relay_parent_state(ctx, maybe_new, &state.keystore, mode).await?;
- gum::debug!(
- target: LOG_TARGET,
- candidate_hash = ?candidate_hash,
- candidate_receipt = ?candidate,
- "Validate and second candidate",
- );
+ if let Some(per) = per {
+ state.per_relay_parent.insert(maybe_new, per);
+ }
+ }
- let bg_sender = ctx.sender().clone();
- self.background_validate_and_make_available(
- ctx,
- BackgroundValidationParams {
- sender: bg_sender,
- tx_command: self.background_validation_tx.clone(),
- candidate: candidate.clone(),
- relay_parent: self.parent,
- pov: PoVData::Ready(pov),
- n_validators: self.table_context.validators.len(),
- span,
- make_command: ValidatedCandidateCommand::Second,
+ Ok(())
+}
+
+/// Load the data necessary to do backing work on top of a relay-parent.
+#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
+async fn construct_per_relay_parent_state(
+ ctx: &mut Context,
+ relay_parent: Hash,
+ keystore: &KeystorePtr,
+ mode: ProspectiveParachainsMode,
+) -> Result, Error> {
+ macro_rules! try_runtime_api {
+ ($x: expr) => {
+ match $x {
+ Ok(x) => x,
+ Err(e) => {
+ gum::warn!(
+ target: LOG_TARGET,
+ err = ?e,
+ "Failed to fetch runtime API data for job",
+ );
+
+ // We can't do candidate validation work if we don't have the
+ // requisite runtime API data. But these errors should not take
+ // down the node.
+ return Ok(None);
+ }
+ }
+ }
+ }
+
+ let parent = relay_parent;
+
+ let (validators, groups, session_index, cores) = futures::try_join!(
+ request_validators(parent, ctx.sender()).await,
+ request_validator_groups(parent, ctx.sender()).await,
+ request_session_index_for_child(parent, ctx.sender()).await,
+ request_from_runtime(parent, ctx.sender(), |tx| {
+ RuntimeApiRequest::AvailabilityCores(tx)
+ },)
+ .await,
+ )
+ .map_err(Error::JoinMultiple)?;
+
+ let validators: Vec<_> = try_runtime_api!(validators);
+ let (validator_groups, group_rotation_info) = try_runtime_api!(groups);
+ let session_index = try_runtime_api!(session_index);
+ let cores = try_runtime_api!(cores);
+
+ let signing_context = SigningContext { parent_hash: parent, session_index };
+ let validator =
+ match Validator::construct(&validators, signing_context.clone(), keystore.clone()) {
+ Ok(v) => Some(v),
+ Err(util::Error::NotAValidator) => None,
+ Err(e) => {
+ gum::warn!(
+ target: LOG_TARGET,
+ err = ?e,
+ "Cannot participate in candidate backing",
+ );
+
+ return Ok(None)
},
- )
- .await?;
+ };
+
+ let mut groups = HashMap::new();
+ let n_cores = cores.len();
+ let mut assignment = None;
+
+ for (idx, core) in cores.into_iter().enumerate() {
+ let core_para_id = match core {
+ CoreState::Scheduled(scheduled) => scheduled.para_id,
+ CoreState::Occupied(occupied) =>
+ if mode.is_enabled() {
+ // Async backing makes it legal to build on top of
+ // occupied core.
+ occupied.candidate_descriptor.para_id
+ } else {
+ continue
+ },
+ CoreState::Free => continue,
+ };
- Ok(())
+ let core_index = CoreIndex(idx as _);
+ let group_index = group_rotation_info.group_for_core(core_index, n_cores);
+ if let Some(g) = validator_groups.get(group_index.0 as usize) {
+ if validator.as_ref().map_or(false, |v| g.contains(&v.index())) {
+ assignment = Some(core_para_id);
+ }
+ groups.insert(core_para_id, g.clone());
+ }
}
- fn sign_import_and_distribute_statement(
- &mut self,
- ctx: &mut Context,
- statement: Statement,
- root_span: &jaeger::Span,
- ) -> Result, Error> {
- if let Some(signed_statement) = self.sign_statement(statement) {
- self.import_statement(ctx, &signed_statement, root_span)?;
- let smsg = StatementDistributionMessage::Share(self.parent, signed_statement.clone());
- ctx.send_unbounded_message(smsg);
-
- Ok(Some(signed_statement))
+ let table_context = TableContext { groups, validators, validator };
+ let table_config = TableConfig {
+ allow_multiple_seconded: match mode {
+ ProspectiveParachainsMode::Enabled { .. } => true,
+ ProspectiveParachainsMode::Disabled => false,
+ },
+ };
+
+ Ok(Some(PerRelayParentState {
+ prospective_parachains_mode: mode,
+ parent,
+ assignment,
+ backed: HashSet::new(),
+ table: Table::new(table_config),
+ table_context,
+ issued_statements: HashSet::new(),
+ awaiting_validation: HashSet::new(),
+ fallbacks: HashMap::new(),
+ }))
+}
+
+enum SecondingAllowed {
+ No,
+ Yes(Vec<(Hash, Vec)>),
+}
+
+/// Checks whether a candidate can be seconded based on its hypothetical frontiers in the fragment
+/// tree and what we've already seconded in all active leaves.
+#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
+async fn seconding_sanity_check(
+ ctx: &mut Context,
+ active_leaves: &HashMap,
+ implicit_view: &ImplicitView,
+ hypothetical_candidate: HypotheticalCandidate,
+ backed_in_path_only: bool,
+) -> SecondingAllowed {
+ let mut membership = Vec::new();
+ let mut responses = FuturesOrdered::>>::new();
+
+ let candidate_para = hypothetical_candidate.candidate_para();
+ let candidate_relay_parent = hypothetical_candidate.relay_parent();
+ let candidate_hash = hypothetical_candidate.candidate_hash();
+
+ for (head, leaf_state) in active_leaves {
+ if leaf_state.prospective_parachains_mode.is_enabled() {
+ // Check that the candidate relay parent is allowed for para, skip the
+ // leaf otherwise.
+ let allowed_parents_for_para =
+ implicit_view.known_allowed_relay_parents_under(head, Some(candidate_para));
+ if !allowed_parents_for_para.unwrap_or_default().contains(&candidate_relay_parent) {
+ continue
+ }
+
+ let (tx, rx) = oneshot::channel();
+ ctx.send_message(ProspectiveParachainsMessage::GetHypotheticalFrontier(
+ HypotheticalFrontierRequest {
+ candidates: vec![hypothetical_candidate.clone()],
+ fragment_tree_relay_parent: Some(*head),
+ backed_in_path_only,
+ },
+ tx,
+ ))
+ .await;
+ let response = rx.map_ok(move |frontiers| {
+ let depths: Vec = frontiers
+ .into_iter()
+ .flat_map(|(candidate, memberships)| {
+ debug_assert_eq!(candidate.candidate_hash(), candidate_hash);
+ memberships.into_iter().flat_map(|(relay_parent, depths)| {
+ debug_assert_eq!(relay_parent, *head);
+ depths
+ })
+ })
+ .collect();
+ (depths, head, leaf_state)
+ });
+ responses.push_back(response.boxed());
} else {
- Ok(None)
+ if *head == candidate_relay_parent {
+ if leaf_state
+ .seconded_at_depth
+ .get(&candidate_para)
+ .map_or(false, |occupied| occupied.contains_key(&0))
+ {
+ // The leaf is already occupied.
+ return SecondingAllowed::No
+ }
+ responses.push_back(futures::future::ok((vec![0], head, leaf_state)).boxed());
+ }
}
}
- /// Check if there have happened any new misbehaviors and issue necessary messages.
- fn issue_new_misbehaviors(&mut self, sender: &mut impl overseer::CandidateBackingSenderTrait) {
- // collect the misbehaviors to avoid double mutable self borrow issues
- let misbehaviors: Vec<_> = self.table.drain_misbehaviors().collect();
- for (validator_id, report) in misbehaviors {
- // The provisioner waits on candidate-backing, which means
- // that we need to send unbounded messages to avoid cycles.
- //
- // Misbehaviors are bounded by the number of validators and
- // the block production protocol.
- sender.send_unbounded_message(ProvisionerMessage::ProvisionableData(
- self.parent,
- ProvisionableData::MisbehaviorReport(self.parent, validator_id, report),
- ));
+ if responses.is_empty() {
+ return SecondingAllowed::No
+ }
+
+ while let Some(response) = responses.next().await {
+ match response {
+ Err(oneshot::Canceled) => {
+ gum::warn!(
+ target: LOG_TARGET,
+ "Failed to reach prospective parachains subsystem for hypothetical frontiers",
+ );
+
+ return SecondingAllowed::No
+ },
+ Ok((depths, head, leaf_state)) => {
+ for depth in &depths {
+ if leaf_state
+ .seconded_at_depth
+ .get(&candidate_para)
+ .map_or(false, |occupied| occupied.contains_key(&depth))
+ {
+ gum::debug!(
+ target: LOG_TARGET,
+ ?candidate_hash,
+ depth,
+ leaf_hash = ?head,
+ "Refusing to second candidate at depth - already occupied."
+ );
+
+ return SecondingAllowed::No
+ }
+ }
+
+ membership.push((*head, depths));
+ },
}
}
- /// Import a statement into the statement table and return the summary of the import.
- fn import_statement(
- &mut self,
- ctx: &mut Context,
- statement: &SignedFullStatement,
- root_span: &jaeger::Span,
- ) -> Result, Error> {
- gum::debug!(
- target: LOG_TARGET,
- statement = ?statement.payload().to_compact(),
- validator_index = statement.validator_index().0,
- "Importing statement",
- );
+ // At this point we've checked the depths of the candidate against all active
+ // leaves.
+ SecondingAllowed::Yes(membership)
+}
- let candidate_hash = statement.payload().candidate_hash();
- let import_statement_span = {
- // create a span only for candidates we're already aware of.
- self.get_unbacked_statement_child(
- root_span,
- candidate_hash,
- statement.validator_index(),
- )
+/// Performs seconding sanity check for an advertisement.
+#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
+async fn handle_can_second_request(
+ ctx: &mut Context,
+ state: &State,
+ request: CanSecondRequest,
+ tx: oneshot::Sender,
+) {
+ let relay_parent = request.candidate_relay_parent;
+ let response = if state
+ .per_relay_parent
+ .get(&relay_parent)
+ .map_or(false, |pr_state| pr_state.prospective_parachains_mode.is_enabled())
+ {
+ let hypothetical_candidate = HypotheticalCandidate::Incomplete {
+ candidate_hash: request.candidate_hash,
+ candidate_para: request.candidate_para_id,
+ parent_head_data_hash: request.parent_head_data_hash,
+ candidate_relay_parent: relay_parent,
};
- let stmt = primitive_statement_to_table(statement);
+ let result = seconding_sanity_check(
+ ctx,
+ &state.per_leaf,
+ &state.implicit_view,
+ hypothetical_candidate,
+ true,
+ )
+ .await;
- let summary = self.table.import_statement(&self.table_context, stmt);
+ match result {
+ SecondingAllowed::No => false,
+ SecondingAllowed::Yes(membership) => {
+ // Candidate should be recognized by at least some fragment tree.
+ membership.iter().any(|(_, m)| !m.is_empty())
+ },
+ }
+ } else {
+ // Relay parent is unknown or async backing is disabled.
+ false
+ };
- let unbacked_span = if let Some(attested) = summary
- .as_ref()
- .and_then(|s| self.table.attested_candidate(&s.candidate, &self.table_context))
- {
- let candidate_hash = attested.candidate.hash();
- // `HashSet::insert` returns true if the thing wasn't in there already.
- if self.backed.insert(candidate_hash) {
- let span = self.remove_unbacked_span(&candidate_hash);
+ let _ = tx.send(response);
+}
- if let Some(backed) = table_attested_to_backed(attested, &self.table_context) {
- gum::debug!(
- target: LOG_TARGET,
- candidate_hash = ?candidate_hash,
- relay_parent = ?self.parent,
- para_id = %backed.candidate.descriptor.para_id,
- "Candidate backed",
- );
+#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
+async fn handle_validated_candidate_command(
+ ctx: &mut Context,
+ state: &mut State,
+ relay_parent: Hash,
+ command: ValidatedCandidateCommand,
+ metrics: &Metrics,
+) -> Result<(), Error> {
+ match state.per_relay_parent.get_mut(&relay_parent) {
+ Some(rp_state) => {
+ let candidate_hash = command.candidate_hash();
+ rp_state.awaiting_validation.remove(&candidate_hash);
+
+ match command {
+ ValidatedCandidateCommand::Second(res) => match res {
+ Ok(outputs) => {
+ let BackgroundValidationOutputs {
+ candidate,
+ commitments,
+ persisted_validation_data,
+ } = outputs;
+ if rp_state.issued_statements.contains(&candidate_hash) {
+ return Ok(())
+ }
+
+ let receipt = CommittedCandidateReceipt {
+ descriptor: candidate.descriptor.clone(),
+ commitments,
+ };
+
+ let parent_head_data_hash = persisted_validation_data.parent_head.hash();
+ // Note that `GetHypotheticalFrontier` doesn't account for recursion,
+ // i.e. candidates can appear at multiple depths in the tree and in fact
+ // at all depths, and we don't know what depths a candidate will ultimately occupy
+ // because that's dependent on other candidates we haven't yet received.
+ //
+ // The only way to effectively rule this out is to have candidate receipts
+ // directly commit to the parachain block number or some other incrementing
+ // counter. That requires a major primitives format upgrade, so for now
+ // we just rule out trivial cycles.
+ if parent_head_data_hash == receipt.commitments.head_data.hash() {
+ return Ok(())
+ }
+ let hypothetical_candidate = HypotheticalCandidate::Complete {
+ candidate_hash,
+ receipt: Arc::new(receipt.clone()),
+ persisted_validation_data: persisted_validation_data.clone(),
+ };
+ // sanity check that we're allowed to second the candidate
+ // and that it doesn't conflict with other candidates we've
+ // seconded.
+ let fragment_tree_membership = match seconding_sanity_check(
+ ctx,
+ &state.per_leaf,
+ &state.implicit_view,
+ hypothetical_candidate,
+ false,
+ )
+ .await
+ {
+ SecondingAllowed::No => return Ok(()),
+ SecondingAllowed::Yes(membership) => membership,
+ };
+
+ let statement =
+ StatementWithPVD::Seconded(receipt, persisted_validation_data);
+
+ // If we get an Error::RejectedByProspectiveParachains,
+ // then the statement has not been distributed or imported into
+ // the table.
+ let res = sign_import_and_distribute_statement(
+ ctx,
+ rp_state,
+ &mut state.per_candidate,
+ statement,
+ state.keystore.clone(),
+ metrics,
+ )
+ .await;
+
+ if let Err(Error::RejectedByProspectiveParachains) = res {
+ let candidate_hash = candidate.hash();
+ gum::debug!(
+ target: LOG_TARGET,
+ relay_parent = ?candidate.descriptor().relay_parent,
+ ?candidate_hash,
+ "Attempted to second candidate but was rejected by prospective parachains",
+ );
+
+ // Ensure the collator is reported.
+ ctx.send_message(CollatorProtocolMessage::Invalid(
+ candidate.descriptor().relay_parent,
+ candidate,
+ ))
+ .await;
+
+ return Ok(())
+ }
+
+ if let Some(stmt) = res? {
+ match state.per_candidate.get_mut(&candidate_hash) {
+ None => {
+ gum::warn!(
+ target: LOG_TARGET,
+ ?candidate_hash,
+ "Missing `per_candidate` for seconded candidate.",
+ );
+ },
+ Some(p) => p.seconded_locally = true,
+ }
+
+ // update seconded depths in active leaves.
+ for (leaf, depths) in fragment_tree_membership {
+ let leaf_data = match state.per_leaf.get_mut(&leaf) {
+ None => {
+ gum::warn!(
+ target: LOG_TARGET,
+ leaf_hash = ?leaf,
+ "Missing `per_leaf` for known active leaf."
+ );
+
+ continue
+ },
+ Some(d) => d,
+ };
+
+ let seconded_at_depth = leaf_data
+ .seconded_at_depth
+ .entry(candidate.descriptor().para_id)
+ .or_default();
+
+ for depth in depths {
+ seconded_at_depth.insert(depth, candidate_hash);
+ }
+ }
+
+ rp_state.issued_statements.insert(candidate_hash);
+
+ metrics.on_candidate_seconded();
+ ctx.send_message(CollatorProtocolMessage::Seconded(
+ rp_state.parent,
+ StatementWithPVD::drop_pvd_from_signed(stmt),
+ ))
+ .await;
+ }
+ },
+ Err(candidate) => {
+ ctx.send_message(CollatorProtocolMessage::Invalid(
+ rp_state.parent,
+ candidate,
+ ))
+ .await;
+ },
+ },
+ ValidatedCandidateCommand::Attest(res) => {
+ // We are done - avoid new validation spawns:
+ rp_state.fallbacks.remove(&candidate_hash);
+ // sanity check.
+ if !rp_state.issued_statements.contains(&candidate_hash) {
+ if res.is_ok() {
+ let statement = StatementWithPVD::Valid(candidate_hash);
+
+ sign_import_and_distribute_statement(
+ ctx,
+ rp_state,
+ &mut state.per_candidate,
+ statement,
+ state.keystore.clone(),
+ metrics,
+ )
+ .await?;
+ }
+ rp_state.issued_statements.insert(candidate_hash);
+ }
+ },
+ ValidatedCandidateCommand::AttestNoPoV(candidate_hash) => {
+ if let Some(attesting) = rp_state.fallbacks.get_mut(&candidate_hash) {
+ if let Some(index) = attesting.backing.pop() {
+ attesting.from_validator = index;
+ let attesting = attesting.clone();
+
+ // The candidate state should be available because we've
+ // validated it before, the relay-parent is still around,
+ // and candidates are pruned on the basis of relay-parents.
+ //
+ // If it's not, then no point in validating it anyway.
+ if let Some(pvd) = state
+ .per_candidate
+ .get(&candidate_hash)
+ .map(|pc| pc.persisted_validation_data.clone())
+ {
+ kick_off_validation_work(
+ ctx,
+ rp_state,
+ pvd,
+ &state.background_validation_tx,
+ attesting,
+ )
+ .await?;
+ }
+ }
+ } else {
+ gum::warn!(
+ target: LOG_TARGET,
+ "AttestNoPoV was triggered without fallback being available."
+ );
+ debug_assert!(false);
+ }
+ },
+ }
+ },
+ None => {
+ // simple race condition; can be ignored = this relay-parent
+ // is no longer relevant.
+ },
+ }
+
+ Ok(())
+}
+
+fn sign_statement(
+ rp_state: &PerRelayParentState,
+ statement: StatementWithPVD,
+ keystore: KeystorePtr,
+ metrics: &Metrics,
+) -> Option {
+ let signed = rp_state
+ .table_context
+ .validator
+ .as_ref()?
+ .sign(keystore, statement)
+ .ok()
+ .flatten()?;
+ metrics.on_statement_signed();
+ Some(signed)
+}
+
+/// Import a statement into the statement table and return the summary of the import.
+///
+/// This will fail with `Error::RejectedByProspectiveParachains` if the message type
+/// is seconded, the candidate is fresh,
+/// and any of the following are true:
+/// 1. There is no `PersistedValidationData` attached.
+/// 2. Prospective parachains are enabled for the relay parent and the prospective parachains
+/// subsystem returned an empty `FragmentTreeMembership`
+/// i.e. did not recognize the candidate as being applicable to any of the active leaves.
+#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
+async fn import_statement(
+ ctx: &mut Context,
+ rp_state: &mut PerRelayParentState,
+ per_candidate: &mut HashMap,
+ statement: &SignedFullStatementWithPVD,
+) -> Result, Error> {
+ gum::debug!(
+ target: LOG_TARGET,
+ statement = ?statement.payload().to_compact(),
+ validator_index = statement.validator_index().0,
+ "Importing statement",
+ );
+
+ let candidate_hash = statement.payload().candidate_hash();
+
+ // If this is a new candidate (statement is 'seconded' and candidate is unknown),
+ // we need to create an entry in the `PerCandidateState` map.
+ //
+ // If the relay parent supports prospective parachains, we also need
+ // to inform the prospective parachains subsystem of the seconded candidate.
+ // If `ProspectiveParachainsMessage::Second` fails, then we return
+ // Error::RejectedByProspectiveParachains.
+ //
+ // Persisted Validation Data should be available - it may already be available
+ // if this is a candidate we are seconding.
+ //
+ // We should also not accept any candidates which have no valid depths under any of
+ // our active leaves.
+ if let StatementWithPVD::Seconded(candidate, pvd) = statement.payload() {
+ if !per_candidate.contains_key(&candidate_hash) {
+ if rp_state.prospective_parachains_mode.is_enabled() {
+ let (tx, rx) = oneshot::channel();
+ ctx.send_message(ProspectiveParachainsMessage::IntroduceCandidate(
+ IntroduceCandidateRequest {
+ candidate_para: candidate.descriptor().para_id,
+ candidate_receipt: candidate.clone(),
+ persisted_validation_data: pvd.clone(),
+ },
+ tx,
+ ))
+ .await;
+
+ match rx.await {
+ Err(oneshot::Canceled) => {
+ gum::warn!(
+ target: LOG_TARGET,
+ "Could not reach the Prospective Parachains subsystem."
+ );
+
+ return Err(Error::RejectedByProspectiveParachains)
+ },
+ Ok(membership) =>
+ if membership.is_empty() {
+ return Err(Error::RejectedByProspectiveParachains)
+ },
+ }
+
+ ctx.send_message(ProspectiveParachainsMessage::CandidateSeconded(
+ candidate.descriptor().para_id,
+ candidate_hash,
+ ))
+ .await;
+ }
+
+ // Only save the candidate if it was approved by prospective parachains.
+ per_candidate.insert(
+ candidate_hash,
+ PerCandidateState {
+ persisted_validation_data: pvd.clone(),
+ // This is set after importing when seconding locally.
+ seconded_locally: false,
+ para_id: candidate.descriptor().para_id,
+ relay_parent: candidate.descriptor().relay_parent,
+ },
+ );
+ }
+ }
+
+ let stmt = primitive_statement_to_table(statement);
+
+ Ok(rp_state.table.import_statement(&rp_state.table_context, stmt))
+}
+
+/// Handles a summary received from [`import_statement`] and dispatches `Backed` notifications and
+/// misbehaviors as a result of importing a statement.
+#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
+async fn post_import_statement_actions(
+ ctx: &mut Context,
+ rp_state: &mut PerRelayParentState,
+ summary: Option<&TableSummary>,
+) -> Result<(), Error> {
+ if let Some(attested) = summary
+ .as_ref()
+ .and_then(|s| rp_state.table.attested_candidate(&s.candidate, &rp_state.table_context))
+ {
+ let candidate_hash = attested.candidate.hash();
+
+ // `HashSet::insert` returns true if the thing wasn't in there already.
+ if rp_state.backed.insert(candidate_hash) {
+ if let Some(backed) = table_attested_to_backed(attested, &rp_state.table_context) {
+ let para_id = backed.candidate.descriptor.para_id;
+ gum::debug!(
+ target: LOG_TARGET,
+ candidate_hash = ?candidate_hash,
+ relay_parent = ?rp_state.parent,
+ %para_id,
+ "Candidate backed",
+ );
+
+ if rp_state.prospective_parachains_mode.is_enabled() {
+ // Inform the prospective parachains subsystem
+ // that the candidate is now backed.
+ ctx.send_message(ProspectiveParachainsMessage::CandidateBacked(
+ para_id,
+ candidate_hash,
+ ))
+ .await;
+ // Backed candidate potentially unblocks new advertisements,
+ // notify collator protocol.
+ ctx.send_message(CollatorProtocolMessage::Backed {
+ para_id,
+ para_head: backed.candidate.descriptor.para_head,
+ })
+ .await;
+ // Notify statement distribution of backed candidate.
+ ctx.send_message(StatementDistributionMessage::Backed(candidate_hash)).await;
+ } else {
// The provisioner waits on candidate-backing, which means
// that we need to send unbounded messages to avoid cycles.
//
// Backed candidates are bounded by the number of validators,
// parachains, and the block production rate of the relay chain.
let message = ProvisionerMessage::ProvisionableData(
- self.parent,
+ rp_state.parent,
ProvisionableData::BackedCandidate(backed.receipt()),
);
ctx.send_unbounded_message(message);
-
- span.as_ref().map(|s| s.child("backed"));
- span
- } else {
- None
}
- } else {
- None
}
- } else {
- None
- };
+ }
+ }
- self.issue_new_misbehaviors(ctx.sender());
+ issue_new_misbehaviors(ctx, rp_state.parent, &mut rp_state.table);
- // It is important that the child span is dropped before its parent span (`unbacked_span`)
- drop(import_statement_span);
- drop(unbacked_span);
+ Ok(())
+}
- Ok(summary)
+/// Check if there have happened any new misbehaviors and issue necessary messages.
+#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
+fn issue_new_misbehaviors(
+ ctx: &mut Context,
+ relay_parent: Hash,
+ table: &mut Table,
+) {
+ // collect the misbehaviors to avoid double mutable self borrow issues
+ let misbehaviors: Vec<_> = table.drain_misbehaviors().collect();
+ for (validator_id, report) in misbehaviors {
+ // The provisioner waits on candidate-backing, which means
+ // that we need to send unbounded messages to avoid cycles.
+ //
+ // Misbehaviors are bounded by the number of validators and
+ // the block production protocol.
+ ctx.send_unbounded_message(ProvisionerMessage::ProvisionableData(
+ relay_parent,
+ ProvisionableData::MisbehaviorReport(relay_parent, validator_id, report),
+ ));
}
+}
- async fn handle_second_msg(
- &mut self,
- root_span: &jaeger::Span,
- ctx: &mut Context,
- candidate: CandidateReceipt,
- pov: PoV,
- ) -> Result<(), Error> {
- let _timer = self.metrics.time_process_second();
-
- let candidate_hash = candidate.hash();
- let span = root_span
- .child("second")
- .with_stage(jaeger::Stage::CandidateBacking)
- .with_pov(&pov)
- .with_candidate(candidate_hash)
- .with_relay_parent(self.parent);
-
- // Sanity check that candidate is from our assignment.
- if Some(candidate.descriptor().para_id) != self.assignment {
- gum::debug!(
- target: LOG_TARGET,
- our_assignment = ?self.assignment,
- collation = ?candidate.descriptor().para_id,
- "Subsystem asked to second for para outside of our assignment",
- );
+/// Sign, import, and distribute a statement.
+#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
+async fn sign_import_and_distribute_statement(
+ ctx: &mut Context,
+ rp_state: &mut PerRelayParentState,
+ per_candidate: &mut HashMap,
+ statement: StatementWithPVD,
+ keystore: KeystorePtr,
+ metrics: &Metrics,
+) -> Result, Error> {
+ if let Some(signed_statement) = sign_statement(&*rp_state, statement, keystore, metrics) {
+ let summary = import_statement(ctx, rp_state, per_candidate, &signed_statement).await?;
- return Ok(())
- }
+ // `Share` must always be sent before `Backed`. We send the latter in
+ // `post_import_statement_action` below.
+ let smsg = StatementDistributionMessage::Share(rp_state.parent, signed_statement.clone());
+ ctx.send_unbounded_message(smsg);
- // If the message is a `CandidateBackingMessage::Second`, sign and dispatch a
- // Seconded statement only if we have not seconded any other candidate and
- // have not signed a Valid statement for the requested candidate.
- if self.seconded.is_none() {
- // This job has not seconded a candidate yet.
+ post_import_statement_actions(ctx, rp_state, summary.as_ref()).await?;
- if !self.issued_statements.contains(&candidate_hash) {
- let pov = Arc::new(pov);
- self.validate_and_second(&span, &root_span, ctx, &candidate, pov).await?;
+ Ok(Some(signed_statement))
+ } else {
+ Ok(None)
+ }
+}
+
+#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
+async fn background_validate_and_make_available(
+ ctx: &mut Context,
+ rp_state: &mut PerRelayParentState,
+ params: BackgroundValidationParams<
+ impl overseer::CandidateBackingSenderTrait,
+ impl Fn(BackgroundValidationResult) -> ValidatedCandidateCommand + Send + 'static + Sync,
+ >,
+) -> Result<(), Error> {
+ let candidate_hash = params.candidate.hash();
+ if rp_state.awaiting_validation.insert(candidate_hash) {
+ // spawn background task.
+ let bg = async move {
+ if let Err(e) = validate_and_make_available(params).await {
+ if let Error::BackgroundValidationMpsc(error) = e {
+ gum::debug!(
+ target: LOG_TARGET,
+ ?error,
+ "Mpsc background validation mpsc died during validation- leaf no longer active?"
+ );
+ } else {
+ gum::error!(
+ target: LOG_TARGET,
+ "Failed to validate and make available: {:?}",
+ e
+ );
+ }
}
- }
+ };
- Ok(())
+ ctx.spawn("backing-validation", bg.boxed())
+ .map_err(|_| Error::FailedToSpawnBackgroundTask)?;
}
- async fn handle_statement_message(
- &mut self,
- root_span: &jaeger::Span,
- ctx: &mut Context,
- statement: SignedFullStatement,
- ) -> Result<(), Error> {
- let _timer = self.metrics.time_process_statement();
- let _span = root_span
- .child("statement")
- .with_stage(jaeger::Stage::CandidateBacking)
- .with_candidate(statement.payload().candidate_hash())
- .with_relay_parent(self.parent);
-
- match self.maybe_validate_and_import(&root_span, ctx, statement).await {
- Err(Error::ValidationFailed(_)) => Ok(()),
- Err(e) => Err(e),
- Ok(()) => Ok(()),
- }
+ Ok(())
+}
+
+/// Kick off validation work and distribute the result as a signed statement.
+#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
+async fn kick_off_validation_work(
+ ctx: &mut Context,
+ rp_state: &mut PerRelayParentState,
+ persisted_validation_data: PersistedValidationData,
+ background_validation_tx: &mpsc::Sender<(Hash, ValidatedCandidateCommand)>,
+ attesting: AttestingData,
+) -> Result<(), Error> {
+ let candidate_hash = attesting.candidate.hash();
+ if rp_state.issued_statements.contains(&candidate_hash) {
+ return Ok(())
}
- fn handle_get_backed_candidates_message(
- &mut self,
- requested_candidates: Vec,
- tx: oneshot::Sender>,
- ) -> Result<(), Error> {
- let _timer = self.metrics.time_get_backed_candidates();
+ gum::debug!(
+ target: LOG_TARGET,
+ candidate_hash = ?candidate_hash,
+ candidate_receipt = ?attesting.candidate,
+ "Kicking off validation",
+ );
+
+ let bg_sender = ctx.sender().clone();
+ let pov = PoVData::FetchFromValidator {
+ from_validator: attesting.from_validator,
+ candidate_hash,
+ pov_hash: attesting.pov_hash,
+ };
- let backed = requested_candidates
- .into_iter()
- .filter_map(|hash| {
- self.table
- .attested_candidate(&hash, &self.table_context)
- .and_then(|attested| table_attested_to_backed(attested, &self.table_context))
- })
- .collect();
-
- tx.send(backed).map_err(|data| Error::Send(data))?;
- Ok(())
- }
+ background_validate_and_make_available(
+ ctx,
+ rp_state,
+ BackgroundValidationParams {
+ sender: bg_sender,
+ tx_command: background_validation_tx.clone(),
+ candidate: attesting.candidate,
+ relay_parent: rp_state.parent,
+ persisted_validation_data,
+ pov,
+ n_validators: rp_state.table_context.validators.len(),
+ make_command: ValidatedCandidateCommand::Attest,
+ },
+ )
+ .await
+}
+
+/// Import the statement and kick off validation work if it is a part of our assignment.
+#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
+async fn maybe_validate_and_import(
+ ctx: &mut Context,
+ state: &mut State,
+ relay_parent: Hash,
+ statement: SignedFullStatementWithPVD,
+) -> Result<(), Error> {
+ let rp_state = match state.per_relay_parent.get_mut(&relay_parent) {
+ Some(r) => r,
+ None => {
+ gum::trace!(
+ target: LOG_TARGET,
+ ?relay_parent,
+ "Received statement for unknown relay-parent"
+ );
- /// Kick off validation work and distribute the result as a signed statement.
- async fn kick_off_validation_work(
- &mut self,
- ctx: &mut Context,
- attesting: AttestingData,
- span: Option,
- ) -> Result<(), Error> {
- let candidate_hash = attesting.candidate.hash();
- if self.issued_statements.contains(&candidate_hash) {
return Ok(())
- }
+ },
+ };
- let descriptor = attesting.candidate.descriptor().clone();
+ let res = import_statement(ctx, rp_state, &mut state.per_candidate, &statement).await;
+ // if we get an Error::RejectedByProspectiveParachains,
+ // we will do nothing.
+ if let Err(Error::RejectedByProspectiveParachains) = res {
gum::debug!(
target: LOG_TARGET,
- candidate_hash = ?candidate_hash,
- candidate_receipt = ?attesting.candidate,
- "Kicking off validation",
+ ?relay_parent,
+ "Statement rejected by prospective parachains."
);
- // Check that candidate is collated by the right collator.
- if self.required_collator.as_ref().map_or(false, |c| c != &descriptor.collator) {
- // If not, we've got the statement in the table but we will
- // not issue validation work for it.
- //
- // Act as though we've issued a statement.
- self.issued_statements.insert(candidate_hash);
+ return Ok(())
+ }
+
+ let summary = res?;
+ post_import_statement_actions(ctx, rp_state, summary.as_ref()).await?;
+
+ if let Some(summary) = summary {
+ // import_statement already takes care of communicating with the
+ // prospective parachains subsystem. At this point, the candidate
+ // has already been accepted into the fragment trees.
+
+ let candidate_hash = summary.candidate;
+
+ if Some(summary.group_id) != rp_state.assignment {
return Ok(())
}
+ let attesting = match statement.payload() {
+ StatementWithPVD::Seconded(receipt, _) => {
+ let attesting = AttestingData {
+ candidate: rp_state
+ .table
+ .get_candidate(&candidate_hash)
+ .ok_or(Error::CandidateNotFound)?
+ .to_plain(),
+ pov_hash: receipt.descriptor.pov_hash,
+ from_validator: statement.validator_index(),
+ backing: Vec::new(),
+ };
+ rp_state.fallbacks.insert(summary.candidate, attesting.clone());
+ attesting
+ },
+ StatementWithPVD::Valid(candidate_hash) => {
+ if let Some(attesting) = rp_state.fallbacks.get_mut(candidate_hash) {
+ let our_index = rp_state.table_context.validator.as_ref().map(|v| v.index());
+ if our_index == Some(statement.validator_index()) {
+ return Ok(())
+ }
- let bg_sender = ctx.sender().clone();
- let pov = PoVData::FetchFromValidator {
- from_validator: attesting.from_validator,
- candidate_hash,
- pov_hash: attesting.pov_hash,
- };
- self.background_validate_and_make_available(
- ctx,
- BackgroundValidationParams {
- sender: bg_sender,
- tx_command: self.background_validation_tx.clone(),
- candidate: attesting.candidate,
- relay_parent: self.parent,
- pov,
- n_validators: self.table_context.validators.len(),
- span,
- make_command: ValidatedCandidateCommand::Attest,
+ if rp_state.awaiting_validation.contains(candidate_hash) {
+ // Job already running:
+ attesting.backing.push(statement.validator_index());
+ return Ok(())
+ } else {
+ // No job, so start another with current validator:
+ attesting.from_validator = statement.validator_index();
+ attesting.clone()
+ }
+ } else {
+ return Ok(())
+ }
},
- )
- .await
+ };
+
+ // After `import_statement` succeeds, the candidate entry is guaranteed
+ // to exist.
+ if let Some(pvd) = state
+ .per_candidate
+ .get(&candidate_hash)
+ .map(|pc| pc.persisted_validation_data.clone())
+ {
+ kick_off_validation_work(
+ ctx,
+ rp_state,
+ pvd,
+ &state.background_validation_tx,
+ attesting,
+ )
+ .await?;
+ }
}
+ Ok(())
+}
- /// Import the statement and kick off validation work if it is a part of our assignment.
- async fn maybe_validate_and_import(
- &mut self,
- root_span: &jaeger::Span,
- ctx: &mut Context,
- statement: SignedFullStatement,
- ) -> Result<(), Error> {
- if let Some(summary) = self.import_statement(ctx, &statement, root_span)? {
- if Some(summary.group_id) != self.assignment {
- return Ok(())
- }
- let (attesting, span) = match statement.payload() {
- Statement::Seconded(receipt) => {
- let candidate_hash = summary.candidate;
-
- let span = self.get_unbacked_validation_child(
- root_span,
- summary.candidate,
- summary.group_id,
- );
+/// Kick off background validation with intent to second.
+#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
+async fn validate_and_second(
+ ctx: &mut Context,
+ rp_state: &mut PerRelayParentState,
+ persisted_validation_data: PersistedValidationData,
+ candidate: &CandidateReceipt,
+ pov: Arc,
+ background_validation_tx: &mpsc::Sender<(Hash, ValidatedCandidateCommand)>,
+) -> Result<(), Error> {
+ let candidate_hash = candidate.hash();
+
+ gum::debug!(
+ target: LOG_TARGET,
+ candidate_hash = ?candidate_hash,
+ candidate_receipt = ?candidate,
+ "Validate and second candidate",
+ );
+
+ let bg_sender = ctx.sender().clone();
+ background_validate_and_make_available(
+ ctx,
+ rp_state,
+ BackgroundValidationParams {
+ sender: bg_sender,
+ tx_command: background_validation_tx.clone(),
+ candidate: candidate.clone(),
+ relay_parent: rp_state.parent,
+ persisted_validation_data,
+ pov: PoVData::Ready(pov),
+ n_validators: rp_state.table_context.validators.len(),
+ make_command: ValidatedCandidateCommand::Second,
+ },
+ )
+ .await?;
- let attesting = AttestingData {
- candidate: self
- .table
- .get_candidate(&candidate_hash)
- .ok_or(Error::CandidateNotFound)?
- .to_plain(),
- pov_hash: receipt.descriptor.pov_hash,
- from_validator: statement.validator_index(),
- backing: Vec::new(),
- };
- let child = span.as_ref().map(|s| s.child("try"));
- self.fallbacks.insert(summary.candidate, (attesting.clone(), span));
- (attesting, child)
- },
- Statement::Valid(candidate_hash) => {
- if let Some((attesting, span)) = self.fallbacks.get_mut(candidate_hash) {
- let our_index = self.table_context.validator.as_ref().map(|v| v.index());
- if our_index == Some(statement.validator_index()) {
- return Ok(())
- }
+ Ok(())
+}
- if self.awaiting_validation.contains(candidate_hash) {
- // Job already running:
- attesting.backing.push(statement.validator_index());
- return Ok(())
- } else {
- // No job, so start another with current validator:
- attesting.from_validator = statement.validator_index();
- (attesting.clone(), span.as_ref().map(|s| s.child("try")))
- }
- } else {
- return Ok(())
- }
- },
- };
+#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
+async fn handle_second_message(
+ ctx: &mut Context,
+ state: &mut State,
+ candidate: CandidateReceipt,
+ persisted_validation_data: PersistedValidationData,
+ pov: PoV,
+ metrics: &Metrics,
+) -> Result<(), Error> {
+ let _timer = metrics.time_process_second();
- self.kick_off_validation_work(ctx, attesting, span).await?;
- }
- Ok(())
+ let candidate_hash = candidate.hash();
+ let relay_parent = candidate.descriptor().relay_parent;
+
+ if candidate.descriptor().persisted_validation_data_hash != persisted_validation_data.hash() {
+ gum::warn!(
+ target: LOG_TARGET,
+ ?candidate_hash,
+ "Candidate backing was asked to second candidate with wrong PVD",
+ );
+
+ return Ok(())
}
- fn sign_statement(&mut self, statement: Statement) -> Option {
- let signed = self
- .table_context
- .validator
- .as_ref()?
- .sign(self.keystore.clone(), statement)
- .ok()
- .flatten()?;
- self.metrics.on_statement_signed();
- Some(signed)
+ let rp_state = match state.per_relay_parent.get_mut(&relay_parent) {
+ None => {
+ gum::trace!(
+ target: LOG_TARGET,
+ ?relay_parent,
+ ?candidate_hash,
+ "We were asked to second a candidate outside of our view."
+ );
+
+ return Ok(())
+ },
+ Some(r) => r,
+ };
+
+ // Sanity check that candidate is from our assignment.
+ if Some(candidate.descriptor().para_id) != rp_state.assignment {
+ gum::debug!(
+ target: LOG_TARGET,
+ our_assignment = ?rp_state.assignment,
+ collation = ?candidate.descriptor().para_id,
+ "Subsystem asked to second for para outside of our assignment",
+ );
+
+ return Ok(())
}
- /// Insert or get the unbacked-span for the given candidate hash.
- fn insert_or_get_unbacked_span(
- &mut self,
- parent_span: &jaeger::Span,
- hash: CandidateHash,
- para_id: Option,
- ) -> Option<&jaeger::Span> {
- if !self.backed.contains(&hash) {
- // only add if we don't consider this backed.
- let span = self.unbacked_candidates.entry(hash).or_insert_with(|| {
- let s = parent_span.child("unbacked-candidate").with_candidate(hash);
- if let Some(para_id) = para_id {
- s.with_para_id(para_id)
- } else {
- s
- }
- });
- Some(span)
- } else {
- None
- }
+ // If the message is a `CandidateBackingMessage::Second`, sign and dispatch a
+ // Seconded statement only if we have not signed a Valid statement for the requested candidate.
+ //
+ // The actual logic of issuing the signed statement checks that this isn't
+ // conflicting with other seconded candidates. Not doing that check here
+ // gives other subsystems the ability to get us to execute arbitrary candidates,
+ // but no more.
+ if !rp_state.issued_statements.contains(&candidate_hash) {
+ let pov = Arc::new(pov);
+
+ validate_and_second(
+ ctx,
+ rp_state,
+ persisted_validation_data,
+ &candidate,
+ pov,
+ &state.background_validation_tx,
+ )
+ .await?;
}
- fn get_unbacked_validation_child(
- &mut self,
- parent_span: &jaeger::Span,
- hash: CandidateHash,
- para_id: ParaId,
- ) -> Option {
- self.insert_or_get_unbacked_span(parent_span, hash, Some(para_id)).map(|span| {
- span.child("validation")
- .with_candidate(hash)
- .with_stage(Stage::CandidateBacking)
- })
+ Ok(())
+}
+
+#[overseer::contextbounds(CandidateBacking, prefix = self::overseer)]
+async fn handle_statement_message(
+ ctx: &mut Context,
+ state: &mut State,
+ relay_parent: Hash,
+ statement: SignedFullStatementWithPVD,
+ metrics: &Metrics,
+) -> Result<(), Error> {
+ let _timer = metrics.time_process_statement();
+
+ match maybe_validate_and_import(ctx, state, relay_parent, statement).await {
+ Err(Error::ValidationFailed(_)) => Ok(()),
+ Err(e) => Err(e),
+ Ok(()) => Ok(()),
}
+}
- fn get_unbacked_statement_child(
- &mut self,
- parent_span: &jaeger::Span,
- hash: CandidateHash,
- validator: ValidatorIndex,
- ) -> Option {
- self.insert_or_get_unbacked_span(parent_span, hash, None).map(|span| {
- span.child("import-statement")
- .with_candidate(hash)
- .with_validator_index(validator)
+fn handle_get_backed_candidates_message(
+ rp_state: &PerRelayParentState,
+ requested_candidates: Vec,
+ tx: oneshot::Sender>,
+ metrics: &Metrics,
+) -> Result<(), Error> {
+ let _timer = metrics.time_get_backed_candidates();
+
+ let backed = requested_candidates
+ .into_iter()
+ .filter_map(|hash| {
+ rp_state
+ .table
+ .attested_candidate(&hash, &rp_state.table_context)
+ .and_then(|attested| table_attested_to_backed(attested, &rp_state.table_context))
})
- }
+ .collect();
- fn remove_unbacked_span(&mut self, hash: &CandidateHash) -> Option {
- self.unbacked_candidates.remove(hash)
- }
+ tx.send(backed).map_err(|data| Error::Send(data))?;
+ Ok(())
}
diff --git a/node/core/backing/src/tests.rs b/node/core/backing/src/tests/mod.rs
similarity index 68%
rename from node/core/backing/src/tests.rs
rename to node/core/backing/src/tests/mod.rs
index 631d66e3d776..5cb312abe8cf 100644
--- a/node/core/backing/src/tests.rs
+++ b/node/core/backing/src/tests/mod.rs
@@ -17,22 +17,24 @@
use super::*;
use ::test_helpers::{
dummy_candidate_receipt_bad_sig, dummy_collator, dummy_collator_signature,
- dummy_committed_candidate_receipt, dummy_hash, dummy_validation_code,
+ dummy_committed_candidate_receipt, dummy_hash,
};
use assert_matches::assert_matches;
use futures::{future, Future};
-use polkadot_node_primitives::{BlockData, InvalidCandidate};
+use polkadot_node_primitives::{BlockData, InvalidCandidate, SignedFullStatement, Statement};
use polkadot_node_subsystem::{
+ errors::RuntimeApiError,
+ jaeger,
messages::{
AllMessages, CollatorProtocolMessage, RuntimeApiMessage, RuntimeApiRequest,
ValidationFailed,
},
- ActivatedLeaf, ActiveLeavesUpdate, FromOrchestra, LeafStatus, OverseerSignal,
+ ActivatedLeaf, ActiveLeavesUpdate, FromOrchestra, LeafStatus, OverseerSignal, TimeoutExt,
};
use polkadot_node_subsystem_test_helpers as test_helpers;
use polkadot_primitives::{
- CandidateDescriptor, CollatorId, GroupRotationInfo, HeadData, PersistedValidationData,
- PvfExecTimeoutKind, ScheduledCore,
+ CandidateDescriptor, GroupRotationInfo, HeadData, PersistedValidationData, PvfExecTimeoutKind,
+ ScheduledCore, SessionIndex,
};
use sp_application_crypto::AppKey;
use sp_keyring::Sr25519Keyring;
@@ -41,6 +43,11 @@ use sp_tracing as _;
use statement_table::v2::Misbehavior;
use std::collections::HashMap;
+mod prospective_parachains;
+
+const ASYNC_BACKING_DISABLED_ERROR: RuntimeApiError =
+ RuntimeApiError::NotSupported { runtime_api_name: "test-runtime" };
+
fn validator_pubkeys(val_ids: &[Sr25519Keyring]) -> Vec {
val_ids.iter().map(|v| v.public().into()).collect()
}
@@ -53,6 +60,15 @@ fn table_statement_to_primitive(statement: TableStatement) -> Statement {
}
}
+fn dummy_pvd() -> PersistedValidationData {
+ PersistedValidationData {
+ parent_head: HeadData(vec![7, 8, 9]),
+ relay_parent_number: 0_u32.into(),
+ max_pov_size: 1024,
+ relay_parent_storage_root: dummy_hash(),
+ }
+}
+
struct TestState {
chain_ids: Vec,
keystore: KeystorePtr,
@@ -66,13 +82,18 @@ struct TestState {
relay_parent: Hash,
}
+impl TestState {
+ fn session(&self) -> SessionIndex {
+ self.signing_context.session_index
+ }
+}
+
impl Default for TestState {
fn default() -> Self {
let chain_a = ParaId::from(1);
let chain_b = ParaId::from(2);
- let thread_a = ParaId::from(3);
- let chain_ids = vec![chain_a, chain_b, thread_a];
+ let chain_ids = vec![chain_a, chain_b];
let validators = vec![
Sr25519Keyring::Alice,
@@ -90,25 +111,21 @@ impl Default for TestState {
let validator_public = validator_pubkeys(&validators);
- let validator_groups = vec![vec![2, 0, 3, 5], vec![1], vec![4]]
+ let validator_groups = vec![vec![2, 0, 3, 5], vec![1]]
.into_iter()
.map(|g| g.into_iter().map(ValidatorIndex).collect())
.collect();
let group_rotation_info =
GroupRotationInfo { session_start_block: 0, group_rotation_frequency: 100, now: 1 };
- let thread_collator: CollatorId = Sr25519Keyring::Two.public().into();
let availability_cores = vec![
CoreState::Scheduled(ScheduledCore { para_id: chain_a, collator: None }),
CoreState::Scheduled(ScheduledCore { para_id: chain_b, collator: None }),
- CoreState::Scheduled(ScheduledCore {
- para_id: thread_a,
- collator: Some(thread_collator.clone()),
- }),
];
let mut head_data = HashMap::new();
head_data.insert(chain_a, HeadData(vec![4, 5, 6]));
+ head_data.insert(chain_b, HeadData(vec![5, 6, 7]));
let relay_parent = Hash::repeat_byte(5);
@@ -165,21 +182,22 @@ fn test_harness>(
));
}
-fn make_erasure_root(test: &TestState, pov: PoV) -> Hash {
- let available_data =
- AvailableData { validation_data: test.validation_data.clone(), pov: Arc::new(pov) };
+fn make_erasure_root(test: &TestState, pov: PoV, validation_data: PersistedValidationData) -> Hash {
+ let available_data = AvailableData { validation_data, pov: Arc::new(pov) };
let chunks = erasure_coding::obtain_chunks_v1(test.validators.len(), &available_data).unwrap();
erasure_coding::branches(&chunks).root()
}
-#[derive(Default)]
+#[derive(Default, Clone)]
struct TestCandidateBuilder {
para_id: ParaId,
head_data: HeadData,
pov_hash: Hash,
relay_parent: Hash,
erasure_root: Hash,
+ persisted_validation_data_hash: Hash,
+ validation_code: Vec,
}
impl TestCandidateBuilder {
@@ -192,9 +210,9 @@ impl TestCandidateBuilder {
erasure_root: self.erasure_root,
collator: dummy_collator(),
signature: dummy_collator_signature(),
- para_head: dummy_hash(),
- validation_code_hash: dummy_validation_code().hash(),
- persisted_validation_data_hash: dummy_hash(),
+ para_head: self.head_data.hash(),
+ validation_code_hash: ValidationCode(self.validation_code).hash(),
+ persisted_validation_data_hash: self.persisted_validation_data_hash,
},
commitments: CandidateCommitments {
head_data: self.head_data,
@@ -222,6 +240,15 @@ async fn test_startup(virtual_overseer: &mut VirtualOverseer, test_state: &TestS
))))
.await;
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(parent, RuntimeApiRequest::StagingAsyncBackingParameters(tx))
+ ) if parent == test_state.relay_parent => {
+ tx.send(Err(ASYNC_BACKING_DISABLED_ERROR)).unwrap();
+ }
+ );
+
// Check that subsystem job issues a request for a validator set.
assert_matches!(
virtual_overseer.recv().await,
@@ -272,6 +299,8 @@ fn backing_second_works() {
test_startup(&mut virtual_overseer, &test_state).await;
let pov = PoV { block_data: BlockData(vec![42, 43, 44]) };
+ let pvd = dummy_pvd();
+ let validation_code = ValidationCode(vec![1, 2, 3]);
let expected_head_data = test_state.head_data.get(&test_state.chain_ids[0]).unwrap();
@@ -281,7 +310,9 @@ fn backing_second_works() {
relay_parent: test_state.relay_parent,
pov_hash,
head_data: expected_head_data.clone(),
- erasure_root: make_erasure_root(&test_state, pov.clone()),
+ erasure_root: make_erasure_root(&test_state, pov.clone(), pvd.clone()),
+ persisted_validation_data_hash: pvd.hash(),
+ validation_code: validation_code.0.clone(),
..Default::default()
}
.build();
@@ -289,31 +320,50 @@ fn backing_second_works() {
let second = CandidateBackingMessage::Second(
test_state.relay_parent,
candidate.to_plain(),
+ pvd.clone(),
pov.clone(),
);
virtual_overseer.send(FromOrchestra::Communication { msg: second }).await;
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(_, RuntimeApiRequest::ValidationCodeByHash(hash, tx))
+ ) if hash == validation_code.hash() => {
+ tx.send(Ok(Some(validation_code.clone()))).unwrap();
+ }
+ );
+
assert_matches!(
virtual_overseer.recv().await,
AllMessages::CandidateValidation(
- CandidateValidationMessage::ValidateFromChainState(
+ CandidateValidationMessage::ValidateFromExhaustive(
+ _pvd,
+ _validation_code,
candidate_receipt,
- pov,
+ _pov,
timeout,
tx,
- )
- ) if pov == pov && &candidate_receipt.descriptor == candidate.descriptor() && timeout == PvfExecTimeoutKind::Backing && candidate.commitments.hash() == candidate_receipt.commitments_hash => {
- tx.send(Ok(
- ValidationResult::Valid(CandidateCommitments {
+ ),
+ ) if _pvd == pvd &&
+ _validation_code == validation_code &&
+ *_pov == pov && &candidate_receipt.descriptor == candidate.descriptor() &&
+ timeout == PvfExecTimeoutKind::Backing &&
+ candidate.commitments.hash() == candidate_receipt.commitments_hash =>
+ {
+ tx.send(Ok(ValidationResult::Valid(
+ CandidateCommitments {
head_data: expected_head_data.clone(),
horizontal_messages: Default::default(),
upward_messages: Default::default(),
new_validation_code: None,
processed_downward_messages: 0,
hrmp_watermark: 0,
- }, test_state.validation_data.clone()),
- )).unwrap();
+ },
+ test_state.validation_data.clone(),
+ )))
+ .unwrap();
}
);
@@ -361,6 +411,8 @@ fn backing_works() {
test_startup(&mut virtual_overseer, &test_state).await;
let pov = PoV { block_data: BlockData(vec![1, 2, 3]) };
+ let pvd = dummy_pvd();
+ let validation_code = ValidationCode(vec![1, 2, 3]);
let pov_hash = pov.hash();
@@ -371,7 +423,8 @@ fn backing_works() {
relay_parent: test_state.relay_parent,
pov_hash,
head_data: expected_head_data.clone(),
- erasure_root: make_erasure_root(&test_state, pov.clone()),
+ erasure_root: make_erasure_root(&test_state, pov.clone(), pvd.clone()),
+ validation_code: validation_code.0.clone(),
..Default::default()
}
.build();
@@ -392,9 +445,9 @@ fn backing_works() {
)
.expect("Insert key into keystore");
- let signed_a = SignedFullStatement::sign(
+ let signed_a = SignedFullStatementWithPVD::sign(
&test_state.keystore,
- Statement::Seconded(candidate_a.clone()),
+ StatementWithPVD::Seconded(candidate_a.clone(), pvd.clone()),
&test_state.signing_context,
ValidatorIndex(2),
&public2.into(),
@@ -403,9 +456,9 @@ fn backing_works() {
.flatten()
.expect("should be signed");
- let signed_b = SignedFullStatement::sign(
+ let signed_b = SignedFullStatementWithPVD::sign(
&test_state.keystore,
- Statement::Valid(candidate_a_hash),
+ StatementWithPVD::Valid(candidate_a_hash),
&test_state.signing_context,
ValidatorIndex(5),
&public1.into(),
@@ -419,6 +472,15 @@ fn backing_works() {
virtual_overseer.send(FromOrchestra::Communication { msg: statement }).await;
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(_, RuntimeApiRequest::ValidationCodeByHash(hash, tx))
+ ) if hash == validation_code.hash() => {
+ tx.send(Ok(Some(validation_code.clone()))).unwrap();
+ }
+ );
+
// Sending a `Statement::Seconded` for our assignment will start
// validation process. The first thing requested is the PoV.
assert_matches!(
@@ -439,13 +501,20 @@ fn backing_works() {
assert_matches!(
virtual_overseer.recv().await,
AllMessages::CandidateValidation(
- CandidateValidationMessage::ValidateFromChainState(
- c,
- pov,
+ CandidateValidationMessage::ValidateFromExhaustive(
+ _pvd,
+ _validation_code,
+ candidate_receipt,
+ _pov,
timeout,
tx,
- )
- ) if pov == pov && c.descriptor() == candidate_a.descriptor() && timeout == PvfExecTimeoutKind::Backing && c.commitments_hash == candidate_a_commitments_hash=> {
+ ),
+ ) if _pvd == pvd &&
+ _validation_code == validation_code &&
+ *_pov == pov && &candidate_receipt.descriptor == candidate_a.descriptor() &&
+ timeout == PvfExecTimeoutKind::Backing &&
+ candidate_a_commitments_hash == candidate_receipt.commitments_hash =>
+ {
tx.send(Ok(
ValidationResult::Valid(CandidateCommitments {
head_data: expected_head_data.clone(),
@@ -470,22 +539,22 @@ fn backing_works() {
assert_matches!(
virtual_overseer.recv().await,
- AllMessages::Provisioner(
- ProvisionerMessage::ProvisionableData(
- _,
- ProvisionableData::BackedCandidate(candidate_receipt)
- )
+ AllMessages::StatementDistribution(
+ StatementDistributionMessage::Share(hash, _stmt)
) => {
- assert_eq!(candidate_receipt, candidate_a.to_plain());
+ assert_eq!(test_state.relay_parent, hash);
}
);
assert_matches!(
virtual_overseer.recv().await,
- AllMessages::StatementDistribution(
- StatementDistributionMessage::Share(hash, _stmt)
+ AllMessages::Provisioner(
+ ProvisionerMessage::ProvisionableData(
+ _,
+ ProvisionableData::BackedCandidate(candidate_receipt)
+ )
) => {
- assert_eq!(test_state.relay_parent, hash);
+ assert_eq!(candidate_receipt, candidate_a.to_plain());
}
);
@@ -510,6 +579,8 @@ fn backing_works_while_validation_ongoing() {
test_startup(&mut virtual_overseer, &test_state).await;
let pov = PoV { block_data: BlockData(vec![1, 2, 3]) };
+ let pvd = dummy_pvd();
+ let validation_code = ValidationCode(vec![1, 2, 3]);
let pov_hash = pov.hash();
@@ -520,7 +591,8 @@ fn backing_works_while_validation_ongoing() {
relay_parent: test_state.relay_parent,
pov_hash,
head_data: expected_head_data.clone(),
- erasure_root: make_erasure_root(&test_state, pov.clone()),
+ erasure_root: make_erasure_root(&test_state, pov.clone(), pvd.clone()),
+ validation_code: validation_code.0.clone(),
..Default::default()
}
.build();
@@ -547,9 +619,9 @@ fn backing_works_while_validation_ongoing() {
)
.expect("Insert key into keystore");
- let signed_a = SignedFullStatement::sign(
+ let signed_a = SignedFullStatementWithPVD::sign(
&test_state.keystore,
- Statement::Seconded(candidate_a.clone()),
+ StatementWithPVD::Seconded(candidate_a.clone(), pvd.clone()),
&test_state.signing_context,
ValidatorIndex(2),
&public2.into(),
@@ -558,9 +630,9 @@ fn backing_works_while_validation_ongoing() {
.flatten()
.expect("should be signed");
- let signed_b = SignedFullStatement::sign(
+ let signed_b = SignedFullStatementWithPVD::sign(
&test_state.keystore,
- Statement::Valid(candidate_a_hash),
+ StatementWithPVD::Valid(candidate_a_hash),
&test_state.signing_context,
ValidatorIndex(5),
&public1.into(),
@@ -569,9 +641,9 @@ fn backing_works_while_validation_ongoing() {
.flatten()
.expect("should be signed");
- let signed_c = SignedFullStatement::sign(
+ let signed_c = SignedFullStatementWithPVD::sign(
&test_state.keystore,
- Statement::Valid(candidate_a_hash),
+ StatementWithPVD::Valid(candidate_a_hash),
&test_state.signing_context,
ValidatorIndex(3),
&public3.into(),
@@ -584,6 +656,15 @@ fn backing_works_while_validation_ongoing() {
CandidateBackingMessage::Statement(test_state.relay_parent, signed_a.clone());
virtual_overseer.send(FromOrchestra::Communication { msg: statement }).await;
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(_, RuntimeApiRequest::ValidationCodeByHash(hash, tx))
+ ) if hash == validation_code.hash() => {
+ tx.send(Ok(Some(validation_code.clone()))).unwrap();
+ }
+ );
+
// Sending a `Statement::Seconded` for our assignment will start
// validation process. The first thing requested is PoV from the
// `PoVDistribution`.
@@ -605,13 +686,20 @@ fn backing_works_while_validation_ongoing() {
assert_matches!(
virtual_overseer.recv().await,
AllMessages::CandidateValidation(
- CandidateValidationMessage::ValidateFromChainState(
- c,
- pov,
+ CandidateValidationMessage::ValidateFromExhaustive(
+ _pvd,
+ _validation_code,
+ candidate_receipt,
+ _pov,
timeout,
tx,
- )
- ) if pov == pov && c.descriptor() == candidate_a.descriptor() && timeout == PvfExecTimeoutKind::Backing && candidate_a_commitments_hash == c.commitments_hash => {
+ ),
+ ) if _pvd == pvd &&
+ _validation_code == validation_code &&
+ *_pov == pov && &candidate_receipt.descriptor == candidate_a.descriptor() &&
+ timeout == PvfExecTimeoutKind::Backing &&
+ candidate_a_commitments_hash == candidate_receipt.commitments_hash =>
+ {
// we never validate the candidate. our local node
// shouldn't issue any statements.
std::mem::forget(tx);
@@ -689,6 +777,8 @@ fn backing_misbehavior_works() {
let pov = PoV { block_data: BlockData(vec![1, 2, 3]) };
let pov_hash = pov.hash();
+ let pvd = dummy_pvd();
+ let validation_code = ValidationCode(vec![1, 2, 3]);
let expected_head_data = test_state.head_data.get(&test_state.chain_ids[0]).unwrap();
@@ -696,8 +786,9 @@ fn backing_misbehavior_works() {
para_id: test_state.chain_ids[0],
relay_parent: test_state.relay_parent,
pov_hash,
- erasure_root: make_erasure_root(&test_state, pov.clone()),
+ erasure_root: make_erasure_root(&test_state, pov.clone(), pvd.clone()),
head_data: expected_head_data.clone(),
+ validation_code: validation_code.0.clone(),
..Default::default()
}
.build();
@@ -711,9 +802,9 @@ fn backing_misbehavior_works() {
Some(&test_state.validators[2].to_seed()),
)
.expect("Insert key into keystore");
- let seconded_2 = SignedFullStatement::sign(
+ let seconded_2 = SignedFullStatementWithPVD::sign(
&test_state.keystore,
- Statement::Seconded(candidate_a.clone()),
+ StatementWithPVD::Seconded(candidate_a.clone(), pvd.clone()),
&test_state.signing_context,
ValidatorIndex(2),
&public2.into(),
@@ -722,9 +813,9 @@ fn backing_misbehavior_works() {
.flatten()
.expect("should be signed");
- let valid_2 = SignedFullStatement::sign(
+ let valid_2 = SignedFullStatementWithPVD::sign(
&test_state.keystore,
- Statement::Valid(candidate_a_hash),
+ StatementWithPVD::Valid(candidate_a_hash),
&test_state.signing_context,
ValidatorIndex(2),
&public2.into(),
@@ -738,6 +829,15 @@ fn backing_misbehavior_works() {
virtual_overseer.send(FromOrchestra::Communication { msg: statement }).await;
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(_, RuntimeApiRequest::ValidationCodeByHash(hash, tx))
+ ) if hash == validation_code.hash() => {
+ tx.send(Ok(Some(validation_code.clone()))).unwrap();
+ }
+ );
+
assert_matches!(
virtual_overseer.recv().await,
AllMessages::AvailabilityDistribution(
@@ -754,13 +854,20 @@ fn backing_misbehavior_works() {
assert_matches!(
virtual_overseer.recv().await,
AllMessages::CandidateValidation(
- CandidateValidationMessage::ValidateFromChainState(
- c,
- pov,
+ CandidateValidationMessage::ValidateFromExhaustive(
+ _pvd,
+ _validation_code,
+ candidate_receipt,
+ _pov,
timeout,
tx,
- )
- ) if pov == pov && c.descriptor() == candidate_a.descriptor() && timeout == PvfExecTimeoutKind::Backing && candidate_a_commitments_hash == c.commitments_hash => {
+ ),
+ ) if _pvd == pvd &&
+ _validation_code == validation_code &&
+ *_pov == pov && &candidate_receipt.descriptor == candidate_a.descriptor() &&
+ timeout == PvfExecTimeoutKind::Backing &&
+ candidate_a_commitments_hash == candidate_receipt.commitments_hash =>
+ {
tx.send(Ok(
ValidationResult::Valid(CandidateCommitments {
head_data: expected_head_data.clone(),
@@ -783,6 +890,18 @@ fn backing_misbehavior_works() {
}
);
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::StatementDistribution(
+ StatementDistributionMessage::Share(
+ relay_parent,
+ signed_statement,
+ )
+ ) if relay_parent == test_state.relay_parent => {
+ assert_eq!(*signed_statement.payload(), StatementWithPVD::Valid(candidate_a_hash));
+ }
+ );
+
assert_matches!(
virtual_overseer.recv().await,
AllMessages::Provisioner(
@@ -796,18 +915,6 @@ fn backing_misbehavior_works() {
) if descriptor == candidate_a.descriptor
);
- assert_matches!(
- virtual_overseer.recv().await,
- AllMessages::StatementDistribution(
- StatementDistributionMessage::Share(
- relay_parent,
- signed_statement,
- )
- ) if relay_parent == test_state.relay_parent => {
- assert_eq!(*signed_statement.payload(), Statement::Valid(candidate_a_hash));
- }
- );
-
// This `Valid` statement is redundant after the `Seconded` statement already sent.
let statement =
CandidateBackingMessage::Statement(test_state.relay_parent, valid_2.clone());
@@ -860,8 +967,17 @@ fn backing_dont_second_invalid() {
test_startup(&mut virtual_overseer, &test_state).await;
let pov_block_a = PoV { block_data: BlockData(vec![42, 43, 44]) };
+ let pvd_a = dummy_pvd();
+ let validation_code_a = ValidationCode(vec![1, 2, 3]);
let pov_block_b = PoV { block_data: BlockData(vec![45, 46, 47]) };
+ let pvd_b = {
+ let mut pvd_b = pvd_a.clone();
+ pvd_b.parent_head = HeadData(vec![14, 15, 16]);
+ pvd_b.max_pov_size = pvd_a.max_pov_size / 2;
+ pvd_b
+ };
+ let validation_code_b = ValidationCode(vec![4, 5, 6]);
let pov_hash_a = pov_block_a.hash();
let pov_hash_b = pov_block_b.hash();
@@ -872,7 +988,9 @@ fn backing_dont_second_invalid() {
para_id: test_state.chain_ids[0],
relay_parent: test_state.relay_parent,
pov_hash: pov_hash_a,
- erasure_root: make_erasure_root(&test_state, pov_block_a.clone()),
+ erasure_root: make_erasure_root(&test_state, pov_block_a.clone(), pvd_a.clone()),
+ persisted_validation_data_hash: pvd_a.hash(),
+ validation_code: validation_code_a.0.clone(),
..Default::default()
}
.build();
@@ -881,8 +999,10 @@ fn backing_dont_second_invalid() {
para_id: test_state.chain_ids[0],
relay_parent: test_state.relay_parent,
pov_hash: pov_hash_b,
- erasure_root: make_erasure_root(&test_state, pov_block_b.clone()),
+ erasure_root: make_erasure_root(&test_state, pov_block_b.clone(), pvd_b.clone()),
head_data: expected_head_data.clone(),
+ persisted_validation_data_hash: pvd_b.hash(),
+ validation_code: validation_code_b.0.clone(),
..Default::default()
}
.build();
@@ -890,21 +1010,38 @@ fn backing_dont_second_invalid() {
let second = CandidateBackingMessage::Second(
test_state.relay_parent,
candidate_a.to_plain(),
+ pvd_a.clone(),
pov_block_a.clone(),
);
virtual_overseer.send(FromOrchestra::Communication { msg: second }).await;
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(_, RuntimeApiRequest::ValidationCodeByHash(hash, tx))
+ ) if hash == validation_code_a.hash() => {
+ tx.send(Ok(Some(validation_code_a.clone()))).unwrap();
+ }
+ );
+
assert_matches!(
virtual_overseer.recv().await,
AllMessages::CandidateValidation(
- CandidateValidationMessage::ValidateFromChainState(
- c,
- pov,
+ CandidateValidationMessage::ValidateFromExhaustive(
+ _pvd,
+ _validation_code,
+ candidate_receipt,
+ _pov,
timeout,
tx,
- )
- ) if pov == pov && c.descriptor() == candidate_a.descriptor() && timeout == PvfExecTimeoutKind::Backing => {
+ ),
+ ) if _pvd == pvd_a &&
+ _validation_code == validation_code_a &&
+ *_pov == pov_block_a && &candidate_receipt.descriptor == candidate_a.descriptor() &&
+ timeout == PvfExecTimeoutKind::Backing &&
+ candidate_a.commitments.hash() == candidate_receipt.commitments_hash =>
+ {
tx.send(Ok(ValidationResult::Invalid(InvalidCandidate::BadReturn))).unwrap();
}
);
@@ -919,21 +1056,38 @@ fn backing_dont_second_invalid() {
let second = CandidateBackingMessage::Second(
test_state.relay_parent,
candidate_b.to_plain(),
+ pvd_b.clone(),
pov_block_b.clone(),
);
virtual_overseer.send(FromOrchestra::Communication { msg: second }).await;
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(_, RuntimeApiRequest::ValidationCodeByHash(hash, tx))
+ ) if hash == validation_code_b.hash() => {
+ tx.send(Ok(Some(validation_code_b.clone()))).unwrap();
+ }
+ );
+
assert_matches!(
virtual_overseer.recv().await,
AllMessages::CandidateValidation(
- CandidateValidationMessage::ValidateFromChainState(
- c,
- pov,
+ CandidateValidationMessage::ValidateFromExhaustive(
+ pvd,
+ _validation_code,
+ candidate_receipt,
+ _pov,
timeout,
tx,
- )
- ) if pov == pov && c.descriptor() == candidate_b.descriptor() && timeout == PvfExecTimeoutKind::Backing => {
+ ),
+ ) if pvd == pvd_b &&
+ _validation_code == validation_code_b &&
+ *_pov == pov_block_b && &candidate_receipt.descriptor == candidate_b.descriptor() &&
+ timeout == PvfExecTimeoutKind::Backing &&
+ candidate_b.commitments.hash() == candidate_receipt.commitments_hash =>
+ {
tx.send(Ok(
ValidationResult::Valid(CandidateCommitments {
head_data: expected_head_data.clone(),
@@ -942,7 +1096,7 @@ fn backing_dont_second_invalid() {
new_validation_code: None,
processed_downward_messages: 0,
hrmp_watermark: 0,
- }, test_state.validation_data.clone()),
+ }, pvd_b.clone()),
)).unwrap();
}
);
@@ -964,7 +1118,7 @@ fn backing_dont_second_invalid() {
signed_statement,
)
) if parent_hash == test_state.relay_parent => {
- assert_eq!(*signed_statement.payload(), Statement::Seconded(candidate_b));
+ assert_eq!(*signed_statement.payload(), StatementWithPVD::Seconded(candidate_b, pvd_b.clone()));
}
);
@@ -986,6 +1140,8 @@ fn backing_second_after_first_fails_works() {
test_startup(&mut virtual_overseer, &test_state).await;
let pov = PoV { block_data: BlockData(vec![42, 43, 44]) };
+ let pvd = dummy_pvd();
+ let validation_code = ValidationCode(vec![1, 2, 3]);
let pov_hash = pov.hash();
@@ -993,7 +1149,9 @@ fn backing_second_after_first_fails_works() {
para_id: test_state.chain_ids[0],
relay_parent: test_state.relay_parent,
pov_hash,
- erasure_root: make_erasure_root(&test_state, pov.clone()),
+ erasure_root: make_erasure_root(&test_state, pov.clone(), pvd.clone()),
+ persisted_validation_data_hash: pvd.hash(),
+ validation_code: validation_code.0.clone(),
..Default::default()
}
.build();
@@ -1005,9 +1163,9 @@ fn backing_second_after_first_fails_works() {
)
.expect("Insert key into keystore");
- let signed_a = SignedFullStatement::sign(
+ let signed_a = SignedFullStatementWithPVD::sign(
&test_state.keystore,
- Statement::Seconded(candidate.clone()),
+ StatementWithPVD::Seconded(candidate.clone(), pvd.clone()),
&test_state.signing_context,
ValidatorIndex(2),
&validator2.into(),
@@ -1022,6 +1180,15 @@ fn backing_second_after_first_fails_works() {
virtual_overseer.send(FromOrchestra::Communication { msg: statement }).await;
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(_, RuntimeApiRequest::ValidationCodeByHash(hash, tx))
+ ) if hash == validation_code.hash() => {
+ tx.send(Ok(Some(validation_code.clone()))).unwrap();
+ }
+ );
+
// Subsystem requests PoV and requests validation.
assert_matches!(
virtual_overseer.recv().await,
@@ -1040,13 +1207,20 @@ fn backing_second_after_first_fails_works() {
assert_matches!(
virtual_overseer.recv().await,
AllMessages::CandidateValidation(
- CandidateValidationMessage::ValidateFromChainState(
- c,
- pov,
+ CandidateValidationMessage::ValidateFromExhaustive(
+ _pvd,
+ _validation_code,
+ candidate_receipt,
+ _pov,
timeout,
tx,
- )
- ) if pov == pov && c.descriptor() == candidate.descriptor() && timeout == PvfExecTimeoutKind::Backing && c.commitments_hash == candidate.commitments.hash() => {
+ ),
+ ) if _pvd == pvd &&
+ _validation_code == validation_code &&
+ *_pov == pov && &candidate_receipt.descriptor == candidate.descriptor() &&
+ timeout == PvfExecTimeoutKind::Backing &&
+ candidate.commitments.hash() == candidate_receipt.commitments_hash =>
+ {
tx.send(Ok(ValidationResult::Invalid(InvalidCandidate::BadReturn))).unwrap();
}
);
@@ -1056,12 +1230,15 @@ fn backing_second_after_first_fails_works() {
let second = CandidateBackingMessage::Second(
test_state.relay_parent,
candidate.to_plain(),
+ pvd.clone(),
pov.clone(),
);
virtual_overseer.send(FromOrchestra::Communication { msg: second }).await;
let pov_to_second = PoV { block_data: BlockData(vec![3, 2, 1]) };
+ let pvd_to_second = dummy_pvd();
+ let validation_code_to_second = ValidationCode(vec![5, 6, 7]);
let pov_hash = pov_to_second.hash();
@@ -1069,7 +1246,13 @@ fn backing_second_after_first_fails_works() {
para_id: test_state.chain_ids[0],
relay_parent: test_state.relay_parent,
pov_hash,
- erasure_root: make_erasure_root(&test_state, pov_to_second.clone()),
+ erasure_root: make_erasure_root(
+ &test_state,
+ pov_to_second.clone(),
+ pvd_to_second.clone(),
+ ),
+ persisted_validation_data_hash: pvd_to_second.hash(),
+ validation_code: validation_code_to_second.0.clone(),
..Default::default()
}
.build();
@@ -1077,6 +1260,7 @@ fn backing_second_after_first_fails_works() {
let second = CandidateBackingMessage::Second(
test_state.relay_parent,
candidate_to_second.to_plain(),
+ pvd_to_second.clone(),
pov_to_second.clone(),
);
@@ -1085,15 +1269,19 @@ fn backing_second_after_first_fails_works() {
// triggered on the prev step.
virtual_overseer.send(FromOrchestra::Communication { msg: second }).await;
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(_, RuntimeApiRequest::ValidationCodeByHash(hash, tx))
+ ) if hash == validation_code_to_second.hash() => {
+ tx.send(Ok(Some(validation_code_to_second.clone()))).unwrap();
+ }
+ );
+
assert_matches!(
virtual_overseer.recv().await,
AllMessages::CandidateValidation(
- CandidateValidationMessage::ValidateFromChainState(
- _,
- pov,
- _,
- _,
- )
+ CandidateValidationMessage::ValidateFromExhaustive(_, _, _, pov, ..),
) => {
assert_eq!(&*pov, &pov_to_second);
}
@@ -1111,6 +1299,8 @@ fn backing_works_after_failed_validation() {
test_startup(&mut virtual_overseer, &test_state).await;
let pov = PoV { block_data: BlockData(vec![42, 43, 44]) };
+ let pvd = dummy_pvd();
+ let validation_code = ValidationCode(vec![1, 2, 3]);
let pov_hash = pov.hash();
@@ -1118,7 +1308,8 @@ fn backing_works_after_failed_validation() {
para_id: test_state.chain_ids[0],
relay_parent: test_state.relay_parent,
pov_hash,
- erasure_root: make_erasure_root(&test_state, pov.clone()),
+ erasure_root: make_erasure_root(&test_state, pov.clone(), pvd.clone()),
+ validation_code: validation_code.0.clone(),
..Default::default()
}
.build();
@@ -1129,9 +1320,9 @@ fn backing_works_after_failed_validation() {
Some(&test_state.validators[2].to_seed()),
)
.expect("Insert key into keystore");
- let signed_a = SignedFullStatement::sign(
+ let signed_a = SignedFullStatementWithPVD::sign(
&test_state.keystore,
- Statement::Seconded(candidate.clone()),
+ StatementWithPVD::Seconded(candidate.clone(), pvd.clone()),
&test_state.signing_context,
ValidatorIndex(2),
&public2.into(),
@@ -1146,6 +1337,15 @@ fn backing_works_after_failed_validation() {
virtual_overseer.send(FromOrchestra::Communication { msg: statement }).await;
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(_, RuntimeApiRequest::ValidationCodeByHash(hash, tx))
+ ) if hash == validation_code.hash() => {
+ tx.send(Ok(Some(validation_code.clone()))).unwrap();
+ }
+ );
+
// Subsystem requests PoV and requests validation.
assert_matches!(
virtual_overseer.recv().await,
@@ -1164,13 +1364,20 @@ fn backing_works_after_failed_validation() {
assert_matches!(
virtual_overseer.recv().await,
AllMessages::CandidateValidation(
- CandidateValidationMessage::ValidateFromChainState(
- c,
- pov,
+ CandidateValidationMessage::ValidateFromExhaustive(
+ _pvd,
+ _validation_code,
+ candidate_receipt,
+ _pov,
timeout,
tx,
- )
- ) if pov == pov && c.descriptor() == candidate.descriptor() && timeout == PvfExecTimeoutKind::Backing && c.commitments_hash == candidate.commitments.hash() => {
+ ),
+ ) if _pvd == pvd &&
+ _validation_code == validation_code &&
+ *_pov == pov && &candidate_receipt.descriptor == candidate.descriptor() &&
+ timeout == PvfExecTimeoutKind::Backing &&
+ candidate.commitments.hash() == candidate_receipt.commitments_hash =>
+ {
tx.send(Err(ValidationFailed("Internal test error".into()))).unwrap();
}
);
@@ -1193,6 +1400,7 @@ fn backing_works_after_failed_validation() {
// Test that a `CandidateBackingMessage::Second` issues validation work
// and in case validation is successful issues a `StatementDistributionMessage`.
#[test]
+#[ignore] // `required_collator` is disabled.
fn backing_doesnt_second_wrong_collator() {
let mut test_state = TestState::default();
test_state.availability_cores[0] = CoreState::Scheduled(ScheduledCore {
@@ -1204,6 +1412,8 @@ fn backing_doesnt_second_wrong_collator() {
test_startup(&mut virtual_overseer, &test_state).await;
let pov = PoV { block_data: BlockData(vec![42, 43, 44]) };
+ let pvd = dummy_pvd();
+ let validation_code = ValidationCode(vec![1, 2, 3]);
let expected_head_data = test_state.head_data.get(&test_state.chain_ids[0]).unwrap();
@@ -1213,7 +1423,9 @@ fn backing_doesnt_second_wrong_collator() {
relay_parent: test_state.relay_parent,
pov_hash,
head_data: expected_head_data.clone(),
- erasure_root: make_erasure_root(&test_state, pov.clone()),
+ erasure_root: make_erasure_root(&test_state, pov.clone(), pvd.clone()),
+ persisted_validation_data_hash: pvd.hash(),
+ validation_code: validation_code.0.clone(),
..Default::default()
}
.build();
@@ -1221,6 +1433,7 @@ fn backing_doesnt_second_wrong_collator() {
let second = CandidateBackingMessage::Second(
test_state.relay_parent,
candidate.to_plain(),
+ pvd.clone(),
pov.clone(),
);
@@ -1244,6 +1457,7 @@ fn backing_doesnt_second_wrong_collator() {
}
#[test]
+#[ignore] // `required_collator` is disabled.
fn validation_work_ignores_wrong_collator() {
let mut test_state = TestState::default();
test_state.availability_cores[0] = CoreState::Scheduled(ScheduledCore {
@@ -1255,6 +1469,8 @@ fn validation_work_ignores_wrong_collator() {
test_startup(&mut virtual_overseer, &test_state).await;
let pov = PoV { block_data: BlockData(vec![1, 2, 3]) };
+ let pvd = dummy_pvd();
+ let validation_code = ValidationCode(vec![1, 2, 3]);
let pov_hash = pov.hash();
@@ -1265,7 +1481,9 @@ fn validation_work_ignores_wrong_collator() {
relay_parent: test_state.relay_parent,
pov_hash,
head_data: expected_head_data.clone(),
- erasure_root: make_erasure_root(&test_state, pov.clone()),
+ erasure_root: make_erasure_root(&test_state, pov.clone(), pvd.clone()),
+ persisted_validation_data_hash: pvd.hash(),
+ validation_code: validation_code.0.clone(),
..Default::default()
}
.build();
@@ -1276,9 +1494,9 @@ fn validation_work_ignores_wrong_collator() {
Some(&test_state.validators[2].to_seed()),
)
.expect("Insert key into keystore");
- let seconding = SignedFullStatement::sign(
+ let seconding = SignedFullStatementWithPVD::sign(
&test_state.keystore,
- Statement::Seconded(candidate_a.clone()),
+ StatementWithPVD::Seconded(candidate_a.clone(), pvd.clone()),
&test_state.signing_context,
ValidatorIndex(2),
&public2.into(),
@@ -1382,6 +1600,8 @@ fn retry_works() {
test_startup(&mut virtual_overseer, &test_state).await;
let pov = PoV { block_data: BlockData(vec![42, 43, 44]) };
+ let pvd = dummy_pvd();
+ let validation_code = ValidationCode(vec![1, 2, 3]);
let pov_hash = pov.hash();
@@ -1389,7 +1609,9 @@ fn retry_works() {
para_id: test_state.chain_ids[0],
relay_parent: test_state.relay_parent,
pov_hash,
- erasure_root: make_erasure_root(&test_state, pov.clone()),
+ erasure_root: make_erasure_root(&test_state, pov.clone(), pvd.clone()),
+ persisted_validation_data_hash: pvd.hash(),
+ validation_code: validation_code.0.clone(),
..Default::default()
}
.build();
@@ -1412,9 +1634,9 @@ fn retry_works() {
Some(&test_state.validators[5].to_seed()),
)
.expect("Insert key into keystore");
- let signed_a = SignedFullStatement::sign(
+ let signed_a = SignedFullStatementWithPVD::sign(
&test_state.keystore,
- Statement::Seconded(candidate.clone()),
+ StatementWithPVD::Seconded(candidate.clone(), pvd.clone()),
&test_state.signing_context,
ValidatorIndex(2),
&public2.into(),
@@ -1422,9 +1644,9 @@ fn retry_works() {
.ok()
.flatten()
.expect("should be signed");
- let signed_b = SignedFullStatement::sign(
+ let signed_b = SignedFullStatementWithPVD::sign(
&test_state.keystore,
- Statement::Valid(candidate.hash()),
+ StatementWithPVD::Valid(candidate.hash()),
&test_state.signing_context,
ValidatorIndex(3),
&public3.into(),
@@ -1432,9 +1654,9 @@ fn retry_works() {
.ok()
.flatten()
.expect("should be signed");
- let signed_c = SignedFullStatement::sign(
+ let signed_c = SignedFullStatementWithPVD::sign(
&test_state.keystore,
- Statement::Valid(candidate.hash()),
+ StatementWithPVD::Valid(candidate.hash()),
&test_state.signing_context,
ValidatorIndex(5),
&public5.into(),
@@ -1448,6 +1670,15 @@ fn retry_works() {
CandidateBackingMessage::Statement(test_state.relay_parent, signed_a.clone());
virtual_overseer.send(FromOrchestra::Communication { msg: statement }).await;
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(_, RuntimeApiRequest::ValidationCodeByHash(hash, tx))
+ ) if hash == validation_code.hash() => {
+ tx.send(Ok(Some(validation_code.clone()))).unwrap();
+ }
+ );
+
// Subsystem requests PoV and requests validation.
// We cancel - should mean retry on next backing statement.
assert_matches!(
@@ -1468,7 +1699,7 @@ fn retry_works() {
virtual_overseer.send(FromOrchestra::Communication { msg: statement }).await;
// Not deterministic which message comes first:
- for _ in 0u32..2 {
+ for _ in 0u32..3 {
match virtual_overseer.recv().await {
AllMessages::Provisioner(ProvisionerMessage::ProvisionableData(
_,
@@ -1481,6 +1712,12 @@ fn retry_works() {
) if relay_parent == test_state.relay_parent => {
std::mem::drop(tx);
},
+ AllMessages::RuntimeApi(RuntimeApiMessage::Request(
+ _,
+ RuntimeApiRequest::ValidationCodeByHash(hash, tx),
+ )) if hash == validation_code.hash() => {
+ tx.send(Ok(Some(validation_code.clone()))).unwrap();
+ },
msg => {
assert!(false, "Unexpected message: {:?}", msg);
},
@@ -1491,6 +1728,15 @@ fn retry_works() {
CandidateBackingMessage::Statement(test_state.relay_parent, signed_c.clone());
virtual_overseer.send(FromOrchestra::Communication { msg: statement }).await;
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(_, RuntimeApiRequest::ValidationCodeByHash(hash, tx))
+ ) if hash == validation_code.hash() => {
+ tx.send(Ok(Some(validation_code.clone()))).unwrap();
+ }
+ );
+
assert_matches!(
virtual_overseer.recv().await,
AllMessages::AvailabilityDistribution(
@@ -1509,13 +1755,19 @@ fn retry_works() {
assert_matches!(
virtual_overseer.recv().await,
AllMessages::CandidateValidation(
- CandidateValidationMessage::ValidateFromChainState(
- c,
- pov,
+ CandidateValidationMessage::ValidateFromExhaustive(
+ _pvd,
+ _validation_code,
+ candidate_receipt,
+ _pov,
timeout,
- _tx,
- )
- ) if pov == pov && c.descriptor() == candidate.descriptor() && timeout == PvfExecTimeoutKind::Backing && c.commitments_hash == candidate.commitments.hash()
+ ..
+ ),
+ ) if _pvd == pvd &&
+ _validation_code == validation_code &&
+ *_pov == pov && &candidate_receipt.descriptor == candidate.descriptor() &&
+ timeout == PvfExecTimeoutKind::Backing &&
+ candidate.commitments.hash() == candidate_receipt.commitments_hash
);
virtual_overseer
});
@@ -1529,6 +1781,8 @@ fn observes_backing_even_if_not_validator() {
test_startup(&mut virtual_overseer, &test_state).await;
let pov = PoV { block_data: BlockData(vec![1, 2, 3]) };
+ let pvd = dummy_pvd();
+ let validation_code = ValidationCode(vec![1, 2, 3]);
let pov_hash = pov.hash();
@@ -1539,7 +1793,9 @@ fn observes_backing_even_if_not_validator() {
relay_parent: test_state.relay_parent,
pov_hash,
head_data: expected_head_data.clone(),
- erasure_root: make_erasure_root(&test_state, pov.clone()),
+ erasure_root: make_erasure_root(&test_state, pov.clone(), pvd.clone()),
+ persisted_validation_data_hash: pvd.hash(),
+ validation_code: validation_code.0.clone(),
..Default::default()
}
.build();
@@ -1566,9 +1822,9 @@ fn observes_backing_even_if_not_validator() {
// Produce a 3-of-5 quorum on the candidate.
- let signed_a = SignedFullStatement::sign(
+ let signed_a = SignedFullStatementWithPVD::sign(
&test_state.keystore,
- Statement::Seconded(candidate_a.clone()),
+ StatementWithPVD::Seconded(candidate_a.clone(), pvd.clone()),
&test_state.signing_context,
ValidatorIndex(0),
&public0.into(),
@@ -1577,9 +1833,9 @@ fn observes_backing_even_if_not_validator() {
.flatten()
.expect("should be signed");
- let signed_b = SignedFullStatement::sign(
+ let signed_b = SignedFullStatementWithPVD::sign(
&test_state.keystore,
- Statement::Valid(candidate_a_hash),
+ StatementWithPVD::Valid(candidate_a_hash),
&test_state.signing_context,
ValidatorIndex(5),
&public1.into(),
@@ -1588,9 +1844,9 @@ fn observes_backing_even_if_not_validator() {
.flatten()
.expect("should be signed");
- let signed_c = SignedFullStatement::sign(
+ let signed_c = SignedFullStatementWithPVD::sign(
&test_state.keystore,
- Statement::Valid(candidate_a_hash),
+ StatementWithPVD::Valid(candidate_a_hash),
&test_state.signing_context,
ValidatorIndex(2),
&public2.into(),
@@ -1634,3 +1890,175 @@ fn observes_backing_even_if_not_validator() {
virtual_overseer
});
}
+
+// Tests that it's impossible to second multiple candidates per relay parent
+// without prospective parachains.
+#[test]
+fn cannot_second_multiple_candidates_per_parent() {
+ let test_state = TestState::default();
+ test_harness(test_state.keystore.clone(), |mut virtual_overseer| async move {
+ test_startup(&mut virtual_overseer, &test_state).await;
+
+ let pov = PoV { block_data: BlockData(vec![42, 43, 44]) };
+ let pvd = dummy_pvd();
+ let validation_code = ValidationCode(vec![1, 2, 3]);
+
+ let expected_head_data = test_state.head_data.get(&test_state.chain_ids[0]).unwrap();
+
+ let pov_hash = pov.hash();
+ let candidate_builder = TestCandidateBuilder {
+ para_id: test_state.chain_ids[0],
+ relay_parent: test_state.relay_parent,
+ pov_hash,
+ head_data: expected_head_data.clone(),
+ erasure_root: make_erasure_root(&test_state, pov.clone(), pvd.clone()),
+ persisted_validation_data_hash: pvd.hash(),
+ validation_code: validation_code.0.clone(),
+ ..Default::default()
+ };
+ let candidate = candidate_builder.clone().build();
+
+ let second = CandidateBackingMessage::Second(
+ test_state.relay_parent,
+ candidate.to_plain(),
+ pvd.clone(),
+ pov.clone(),
+ );
+
+ virtual_overseer.send(FromOrchestra::Communication { msg: second }).await;
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(_, RuntimeApiRequest::ValidationCodeByHash(hash, tx))
+ ) if hash == validation_code.hash() => {
+ tx.send(Ok(Some(validation_code.clone()))).unwrap();
+ }
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::CandidateValidation(
+ CandidateValidationMessage::ValidateFromExhaustive(
+ _pvd,
+ _validation_code,
+ candidate_receipt,
+ _pov,
+ timeout,
+ tx,
+ ),
+ ) if _pvd == pvd &&
+ _validation_code == validation_code &&
+ *_pov == pov && &candidate_receipt.descriptor == candidate.descriptor() &&
+ timeout == PvfExecTimeoutKind::Backing &&
+ candidate.commitments.hash() == candidate_receipt.commitments_hash =>
+ {
+ tx.send(Ok(ValidationResult::Valid(
+ CandidateCommitments {
+ head_data: expected_head_data.clone(),
+ horizontal_messages: Default::default(),
+ upward_messages: Default::default(),
+ new_validation_code: None,
+ processed_downward_messages: 0,
+ hrmp_watermark: 0,
+ },
+ test_state.validation_data.clone(),
+ )))
+ .unwrap();
+ }
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::AvailabilityStore(
+ AvailabilityStoreMessage::StoreAvailableData { candidate_hash, tx, .. }
+ ) if candidate_hash == candidate.hash() => {
+ tx.send(Ok(())).unwrap();
+ }
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::StatementDistribution(
+ StatementDistributionMessage::Share(
+ parent_hash,
+ _signed_statement,
+ )
+ ) if parent_hash == test_state.relay_parent => {}
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::CollatorProtocol(CollatorProtocolMessage::Seconded(hash, statement)) => {
+ assert_eq!(test_state.relay_parent, hash);
+ assert_matches!(statement.payload(), Statement::Seconded(_));
+ }
+ );
+
+ // Try to second candidate with the same relay parent again.
+
+ // Make sure the candidate hash is different.
+ let validation_code = ValidationCode(vec![4, 5, 6]);
+ let mut candidate_builder = candidate_builder;
+ candidate_builder.validation_code = validation_code.0.clone();
+ let candidate = candidate_builder.build();
+
+ let second = CandidateBackingMessage::Second(
+ test_state.relay_parent,
+ candidate.to_plain(),
+ pvd.clone(),
+ pov.clone(),
+ );
+
+ virtual_overseer.send(FromOrchestra::Communication { msg: second }).await;
+
+ // The validation is still requested.
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(_, RuntimeApiRequest::ValidationCodeByHash(hash, tx))
+ ) if hash == validation_code.hash() => {
+ tx.send(Ok(Some(validation_code.clone()))).unwrap();
+ }
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::CandidateValidation(
+ CandidateValidationMessage::ValidateFromExhaustive(.., tx),
+ ) => {
+ tx.send(Ok(ValidationResult::Valid(
+ CandidateCommitments {
+ head_data: expected_head_data.clone(),
+ horizontal_messages: Default::default(),
+ upward_messages: Default::default(),
+ new_validation_code: None,
+ processed_downward_messages: 0,
+ hrmp_watermark: 0,
+ },
+ test_state.validation_data.clone(),
+ )))
+ .unwrap();
+ }
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::AvailabilityStore(
+ AvailabilityStoreMessage::StoreAvailableData { candidate_hash, tx, .. }
+ ) if candidate_hash == candidate.hash() => {
+ tx.send(Ok(())).unwrap();
+ }
+ );
+
+ // Validation done, but the candidate is rejected cause of 0-depth being already occupied.
+
+ assert!(virtual_overseer
+ .recv()
+ .timeout(std::time::Duration::from_millis(50))
+ .await
+ .is_none());
+
+ virtual_overseer
+ });
+}
diff --git a/node/core/backing/src/tests/prospective_parachains.rs b/node/core/backing/src/tests/prospective_parachains.rs
new file mode 100644
index 000000000000..4dc346f880ee
--- /dev/null
+++ b/node/core/backing/src/tests/prospective_parachains.rs
@@ -0,0 +1,1705 @@
+// Copyright 2022 Parity Technologies (UK) Ltd.
+// This file is part of Polkadot.
+
+// Polkadot is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Polkadot is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Polkadot. If not, see .
+
+//! Tests for the backing subsystem with enabled prospective parachains.
+
+use polkadot_node_subsystem::{
+ messages::{ChainApiMessage, FragmentTreeMembership},
+ TimeoutExt,
+};
+use polkadot_primitives::{vstaging as vstaging_primitives, BlockNumber, Header, OccupiedCore};
+
+use super::*;
+
+const ASYNC_BACKING_PARAMETERS: vstaging_primitives::AsyncBackingParameters =
+ vstaging_primitives::AsyncBackingParameters { max_candidate_depth: 4, allowed_ancestry_len: 3 };
+
+struct TestLeaf {
+ activated: ActivatedLeaf,
+ min_relay_parents: Vec<(ParaId, u32)>,
+}
+
+fn get_parent_hash(hash: Hash) -> Hash {
+ Hash::from_low_u64_be(hash.to_low_u64_be() + 1)
+}
+
+async fn activate_leaf(
+ virtual_overseer: &mut VirtualOverseer,
+ leaf: TestLeaf,
+ test_state: &TestState,
+ seconded_in_view: usize,
+) {
+ let TestLeaf { activated, min_relay_parents } = leaf;
+ let leaf_hash = activated.hash;
+ let leaf_number = activated.number;
+ // Start work on some new parent.
+ virtual_overseer
+ .send(FromOrchestra::Signal(OverseerSignal::ActiveLeaves(ActiveLeavesUpdate::start_work(
+ activated,
+ ))))
+ .await;
+
+ // Prospective parachains mode is temporarily defined by the Runtime API version.
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(parent, RuntimeApiRequest::StagingAsyncBackingParameters(tx))
+ ) if parent == leaf_hash => {
+ tx.send(Ok(ASYNC_BACKING_PARAMETERS)).unwrap();
+ }
+ );
+
+ let min_min = *min_relay_parents
+ .iter()
+ .map(|(_, block_num)| block_num)
+ .min()
+ .unwrap_or(&leaf_number);
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ProspectiveParachains(
+ ProspectiveParachainsMessage::GetMinimumRelayParents(parent, tx)
+ ) if parent == leaf_hash => {
+ tx.send(min_relay_parents).unwrap();
+ }
+ );
+
+ let ancestry_len = leaf_number + 1 - min_min;
+
+ let ancestry_hashes = std::iter::successors(Some(leaf_hash), |h| Some(get_parent_hash(*h)))
+ .take(ancestry_len as usize);
+ let ancestry_numbers = (min_min..=leaf_number).rev();
+ let ancestry_iter = ancestry_hashes.zip(ancestry_numbers).peekable();
+
+ let mut next_overseer_message = None;
+ // How many blocks were actually requested.
+ let mut requested_len = 0;
+ {
+ let mut ancestry_iter = ancestry_iter.clone();
+ loop {
+ let (hash, number) = match ancestry_iter.next() {
+ Some((hash, number)) => (hash, number),
+ None => break,
+ };
+
+ // May be `None` for the last element.
+ let parent_hash =
+ ancestry_iter.peek().map(|(h, _)| *h).unwrap_or_else(|| get_parent_hash(hash));
+
+ let msg = virtual_overseer.recv().await;
+ // It may happen that some blocks were cached by implicit view,
+ // reuse the message.
+ if !matches!(&msg, AllMessages::ChainApi(ChainApiMessage::BlockHeader(..))) {
+ next_overseer_message.replace(msg);
+ break
+ }
+
+ assert_matches!(
+ msg,
+ AllMessages::ChainApi(
+ ChainApiMessage::BlockHeader(_hash, tx)
+ ) if _hash == hash => {
+ let header = Header {
+ parent_hash,
+ number,
+ state_root: Hash::zero(),
+ extrinsics_root: Hash::zero(),
+ digest: Default::default(),
+ };
+
+ tx.send(Ok(Some(header))).unwrap();
+ }
+ );
+ requested_len += 1;
+ }
+ }
+
+ for _ in 0..seconded_in_view {
+ let msg = match next_overseer_message.take() {
+ Some(msg) => msg,
+ None => virtual_overseer.recv().await,
+ };
+ assert_matches!(
+ msg,
+ AllMessages::ProspectiveParachains(
+ ProspectiveParachainsMessage::GetTreeMembership(.., tx),
+ ) => {
+ tx.send(Vec::new()).unwrap();
+ }
+ );
+ }
+
+ for (hash, number) in ancestry_iter.take(requested_len) {
+ // Check that subsystem job issues a request for a validator set.
+ let msg = match next_overseer_message.take() {
+ Some(msg) => msg,
+ None => virtual_overseer.recv().await,
+ };
+ assert_matches!(
+ msg,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(parent, RuntimeApiRequest::Validators(tx))
+ ) if parent == hash => {
+ tx.send(Ok(test_state.validator_public.clone())).unwrap();
+ }
+ );
+
+ // Check that subsystem job issues a request for the validator groups.
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(parent, RuntimeApiRequest::ValidatorGroups(tx))
+ ) if parent == hash => {
+ let (validator_groups, mut group_rotation_info) = test_state.validator_groups.clone();
+ group_rotation_info.now = number;
+ tx.send(Ok((validator_groups, group_rotation_info))).unwrap();
+ }
+ );
+
+ // Check that subsystem job issues a request for the session index for child.
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(parent, RuntimeApiRequest::SessionIndexForChild(tx))
+ ) if parent == hash => {
+ tx.send(Ok(test_state.signing_context.session_index)).unwrap();
+ }
+ );
+
+ // Check that subsystem job issues a request for the availability cores.
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(parent, RuntimeApiRequest::AvailabilityCores(tx))
+ ) if parent == hash => {
+ tx.send(Ok(test_state.availability_cores.clone())).unwrap();
+ }
+ );
+ }
+}
+
+async fn assert_validate_seconded_candidate(
+ virtual_overseer: &mut VirtualOverseer,
+ relay_parent: Hash,
+ candidate: &CommittedCandidateReceipt,
+ pov: &PoV,
+ pvd: &PersistedValidationData,
+ validation_code: &ValidationCode,
+ expected_head_data: &HeadData,
+ fetch_pov: bool,
+) {
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(parent, RuntimeApiRequest::ValidationCodeByHash(hash, tx))
+ ) if parent == relay_parent && hash == validation_code.hash() => {
+ tx.send(Ok(Some(validation_code.clone()))).unwrap();
+ }
+ );
+
+ if fetch_pov {
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::AvailabilityDistribution(
+ AvailabilityDistributionMessage::FetchPoV {
+ relay_parent: hash,
+ tx,
+ ..
+ }
+ ) if hash == relay_parent => {
+ tx.send(pov.clone()).unwrap();
+ }
+ );
+ }
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::CandidateValidation(CandidateValidationMessage::ValidateFromExhaustive(
+ _pvd,
+ _validation_code,
+ candidate_receipt,
+ _pov,
+ timeout,
+ tx,
+ )) if &_pvd == pvd &&
+ &_validation_code == validation_code &&
+ &*_pov == pov &&
+ &candidate_receipt.descriptor == candidate.descriptor() &&
+ timeout == PvfExecTimeoutKind::Backing &&
+ candidate.commitments.hash() == candidate_receipt.commitments_hash =>
+ {
+ tx.send(Ok(ValidationResult::Valid(
+ CandidateCommitments {
+ head_data: expected_head_data.clone(),
+ horizontal_messages: Default::default(),
+ upward_messages: Default::default(),
+ new_validation_code: None,
+ processed_downward_messages: 0,
+ hrmp_watermark: 0,
+ },
+ pvd.clone(),
+ )))
+ .unwrap();
+ }
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::AvailabilityStore(
+ AvailabilityStoreMessage::StoreAvailableData { candidate_hash, tx, .. }
+ ) if candidate_hash == candidate.hash() => {
+ tx.send(Ok(())).unwrap();
+ }
+ );
+}
+
+async fn assert_hypothetical_frontier_requests(
+ virtual_overseer: &mut VirtualOverseer,
+ mut expected_requests: Vec<(
+ HypotheticalFrontierRequest,
+ Vec<(HypotheticalCandidate, FragmentTreeMembership)>,
+ )>,
+) {
+ // Requests come with no particular order.
+ let requests_num = expected_requests.len();
+
+ for _ in 0..requests_num {
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ProspectiveParachains(
+ ProspectiveParachainsMessage::GetHypotheticalFrontier(request, tx),
+ ) => {
+ let idx = match expected_requests.iter().position(|r| r.0 == request) {
+ Some(idx) => idx,
+ None => panic!(
+ "unexpected hypothetical frontier request, no match found for {:?}",
+ request
+ ),
+ };
+ let resp = std::mem::take(&mut expected_requests[idx].1);
+ tx.send(resp).unwrap();
+
+ expected_requests.remove(idx);
+ }
+ );
+ }
+}
+
+fn make_hypothetical_frontier_response(
+ depths: Vec,
+ hypothetical_candidate: HypotheticalCandidate,
+ relay_parent_hash: Hash,
+) -> Vec<(HypotheticalCandidate, FragmentTreeMembership)> {
+ vec![(hypothetical_candidate, vec![(relay_parent_hash, depths)])]
+}
+
+// Test that `seconding_sanity_check` works when a candidate is allowed
+// for all leaves.
+#[test]
+fn seconding_sanity_check_allowed() {
+ let test_state = TestState::default();
+ test_harness(test_state.keystore.clone(), |mut virtual_overseer| async move {
+ // Candidate is seconded in a parent of the activated `leaf_a`.
+ const LEAF_A_BLOCK_NUMBER: BlockNumber = 100;
+ const LEAF_A_ANCESTRY_LEN: BlockNumber = 3;
+ let para_id = test_state.chain_ids[0];
+
+ // `a` is grandparent of `b`.
+ let leaf_a_hash = Hash::from_low_u64_be(130);
+ let leaf_a_parent = get_parent_hash(leaf_a_hash);
+ let activated = ActivatedLeaf {
+ hash: leaf_a_hash,
+ number: LEAF_A_BLOCK_NUMBER,
+ status: LeafStatus::Fresh,
+ span: Arc::new(jaeger::Span::Disabled),
+ };
+ let min_relay_parents = vec![(para_id, LEAF_A_BLOCK_NUMBER - LEAF_A_ANCESTRY_LEN)];
+ let test_leaf_a = TestLeaf { activated, min_relay_parents };
+
+ const LEAF_B_BLOCK_NUMBER: BlockNumber = LEAF_A_BLOCK_NUMBER + 2;
+ const LEAF_B_ANCESTRY_LEN: BlockNumber = 4;
+
+ let leaf_b_hash = Hash::from_low_u64_be(128);
+ let activated = ActivatedLeaf {
+ hash: leaf_b_hash,
+ number: LEAF_B_BLOCK_NUMBER,
+ status: LeafStatus::Fresh,
+ span: Arc::new(jaeger::Span::Disabled),
+ };
+ let min_relay_parents = vec![(para_id, LEAF_B_BLOCK_NUMBER - LEAF_B_ANCESTRY_LEN)];
+ let test_leaf_b = TestLeaf { activated, min_relay_parents };
+
+ activate_leaf(&mut virtual_overseer, test_leaf_a, &test_state, 0).await;
+ activate_leaf(&mut virtual_overseer, test_leaf_b, &test_state, 0).await;
+
+ let pov = PoV { block_data: BlockData(vec![42, 43, 44]) };
+ let pvd = dummy_pvd();
+ let validation_code = ValidationCode(vec![1, 2, 3]);
+
+ let expected_head_data = test_state.head_data.get(¶_id).unwrap();
+
+ let pov_hash = pov.hash();
+ let candidate = TestCandidateBuilder {
+ para_id,
+ relay_parent: leaf_a_parent,
+ pov_hash,
+ head_data: expected_head_data.clone(),
+ erasure_root: make_erasure_root(&test_state, pov.clone(), pvd.clone()),
+ persisted_validation_data_hash: pvd.hash(),
+ validation_code: validation_code.0.clone(),
+ ..Default::default()
+ }
+ .build();
+
+ let second = CandidateBackingMessage::Second(
+ leaf_a_hash,
+ candidate.to_plain(),
+ pvd.clone(),
+ pov.clone(),
+ );
+
+ virtual_overseer.send(FromOrchestra::Communication { msg: second }).await;
+
+ assert_validate_seconded_candidate(
+ &mut virtual_overseer,
+ leaf_a_parent,
+ &candidate,
+ &pov,
+ &pvd,
+ &validation_code,
+ expected_head_data,
+ false,
+ )
+ .await;
+
+ // `seconding_sanity_check`
+ let hypothetical_candidate = HypotheticalCandidate::Complete {
+ candidate_hash: candidate.hash(),
+ receipt: Arc::new(candidate.clone()),
+ persisted_validation_data: pvd.clone(),
+ };
+ let expected_request_a = HypotheticalFrontierRequest {
+ candidates: vec![hypothetical_candidate.clone()],
+ fragment_tree_relay_parent: Some(leaf_a_hash),
+ backed_in_path_only: false,
+ };
+ let expected_response_a = make_hypothetical_frontier_response(
+ vec![0, 1, 2, 3],
+ hypothetical_candidate.clone(),
+ leaf_a_hash,
+ );
+ let expected_request_b = HypotheticalFrontierRequest {
+ candidates: vec![hypothetical_candidate.clone()],
+ fragment_tree_relay_parent: Some(leaf_b_hash),
+ backed_in_path_only: false,
+ };
+ let expected_response_b =
+ make_hypothetical_frontier_response(vec![3], hypothetical_candidate, leaf_b_hash);
+ assert_hypothetical_frontier_requests(
+ &mut virtual_overseer,
+ vec![
+ (expected_request_a, expected_response_a),
+ (expected_request_b, expected_response_b),
+ ],
+ )
+ .await;
+ // Prospective parachains are notified.
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ProspectiveParachains(
+ ProspectiveParachainsMessage::IntroduceCandidate(
+ req,
+ tx,
+ ),
+ ) if
+ req.candidate_receipt == candidate
+ && req.candidate_para == para_id
+ && pvd == req.persisted_validation_data => {
+ // Any non-empty response will do.
+ tx.send(vec![(leaf_a_hash, vec![0, 1, 2, 3])]).unwrap();
+ }
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ProspectiveParachains(ProspectiveParachainsMessage::CandidateSeconded(
+ _,
+ _
+ ))
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::StatementDistribution(
+ StatementDistributionMessage::Share(
+ parent_hash,
+ _signed_statement,
+ )
+ ) if parent_hash == leaf_a_parent => {}
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::CollatorProtocol(CollatorProtocolMessage::Seconded(hash, statement)) => {
+ assert_eq!(leaf_a_parent, hash);
+ assert_matches!(statement.payload(), Statement::Seconded(_));
+ }
+ );
+
+ virtual_overseer
+ });
+}
+
+// Test that `seconding_sanity_check` works when a candidate is disallowed
+// for at least one leaf.
+#[test]
+fn seconding_sanity_check_disallowed() {
+ let test_state = TestState::default();
+ test_harness(test_state.keystore.clone(), |mut virtual_overseer| async move {
+ // Candidate is seconded in a parent of the activated `leaf_a`.
+ const LEAF_A_BLOCK_NUMBER: BlockNumber = 100;
+ const LEAF_A_ANCESTRY_LEN: BlockNumber = 3;
+ let para_id = test_state.chain_ids[0];
+
+ let leaf_b_hash = Hash::from_low_u64_be(128);
+ // `a` is grandparent of `b`.
+ let leaf_a_hash = Hash::from_low_u64_be(130);
+ let leaf_a_parent = get_parent_hash(leaf_a_hash);
+ let activated = ActivatedLeaf {
+ hash: leaf_a_hash,
+ number: LEAF_A_BLOCK_NUMBER,
+ status: LeafStatus::Fresh,
+ span: Arc::new(jaeger::Span::Disabled),
+ };
+ let min_relay_parents = vec![(para_id, LEAF_A_BLOCK_NUMBER - LEAF_A_ANCESTRY_LEN)];
+ let test_leaf_a = TestLeaf { activated, min_relay_parents };
+
+ const LEAF_B_BLOCK_NUMBER: BlockNumber = LEAF_A_BLOCK_NUMBER + 2;
+ const LEAF_B_ANCESTRY_LEN: BlockNumber = 4;
+
+ let activated = ActivatedLeaf {
+ hash: leaf_b_hash,
+ number: LEAF_B_BLOCK_NUMBER,
+ status: LeafStatus::Fresh,
+ span: Arc::new(jaeger::Span::Disabled),
+ };
+ let min_relay_parents = vec![(para_id, LEAF_B_BLOCK_NUMBER - LEAF_B_ANCESTRY_LEN)];
+ let test_leaf_b = TestLeaf { activated, min_relay_parents };
+
+ activate_leaf(&mut virtual_overseer, test_leaf_a, &test_state, 0).await;
+
+ let pov = PoV { block_data: BlockData(vec![42, 43, 44]) };
+ let pvd = dummy_pvd();
+ let validation_code = ValidationCode(vec![1, 2, 3]);
+
+ let expected_head_data = test_state.head_data.get(¶_id).unwrap();
+
+ let pov_hash = pov.hash();
+ let candidate = TestCandidateBuilder {
+ para_id,
+ relay_parent: leaf_a_parent,
+ pov_hash,
+ head_data: expected_head_data.clone(),
+ erasure_root: make_erasure_root(&test_state, pov.clone(), pvd.clone()),
+ persisted_validation_data_hash: pvd.hash(),
+ validation_code: validation_code.0.clone(),
+ ..Default::default()
+ }
+ .build();
+
+ let second = CandidateBackingMessage::Second(
+ leaf_a_hash,
+ candidate.to_plain(),
+ pvd.clone(),
+ pov.clone(),
+ );
+
+ virtual_overseer.send(FromOrchestra::Communication { msg: second }).await;
+
+ assert_validate_seconded_candidate(
+ &mut virtual_overseer,
+ leaf_a_parent,
+ &candidate,
+ &pov,
+ &pvd,
+ &validation_code,
+ expected_head_data,
+ false,
+ )
+ .await;
+
+ // `seconding_sanity_check`
+ let hypothetical_candidate = HypotheticalCandidate::Complete {
+ candidate_hash: candidate.hash(),
+ receipt: Arc::new(candidate.clone()),
+ persisted_validation_data: pvd.clone(),
+ };
+ let expected_request_a = HypotheticalFrontierRequest {
+ candidates: vec![hypothetical_candidate.clone()],
+ fragment_tree_relay_parent: Some(leaf_a_hash),
+ backed_in_path_only: false,
+ };
+ let expected_response_a = make_hypothetical_frontier_response(
+ vec![0, 1, 2, 3],
+ hypothetical_candidate,
+ leaf_a_hash,
+ );
+ assert_hypothetical_frontier_requests(
+ &mut virtual_overseer,
+ vec![(expected_request_a, expected_response_a)],
+ )
+ .await;
+ // Prospective parachains are notified.
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ProspectiveParachains(
+ ProspectiveParachainsMessage::IntroduceCandidate(
+ req,
+ tx,
+ ),
+ ) if
+ req.candidate_receipt == candidate
+ && req.candidate_para == para_id
+ && pvd == req.persisted_validation_data => {
+ // Any non-empty response will do.
+ tx.send(vec![(leaf_a_hash, vec![0, 2, 3])]).unwrap();
+ }
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ProspectiveParachains(ProspectiveParachainsMessage::CandidateSeconded(
+ _,
+ _
+ ))
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::StatementDistribution(
+ StatementDistributionMessage::Share(
+ parent_hash,
+ _signed_statement,
+ )
+ ) if parent_hash == leaf_a_parent => {}
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::CollatorProtocol(CollatorProtocolMessage::Seconded(hash, statement)) => {
+ assert_eq!(leaf_a_parent, hash);
+ assert_matches!(statement.payload(), Statement::Seconded(_));
+ }
+ );
+
+ // A seconded candidate occupies a depth, try to second another one.
+ // It is allowed in a new leaf but not allowed in the old one.
+ // Expect it to be rejected.
+ activate_leaf(&mut virtual_overseer, test_leaf_b, &test_state, 1).await;
+ let leaf_a_grandparent = get_parent_hash(leaf_a_parent);
+ let candidate = TestCandidateBuilder {
+ para_id,
+ relay_parent: leaf_a_grandparent,
+ pov_hash,
+ head_data: expected_head_data.clone(),
+ erasure_root: make_erasure_root(&test_state, pov.clone(), pvd.clone()),
+ persisted_validation_data_hash: pvd.hash(),
+ validation_code: validation_code.0.clone(),
+ ..Default::default()
+ }
+ .build();
+
+ let second = CandidateBackingMessage::Second(
+ leaf_a_hash,
+ candidate.to_plain(),
+ pvd.clone(),
+ pov.clone(),
+ );
+
+ virtual_overseer.send(FromOrchestra::Communication { msg: second }).await;
+
+ assert_validate_seconded_candidate(
+ &mut virtual_overseer,
+ leaf_a_grandparent,
+ &candidate,
+ &pov,
+ &pvd,
+ &validation_code,
+ expected_head_data,
+ false,
+ )
+ .await;
+
+ // `seconding_sanity_check`
+
+ let hypothetical_candidate = HypotheticalCandidate::Complete {
+ candidate_hash: candidate.hash(),
+ receipt: Arc::new(candidate),
+ persisted_validation_data: pvd,
+ };
+ let expected_request_a = HypotheticalFrontierRequest {
+ candidates: vec![hypothetical_candidate.clone()],
+ fragment_tree_relay_parent: Some(leaf_a_hash),
+ backed_in_path_only: false,
+ };
+ let expected_response_a = make_hypothetical_frontier_response(
+ vec![3],
+ hypothetical_candidate.clone(),
+ leaf_a_hash,
+ );
+ let expected_request_b = HypotheticalFrontierRequest {
+ candidates: vec![hypothetical_candidate.clone()],
+ fragment_tree_relay_parent: Some(leaf_b_hash),
+ backed_in_path_only: false,
+ };
+ let expected_response_b =
+ make_hypothetical_frontier_response(vec![1], hypothetical_candidate, leaf_b_hash);
+ assert_hypothetical_frontier_requests(
+ &mut virtual_overseer,
+ vec![
+ (expected_request_a, expected_response_a), // All depths are occupied.
+ (expected_request_b, expected_response_b),
+ ],
+ )
+ .await;
+
+ assert!(virtual_overseer
+ .recv()
+ .timeout(std::time::Duration::from_millis(50))
+ .await
+ .is_none());
+
+ virtual_overseer
+ });
+}
+
+// Test that a seconded candidate which is not approved by prospective parachains
+// subsystem doesn't change the view.
+#[test]
+fn prospective_parachains_reject_candidate() {
+ let test_state = TestState::default();
+ test_harness(test_state.keystore.clone(), |mut virtual_overseer| async move {
+ // Candidate is seconded in a parent of the activated `leaf_a`.
+ const LEAF_A_BLOCK_NUMBER: BlockNumber = 100;
+ const LEAF_A_ANCESTRY_LEN: BlockNumber = 3;
+ let para_id = test_state.chain_ids[0];
+
+ let leaf_a_hash = Hash::from_low_u64_be(130);
+ let leaf_a_parent = get_parent_hash(leaf_a_hash);
+ let activated = ActivatedLeaf {
+ hash: leaf_a_hash,
+ number: LEAF_A_BLOCK_NUMBER,
+ status: LeafStatus::Fresh,
+ span: Arc::new(jaeger::Span::Disabled),
+ };
+ let min_relay_parents = vec![(para_id, LEAF_A_BLOCK_NUMBER - LEAF_A_ANCESTRY_LEN)];
+ let test_leaf_a = TestLeaf { activated, min_relay_parents };
+
+ activate_leaf(&mut virtual_overseer, test_leaf_a, &test_state, 0).await;
+
+ let pov = PoV { block_data: BlockData(vec![42, 43, 44]) };
+ let pvd = dummy_pvd();
+ let validation_code = ValidationCode(vec![1, 2, 3]);
+
+ let expected_head_data = test_state.head_data.get(¶_id).unwrap();
+
+ let pov_hash = pov.hash();
+ let candidate = TestCandidateBuilder {
+ para_id,
+ relay_parent: leaf_a_parent,
+ pov_hash,
+ head_data: expected_head_data.clone(),
+ erasure_root: make_erasure_root(&test_state, pov.clone(), pvd.clone()),
+ persisted_validation_data_hash: pvd.hash(),
+ validation_code: validation_code.0.clone(),
+ ..Default::default()
+ }
+ .build();
+
+ let second = CandidateBackingMessage::Second(
+ leaf_a_hash,
+ candidate.to_plain(),
+ pvd.clone(),
+ pov.clone(),
+ );
+
+ virtual_overseer.send(FromOrchestra::Communication { msg: second }).await;
+
+ assert_validate_seconded_candidate(
+ &mut virtual_overseer,
+ leaf_a_parent,
+ &candidate,
+ &pov,
+ &pvd,
+ &validation_code,
+ expected_head_data,
+ false,
+ )
+ .await;
+
+ // `seconding_sanity_check`
+ let hypothetical_candidate = HypotheticalCandidate::Complete {
+ candidate_hash: candidate.hash(),
+ receipt: Arc::new(candidate.clone()),
+ persisted_validation_data: pvd.clone(),
+ };
+ let expected_request_a = vec![(
+ HypotheticalFrontierRequest {
+ candidates: vec![hypothetical_candidate.clone()],
+ fragment_tree_relay_parent: Some(leaf_a_hash),
+ backed_in_path_only: false,
+ },
+ make_hypothetical_frontier_response(
+ vec![0, 1, 2, 3],
+ hypothetical_candidate,
+ leaf_a_hash,
+ ),
+ )];
+ assert_hypothetical_frontier_requests(&mut virtual_overseer, expected_request_a.clone())
+ .await;
+
+ // Prospective parachains are notified.
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ProspectiveParachains(
+ ProspectiveParachainsMessage::IntroduceCandidate(
+ req,
+ tx,
+ ),
+ ) if
+ req.candidate_receipt == candidate
+ && req.candidate_para == para_id
+ && pvd == req.persisted_validation_data => {
+ // Reject it.
+ tx.send(Vec::new()).unwrap();
+ }
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::CollatorProtocol(CollatorProtocolMessage::Invalid(
+ relay_parent,
+ candidate_receipt,
+ )) if candidate_receipt.descriptor() == candidate.descriptor() &&
+ candidate_receipt.commitments_hash == candidate.commitments.hash() &&
+ relay_parent == leaf_a_parent
+ );
+
+ // Try seconding the same candidate.
+
+ let second = CandidateBackingMessage::Second(
+ leaf_a_hash,
+ candidate.to_plain(),
+ pvd.clone(),
+ pov.clone(),
+ );
+
+ virtual_overseer.send(FromOrchestra::Communication { msg: second }).await;
+
+ assert_validate_seconded_candidate(
+ &mut virtual_overseer,
+ leaf_a_parent,
+ &candidate,
+ &pov,
+ &pvd,
+ &validation_code,
+ expected_head_data,
+ false,
+ )
+ .await;
+
+ // `seconding_sanity_check`
+ assert_hypothetical_frontier_requests(&mut virtual_overseer, expected_request_a).await;
+ // Prospective parachains are notified.
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ProspectiveParachains(
+ ProspectiveParachainsMessage::IntroduceCandidate(
+ req,
+ tx,
+ ),
+ ) if
+ req.candidate_receipt == candidate
+ && req.candidate_para == para_id
+ && pvd == req.persisted_validation_data => {
+ // Any non-empty response will do.
+ tx.send(vec![(leaf_a_hash, vec![0, 2, 3])]).unwrap();
+ }
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ProspectiveParachains(ProspectiveParachainsMessage::CandidateSeconded(
+ _,
+ _
+ ))
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::StatementDistribution(
+ StatementDistributionMessage::Share(
+ parent_hash,
+ _signed_statement,
+ )
+ ) if parent_hash == leaf_a_parent => {}
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::CollatorProtocol(CollatorProtocolMessage::Seconded(hash, statement)) => {
+ assert_eq!(leaf_a_parent, hash);
+ assert_matches!(statement.payload(), Statement::Seconded(_));
+ }
+ );
+
+ virtual_overseer
+ });
+}
+
+// Test that a validator can second multiple candidates per single relay parent.
+#[test]
+fn second_multiple_candidates_per_relay_parent() {
+ let test_state = TestState::default();
+ test_harness(test_state.keystore.clone(), |mut virtual_overseer| async move {
+ // Candidate `a` is seconded in a parent of the activated `leaf`.
+ const LEAF_BLOCK_NUMBER: BlockNumber = 100;
+ const LEAF_ANCESTRY_LEN: BlockNumber = 3;
+ let para_id = test_state.chain_ids[0];
+
+ let leaf_hash = Hash::from_low_u64_be(130);
+ let leaf_parent = get_parent_hash(leaf_hash);
+ let leaf_grandparent = get_parent_hash(leaf_parent);
+ let activated = ActivatedLeaf {
+ hash: leaf_hash,
+ number: LEAF_BLOCK_NUMBER,
+ status: LeafStatus::Fresh,
+ span: Arc::new(jaeger::Span::Disabled),
+ };
+ let min_relay_parents = vec![(para_id, LEAF_BLOCK_NUMBER - LEAF_ANCESTRY_LEN)];
+ let test_leaf_a = TestLeaf { activated, min_relay_parents };
+
+ activate_leaf(&mut virtual_overseer, test_leaf_a, &test_state, 0).await;
+
+ let pov = PoV { block_data: BlockData(vec![42, 43, 44]) };
+ let pvd = dummy_pvd();
+ let validation_code = ValidationCode(vec![1, 2, 3]);
+
+ let expected_head_data = test_state.head_data.get(¶_id).unwrap();
+
+ let pov_hash = pov.hash();
+ let candidate_a = TestCandidateBuilder {
+ para_id,
+ relay_parent: leaf_parent,
+ pov_hash,
+ head_data: expected_head_data.clone(),
+ erasure_root: make_erasure_root(&test_state, pov.clone(), pvd.clone()),
+ persisted_validation_data_hash: pvd.hash(),
+ validation_code: validation_code.0.clone(),
+ ..Default::default()
+ };
+ let mut candidate_b = candidate_a.clone();
+ candidate_b.relay_parent = leaf_grandparent;
+
+ // With depths.
+ let candidate_a = (candidate_a.build(), 1);
+ let candidate_b = (candidate_b.build(), 2);
+
+ for candidate in &[candidate_a, candidate_b] {
+ let (candidate, depth) = candidate;
+ let second = CandidateBackingMessage::Second(
+ leaf_hash,
+ candidate.to_plain(),
+ pvd.clone(),
+ pov.clone(),
+ );
+
+ virtual_overseer.send(FromOrchestra::Communication { msg: second }).await;
+
+ assert_validate_seconded_candidate(
+ &mut virtual_overseer,
+ candidate.descriptor().relay_parent,
+ &candidate,
+ &pov,
+ &pvd,
+ &validation_code,
+ expected_head_data,
+ false,
+ )
+ .await;
+
+ // `seconding_sanity_check`
+ let hypothetical_candidate = HypotheticalCandidate::Complete {
+ candidate_hash: candidate.hash(),
+ receipt: Arc::new(candidate.clone()),
+ persisted_validation_data: pvd.clone(),
+ };
+ let expected_request_a = vec![(
+ HypotheticalFrontierRequest {
+ candidates: vec![hypothetical_candidate.clone()],
+ fragment_tree_relay_parent: Some(leaf_hash),
+ backed_in_path_only: false,
+ },
+ make_hypothetical_frontier_response(
+ vec![*depth],
+ hypothetical_candidate,
+ leaf_hash,
+ ),
+ )];
+ assert_hypothetical_frontier_requests(
+ &mut virtual_overseer,
+ expected_request_a.clone(),
+ )
+ .await;
+
+ // Prospective parachains are notified.
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ProspectiveParachains(
+ ProspectiveParachainsMessage::IntroduceCandidate(
+ req,
+ tx,
+ ),
+ ) if
+ &req.candidate_receipt == candidate
+ && req.candidate_para == para_id
+ && pvd == req.persisted_validation_data
+ => {
+ // Any non-empty response will do.
+ tx.send(vec![(leaf_hash, vec![0, 2, 3])]).unwrap();
+ }
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ProspectiveParachains(
+ ProspectiveParachainsMessage::CandidateSeconded(_, _)
+ )
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::StatementDistribution(
+ StatementDistributionMessage::Share(
+ parent_hash,
+ _signed_statement,
+ )
+ ) if parent_hash == candidate.descriptor().relay_parent => {}
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::CollatorProtocol(CollatorProtocolMessage::Seconded(hash, statement)) => {
+ assert_eq!(candidate.descriptor().relay_parent, hash);
+ assert_matches!(statement.payload(), Statement::Seconded(_));
+ }
+ );
+ }
+
+ virtual_overseer
+ });
+}
+
+// Test that the candidate reaches quorum successfully.
+#[test]
+fn backing_works() {
+ let test_state = TestState::default();
+ test_harness(test_state.keystore.clone(), |mut virtual_overseer| async move {
+ // Candidate `a` is seconded in a parent of the activated `leaf`.
+ const LEAF_BLOCK_NUMBER: BlockNumber = 100;
+ const LEAF_ANCESTRY_LEN: BlockNumber = 3;
+ let para_id = test_state.chain_ids[0];
+
+ let leaf_hash = Hash::from_low_u64_be(130);
+ let leaf_parent = get_parent_hash(leaf_hash);
+ let activated = ActivatedLeaf {
+ hash: leaf_hash,
+ number: LEAF_BLOCK_NUMBER,
+ status: LeafStatus::Fresh,
+ span: Arc::new(jaeger::Span::Disabled),
+ };
+ let min_relay_parents = vec![(para_id, LEAF_BLOCK_NUMBER - LEAF_ANCESTRY_LEN)];
+ let test_leaf_a = TestLeaf { activated, min_relay_parents };
+
+ activate_leaf(&mut virtual_overseer, test_leaf_a, &test_state, 0).await;
+
+ let pov = PoV { block_data: BlockData(vec![42, 43, 44]) };
+ let pvd = dummy_pvd();
+ let validation_code = ValidationCode(vec![1, 2, 3]);
+
+ let expected_head_data = test_state.head_data.get(¶_id).unwrap();
+
+ let pov_hash = pov.hash();
+
+ let candidate_a = TestCandidateBuilder {
+ para_id,
+ relay_parent: leaf_parent,
+ pov_hash,
+ head_data: expected_head_data.clone(),
+ erasure_root: make_erasure_root(&test_state, pov.clone(), pvd.clone()),
+ validation_code: validation_code.0.clone(),
+ persisted_validation_data_hash: pvd.hash(),
+ ..Default::default()
+ }
+ .build();
+
+ let candidate_a_hash = candidate_a.hash();
+ let candidate_a_para_head = candidate_a.descriptor().para_head;
+
+ let public1 = Keystore::sr25519_generate_new(
+ &*test_state.keystore,
+ ValidatorId::ID,
+ Some(&test_state.validators[5].to_seed()),
+ )
+ .expect("Insert key into keystore");
+ let public2 = Keystore::sr25519_generate_new(
+ &*test_state.keystore,
+ ValidatorId::ID,
+ Some(&test_state.validators[2].to_seed()),
+ )
+ .expect("Insert key into keystore");
+
+ // Signing context should have a parent hash candidate is based on.
+ let signing_context =
+ SigningContext { parent_hash: leaf_parent, session_index: test_state.session() };
+ let signed_a = SignedFullStatementWithPVD::sign(
+ &test_state.keystore,
+ StatementWithPVD::Seconded(candidate_a.clone(), pvd.clone()),
+ &signing_context,
+ ValidatorIndex(2),
+ &public2.into(),
+ )
+ .ok()
+ .flatten()
+ .expect("should be signed");
+
+ let signed_b = SignedFullStatementWithPVD::sign(
+ &test_state.keystore,
+ StatementWithPVD::Valid(candidate_a_hash),
+ &signing_context,
+ ValidatorIndex(5),
+ &public1.into(),
+ )
+ .ok()
+ .flatten()
+ .expect("should be signed");
+
+ let statement = CandidateBackingMessage::Statement(leaf_parent, signed_a.clone());
+
+ virtual_overseer.send(FromOrchestra::Communication { msg: statement }).await;
+
+ // Prospective parachains are notified about candidate seconded first.
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ProspectiveParachains(
+ ProspectiveParachainsMessage::IntroduceCandidate(
+ req,
+ tx,
+ ),
+ ) if
+ req.candidate_receipt == candidate_a
+ && req.candidate_para == para_id
+ && pvd == req.persisted_validation_data => {
+ // Any non-empty response will do.
+ tx.send(vec![(leaf_hash, vec![0, 2, 3])]).unwrap();
+ }
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ProspectiveParachains(ProspectiveParachainsMessage::CandidateSeconded(
+ _,
+ _
+ ))
+ );
+
+ assert_validate_seconded_candidate(
+ &mut virtual_overseer,
+ candidate_a.descriptor().relay_parent,
+ &candidate_a,
+ &pov,
+ &pvd,
+ &validation_code,
+ expected_head_data,
+ true,
+ )
+ .await;
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::StatementDistribution(
+ StatementDistributionMessage::Share(hash, _stmt)
+ ) => {
+ assert_eq!(leaf_parent, hash);
+ }
+ );
+
+ // Prospective parachains and collator protocol are notified about candidate backed.
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ProspectiveParachains(
+ ProspectiveParachainsMessage::CandidateBacked(
+ candidate_para_id, candidate_hash
+ ),
+ ) if candidate_a_hash == candidate_hash && candidate_para_id == para_id
+ );
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::CollatorProtocol(CollatorProtocolMessage::Backed {
+ para_id: _para_id,
+ para_head,
+ }) if para_id == _para_id && candidate_a_para_head == para_head
+ );
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::StatementDistribution(StatementDistributionMessage::Backed (
+ candidate_hash
+ )) if candidate_a_hash == candidate_hash
+ );
+
+ let statement = CandidateBackingMessage::Statement(leaf_parent, signed_b.clone());
+
+ virtual_overseer.send(FromOrchestra::Communication { msg: statement }).await;
+
+ virtual_overseer
+ });
+}
+
+// Tests that validators start work on consecutive prospective parachain blocks.
+#[test]
+fn concurrent_dependent_candidates() {
+ let test_state = TestState::default();
+ test_harness(test_state.keystore.clone(), |mut virtual_overseer| async move {
+ // Candidate `a` is seconded in a grandparent of the activated `leaf`,
+ // candidate `b` -- in parent.
+ const LEAF_BLOCK_NUMBER: BlockNumber = 100;
+ const LEAF_ANCESTRY_LEN: BlockNumber = 3;
+ let para_id = test_state.chain_ids[0];
+
+ let leaf_hash = Hash::from_low_u64_be(130);
+ let leaf_parent = get_parent_hash(leaf_hash);
+ let leaf_grandparent = get_parent_hash(leaf_parent);
+ let activated = ActivatedLeaf {
+ hash: leaf_hash,
+ number: LEAF_BLOCK_NUMBER,
+ status: LeafStatus::Fresh,
+ span: Arc::new(jaeger::Span::Disabled),
+ };
+ let min_relay_parents = vec![(para_id, LEAF_BLOCK_NUMBER - LEAF_ANCESTRY_LEN)];
+ let test_leaf_a = TestLeaf { activated, min_relay_parents };
+
+ activate_leaf(&mut virtual_overseer, test_leaf_a, &test_state, 0).await;
+
+ let head_data = &[
+ HeadData(vec![10, 20, 30]), // Before `a`.
+ HeadData(vec![11, 21, 31]), // After `a`.
+ HeadData(vec![12, 22]), // After `b`.
+ ];
+
+ let pov_a = PoV { block_data: BlockData(vec![42, 43, 44]) };
+ let pvd_a = PersistedValidationData {
+ parent_head: head_data[0].clone(),
+ relay_parent_number: LEAF_BLOCK_NUMBER - 2,
+ relay_parent_storage_root: Hash::zero(),
+ max_pov_size: 1024,
+ };
+
+ let pov_b = PoV { block_data: BlockData(vec![22, 14, 100]) };
+ let pvd_b = PersistedValidationData {
+ parent_head: head_data[1].clone(),
+ relay_parent_number: LEAF_BLOCK_NUMBER - 1,
+ relay_parent_storage_root: Hash::zero(),
+ max_pov_size: 1024,
+ };
+ let validation_code = ValidationCode(vec![1, 2, 3]);
+
+ let candidate_a = TestCandidateBuilder {
+ para_id,
+ relay_parent: leaf_grandparent,
+ pov_hash: pov_a.hash(),
+ head_data: head_data[1].clone(),
+ erasure_root: make_erasure_root(&test_state, pov_a.clone(), pvd_a.clone()),
+ persisted_validation_data_hash: pvd_a.hash(),
+ validation_code: validation_code.0.clone(),
+ ..Default::default()
+ }
+ .build();
+ let candidate_b = TestCandidateBuilder {
+ para_id,
+ relay_parent: leaf_parent,
+ pov_hash: pov_b.hash(),
+ head_data: head_data[2].clone(),
+ erasure_root: make_erasure_root(&test_state, pov_b.clone(), pvd_b.clone()),
+ persisted_validation_data_hash: pvd_b.hash(),
+ validation_code: validation_code.0.clone(),
+ ..Default::default()
+ }
+ .build();
+ let candidate_a_hash = candidate_a.hash();
+ let candidate_b_hash = candidate_b.hash();
+
+ let public1 = Keystore::sr25519_generate_new(
+ &*test_state.keystore,
+ ValidatorId::ID,
+ Some(&test_state.validators[5].to_seed()),
+ )
+ .expect("Insert key into keystore");
+ let public2 = Keystore::sr25519_generate_new(
+ &*test_state.keystore,
+ ValidatorId::ID,
+ Some(&test_state.validators[2].to_seed()),
+ )
+ .expect("Insert key into keystore");
+
+ // Signing context should have a parent hash candidate is based on.
+ let signing_context =
+ SigningContext { parent_hash: leaf_grandparent, session_index: test_state.session() };
+ let signed_a = SignedFullStatementWithPVD::sign(
+ &test_state.keystore,
+ StatementWithPVD::Seconded(candidate_a.clone(), pvd_a.clone()),
+ &signing_context,
+ ValidatorIndex(2),
+ &public2.into(),
+ )
+ .ok()
+ .flatten()
+ .expect("should be signed");
+
+ let signing_context =
+ SigningContext { parent_hash: leaf_parent, session_index: test_state.session() };
+ let signed_b = SignedFullStatementWithPVD::sign(
+ &test_state.keystore,
+ StatementWithPVD::Seconded(candidate_b.clone(), pvd_b.clone()),
+ &signing_context,
+ ValidatorIndex(5),
+ &public1.into(),
+ )
+ .ok()
+ .flatten()
+ .expect("should be signed");
+
+ let statement_a = CandidateBackingMessage::Statement(leaf_grandparent, signed_a.clone());
+ let statement_b = CandidateBackingMessage::Statement(leaf_parent, signed_b.clone());
+
+ virtual_overseer.send(FromOrchestra::Communication { msg: statement_a }).await;
+ // At this point the subsystem waits for response, the previous message is received,
+ // send a second one without blocking.
+ let _ = virtual_overseer
+ .tx
+ .start_send_unpin(FromOrchestra::Communication { msg: statement_b });
+
+ let mut valid_statements = HashSet::new();
+ let mut backed_statements = HashSet::new();
+
+ loop {
+ let msg = virtual_overseer
+ .recv()
+ .timeout(std::time::Duration::from_secs(1))
+ .await
+ .expect("overseer recv timed out");
+
+ // Order is not guaranteed since we have 2 statements being handled concurrently.
+ match msg {
+ AllMessages::ProspectiveParachains(
+ ProspectiveParachainsMessage::IntroduceCandidate(_, tx),
+ ) => {
+ tx.send(vec![(leaf_hash, vec![0, 2, 3])]).unwrap();
+ },
+ AllMessages::ProspectiveParachains(
+ ProspectiveParachainsMessage::CandidateSeconded(_, _),
+ ) => {},
+ AllMessages::RuntimeApi(RuntimeApiMessage::Request(
+ _,
+ RuntimeApiRequest::ValidationCodeByHash(_, tx),
+ )) => {
+ tx.send(Ok(Some(validation_code.clone()))).unwrap();
+ },
+ AllMessages::AvailabilityDistribution(
+ AvailabilityDistributionMessage::FetchPoV { candidate_hash, tx, .. },
+ ) => {
+ let pov = if candidate_hash == candidate_a_hash {
+ &pov_a
+ } else if candidate_hash == candidate_b_hash {
+ &pov_b
+ } else {
+ panic!("unknown candidate hash")
+ };
+ tx.send(pov.clone()).unwrap();
+ },
+ AllMessages::CandidateValidation(
+ CandidateValidationMessage::ValidateFromExhaustive(.., candidate, _, _, tx),
+ ) => {
+ let candidate_hash = candidate.hash();
+ let (head_data, pvd) = if candidate_hash == candidate_a_hash {
+ (&head_data[1], &pvd_a)
+ } else if candidate_hash == candidate_b_hash {
+ (&head_data[2], &pvd_b)
+ } else {
+ panic!("unknown candidate hash")
+ };
+ tx.send(Ok(ValidationResult::Valid(
+ CandidateCommitments {
+ head_data: head_data.clone(),
+ horizontal_messages: Default::default(),
+ upward_messages: Default::default(),
+ new_validation_code: None,
+ processed_downward_messages: 0,
+ hrmp_watermark: 0,
+ },
+ pvd.clone(),
+ )))
+ .unwrap();
+ },
+ AllMessages::AvailabilityStore(AvailabilityStoreMessage::StoreAvailableData {
+ tx,
+ ..
+ }) => {
+ tx.send(Ok(())).unwrap();
+ },
+ AllMessages::ProspectiveParachains(
+ ProspectiveParachainsMessage::CandidateBacked(..),
+ ) => {},
+ AllMessages::CollatorProtocol(CollatorProtocolMessage::Backed { .. }) => {},
+ AllMessages::StatementDistribution(StatementDistributionMessage::Share(
+ _,
+ statement,
+ )) => {
+ assert_eq!(statement.validator_index(), ValidatorIndex(0));
+ let payload = statement.payload();
+ assert_matches!(
+ payload.clone(),
+ StatementWithPVD::Valid(hash)
+ if hash == candidate_a_hash || hash == candidate_b_hash =>
+ {
+ assert!(valid_statements.insert(hash));
+ }
+ );
+ },
+ AllMessages::StatementDistribution(StatementDistributionMessage::Backed(hash)) => {
+ // Ensure that `Share` was received first for the candidate.
+ assert!(valid_statements.contains(&hash));
+ backed_statements.insert(hash);
+
+ if backed_statements.len() == 2 {
+ break
+ }
+ },
+ _ => panic!("unexpected message received from overseer: {:?}", msg),
+ }
+ }
+
+ assert!(valid_statements.contains(&candidate_a_hash));
+ assert!(valid_statements.contains(&candidate_b_hash));
+ assert!(backed_statements.contains(&candidate_a_hash));
+ assert!(backed_statements.contains(&candidate_b_hash));
+
+ virtual_overseer
+ });
+}
+
+// Test that multiple candidates from different paras can occupy the same depth
+// in a given relay parent.
+#[test]
+fn seconding_sanity_check_occupy_same_depth() {
+ let test_state = TestState::default();
+ test_harness(test_state.keystore.clone(), |mut virtual_overseer| async move {
+ // Candidate `a` is seconded in a parent of the activated `leaf`.
+ const LEAF_BLOCK_NUMBER: BlockNumber = 100;
+ const LEAF_ANCESTRY_LEN: BlockNumber = 3;
+
+ let para_id_a = test_state.chain_ids[0];
+ let para_id_b = test_state.chain_ids[1];
+
+ let leaf_hash = Hash::from_low_u64_be(130);
+ let leaf_parent = get_parent_hash(leaf_hash);
+
+ let activated = ActivatedLeaf {
+ hash: leaf_hash,
+ number: LEAF_BLOCK_NUMBER,
+ status: LeafStatus::Fresh,
+ span: Arc::new(jaeger::Span::Disabled),
+ };
+
+ let min_block_number = LEAF_BLOCK_NUMBER - LEAF_ANCESTRY_LEN;
+ let min_relay_parents = vec![(para_id_a, min_block_number), (para_id_b, min_block_number)];
+ let test_leaf_a = TestLeaf { activated, min_relay_parents };
+
+ activate_leaf(&mut virtual_overseer, test_leaf_a, &test_state, 0).await;
+
+ let pov = PoV { block_data: BlockData(vec![42, 43, 44]) };
+ let pvd = dummy_pvd();
+ let validation_code = ValidationCode(vec![1, 2, 3]);
+
+ let expected_head_data_a = test_state.head_data.get(¶_id_a).unwrap();
+ let expected_head_data_b = test_state.head_data.get(¶_id_b).unwrap();
+
+ let pov_hash = pov.hash();
+ let candidate_a = TestCandidateBuilder {
+ para_id: para_id_a,
+ relay_parent: leaf_parent,
+ pov_hash,
+ head_data: expected_head_data_a.clone(),
+ erasure_root: make_erasure_root(&test_state, pov.clone(), pvd.clone()),
+ persisted_validation_data_hash: pvd.hash(),
+ validation_code: validation_code.0.clone(),
+ ..Default::default()
+ };
+
+ let mut candidate_b = candidate_a.clone();
+ candidate_b.para_id = para_id_b;
+ candidate_b.head_data = expected_head_data_b.clone();
+ // A rotation happens, test validator is assigned to second para here.
+ candidate_b.relay_parent = leaf_hash;
+
+ let candidate_a = (candidate_a.build(), expected_head_data_a, para_id_a);
+ let candidate_b = (candidate_b.build(), expected_head_data_b, para_id_b);
+
+ for candidate in &[candidate_a, candidate_b] {
+ let (candidate, expected_head_data, para_id) = candidate;
+ let second = CandidateBackingMessage::Second(
+ leaf_hash,
+ candidate.to_plain(),
+ pvd.clone(),
+ pov.clone(),
+ );
+
+ virtual_overseer.send(FromOrchestra::Communication { msg: second }).await;
+
+ assert_validate_seconded_candidate(
+ &mut virtual_overseer,
+ candidate.descriptor().relay_parent,
+ &candidate,
+ &pov,
+ &pvd,
+ &validation_code,
+ *expected_head_data,
+ false,
+ )
+ .await;
+
+ // `seconding_sanity_check`
+ let hypothetical_candidate = HypotheticalCandidate::Complete {
+ candidate_hash: candidate.hash(),
+ receipt: Arc::new(candidate.clone()),
+ persisted_validation_data: pvd.clone(),
+ };
+ let expected_request_a = vec![(
+ HypotheticalFrontierRequest {
+ candidates: vec![hypothetical_candidate.clone()],
+ fragment_tree_relay_parent: Some(leaf_hash),
+ backed_in_path_only: false,
+ },
+ // Send the same membership for both candidates.
+ make_hypothetical_frontier_response(vec![0, 1], hypothetical_candidate, leaf_hash),
+ )];
+
+ assert_hypothetical_frontier_requests(
+ &mut virtual_overseer,
+ expected_request_a.clone(),
+ )
+ .await;
+
+ // Prospective parachains are notified.
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ProspectiveParachains(
+ ProspectiveParachainsMessage::IntroduceCandidate(
+ req,
+ tx,
+ ),
+ ) if
+ &req.candidate_receipt == candidate
+ && &req.candidate_para == para_id
+ && pvd == req.persisted_validation_data
+ => {
+ // Any non-empty response will do.
+ tx.send(vec![(leaf_hash, vec![0, 2, 3])]).unwrap();
+ }
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ProspectiveParachains(
+ ProspectiveParachainsMessage::CandidateSeconded(_, _)
+ )
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::StatementDistribution(
+ StatementDistributionMessage::Share(
+ parent_hash,
+ _signed_statement,
+ )
+ ) if parent_hash == candidate.descriptor().relay_parent => {}
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::CollatorProtocol(CollatorProtocolMessage::Seconded(hash, statement)) => {
+ assert_eq!(candidate.descriptor().relay_parent, hash);
+ assert_matches!(statement.payload(), Statement::Seconded(_));
+ }
+ );
+ }
+
+ virtual_overseer
+ });
+}
+
+// Test that the subsystem doesn't skip occupied cores assignments.
+#[test]
+fn occupied_core_assignment() {
+ let mut test_state = TestState::default();
+ test_harness(test_state.keystore.clone(), |mut virtual_overseer| async move {
+ // Candidate is seconded in a parent of the activated `leaf_a`.
+ const LEAF_A_BLOCK_NUMBER: BlockNumber = 100;
+ const LEAF_A_ANCESTRY_LEN: BlockNumber = 3;
+ let para_id = test_state.chain_ids[0];
+
+ // Set the core state to occupied.
+ let mut candidate_descriptor = ::test_helpers::dummy_candidate_descriptor(Hash::zero());
+ candidate_descriptor.para_id = para_id;
+ test_state.availability_cores[0] = CoreState::Occupied(OccupiedCore {
+ group_responsible: Default::default(),
+ next_up_on_available: None,
+ occupied_since: 100_u32,
+ time_out_at: 200_u32,
+ next_up_on_time_out: None,
+ availability: Default::default(),
+ candidate_descriptor,
+ candidate_hash: Default::default(),
+ });
+
+ let leaf_a_hash = Hash::from_low_u64_be(130);
+ let leaf_a_parent = get_parent_hash(leaf_a_hash);
+ let activated = ActivatedLeaf {
+ hash: leaf_a_hash,
+ number: LEAF_A_BLOCK_NUMBER,
+ status: LeafStatus::Fresh,
+ span: Arc::new(jaeger::Span::Disabled),
+ };
+ let min_relay_parents = vec![(para_id, LEAF_A_BLOCK_NUMBER - LEAF_A_ANCESTRY_LEN)];
+ let test_leaf_a = TestLeaf { activated, min_relay_parents };
+
+ activate_leaf(&mut virtual_overseer, test_leaf_a, &test_state, 0).await;
+
+ let pov = PoV { block_data: BlockData(vec![42, 43, 44]) };
+ let pvd = dummy_pvd();
+ let validation_code = ValidationCode(vec![1, 2, 3]);
+
+ let expected_head_data = test_state.head_data.get(¶_id).unwrap();
+
+ let pov_hash = pov.hash();
+ let candidate = TestCandidateBuilder {
+ para_id,
+ relay_parent: leaf_a_parent,
+ pov_hash,
+ head_data: expected_head_data.clone(),
+ erasure_root: make_erasure_root(&test_state, pov.clone(), pvd.clone()),
+ persisted_validation_data_hash: pvd.hash(),
+ validation_code: validation_code.0.clone(),
+ ..Default::default()
+ }
+ .build();
+
+ let second = CandidateBackingMessage::Second(
+ leaf_a_hash,
+ candidate.to_plain(),
+ pvd.clone(),
+ pov.clone(),
+ );
+
+ virtual_overseer.send(FromOrchestra::Communication { msg: second }).await;
+
+ assert_validate_seconded_candidate(
+ &mut virtual_overseer,
+ leaf_a_parent,
+ &candidate,
+ &pov,
+ &pvd,
+ &validation_code,
+ expected_head_data,
+ false,
+ )
+ .await;
+
+ // `seconding_sanity_check`
+ let hypothetical_candidate = HypotheticalCandidate::Complete {
+ candidate_hash: candidate.hash(),
+ receipt: Arc::new(candidate.clone()),
+ persisted_validation_data: pvd.clone(),
+ };
+ let expected_request = vec![(
+ HypotheticalFrontierRequest {
+ candidates: vec![hypothetical_candidate.clone()],
+ fragment_tree_relay_parent: Some(leaf_a_hash),
+ backed_in_path_only: false,
+ },
+ make_hypothetical_frontier_response(
+ vec![0, 1, 2, 3],
+ hypothetical_candidate,
+ leaf_a_hash,
+ ),
+ )];
+ assert_hypothetical_frontier_requests(&mut virtual_overseer, expected_request).await;
+ // Prospective parachains are notified.
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ProspectiveParachains(
+ ProspectiveParachainsMessage::IntroduceCandidate(
+ req,
+ tx,
+ ),
+ ) if
+ req.candidate_receipt == candidate
+ && req.candidate_para == para_id
+ && pvd == req.persisted_validation_data
+ => {
+ // Any non-empty response will do.
+ tx.send(vec![(leaf_a_hash, vec![0, 1, 2, 3])]).unwrap();
+ }
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ProspectiveParachains(ProspectiveParachainsMessage::CandidateSeconded(
+ _,
+ _
+ ))
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::StatementDistribution(
+ StatementDistributionMessage::Share(
+ parent_hash,
+ _signed_statement,
+ )
+ ) if parent_hash == leaf_a_parent => {}
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::CollatorProtocol(CollatorProtocolMessage::Seconded(hash, statement)) => {
+ assert_eq!(leaf_a_parent, hash);
+ assert_matches!(statement.payload(), Statement::Seconded(_));
+ }
+ );
+
+ virtual_overseer
+ });
+}
diff --git a/node/core/dispute-coordinator/src/import.rs b/node/core/dispute-coordinator/src/import.rs
index 4f6edc5fcef0..3caca8e02cac 100644
--- a/node/core/dispute-coordinator/src/import.rs
+++ b/node/core/dispute-coordinator/src/import.rs
@@ -97,7 +97,7 @@ pub enum OwnVoteState {
}
impl OwnVoteState {
- fn new<'a>(votes: &CandidateVotes, env: &CandidateEnvironment<'a>) -> Self {
+ fn new(votes: &CandidateVotes, env: &CandidateEnvironment) -> Self {
let controlled_indices = env.controlled_indices();
if controlled_indices.is_empty() {
return Self::CannotVote
diff --git a/node/core/dispute-coordinator/src/scraping/tests.rs b/node/core/dispute-coordinator/src/scraping/tests.rs
index b7183739d8f8..621947345bef 100644
--- a/node/core/dispute-coordinator/src/scraping/tests.rs
+++ b/node/core/dispute-coordinator/src/scraping/tests.rs
@@ -135,8 +135,7 @@ fn make_candidate_receipt(relay_parent: Hash) -> CandidateReceipt {
para_head: zeros,
validation_code_hash: zeros.into(),
};
- let candidate = CandidateReceipt { descriptor, commitments_hash: zeros };
- candidate
+ CandidateReceipt { descriptor, commitments_hash: zeros }
}
/// Get a dummy `ActivatedLeaf` for a given block number.
diff --git a/node/core/prospective-parachains/Cargo.toml b/node/core/prospective-parachains/Cargo.toml
new file mode 100644
index 000000000000..7a149e268ef4
--- /dev/null
+++ b/node/core/prospective-parachains/Cargo.toml
@@ -0,0 +1,33 @@
+[package]
+name = "polkadot-node-core-prospective-parachains"
+version = "0.9.16"
+authors = ["Parity Technologies "]
+edition = "2018"
+
+[dependencies]
+futures = "0.3.19"
+gum = { package = "tracing-gum", path = "../../gum" }
+parity-scale-codec = "2"
+thiserror = "1.0.30"
+fatality = "0.0.6"
+bitvec = "1"
+
+polkadot-primitives = { path = "../../../primitives" }
+polkadot-node-primitives = { path = "../../primitives" }
+polkadot-node-subsystem = { path = "../../subsystem" }
+polkadot-node-subsystem-util = { path = "../../subsystem-util" }
+
+[dev-dependencies]
+assert_matches = "1"
+polkadot-node-subsystem-test-helpers = { path = "../../subsystem-test-helpers" }
+polkadot-node-subsystem-types = { path = "../../subsystem-types" }
+polkadot-primitives-test-helpers = { path = "../../../primitives/test-helpers" }
+sp-core = { git = "https://github.com/paritytech/substrate", branch = "master" }
+sc-keystore = { git = "https://github.com/paritytech/substrate", branch = "master" }
+sp-application-crypto = { git = "https://github.com/paritytech/substrate", branch = "master" }
+sp-keyring = { git = "https://github.com/paritytech/substrate", branch = "master" }
+sp-keystore = { git = "https://github.com/paritytech/substrate", branch = "master" }
+
+[features]
+# If not enabled, the dispute coordinator will do nothing.
+disputes = []
diff --git a/node/core/prospective-parachains/src/error.rs b/node/core/prospective-parachains/src/error.rs
new file mode 100644
index 000000000000..0ad98d1ff908
--- /dev/null
+++ b/node/core/prospective-parachains/src/error.rs
@@ -0,0 +1,87 @@
+// Copyright 2022 Parity Technologies (UK) Ltd.
+// This file is part of Polkadot.
+
+// Polkadot is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Polkadot is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Polkadot. If not, see .
+
+//! Error types.
+
+use futures::channel::oneshot;
+
+use polkadot_node_subsystem::{
+ errors::{ChainApiError, RuntimeApiError},
+ SubsystemError,
+};
+use polkadot_node_subsystem_util::runtime;
+
+use crate::LOG_TARGET;
+use fatality::Nested;
+
+#[allow(missing_docs)]
+#[fatality::fatality(splitable)]
+pub enum Error {
+ #[fatal]
+ #[error("SubsystemError::Context error: {0}")]
+ SubsystemContext(String),
+
+ #[fatal]
+ #[error("Spawning a task failed: {0}")]
+ SpawnFailed(SubsystemError),
+
+ #[fatal]
+ #[error("Participation worker receiver exhausted.")]
+ ParticipationWorkerReceiverExhausted,
+
+ #[fatal]
+ #[error("Receiving message from overseer failed: {0}")]
+ SubsystemReceive(#[source] SubsystemError),
+
+ #[error("Error while accessing runtime information")]
+ Runtime(#[from] runtime::Error),
+
+ #[error(transparent)]
+ RuntimeApi(#[from] RuntimeApiError),
+
+ #[error(transparent)]
+ ChainApi(#[from] ChainApiError),
+
+ #[error(transparent)]
+ Subsystem(SubsystemError),
+
+ #[error("Request to chain API subsystem dropped")]
+ ChainApiRequestCanceled(oneshot::Canceled),
+
+ #[error("Request to runtime API subsystem dropped")]
+ RuntimeApiRequestCanceled(oneshot::Canceled),
+}
+
+/// General `Result` type.
+pub type Result = std::result::Result;
+/// Result for non-fatal only failures.
+pub type JfyiErrorResult = std::result::Result;
+/// Result for fatal only failures.
+pub type FatalResult = std::result::Result;
+
+/// Utility for eating top level errors and log them.
+///
+/// We basically always want to try and continue on error. This utility function is meant to
+/// consume top-level errors by simply logging them
+pub fn log_error(result: Result<()>, ctx: &'static str) -> FatalResult<()> {
+ match result.into_nested()? {
+ Ok(()) => Ok(()),
+ Err(jfyi) => {
+ gum::debug!(target: LOG_TARGET, error = ?jfyi, ctx);
+ Ok(())
+ },
+ }
+}
diff --git a/node/core/prospective-parachains/src/fragment_tree.rs b/node/core/prospective-parachains/src/fragment_tree.rs
new file mode 100644
index 000000000000..cbed7cf3f9dc
--- /dev/null
+++ b/node/core/prospective-parachains/src/fragment_tree.rs
@@ -0,0 +1,1939 @@
+// Copyright 2022 Parity Technologies (UK) Ltd.
+// This file is part of Polkadot.
+
+// Polkadot is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Polkadot is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Polkadot. If not, see .
+
+//! A tree utility for managing parachain fragments not referenced by the relay-chain.
+//!
+//! This module exposes two main types: [`FragmentTree`] and [`CandidateStorage`]
+//! which are meant to be used in close conjunction. Each tree is associated with a particular
+//! relay-parent, and it's expected that higher-level code will have a tree for each
+//! relay-chain block which might reasonably have blocks built upon it.
+//!
+//! Trees only store indices into the [`CandidateStorage`] and the storage is meant to
+//! be pruned when trees are dropped by higher-level code.
+//!
+//! Each node in the tree represents a candidate. Nodes do not uniquely refer to a parachain
+//! block for two reasons.
+//! 1. There's no requirement that head-data is unique
+//! for a parachain. Furthermore, a parachain is under no obligation to be acyclic, and this is mostly
+//! just because it's totally inefficient to enforce it. Practical use-cases are acyclic, but there is
+//! still more than one way to reach the same head-data.
+//! 2. and candidates only refer to their parent by its head-data. This whole issue could be
+//! resolved by having candidates reference their parent by candidate hash.
+//!
+//! The implication is that when we receive a candidate receipt, there are actually multiple
+//! possibilities for any candidates between the para-head recorded in the relay parent's state
+//! and the candidate in question.
+//!
+//! This means that our candidates need to handle multiple parents and that depth is an
+//! attribute of a node in a tree, not a candidate. Put another way, the same candidate might
+//! have different depths in different parts of the tree.
+//!
+//! As an extreme example, a candidate which produces head-data which is the same as its parent
+//! can correspond to multiple nodes within the same [`FragmentTree`]. Such cycles are bounded
+//! by the maximum depth allowed by the tree.
+//!
+//! As long as the [`CandidateStorage`] has bounded input on the number of candidates supplied,
+//! [`FragmentTree`] complexity is bounded. This means that higher-level code needs to be selective
+//! about limiting the amount of candidates that are considered.
+//!
+//! The code in this module is not designed for speed or efficiency, but conceptual simplicity.
+//! Our assumption is that the amount of candidates and parachains we consider will be reasonably
+//! bounded and in practice will not exceed a few thousand at any time. This naive implementation
+//! will still perform fairly well under these conditions, despite being somewhat wasteful of memory.
+
+use std::{
+ borrow::Cow,
+ collections::{
+ hash_map::{Entry, HashMap},
+ BTreeMap, HashSet,
+ },
+};
+
+use super::LOG_TARGET;
+use bitvec::prelude::*;
+use polkadot_node_subsystem_util::inclusion_emulator::staging::{
+ ConstraintModifications, Constraints, Fragment, ProspectiveCandidate, RelayChainBlockInfo,
+};
+use polkadot_primitives::vstaging::{
+ BlockNumber, CandidateHash, CommittedCandidateReceipt, Hash, HeadData, Id as ParaId,
+ PersistedValidationData,
+};
+
+/// Kinds of failures to import a candidate into storage.
+#[derive(Debug, Clone, PartialEq)]
+pub enum CandidateStorageInsertionError {
+ /// An error indicating that a supplied candidate didn't match the persisted
+ /// validation data provided alongside it.
+ PersistedValidationDataMismatch,
+ /// The candidate was already known.
+ CandidateAlreadyKnown(CandidateHash),
+}
+
+pub(crate) struct CandidateStorage {
+ // Index from head data hash to candidate hashes with that head data as a parent.
+ by_parent_head: HashMap>,
+
+ // Index from head data hash to candidate hashes outputting that head data.
+ by_output_head: HashMap>,
+
+ // Index from candidate hash to fragment node.
+ by_candidate_hash: HashMap,
+}
+
+impl CandidateStorage {
+ /// Create a new `CandidateStorage`.
+ pub fn new() -> Self {
+ CandidateStorage {
+ by_parent_head: HashMap::new(),
+ by_output_head: HashMap::new(),
+ by_candidate_hash: HashMap::new(),
+ }
+ }
+
+ /// Introduce a new candidate.
+ pub fn add_candidate(
+ &mut self,
+ candidate: CommittedCandidateReceipt,
+ persisted_validation_data: PersistedValidationData,
+ ) -> Result {
+ let candidate_hash = candidate.hash();
+
+ if self.by_candidate_hash.contains_key(&candidate_hash) {
+ return Err(CandidateStorageInsertionError::CandidateAlreadyKnown(candidate_hash))
+ }
+
+ if persisted_validation_data.hash() != candidate.descriptor.persisted_validation_data_hash {
+ return Err(CandidateStorageInsertionError::PersistedValidationDataMismatch)
+ }
+
+ let parent_head_hash = persisted_validation_data.parent_head.hash();
+ let output_head_hash = candidate.commitments.head_data.hash();
+ let entry = CandidateEntry {
+ candidate_hash,
+ relay_parent: candidate.descriptor.relay_parent,
+ state: CandidateState::Introduced,
+ candidate: ProspectiveCandidate {
+ commitments: Cow::Owned(candidate.commitments),
+ collator: candidate.descriptor.collator,
+ collator_signature: candidate.descriptor.signature,
+ persisted_validation_data,
+ pov_hash: candidate.descriptor.pov_hash,
+ validation_code_hash: candidate.descriptor.validation_code_hash,
+ },
+ };
+
+ self.by_parent_head.entry(parent_head_hash).or_default().insert(candidate_hash);
+ self.by_output_head.entry(output_head_hash).or_default().insert(candidate_hash);
+ // sanity-checked already.
+ self.by_candidate_hash.insert(candidate_hash, entry);
+
+ Ok(candidate_hash)
+ }
+
+ /// Remove a candidate from the store.
+ pub fn remove_candidate(&mut self, candidate_hash: &CandidateHash) {
+ if let Some(entry) = self.by_candidate_hash.remove(candidate_hash) {
+ let parent_head_hash = entry.candidate.persisted_validation_data.parent_head.hash();
+ if let Entry::Occupied(mut e) = self.by_parent_head.entry(parent_head_hash) {
+ e.get_mut().remove(&candidate_hash);
+ if e.get().is_empty() {
+ e.remove();
+ }
+ }
+ }
+ }
+
+ /// Note that an existing candidate has been seconded.
+ pub fn mark_seconded(&mut self, candidate_hash: &CandidateHash) {
+ if let Some(entry) = self.by_candidate_hash.get_mut(candidate_hash) {
+ if entry.state != CandidateState::Backed {
+ entry.state = CandidateState::Seconded;
+ }
+ }
+ }
+
+ /// Note that an existing candidate has been backed.
+ pub fn mark_backed(&mut self, candidate_hash: &CandidateHash) {
+ if let Some(entry) = self.by_candidate_hash.get_mut(candidate_hash) {
+ entry.state = CandidateState::Backed;
+ }
+ }
+
+ /// Whether a candidate is recorded as being backed.
+ pub fn is_backed(&self, candidate_hash: &CandidateHash) -> bool {
+ self.by_candidate_hash
+ .get(candidate_hash)
+ .map_or(false, |e| e.state == CandidateState::Backed)
+ }
+
+ /// Whether a candidate is contained within the storage already.
+ pub fn contains(&self, candidate_hash: &CandidateHash) -> bool {
+ self.by_candidate_hash.contains_key(candidate_hash)
+ }
+
+ /// Retain only candidates which pass the predicate.
+ pub(crate) fn retain(&mut self, pred: impl Fn(&CandidateHash) -> bool) {
+ self.by_candidate_hash.retain(|h, _v| pred(h));
+ self.by_parent_head.retain(|_parent, children| {
+ children.retain(|h| pred(h));
+ !children.is_empty()
+ });
+ self.by_output_head.retain(|_output, candidates| {
+ candidates.retain(|h| pred(h));
+ !candidates.is_empty()
+ });
+ }
+
+ /// Get head-data by hash.
+ pub(crate) fn head_data_by_hash(&self, hash: &Hash) -> Option<&HeadData> {
+ // First, search for candidates outputting this head data and extract the head data
+ // from their commitments if they exist.
+ //
+ // Otherwise, search for candidates building upon this head data and extract the head data
+ // from their persisted validation data if they exist.
+ self.by_output_head
+ .get(hash)
+ .and_then(|m| m.iter().next())
+ .and_then(|a_candidate| self.by_candidate_hash.get(a_candidate))
+ .map(|e| &e.candidate.commitments.head_data)
+ .or_else(|| {
+ self.by_parent_head
+ .get(hash)
+ .and_then(|m| m.iter().next())
+ .and_then(|a_candidate| self.by_candidate_hash.get(a_candidate))
+ .map(|e| &e.candidate.persisted_validation_data.parent_head)
+ })
+ }
+
+ fn iter_para_children<'a>(
+ &'a self,
+ parent_head_hash: &Hash,
+ ) -> impl Iterator- + 'a {
+ let by_candidate_hash = &self.by_candidate_hash;
+ self.by_parent_head
+ .get(parent_head_hash)
+ .into_iter()
+ .flat_map(|hashes| hashes.iter())
+ .filter_map(move |h| by_candidate_hash.get(h))
+ }
+
+ fn get(&'_ self, candidate_hash: &CandidateHash) -> Option<&'_ CandidateEntry> {
+ self.by_candidate_hash.get(candidate_hash)
+ }
+
+ #[cfg(test)]
+ pub fn len(&self) -> (usize, usize) {
+ (self.by_parent_head.len(), self.by_candidate_hash.len())
+ }
+}
+
+/// The state of a candidate.
+///
+/// Candidates aren't even considered until they've at least been seconded.
+#[derive(Debug, PartialEq)]
+enum CandidateState {
+ /// The candidate has been introduced in a spam-protected way but
+ /// is not necessarily backed.
+ Introduced,
+ /// The candidate has been seconded.
+ Seconded,
+ /// The candidate has been completely backed by the group.
+ Backed,
+}
+
+#[derive(Debug)]
+struct CandidateEntry {
+ candidate_hash: CandidateHash,
+ relay_parent: Hash,
+ candidate: ProspectiveCandidate<'static>,
+ state: CandidateState,
+}
+
+/// A candidate existing on-chain but pending availability, for special treatment
+/// in the [`Scope`].
+#[derive(Debug, Clone)]
+pub(crate) struct PendingAvailability {
+ /// The candidate hash.
+ pub candidate_hash: CandidateHash,
+ /// The block info of the relay parent.
+ pub relay_parent: RelayChainBlockInfo,
+}
+
+/// The scope of a [`FragmentTree`].
+#[derive(Debug)]
+pub(crate) struct Scope {
+ para: ParaId,
+ relay_parent: RelayChainBlockInfo,
+ ancestors: BTreeMap,
+ ancestors_by_hash: HashMap,
+ pending_availability: Vec,
+ base_constraints: Constraints,
+ max_depth: usize,
+}
+
+/// An error variant indicating that ancestors provided to a scope
+/// had unexpected order.
+#[derive(Debug)]
+pub struct UnexpectedAncestor {
+ /// The block number that this error occurred at.
+ pub number: BlockNumber,
+ /// The previous seen block number, which did not match `number`.
+ pub prev: BlockNumber,
+}
+
+impl Scope {
+ /// Define a new [`Scope`].
+ ///
+ /// All arguments are straightforward except the ancestors.
+ ///
+ /// Ancestors should be in reverse order, starting with the parent
+ /// of the `relay_parent`, and proceeding backwards in block number
+ /// increments of 1. Ancestors not following these conditions will be
+ /// rejected.
+ ///
+ /// This function will only consume ancestors up to the `min_relay_parent_number` of
+ /// the `base_constraints`.
+ ///
+ /// Only ancestors whose children have the same session as the relay-parent's
+ /// children should be provided.
+ ///
+ /// It is allowed to provide zero ancestors.
+ pub fn with_ancestors(
+ para: ParaId,
+ relay_parent: RelayChainBlockInfo,
+ base_constraints: Constraints,
+ pending_availability: Vec,
+ max_depth: usize,
+ ancestors: impl IntoIterator
- ,
+ ) -> Result {
+ let mut ancestors_map = BTreeMap::new();
+ let mut ancestors_by_hash = HashMap::new();
+ {
+ let mut prev = relay_parent.number;
+ for ancestor in ancestors {
+ if prev == 0 {
+ return Err(UnexpectedAncestor { number: ancestor.number, prev })
+ } else if ancestor.number != prev - 1 {
+ return Err(UnexpectedAncestor { number: ancestor.number, prev })
+ } else if prev == base_constraints.min_relay_parent_number {
+ break
+ } else {
+ prev = ancestor.number;
+ ancestors_by_hash.insert(ancestor.hash, ancestor.clone());
+ ancestors_map.insert(ancestor.number, ancestor);
+ }
+ }
+ }
+
+ Ok(Scope {
+ para,
+ relay_parent,
+ base_constraints,
+ pending_availability,
+ max_depth,
+ ancestors: ancestors_map,
+ ancestors_by_hash,
+ })
+ }
+
+ /// Get the earliest relay-parent allowed in the scope of the fragment tree.
+ pub fn earliest_relay_parent(&self) -> RelayChainBlockInfo {
+ self.ancestors
+ .iter()
+ .next()
+ .map(|(_, v)| v.clone())
+ .unwrap_or_else(|| self.relay_parent.clone())
+ }
+
+ /// Get the ancestor of the fragment tree by hash.
+ pub fn ancestor_by_hash(&self, hash: &Hash) -> Option {
+ if hash == &self.relay_parent.hash {
+ return Some(self.relay_parent.clone())
+ }
+
+ self.ancestors_by_hash.get(hash).map(|info| info.clone())
+ }
+
+ /// Whether the candidate in question is one pending availability in this scope.
+ pub fn get_pending_availability(
+ &self,
+ candidate_hash: &CandidateHash,
+ ) -> Option<&PendingAvailability> {
+ self.pending_availability.iter().find(|c| &c.candidate_hash == candidate_hash)
+ }
+
+ /// Get the base constraints of the scope
+ pub fn base_constraints(&self) -> &Constraints {
+ &self.base_constraints
+ }
+}
+
+/// We use indices into a flat vector to refer to nodes in the tree.
+/// Every tree also has an implicit root.
+#[derive(Debug, Clone, Copy, PartialEq)]
+enum NodePointer {
+ Root,
+ Storage(usize),
+}
+
+/// A hypothetical candidate, which may or may not exist in
+/// the fragment tree already.
+pub(crate) enum HypotheticalCandidate<'a> {
+ Complete {
+ receipt: Cow<'a, CommittedCandidateReceipt>,
+ persisted_validation_data: Cow<'a, PersistedValidationData>,
+ },
+ Incomplete {
+ relay_parent: Hash,
+ parent_head_data_hash: Hash,
+ },
+}
+
+impl<'a> HypotheticalCandidate<'a> {
+ fn parent_head_data_hash(&self) -> Hash {
+ match *self {
+ HypotheticalCandidate::Complete { ref persisted_validation_data, .. } =>
+ persisted_validation_data.as_ref().parent_head.hash(),
+ HypotheticalCandidate::Incomplete { ref parent_head_data_hash, .. } =>
+ *parent_head_data_hash,
+ }
+ }
+
+ fn relay_parent(&self) -> Hash {
+ match *self {
+ HypotheticalCandidate::Complete { ref receipt, .. } =>
+ receipt.descriptor().relay_parent,
+ HypotheticalCandidate::Incomplete { ref relay_parent, .. } => *relay_parent,
+ }
+ }
+}
+
+/// This is a tree of candidates based on some underlying storage of candidates
+/// and a scope.
+pub(crate) struct FragmentTree {
+ scope: Scope,
+
+ // Invariant: a contiguous prefix of the 'nodes' storage will contain
+ // the top-level children.
+ nodes: Vec,
+
+ // The candidates stored in this tree, mapped to a bitvec indicating the depths
+ // where the candidate is stored.
+ candidates: HashMap>,
+}
+
+impl FragmentTree {
+ /// Create a new [`FragmentTree`] with given scope and populated from the
+ /// storage.
+ pub fn populate(scope: Scope, storage: &CandidateStorage) -> Self {
+ gum::trace!(
+ target: LOG_TARGET,
+ relay_parent = ?scope.relay_parent.hash,
+ relay_parent_num = scope.relay_parent.number,
+ para_id = ?scope.para,
+ ancestors = scope.ancestors.len(),
+ "Instantiating Fragment Tree",
+ );
+
+ let mut tree = FragmentTree { scope, nodes: Vec::new(), candidates: HashMap::new() };
+
+ tree.populate_from_bases(storage, vec![NodePointer::Root]);
+
+ tree
+ }
+
+ /// Get the scope of the Fragment Tree.
+ pub fn scope(&self) -> &Scope {
+ &self.scope
+ }
+
+ // Inserts a node and updates child references in a non-root parent.
+ fn insert_node(&mut self, node: FragmentNode) {
+ let pointer = NodePointer::Storage(self.nodes.len());
+ let parent_pointer = node.parent;
+ let candidate_hash = node.candidate_hash;
+
+ let max_depth = self.scope.max_depth;
+
+ self.candidates
+ .entry(candidate_hash)
+ .or_insert_with(|| bitvec![u16, Msb0; 0; max_depth + 1])
+ .set(node.depth, true);
+
+ match parent_pointer {
+ NodePointer::Storage(ptr) => {
+ self.nodes.push(node);
+ self.nodes[ptr].children.push((pointer, candidate_hash))
+ },
+ NodePointer::Root => {
+ // Maintain the invariant of node storage beginning with depth-0.
+ if self.nodes.last().map_or(true, |last| last.parent == NodePointer::Root) {
+ self.nodes.push(node);
+ } else {
+ let pos =
+ self.nodes.iter().take_while(|n| n.parent == NodePointer::Root).count();
+ self.nodes.insert(pos, node);
+ }
+ },
+ }
+ }
+
+ fn node_has_candidate_child(
+ &self,
+ pointer: NodePointer,
+ candidate_hash: &CandidateHash,
+ ) -> bool {
+ self.node_candidate_child(pointer, candidate_hash).is_some()
+ }
+
+ fn node_candidate_child(
+ &self,
+ pointer: NodePointer,
+ candidate_hash: &CandidateHash,
+ ) -> Option {
+ match pointer {
+ NodePointer::Root => self
+ .nodes
+ .iter()
+ .take_while(|n| n.parent == NodePointer::Root)
+ .enumerate()
+ .find(|(_, n)| &n.candidate_hash == candidate_hash)
+ .map(|(i, _)| NodePointer::Storage(i)),
+ NodePointer::Storage(ptr) =>
+ self.nodes.get(ptr).and_then(|n| n.candidate_child(candidate_hash)),
+ }
+ }
+
+ /// Returns an O(n) iterator over the hashes of candidates contained in the
+ /// tree.
+ pub(crate) fn candidates(&self) -> impl Iterator
- + '_ {
+ self.candidates.keys().cloned()
+ }
+
+ /// Whether the candidate exists and at what depths.
+ pub(crate) fn candidate(&self, candidate: &CandidateHash) -> Option> {
+ self.candidates.get(candidate).map(|d| d.iter_ones().collect())
+ }
+
+ /// Add a candidate and recursively populate from storage.
+ pub(crate) fn add_and_populate(&mut self, hash: CandidateHash, storage: &CandidateStorage) {
+ let candidate_entry = match storage.get(&hash) {
+ None => return,
+ Some(e) => e,
+ };
+
+ let candidate_parent = &candidate_entry.candidate.persisted_validation_data.parent_head;
+
+ // Select an initial set of bases, whose required relay-parent matches that of the candidate.
+ let root_base = if &self.scope.base_constraints.required_parent == candidate_parent {
+ Some(NodePointer::Root)
+ } else {
+ None
+ };
+
+ let non_root_bases = self
+ .nodes
+ .iter()
+ .enumerate()
+ .filter(|(_, n)| {
+ n.cumulative_modifications.required_parent.as_ref() == Some(candidate_parent)
+ })
+ .map(|(i, _)| NodePointer::Storage(i));
+
+ let bases = root_base.into_iter().chain(non_root_bases).collect();
+
+ // Pass this into the population function, which will sanity-check stuff like depth, fragments,
+ // etc. and then recursively populate.
+ self.populate_from_bases(storage, bases);
+ }
+
+ /// Returns `true` if the path from the root to the node's parent (inclusive)
+ /// only contains backed candidates, `false` otherwise.
+ fn path_contains_backed_only_candidates(
+ &self,
+ mut parent_pointer: NodePointer,
+ candidate_storage: &CandidateStorage,
+ ) -> bool {
+ while let NodePointer::Storage(ptr) = parent_pointer {
+ let node = &self.nodes[ptr];
+ let candidate_hash = &node.candidate_hash;
+
+ if candidate_storage.get(candidate_hash).map_or(true, |candidate_entry| {
+ !matches!(candidate_entry.state, CandidateState::Backed)
+ }) {
+ return false
+ }
+ parent_pointer = node.parent;
+ }
+
+ true
+ }
+
+ /// Returns the hypothetical depths where a candidate with the given hash and parent head data
+ /// would be added to the tree, without applying other candidates recursively on top of it.
+ ///
+ /// If the candidate is already known, this returns the actual depths where this
+ /// candidate is part of the tree.
+ ///
+ /// Setting `backed_in_path_only` to `true` ensures this function only returns such membership
+ /// that every candidate in the path from the root is backed.
+ pub(crate) fn hypothetical_depths(
+ &self,
+ hash: CandidateHash,
+ candidate: HypotheticalCandidate,
+ candidate_storage: &CandidateStorage,
+ backed_in_path_only: bool,
+ ) -> Vec {
+ // if `true`, we always have to traverse the tree.
+ if !backed_in_path_only {
+ // if known.
+ if let Some(depths) = self.candidates.get(&hash) {
+ return depths.iter_ones().collect()
+ }
+ }
+
+ // if out of scope.
+ let candidate_relay_parent = candidate.relay_parent();
+ let candidate_relay_parent = if self.scope.relay_parent.hash == candidate_relay_parent {
+ self.scope.relay_parent.clone()
+ } else if let Some(info) = self.scope.ancestors_by_hash.get(&candidate_relay_parent) {
+ info.clone()
+ } else {
+ return Vec::new()
+ };
+
+ let max_depth = self.scope.max_depth;
+ let mut depths = bitvec![u16, Msb0; 0; max_depth + 1];
+
+ // iterate over all nodes where parent head-data matches,
+ // relay-parent number is <= candidate, and depth < max_depth.
+ let node_pointers = (0..self.nodes.len()).map(NodePointer::Storage);
+ for parent_pointer in std::iter::once(NodePointer::Root).chain(node_pointers) {
+ let (modifications, child_depth, earliest_rp) = match parent_pointer {
+ NodePointer::Root =>
+ (ConstraintModifications::identity(), 0, self.scope.earliest_relay_parent()),
+ NodePointer::Storage(ptr) => {
+ let node = &self.nodes[ptr];
+ let parent_rp = self
+ .scope
+ .ancestor_by_hash(&node.relay_parent())
+ .or_else(|| {
+ self.scope
+ .get_pending_availability(&node.candidate_hash)
+ .map(|_| self.scope.earliest_relay_parent())
+ })
+ .expect("All nodes in tree are either pending availability or within scope; qed");
+
+ (node.cumulative_modifications.clone(), node.depth + 1, parent_rp)
+ },
+ };
+
+ if child_depth > max_depth {
+ continue
+ }
+
+ if earliest_rp.number > candidate_relay_parent.number {
+ continue
+ }
+
+ let child_constraints =
+ match self.scope.base_constraints.apply_modifications(&modifications) {
+ Err(e) => {
+ gum::debug!(
+ target: LOG_TARGET,
+ new_parent_head = ?modifications.required_parent,
+ err = ?e,
+ "Failed to apply modifications",
+ );
+
+ continue
+ },
+ Ok(c) => c,
+ };
+
+ let parent_head_hash = candidate.parent_head_data_hash();
+ if parent_head_hash != child_constraints.required_parent.hash() {
+ continue
+ }
+
+ // We do additional checks for complete candidates.
+ if let HypotheticalCandidate::Complete { ref receipt, ref persisted_validation_data } =
+ candidate
+ {
+ let prospective_candidate = ProspectiveCandidate {
+ commitments: Cow::Borrowed(&receipt.commitments),
+ collator: receipt.descriptor().collator.clone(),
+ collator_signature: receipt.descriptor().signature.clone(),
+ persisted_validation_data: persisted_validation_data.as_ref().clone(),
+ pov_hash: receipt.descriptor().pov_hash,
+ validation_code_hash: receipt.descriptor().validation_code_hash,
+ };
+
+ if Fragment::new(
+ candidate_relay_parent.clone(),
+ child_constraints,
+ prospective_candidate,
+ )
+ .is_err()
+ {
+ continue
+ }
+ }
+
+ // Check that the path only contains backed candidates, if necessary.
+ if !backed_in_path_only ||
+ self.path_contains_backed_only_candidates(parent_pointer, candidate_storage)
+ {
+ depths.set(child_depth, true);
+ }
+ }
+
+ depths.iter_ones().collect()
+ }
+
+ /// Select a candidate after the given `required_path` which passes
+ /// the predicate.
+ ///
+ /// If there are multiple possibilities, this will select the first one.
+ ///
+ /// This returns `None` if there is no candidate meeting those criteria.
+ ///
+ /// The intention of the `required_path` is to allow queries on the basis of
+ /// one or more candidates which were previously pending availability becoming
+ /// available and opening up more room on the core.
+ pub(crate) fn select_child(
+ &self,
+ required_path: &[CandidateHash],
+ pred: impl Fn(&CandidateHash) -> bool,
+ ) -> Option {
+ let base_node = {
+ // traverse the required path.
+ let mut node = NodePointer::Root;
+ for required_step in required_path {
+ node = self.node_candidate_child(node, &required_step)?;
+ }
+
+ node
+ };
+
+ // TODO [now]: taking the first selection might introduce bias
+ // or become gameable.
+ //
+ // For plausibly unique parachains, this shouldn't matter much.
+ // figure out alternative selection criteria?
+ match base_node {
+ NodePointer::Root => self
+ .nodes
+ .iter()
+ .take_while(|n| n.parent == NodePointer::Root)
+ .filter(|n| self.scope.get_pending_availability(&n.candidate_hash).is_none())
+ .filter(|n| pred(&n.candidate_hash))
+ .map(|n| n.candidate_hash)
+ .next(),
+ NodePointer::Storage(ptr) => self.nodes[ptr]
+ .children
+ .iter()
+ .filter(|n| self.scope.get_pending_availability(&n.1).is_none())
+ .filter(|n| pred(&n.1))
+ .map(|n| n.1)
+ .next(),
+ }
+ }
+
+ fn populate_from_bases(&mut self, storage: &CandidateStorage, initial_bases: Vec) {
+ // Populate the tree breadth-first.
+ let mut last_sweep_start = None;
+
+ loop {
+ let sweep_start = self.nodes.len();
+
+ if Some(sweep_start) == last_sweep_start {
+ break
+ }
+
+ let parents: Vec = if let Some(last_start) = last_sweep_start {
+ (last_start..self.nodes.len()).map(NodePointer::Storage).collect()
+ } else {
+ initial_bases.clone()
+ };
+
+ // 1. get parent head and find constraints
+ // 2. iterate all candidates building on the right head and viable relay parent
+ // 3. add new node
+ for parent_pointer in parents {
+ let (modifications, child_depth, earliest_rp) = match parent_pointer {
+ NodePointer::Root =>
+ (ConstraintModifications::identity(), 0, self.scope.earliest_relay_parent()),
+ NodePointer::Storage(ptr) => {
+ let node = &self.nodes[ptr];
+ let parent_rp = self
+ .scope
+ .ancestor_by_hash(&node.relay_parent())
+ .or_else(|| {
+ // if the relay-parent is out of scope _and_ it is in the tree,
+ // it must be a candidate pending availability.
+ self.scope
+ .get_pending_availability(&node.candidate_hash)
+ .map(|c| c.relay_parent.clone())
+ })
+ .expect("All nodes in tree are either pending availability or within scope; qed");
+
+ (node.cumulative_modifications.clone(), node.depth + 1, parent_rp)
+ },
+ };
+
+ if child_depth > self.scope.max_depth {
+ continue
+ }
+
+ let child_constraints =
+ match self.scope.base_constraints.apply_modifications(&modifications) {
+ Err(e) => {
+ gum::debug!(
+ target: LOG_TARGET,
+ new_parent_head = ?modifications.required_parent,
+ err = ?e,
+ "Failed to apply modifications",
+ );
+
+ continue
+ },
+ Ok(c) => c,
+ };
+
+ // Add nodes to tree wherever
+ // 1. parent hash is correct
+ // 2. relay-parent does not move backwards.
+ // 3. all non-pending-availability candidates have relay-parent in scope.
+ // 4. candidate outputs fulfill constraints
+ let required_head_hash = child_constraints.required_parent.hash();
+ for candidate in storage.iter_para_children(&required_head_hash) {
+ let pending = self.scope.get_pending_availability(&candidate.candidate_hash);
+ let relay_parent = pending
+ .map(|p| p.relay_parent.clone())
+ .or_else(|| self.scope.ancestor_by_hash(&candidate.relay_parent));
+
+ let relay_parent = match relay_parent {
+ Some(r) => r,
+ None => continue,
+ };
+
+ // require: pending availability candidates don't move backwards
+ // and only those can be out-of-scope.
+ //
+ // earliest_rp can be before the earliest relay parent in the scope
+ // when the parent is a pending availability candidate as well, but
+ // only other pending candidates can have a relay parent out of scope.
+ let min_relay_parent_number = pending
+ .map(|p| match parent_pointer {
+ NodePointer::Root => p.relay_parent.number,
+ NodePointer::Storage(_) => earliest_rp.number,
+ })
+ .unwrap_or_else(|| {
+ std::cmp::max(
+ earliest_rp.number,
+ self.scope.earliest_relay_parent().number,
+ )
+ });
+
+ if relay_parent.number < min_relay_parent_number {
+ continue // relay parent moved backwards.
+ }
+
+ // don't add candidates where the parent already has it as a child.
+ if self.node_has_candidate_child(parent_pointer, &candidate.candidate_hash) {
+ continue
+ }
+
+ let fragment = {
+ let mut constraints = child_constraints.clone();
+ if let Some(ref p) = pending {
+ // overwrite for candidates pending availability as a special-case.
+ constraints.min_relay_parent_number = p.relay_parent.number;
+ }
+
+ let f = Fragment::new(
+ relay_parent.clone(),
+ constraints,
+ candidate.candidate.partial_clone(),
+ );
+
+ match f {
+ Ok(f) => f.into_owned(),
+ Err(e) => {
+ gum::debug!(
+ target: LOG_TARGET,
+ err = ?e,
+ ?relay_parent,
+ candidate_hash = ?candidate.candidate_hash,
+ "Failed to instantiate fragment",
+ );
+
+ continue
+ },
+ }
+ };
+
+ let mut cumulative_modifications = modifications.clone();
+ cumulative_modifications.stack(fragment.constraint_modifications());
+
+ let node = FragmentNode {
+ parent: parent_pointer,
+ fragment,
+ candidate_hash: candidate.candidate_hash,
+ depth: child_depth,
+ cumulative_modifications,
+ children: Vec::new(),
+ };
+
+ self.insert_node(node);
+ }
+ }
+
+ last_sweep_start = Some(sweep_start);
+ }
+ }
+}
+
+struct FragmentNode {
+ // A pointer to the parent node.
+ parent: NodePointer,
+ fragment: Fragment<'static>,
+ candidate_hash: CandidateHash,
+ depth: usize,
+ cumulative_modifications: ConstraintModifications,
+ children: Vec<(NodePointer, CandidateHash)>,
+}
+
+impl FragmentNode {
+ fn relay_parent(&self) -> Hash {
+ self.fragment.relay_parent().hash
+ }
+
+ fn candidate_child(&self, candidate_hash: &CandidateHash) -> Option {
+ self.children.iter().find(|(_, c)| c == candidate_hash).map(|(p, _)| *p)
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use assert_matches::assert_matches;
+ use polkadot_node_subsystem_util::inclusion_emulator::staging::InboundHrmpLimitations;
+ use polkadot_primitives::vstaging::{
+ BlockNumber, CandidateCommitments, CandidateDescriptor, HeadData,
+ };
+ use polkadot_primitives_test_helpers as test_helpers;
+
+ fn make_constraints(
+ min_relay_parent_number: BlockNumber,
+ valid_watermarks: Vec,
+ required_parent: HeadData,
+ ) -> Constraints {
+ Constraints {
+ min_relay_parent_number,
+ max_pov_size: 1_000_000,
+ max_code_size: 1_000_000,
+ ump_remaining: 10,
+ ump_remaining_bytes: 1_000,
+ max_ump_num_per_candidate: 10,
+ dmp_remaining_messages: [0; 10].into(),
+ hrmp_inbound: InboundHrmpLimitations { valid_watermarks },
+ hrmp_channels_out: HashMap::new(),
+ max_hrmp_num_per_candidate: 0,
+ required_parent,
+ validation_code_hash: Hash::repeat_byte(42).into(),
+ upgrade_restriction: None,
+ future_validation_code: None,
+ }
+ }
+
+ fn make_committed_candidate(
+ para_id: ParaId,
+ relay_parent: Hash,
+ relay_parent_number: BlockNumber,
+ parent_head: HeadData,
+ para_head: HeadData,
+ hrmp_watermark: BlockNumber,
+ ) -> (PersistedValidationData, CommittedCandidateReceipt) {
+ let persisted_validation_data = PersistedValidationData {
+ parent_head,
+ relay_parent_number,
+ relay_parent_storage_root: Hash::repeat_byte(69),
+ max_pov_size: 1_000_000,
+ };
+
+ let candidate = CommittedCandidateReceipt {
+ descriptor: CandidateDescriptor {
+ para_id,
+ relay_parent,
+ collator: test_helpers::dummy_collator(),
+ persisted_validation_data_hash: persisted_validation_data.hash(),
+ pov_hash: Hash::repeat_byte(1),
+ erasure_root: Hash::repeat_byte(1),
+ signature: test_helpers::dummy_collator_signature(),
+ para_head: para_head.hash(),
+ validation_code_hash: Hash::repeat_byte(42).into(),
+ },
+ commitments: CandidateCommitments {
+ upward_messages: Default::default(),
+ horizontal_messages: Default::default(),
+ new_validation_code: None,
+ head_data: para_head,
+ processed_downward_messages: 1,
+ hrmp_watermark,
+ },
+ };
+
+ (persisted_validation_data, candidate)
+ }
+
+ #[test]
+ fn scope_rejects_ancestors_that_skip_blocks() {
+ let para_id = ParaId::from(5u32);
+ let relay_parent = RelayChainBlockInfo {
+ number: 10,
+ hash: Hash::repeat_byte(10),
+ storage_root: Hash::repeat_byte(69),
+ };
+
+ let ancestors = vec![RelayChainBlockInfo {
+ number: 8,
+ hash: Hash::repeat_byte(8),
+ storage_root: Hash::repeat_byte(69),
+ }];
+
+ let max_depth = 2;
+ let base_constraints = make_constraints(8, vec![8, 9], vec![1, 2, 3].into());
+ let pending_availability = Vec::new();
+
+ assert_matches!(
+ Scope::with_ancestors(
+ para_id,
+ relay_parent,
+ base_constraints,
+ pending_availability,
+ max_depth,
+ ancestors
+ ),
+ Err(UnexpectedAncestor { number: 8, prev: 10 })
+ );
+ }
+
+ #[test]
+ fn scope_rejects_ancestor_for_0_block() {
+ let para_id = ParaId::from(5u32);
+ let relay_parent = RelayChainBlockInfo {
+ number: 0,
+ hash: Hash::repeat_byte(0),
+ storage_root: Hash::repeat_byte(69),
+ };
+
+ let ancestors = vec![RelayChainBlockInfo {
+ number: 99999,
+ hash: Hash::repeat_byte(99),
+ storage_root: Hash::repeat_byte(69),
+ }];
+
+ let max_depth = 2;
+ let base_constraints = make_constraints(0, vec![], vec![1, 2, 3].into());
+ let pending_availability = Vec::new();
+
+ assert_matches!(
+ Scope::with_ancestors(
+ para_id,
+ relay_parent,
+ base_constraints,
+ pending_availability,
+ max_depth,
+ ancestors,
+ ),
+ Err(UnexpectedAncestor { number: 99999, prev: 0 })
+ );
+ }
+
+ #[test]
+ fn scope_only_takes_ancestors_up_to_min() {
+ let para_id = ParaId::from(5u32);
+ let relay_parent = RelayChainBlockInfo {
+ number: 5,
+ hash: Hash::repeat_byte(0),
+ storage_root: Hash::repeat_byte(69),
+ };
+
+ let ancestors = vec![
+ RelayChainBlockInfo {
+ number: 4,
+ hash: Hash::repeat_byte(4),
+ storage_root: Hash::repeat_byte(69),
+ },
+ RelayChainBlockInfo {
+ number: 3,
+ hash: Hash::repeat_byte(3),
+ storage_root: Hash::repeat_byte(69),
+ },
+ RelayChainBlockInfo {
+ number: 2,
+ hash: Hash::repeat_byte(2),
+ storage_root: Hash::repeat_byte(69),
+ },
+ ];
+
+ let max_depth = 2;
+ let base_constraints = make_constraints(3, vec![2], vec![1, 2, 3].into());
+ let pending_availability = Vec::new();
+
+ let scope = Scope::with_ancestors(
+ para_id,
+ relay_parent,
+ base_constraints,
+ pending_availability,
+ max_depth,
+ ancestors,
+ )
+ .unwrap();
+
+ assert_eq!(scope.ancestors.len(), 2);
+ assert_eq!(scope.ancestors_by_hash.len(), 2);
+ }
+
+ #[test]
+ fn storage_add_candidate() {
+ let mut storage = CandidateStorage::new();
+
+ let (pvd, candidate) = make_committed_candidate(
+ ParaId::from(5u32),
+ Hash::repeat_byte(69),
+ 8,
+ vec![4, 5, 6].into(),
+ vec![1, 2, 3].into(),
+ 7,
+ );
+
+ let candidate_hash = candidate.hash();
+ let parent_head_hash = pvd.parent_head.hash();
+
+ storage.add_candidate(candidate, pvd).unwrap();
+ assert!(storage.contains(&candidate_hash));
+ assert_eq!(storage.iter_para_children(&parent_head_hash).count(), 1);
+ }
+
+ #[test]
+ fn storage_retain() {
+ let mut storage = CandidateStorage::new();
+
+ let (pvd, candidate) = make_committed_candidate(
+ ParaId::from(5u32),
+ Hash::repeat_byte(69),
+ 8,
+ vec![4, 5, 6].into(),
+ vec![1, 2, 3].into(),
+ 7,
+ );
+
+ let candidate_hash = candidate.hash();
+ let output_head_hash = candidate.commitments.head_data.hash();
+ let parent_head_hash = pvd.parent_head.hash();
+
+ storage.add_candidate(candidate, pvd).unwrap();
+ storage.retain(|_| true);
+ assert!(storage.contains(&candidate_hash));
+ assert_eq!(storage.iter_para_children(&parent_head_hash).count(), 1);
+ assert!(storage.head_data_by_hash(&output_head_hash).is_some());
+
+ storage.retain(|_| false);
+ assert!(!storage.contains(&candidate_hash));
+ assert_eq!(storage.iter_para_children(&parent_head_hash).count(), 0);
+ assert!(storage.head_data_by_hash(&output_head_hash).is_none());
+ }
+
+ // [`FragmentTree::populate`] should pick up candidates that build on other candidates.
+ #[test]
+ fn populate_works_recursively() {
+ let mut storage = CandidateStorage::new();
+
+ let para_id = ParaId::from(5u32);
+ let relay_parent_a = Hash::repeat_byte(1);
+ let relay_parent_b = Hash::repeat_byte(2);
+
+ let (pvd_a, candidate_a) = make_committed_candidate(
+ para_id,
+ relay_parent_a,
+ 0,
+ vec![0x0a].into(),
+ vec![0x0b].into(),
+ 0,
+ );
+ let candidate_a_hash = candidate_a.hash();
+
+ let (pvd_b, candidate_b) = make_committed_candidate(
+ para_id,
+ relay_parent_b,
+ 1,
+ vec![0x0b].into(),
+ vec![0x0c].into(),
+ 1,
+ );
+ let candidate_b_hash = candidate_b.hash();
+
+ let base_constraints = make_constraints(0, vec![0], vec![0x0a].into());
+ let pending_availability = Vec::new();
+
+ let ancestors = vec![RelayChainBlockInfo {
+ number: pvd_a.relay_parent_number,
+ hash: relay_parent_a,
+ storage_root: pvd_a.relay_parent_storage_root,
+ }];
+
+ let relay_parent_b_info = RelayChainBlockInfo {
+ number: pvd_b.relay_parent_number,
+ hash: relay_parent_b,
+ storage_root: pvd_b.relay_parent_storage_root,
+ };
+
+ storage.add_candidate(candidate_a, pvd_a).unwrap();
+ storage.add_candidate(candidate_b, pvd_b).unwrap();
+ let scope = Scope::with_ancestors(
+ para_id,
+ relay_parent_b_info,
+ base_constraints,
+ pending_availability,
+ 4,
+ ancestors,
+ )
+ .unwrap();
+ let tree = FragmentTree::populate(scope, &storage);
+
+ let candidates: Vec<_> = tree.candidates().collect();
+ assert_eq!(candidates.len(), 2);
+ assert!(candidates.contains(&candidate_a_hash));
+ assert!(candidates.contains(&candidate_b_hash));
+
+ assert_eq!(tree.nodes.len(), 2);
+ assert_eq!(tree.nodes[0].parent, NodePointer::Root);
+ assert_eq!(tree.nodes[0].candidate_hash, candidate_a_hash);
+ assert_eq!(tree.nodes[0].depth, 0);
+
+ assert_eq!(tree.nodes[1].parent, NodePointer::Storage(0));
+ assert_eq!(tree.nodes[1].candidate_hash, candidate_b_hash);
+ assert_eq!(tree.nodes[1].depth, 1);
+ }
+
+ #[test]
+ fn children_of_root_are_contiguous() {
+ let mut storage = CandidateStorage::new();
+
+ let para_id = ParaId::from(5u32);
+ let relay_parent_a = Hash::repeat_byte(1);
+ let relay_parent_b = Hash::repeat_byte(2);
+
+ let (pvd_a, candidate_a) = make_committed_candidate(
+ para_id,
+ relay_parent_a,
+ 0,
+ vec![0x0a].into(),
+ vec![0x0b].into(),
+ 0,
+ );
+
+ let (pvd_b, candidate_b) = make_committed_candidate(
+ para_id,
+ relay_parent_b,
+ 1,
+ vec![0x0b].into(),
+ vec![0x0c].into(),
+ 1,
+ );
+
+ let (pvd_a2, candidate_a2) = make_committed_candidate(
+ para_id,
+ relay_parent_a,
+ 0,
+ vec![0x0a].into(),
+ vec![0x0b, 1].into(),
+ 0,
+ );
+ let candidate_a2_hash = candidate_a2.hash();
+
+ let base_constraints = make_constraints(0, vec![0], vec![0x0a].into());
+ let pending_availability = Vec::new();
+
+ let ancestors = vec![RelayChainBlockInfo {
+ number: pvd_a.relay_parent_number,
+ hash: relay_parent_a,
+ storage_root: pvd_a.relay_parent_storage_root,
+ }];
+
+ let relay_parent_b_info = RelayChainBlockInfo {
+ number: pvd_b.relay_parent_number,
+ hash: relay_parent_b,
+ storage_root: pvd_b.relay_parent_storage_root,
+ };
+
+ storage.add_candidate(candidate_a, pvd_a).unwrap();
+ storage.add_candidate(candidate_b, pvd_b).unwrap();
+ let scope = Scope::with_ancestors(
+ para_id,
+ relay_parent_b_info,
+ base_constraints,
+ pending_availability,
+ 4,
+ ancestors,
+ )
+ .unwrap();
+ let mut tree = FragmentTree::populate(scope, &storage);
+
+ storage.add_candidate(candidate_a2, pvd_a2).unwrap();
+ tree.add_and_populate(candidate_a2_hash, &storage);
+ let candidates: Vec<_> = tree.candidates().collect();
+ assert_eq!(candidates.len(), 3);
+
+ assert_eq!(tree.nodes[0].parent, NodePointer::Root);
+ assert_eq!(tree.nodes[1].parent, NodePointer::Root);
+ assert_eq!(tree.nodes[2].parent, NodePointer::Storage(0));
+ }
+
+ #[test]
+ fn add_candidate_child_of_root() {
+ let mut storage = CandidateStorage::new();
+
+ let para_id = ParaId::from(5u32);
+ let relay_parent_a = Hash::repeat_byte(1);
+
+ let (pvd_a, candidate_a) = make_committed_candidate(
+ para_id,
+ relay_parent_a,
+ 0,
+ vec![0x0a].into(),
+ vec![0x0b].into(),
+ 0,
+ );
+
+ let (pvd_b, candidate_b) = make_committed_candidate(
+ para_id,
+ relay_parent_a,
+ 0,
+ vec![0x0a].into(),
+ vec![0x0c].into(),
+ 0,
+ );
+ let candidate_b_hash = candidate_b.hash();
+
+ let base_constraints = make_constraints(0, vec![0], vec![0x0a].into());
+ let pending_availability = Vec::new();
+
+ let relay_parent_a_info = RelayChainBlockInfo {
+ number: pvd_a.relay_parent_number,
+ hash: relay_parent_a,
+ storage_root: pvd_a.relay_parent_storage_root,
+ };
+
+ storage.add_candidate(candidate_a, pvd_a).unwrap();
+ let scope = Scope::with_ancestors(
+ para_id,
+ relay_parent_a_info,
+ base_constraints,
+ pending_availability,
+ 4,
+ vec![],
+ )
+ .unwrap();
+ let mut tree = FragmentTree::populate(scope, &storage);
+
+ storage.add_candidate(candidate_b, pvd_b).unwrap();
+ tree.add_and_populate(candidate_b_hash, &storage);
+ let candidates: Vec<_> = tree.candidates().collect();
+ assert_eq!(candidates.len(), 2);
+
+ assert_eq!(tree.nodes[0].parent, NodePointer::Root);
+ assert_eq!(tree.nodes[1].parent, NodePointer::Root);
+ }
+
+ #[test]
+ fn add_candidate_child_of_non_root() {
+ let mut storage = CandidateStorage::new();
+
+ let para_id = ParaId::from(5u32);
+ let relay_parent_a = Hash::repeat_byte(1);
+
+ let (pvd_a, candidate_a) = make_committed_candidate(
+ para_id,
+ relay_parent_a,
+ 0,
+ vec![0x0a].into(),
+ vec![0x0b].into(),
+ 0,
+ );
+
+ let (pvd_b, candidate_b) = make_committed_candidate(
+ para_id,
+ relay_parent_a,
+ 0,
+ vec![0x0b].into(),
+ vec![0x0c].into(),
+ 0,
+ );
+ let candidate_b_hash = candidate_b.hash();
+
+ let base_constraints = make_constraints(0, vec![0], vec![0x0a].into());
+ let pending_availability = Vec::new();
+
+ let relay_parent_a_info = RelayChainBlockInfo {
+ number: pvd_a.relay_parent_number,
+ hash: relay_parent_a,
+ storage_root: pvd_a.relay_parent_storage_root,
+ };
+
+ storage.add_candidate(candidate_a, pvd_a).unwrap();
+ let scope = Scope::with_ancestors(
+ para_id,
+ relay_parent_a_info,
+ base_constraints,
+ pending_availability,
+ 4,
+ vec![],
+ )
+ .unwrap();
+ let mut tree = FragmentTree::populate(scope, &storage);
+
+ storage.add_candidate(candidate_b, pvd_b).unwrap();
+ tree.add_and_populate(candidate_b_hash, &storage);
+ let candidates: Vec<_> = tree.candidates().collect();
+ assert_eq!(candidates.len(), 2);
+
+ assert_eq!(tree.nodes[0].parent, NodePointer::Root);
+ assert_eq!(tree.nodes[1].parent, NodePointer::Storage(0));
+ }
+
+ #[test]
+ fn graceful_cycle_of_0() {
+ let mut storage = CandidateStorage::new();
+
+ let para_id = ParaId::from(5u32);
+ let relay_parent_a = Hash::repeat_byte(1);
+
+ let (pvd_a, candidate_a) = make_committed_candidate(
+ para_id,
+ relay_parent_a,
+ 0,
+ vec![0x0a].into(),
+ vec![0x0a].into(), // input same as output
+ 0,
+ );
+ let candidate_a_hash = candidate_a.hash();
+ let base_constraints = make_constraints(0, vec![0], vec![0x0a].into());
+ let pending_availability = Vec::new();
+
+ let relay_parent_a_info = RelayChainBlockInfo {
+ number: pvd_a.relay_parent_number,
+ hash: relay_parent_a,
+ storage_root: pvd_a.relay_parent_storage_root,
+ };
+
+ let max_depth = 4;
+ storage.add_candidate(candidate_a, pvd_a).unwrap();
+ let scope = Scope::with_ancestors(
+ para_id,
+ relay_parent_a_info,
+ base_constraints,
+ pending_availability,
+ max_depth,
+ vec![],
+ )
+ .unwrap();
+ let tree = FragmentTree::populate(scope, &storage);
+
+ let candidates: Vec<_> = tree.candidates().collect();
+ assert_eq!(candidates.len(), 1);
+ assert_eq!(tree.nodes.len(), max_depth + 1);
+
+ assert_eq!(tree.nodes[0].parent, NodePointer::Root);
+ assert_eq!(tree.nodes[1].parent, NodePointer::Storage(0));
+ assert_eq!(tree.nodes[2].parent, NodePointer::Storage(1));
+ assert_eq!(tree.nodes[3].parent, NodePointer::Storage(2));
+ assert_eq!(tree.nodes[4].parent, NodePointer::Storage(3));
+
+ assert_eq!(tree.nodes[0].candidate_hash, candidate_a_hash);
+ assert_eq!(tree.nodes[1].candidate_hash, candidate_a_hash);
+ assert_eq!(tree.nodes[2].candidate_hash, candidate_a_hash);
+ assert_eq!(tree.nodes[3].candidate_hash, candidate_a_hash);
+ assert_eq!(tree.nodes[4].candidate_hash, candidate_a_hash);
+ }
+
+ #[test]
+ fn graceful_cycle_of_1() {
+ let mut storage = CandidateStorage::new();
+
+ let para_id = ParaId::from(5u32);
+ let relay_parent_a = Hash::repeat_byte(1);
+
+ let (pvd_a, candidate_a) = make_committed_candidate(
+ para_id,
+ relay_parent_a,
+ 0,
+ vec![0x0a].into(),
+ vec![0x0b].into(), // input same as output
+ 0,
+ );
+ let candidate_a_hash = candidate_a.hash();
+
+ let (pvd_b, candidate_b) = make_committed_candidate(
+ para_id,
+ relay_parent_a,
+ 0,
+ vec![0x0b].into(),
+ vec![0x0a].into(), // input same as output
+ 0,
+ );
+ let candidate_b_hash = candidate_b.hash();
+
+ let base_constraints = make_constraints(0, vec![0], vec![0x0a].into());
+ let pending_availability = Vec::new();
+
+ let relay_parent_a_info = RelayChainBlockInfo {
+ number: pvd_a.relay_parent_number,
+ hash: relay_parent_a,
+ storage_root: pvd_a.relay_parent_storage_root,
+ };
+
+ let max_depth = 4;
+ storage.add_candidate(candidate_a, pvd_a).unwrap();
+ storage.add_candidate(candidate_b, pvd_b).unwrap();
+ let scope = Scope::with_ancestors(
+ para_id,
+ relay_parent_a_info,
+ base_constraints,
+ pending_availability,
+ max_depth,
+ vec![],
+ )
+ .unwrap();
+ let tree = FragmentTree::populate(scope, &storage);
+
+ let candidates: Vec<_> = tree.candidates().collect();
+ assert_eq!(candidates.len(), 2);
+ assert_eq!(tree.nodes.len(), max_depth + 1);
+
+ assert_eq!(tree.nodes[0].parent, NodePointer::Root);
+ assert_eq!(tree.nodes[1].parent, NodePointer::Storage(0));
+ assert_eq!(tree.nodes[2].parent, NodePointer::Storage(1));
+ assert_eq!(tree.nodes[3].parent, NodePointer::Storage(2));
+ assert_eq!(tree.nodes[4].parent, NodePointer::Storage(3));
+
+ assert_eq!(tree.nodes[0].candidate_hash, candidate_a_hash);
+ assert_eq!(tree.nodes[1].candidate_hash, candidate_b_hash);
+ assert_eq!(tree.nodes[2].candidate_hash, candidate_a_hash);
+ assert_eq!(tree.nodes[3].candidate_hash, candidate_b_hash);
+ assert_eq!(tree.nodes[4].candidate_hash, candidate_a_hash);
+ }
+
+ #[test]
+ fn hypothetical_depths_known_and_unknown() {
+ let mut storage = CandidateStorage::new();
+
+ let para_id = ParaId::from(5u32);
+ let relay_parent_a = Hash::repeat_byte(1);
+
+ let (pvd_a, candidate_a) = make_committed_candidate(
+ para_id,
+ relay_parent_a,
+ 0,
+ vec![0x0a].into(),
+ vec![0x0b].into(), // input same as output
+ 0,
+ );
+ let candidate_a_hash = candidate_a.hash();
+
+ let (pvd_b, candidate_b) = make_committed_candidate(
+ para_id,
+ relay_parent_a,
+ 0,
+ vec![0x0b].into(),
+ vec![0x0a].into(), // input same as output
+ 0,
+ );
+ let candidate_b_hash = candidate_b.hash();
+
+ let base_constraints = make_constraints(0, vec![0], vec![0x0a].into());
+ let pending_availability = Vec::new();
+
+ let relay_parent_a_info = RelayChainBlockInfo {
+ number: pvd_a.relay_parent_number,
+ hash: relay_parent_a,
+ storage_root: pvd_a.relay_parent_storage_root,
+ };
+
+ let max_depth = 4;
+ storage.add_candidate(candidate_a, pvd_a).unwrap();
+ storage.add_candidate(candidate_b, pvd_b).unwrap();
+ let scope = Scope::with_ancestors(
+ para_id,
+ relay_parent_a_info,
+ base_constraints,
+ pending_availability,
+ max_depth,
+ vec![],
+ )
+ .unwrap();
+ let tree = FragmentTree::populate(scope, &storage);
+
+ let candidates: Vec<_> = tree.candidates().collect();
+ assert_eq!(candidates.len(), 2);
+ assert_eq!(tree.nodes.len(), max_depth + 1);
+
+ assert_eq!(
+ tree.hypothetical_depths(
+ candidate_a_hash,
+ HypotheticalCandidate::Incomplete {
+ parent_head_data_hash: HeadData::from(vec![0x0a]).hash(),
+ relay_parent: relay_parent_a,
+ },
+ &storage,
+ false,
+ ),
+ vec![0, 2, 4],
+ );
+
+ assert_eq!(
+ tree.hypothetical_depths(
+ candidate_b_hash,
+ HypotheticalCandidate::Incomplete {
+ parent_head_data_hash: HeadData::from(vec![0x0b]).hash(),
+ relay_parent: relay_parent_a,
+ },
+ &storage,
+ false,
+ ),
+ vec![1, 3],
+ );
+
+ assert_eq!(
+ tree.hypothetical_depths(
+ CandidateHash(Hash::repeat_byte(21)),
+ HypotheticalCandidate::Incomplete {
+ parent_head_data_hash: HeadData::from(vec![0x0a]).hash(),
+ relay_parent: relay_parent_a,
+ },
+ &storage,
+ false,
+ ),
+ vec![0, 2, 4],
+ );
+
+ assert_eq!(
+ tree.hypothetical_depths(
+ CandidateHash(Hash::repeat_byte(22)),
+ HypotheticalCandidate::Incomplete {
+ parent_head_data_hash: HeadData::from(vec![0x0b]).hash(),
+ relay_parent: relay_parent_a,
+ },
+ &storage,
+ false,
+ ),
+ vec![1, 3]
+ );
+ }
+
+ #[test]
+ fn hypothetical_depths_stricter_on_complete() {
+ let storage = CandidateStorage::new();
+
+ let para_id = ParaId::from(5u32);
+ let relay_parent_a = Hash::repeat_byte(1);
+
+ let (pvd_a, candidate_a) = make_committed_candidate(
+ para_id,
+ relay_parent_a,
+ 0,
+ vec![0x0a].into(),
+ vec![0x0b].into(),
+ 1000, // watermark is illegal
+ );
+
+ let candidate_a_hash = candidate_a.hash();
+
+ let base_constraints = make_constraints(0, vec![0], vec![0x0a].into());
+ let pending_availability = Vec::new();
+
+ let relay_parent_a_info = RelayChainBlockInfo {
+ number: pvd_a.relay_parent_number,
+ hash: relay_parent_a,
+ storage_root: pvd_a.relay_parent_storage_root,
+ };
+
+ let max_depth = 4;
+ let scope = Scope::with_ancestors(
+ para_id,
+ relay_parent_a_info,
+ base_constraints,
+ pending_availability,
+ max_depth,
+ vec![],
+ )
+ .unwrap();
+ let tree = FragmentTree::populate(scope, &storage);
+
+ assert_eq!(
+ tree.hypothetical_depths(
+ candidate_a_hash,
+ HypotheticalCandidate::Incomplete {
+ parent_head_data_hash: HeadData::from(vec![0x0a]).hash(),
+ relay_parent: relay_parent_a,
+ },
+ &storage,
+ false,
+ ),
+ vec![0],
+ );
+
+ assert!(tree
+ .hypothetical_depths(
+ candidate_a_hash,
+ HypotheticalCandidate::Complete {
+ receipt: Cow::Owned(candidate_a),
+ persisted_validation_data: Cow::Owned(pvd_a),
+ },
+ &storage,
+ false,
+ )
+ .is_empty());
+ }
+
+ #[test]
+ fn hypothetical_depths_backed_in_path() {
+ let mut storage = CandidateStorage::new();
+
+ let para_id = ParaId::from(5u32);
+ let relay_parent_a = Hash::repeat_byte(1);
+
+ let (pvd_a, candidate_a) = make_committed_candidate(
+ para_id,
+ relay_parent_a,
+ 0,
+ vec![0x0a].into(),
+ vec![0x0b].into(),
+ 0,
+ );
+ let candidate_a_hash = candidate_a.hash();
+
+ let (pvd_b, candidate_b) = make_committed_candidate(
+ para_id,
+ relay_parent_a,
+ 0,
+ vec![0x0b].into(),
+ vec![0x0c].into(),
+ 0,
+ );
+ let candidate_b_hash = candidate_b.hash();
+
+ let (pvd_c, candidate_c) = make_committed_candidate(
+ para_id,
+ relay_parent_a,
+ 0,
+ vec![0x0b].into(),
+ vec![0x0d].into(),
+ 0,
+ );
+
+ let base_constraints = make_constraints(0, vec![0], vec![0x0a].into());
+ let pending_availability = Vec::new();
+
+ let relay_parent_a_info = RelayChainBlockInfo {
+ number: pvd_a.relay_parent_number,
+ hash: relay_parent_a,
+ storage_root: pvd_a.relay_parent_storage_root,
+ };
+
+ let max_depth = 4;
+ storage.add_candidate(candidate_a, pvd_a).unwrap();
+ storage.add_candidate(candidate_b, pvd_b).unwrap();
+ storage.add_candidate(candidate_c, pvd_c).unwrap();
+
+ // `A` and `B` are backed, `C` is not.
+ storage.mark_backed(&candidate_a_hash);
+ storage.mark_backed(&candidate_b_hash);
+
+ let scope = Scope::with_ancestors(
+ para_id,
+ relay_parent_a_info,
+ base_constraints,
+ pending_availability,
+ max_depth,
+ vec![],
+ )
+ .unwrap();
+ let tree = FragmentTree::populate(scope, &storage);
+
+ let candidates: Vec<_> = tree.candidates().collect();
+ assert_eq!(candidates.len(), 3);
+ assert_eq!(tree.nodes.len(), 3);
+
+ let candidate_d_hash = CandidateHash(Hash::repeat_byte(0xAA));
+
+ assert_eq!(
+ tree.hypothetical_depths(
+ candidate_d_hash,
+ HypotheticalCandidate::Incomplete {
+ parent_head_data_hash: HeadData::from(vec![0x0a]).hash(),
+ relay_parent: relay_parent_a,
+ },
+ &storage,
+ true,
+ ),
+ vec![0],
+ );
+
+ assert_eq!(
+ tree.hypothetical_depths(
+ candidate_d_hash,
+ HypotheticalCandidate::Incomplete {
+ parent_head_data_hash: HeadData::from(vec![0x0c]).hash(),
+ relay_parent: relay_parent_a,
+ },
+ &storage,
+ true,
+ ),
+ vec![2],
+ );
+
+ assert_eq!(
+ tree.hypothetical_depths(
+ candidate_d_hash,
+ HypotheticalCandidate::Incomplete {
+ parent_head_data_hash: HeadData::from(vec![0x0d]).hash(),
+ relay_parent: relay_parent_a,
+ },
+ &storage,
+ true,
+ ),
+ Vec::::new(),
+ );
+
+ assert_eq!(
+ tree.hypothetical_depths(
+ candidate_d_hash,
+ HypotheticalCandidate::Incomplete {
+ parent_head_data_hash: HeadData::from(vec![0x0d]).hash(),
+ relay_parent: relay_parent_a,
+ },
+ &storage,
+ false,
+ ),
+ vec![2], // non-empty if `false`.
+ );
+ }
+
+ #[test]
+ fn pending_availability_in_scope() {
+ let mut storage = CandidateStorage::new();
+
+ let para_id = ParaId::from(5u32);
+ let relay_parent_a = Hash::repeat_byte(1);
+ let relay_parent_b = Hash::repeat_byte(2);
+ let relay_parent_c = Hash::repeat_byte(3);
+
+ let (pvd_a, candidate_a) = make_committed_candidate(
+ para_id,
+ relay_parent_a,
+ 0,
+ vec![0x0a].into(),
+ vec![0x0b].into(),
+ 0,
+ );
+ let candidate_a_hash = candidate_a.hash();
+
+ let (pvd_b, candidate_b) = make_committed_candidate(
+ para_id,
+ relay_parent_b,
+ 1,
+ vec![0x0b].into(),
+ vec![0x0c].into(),
+ 1,
+ );
+
+ // Note that relay parent `a` is not allowed.
+ let base_constraints = make_constraints(1, vec![], vec![0x0a].into());
+
+ let relay_parent_a_info = RelayChainBlockInfo {
+ number: pvd_a.relay_parent_number,
+ hash: relay_parent_a,
+ storage_root: pvd_a.relay_parent_storage_root,
+ };
+ let pending_availability = vec![PendingAvailability {
+ candidate_hash: candidate_a_hash,
+ relay_parent: relay_parent_a_info,
+ }];
+
+ let relay_parent_b_info = RelayChainBlockInfo {
+ number: pvd_b.relay_parent_number,
+ hash: relay_parent_b,
+ storage_root: pvd_b.relay_parent_storage_root,
+ };
+ let relay_parent_c_info = RelayChainBlockInfo {
+ number: pvd_b.relay_parent_number + 1,
+ hash: relay_parent_c,
+ storage_root: Hash::zero(),
+ };
+
+ let max_depth = 4;
+ storage.add_candidate(candidate_a, pvd_a).unwrap();
+ storage.add_candidate(candidate_b, pvd_b).unwrap();
+ storage.mark_backed(&candidate_a_hash);
+
+ let scope = Scope::with_ancestors(
+ para_id,
+ relay_parent_c_info,
+ base_constraints,
+ pending_availability,
+ max_depth,
+ vec![relay_parent_b_info],
+ )
+ .unwrap();
+ let tree = FragmentTree::populate(scope, &storage);
+
+ let candidates: Vec<_> = tree.candidates().collect();
+ assert_eq!(candidates.len(), 2);
+ assert_eq!(tree.nodes.len(), 2);
+
+ let candidate_d_hash = CandidateHash(Hash::repeat_byte(0xAA));
+
+ assert_eq!(
+ tree.hypothetical_depths(
+ candidate_d_hash,
+ HypotheticalCandidate::Incomplete {
+ parent_head_data_hash: HeadData::from(vec![0x0b]).hash(),
+ relay_parent: relay_parent_c,
+ },
+ &storage,
+ false,
+ ),
+ vec![1],
+ );
+
+ assert_eq!(
+ tree.hypothetical_depths(
+ candidate_d_hash,
+ HypotheticalCandidate::Incomplete {
+ parent_head_data_hash: HeadData::from(vec![0x0c]).hash(),
+ relay_parent: relay_parent_b,
+ },
+ &storage,
+ false,
+ ),
+ vec![2],
+ );
+ }
+}
diff --git a/node/core/prospective-parachains/src/lib.rs b/node/core/prospective-parachains/src/lib.rs
new file mode 100644
index 000000000000..5ef35bcaa628
--- /dev/null
+++ b/node/core/prospective-parachains/src/lib.rs
@@ -0,0 +1,904 @@
+// Copyright 2022-2023 Parity Technologies (UK) Ltd.
+// This file is part of Polkadot.
+
+// Polkadot is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Polkadot is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Polkadot. If not, see .
+
+//! Implementation of the Prospective Parachains subsystem - this tracks and handles
+//! prospective parachain fragments and informs other backing-stage subsystems
+//! of work to be done.
+//!
+//! This is the main coordinator of work within the node for the collation and
+//! backing phases of parachain consensus.
+//!
+//! This is primarily an implementation of "Fragment Trees", as described in
+//! [`polkadot_node_subsystem_util::inclusion_emulator::staging`].
+//!
+//! This also handles concerns such as the relay-chain being forkful,
+//! session changes, predicting validator group assignments.
+
+use std::{
+ borrow::Cow,
+ collections::{HashMap, HashSet},
+};
+
+use futures::{channel::oneshot, prelude::*};
+
+use polkadot_node_subsystem::{
+ messages::{
+ ChainApiMessage, FragmentTreeMembership, HypotheticalCandidate,
+ HypotheticalFrontierRequest, IntroduceCandidateRequest, ProspectiveParachainsMessage,
+ ProspectiveValidationDataRequest, RuntimeApiMessage, RuntimeApiRequest,
+ },
+ overseer, ActiveLeavesUpdate, FromOrchestra, OverseerSignal, SpawnedSubsystem, SubsystemError,
+};
+use polkadot_node_subsystem_util::{
+ inclusion_emulator::staging::{Constraints, RelayChainBlockInfo},
+ runtime::{prospective_parachains_mode, ProspectiveParachainsMode},
+};
+use polkadot_primitives::vstaging::{
+ BlockNumber, CandidateHash, CandidatePendingAvailability, CommittedCandidateReceipt, CoreState,
+ Hash, HeadData, Header, Id as ParaId, PersistedValidationData,
+};
+
+use crate::{
+ error::{FatalError, FatalResult, JfyiError, JfyiErrorResult, Result},
+ fragment_tree::{
+ CandidateStorage, CandidateStorageInsertionError, FragmentTree, Scope as TreeScope,
+ },
+};
+
+mod error;
+mod fragment_tree;
+#[cfg(test)]
+mod tests;
+
+mod metrics;
+use self::metrics::Metrics;
+
+const LOG_TARGET: &str = "parachain::prospective-parachains";
+
+struct RelayBlockViewData {
+ // Scheduling info for paras and upcoming paras.
+ fragment_trees: HashMap,
+ pending_availability: HashSet,
+}
+
+struct View {
+ // Active or recent relay-chain blocks by block hash.
+ active_leaves: HashMap,
+ candidate_storage: HashMap,
+}
+
+impl View {
+ fn new() -> Self {
+ View { active_leaves: HashMap::new(), candidate_storage: HashMap::new() }
+ }
+}
+
+/// The prospective parachains subsystem.
+#[derive(Default)]
+pub struct ProspectiveParachainsSubsystem {
+ metrics: Metrics,
+}
+
+impl ProspectiveParachainsSubsystem {
+ /// Create a new instance of the `ProspectiveParachainsSubsystem`.
+ pub fn new(metrics: Metrics) -> Self {
+ Self { metrics }
+ }
+}
+
+#[overseer::subsystem(ProspectiveParachains, error = SubsystemError, prefix = self::overseer)]
+impl ProspectiveParachainsSubsystem
+where
+ Context: Send + Sync,
+{
+ fn start(self, ctx: Context) -> SpawnedSubsystem {
+ SpawnedSubsystem {
+ future: run(ctx, self.metrics)
+ .map_err(|e| SubsystemError::with_origin("prospective-parachains", e))
+ .boxed(),
+ name: "prospective-parachains-subsystem",
+ }
+ }
+}
+
+#[overseer::contextbounds(ProspectiveParachains, prefix = self::overseer)]
+async fn run(mut ctx: Context, metrics: Metrics) -> FatalResult<()> {
+ let mut view = View::new();
+ loop {
+ crate::error::log_error(
+ run_iteration(&mut ctx, &mut view, &metrics).await,
+ "Encountered issue during run iteration",
+ )?;
+ }
+}
+
+#[overseer::contextbounds(ProspectiveParachains, prefix = self::overseer)]
+async fn run_iteration(
+ ctx: &mut Context,
+ view: &mut View,
+ metrics: &Metrics,
+) -> Result<()> {
+ loop {
+ match ctx.recv().await.map_err(FatalError::SubsystemReceive)? {
+ FromOrchestra::Signal(OverseerSignal::Conclude) => return Ok(()),
+ FromOrchestra::Signal(OverseerSignal::ActiveLeaves(update)) => {
+ handle_active_leaves_update(&mut *ctx, view, update, metrics).await?;
+ },
+ FromOrchestra::Signal(OverseerSignal::BlockFinalized(..)) => {},
+ FromOrchestra::Communication { msg } => match msg {
+ ProspectiveParachainsMessage::IntroduceCandidate(request, tx) =>
+ handle_candidate_introduced(&mut *ctx, view, request, tx).await?,
+ ProspectiveParachainsMessage::CandidateSeconded(para, candidate_hash) =>
+ handle_candidate_seconded(view, para, candidate_hash),
+ ProspectiveParachainsMessage::CandidateBacked(para, candidate_hash) =>
+ handle_candidate_backed(&mut *ctx, view, para, candidate_hash).await?,
+ ProspectiveParachainsMessage::GetBackableCandidate(
+ relay_parent,
+ para,
+ required_path,
+ tx,
+ ) => answer_get_backable_candidate(&view, relay_parent, para, required_path, tx),
+ ProspectiveParachainsMessage::GetHypotheticalFrontier(request, tx) =>
+ answer_hypothetical_frontier_request(&view, request, tx),
+ ProspectiveParachainsMessage::GetTreeMembership(para, candidate, tx) =>
+ answer_tree_membership_request(&view, para, candidate, tx),
+ ProspectiveParachainsMessage::GetMinimumRelayParents(relay_parent, tx) =>
+ answer_minimum_relay_parents_request(&view, relay_parent, tx),
+ ProspectiveParachainsMessage::GetProspectiveValidationData(request, tx) =>
+ answer_prospective_validation_data_request(&view, request, tx),
+ },
+ }
+ }
+}
+
+#[overseer::contextbounds(ProspectiveParachains, prefix = self::overseer)]
+async fn handle_active_leaves_update(
+ ctx: &mut Context,
+ view: &mut View,
+ update: ActiveLeavesUpdate,
+ metrics: &Metrics,
+) -> JfyiErrorResult<()> {
+ // 1. clean up inactive leaves
+ // 2. determine all scheduled para at new block
+ // 3. construct new fragment tree for each para for each new leaf
+ // 4. prune candidate storage.
+
+ for deactivated in &update.deactivated {
+ view.active_leaves.remove(deactivated);
+ }
+
+ let mut temp_header_cache = HashMap::new();
+ for activated in update.activated.into_iter() {
+ let hash = activated.hash;
+
+ let mode = prospective_parachains_mode(ctx.sender(), hash)
+ .await
+ .map_err(JfyiError::Runtime)?;
+
+ let ProspectiveParachainsMode::Enabled { max_candidate_depth, allowed_ancestry_len } = mode else {
+ gum::trace!(
+ target: LOG_TARGET,
+ block_hash = ?hash,
+ "Skipping leaf activation since async backing is disabled"
+ );
+
+ // Not a part of any allowed ancestry.
+ return Ok(())
+ };
+
+ let mut pending_availability = HashSet::new();
+ let scheduled_paras =
+ fetch_upcoming_paras(&mut *ctx, hash, &mut pending_availability).await?;
+
+ let block_info: RelayChainBlockInfo =
+ match fetch_block_info(&mut *ctx, &mut temp_header_cache, hash).await? {
+ None => {
+ gum::warn!(
+ target: LOG_TARGET,
+ block_hash = ?hash,
+ "Failed to get block info for newly activated leaf block."
+ );
+
+ // `update.activated` is an option, but we can use this
+ // to exit the 'loop' and skip this block without skipping
+ // pruning logic.
+ continue
+ },
+ Some(info) => info,
+ };
+
+ let ancestry =
+ fetch_ancestry(&mut *ctx, &mut temp_header_cache, hash, allowed_ancestry_len).await?;
+
+ // Find constraints.
+ let mut fragment_trees = HashMap::new();
+ for para in scheduled_paras {
+ let candidate_storage =
+ view.candidate_storage.entry(para).or_insert_with(CandidateStorage::new);
+
+ let backing_state = fetch_backing_state(&mut *ctx, hash, para).await?;
+
+ let (constraints, pending_availability) = match backing_state {
+ Some(c) => c,
+ None => {
+ // This indicates a runtime conflict of some kind.
+
+ gum::debug!(
+ target: LOG_TARGET,
+ para_id = ?para,
+ relay_parent = ?hash,
+ "Failed to get inclusion backing state."
+ );
+
+ continue
+ },
+ };
+
+ let pending_availability = preprocess_candidates_pending_availability(
+ ctx,
+ &mut temp_header_cache,
+ constraints.required_parent.clone(),
+ pending_availability,
+ )
+ .await?;
+ let mut compact_pending = Vec::with_capacity(pending_availability.len());
+
+ for c in pending_availability {
+ let res = candidate_storage.add_candidate(c.candidate, c.persisted_validation_data);
+ let candidate_hash = c.compact.candidate_hash;
+ compact_pending.push(c.compact);
+
+ match res {
+ Ok(_) | Err(CandidateStorageInsertionError::CandidateAlreadyKnown(_)) => {
+ // Anything on-chain is guaranteed to be backed.
+ candidate_storage.mark_backed(&candidate_hash);
+ },
+ Err(err) => {
+ gum::warn!(
+ target: LOG_TARGET,
+ ?candidate_hash,
+ para_id = ?para,
+ ?err,
+ "Scraped invalid candidate pending availability",
+ );
+ },
+ }
+ }
+
+ let scope = TreeScope::with_ancestors(
+ para,
+ block_info.clone(),
+ constraints,
+ compact_pending,
+ max_candidate_depth,
+ ancestry.iter().cloned(),
+ )
+ .expect("ancestors are provided in reverse order and correctly; qed");
+
+ let tree = FragmentTree::populate(scope, &*candidate_storage);
+
+ fragment_trees.insert(para, tree);
+ }
+
+ view.active_leaves
+ .insert(hash, RelayBlockViewData { fragment_trees, pending_availability });
+ }
+
+ if !update.deactivated.is_empty() {
+ // This has potential to be a hotspot.
+ prune_view_candidate_storage(view, metrics);
+ }
+
+ Ok(())
+}
+
+fn prune_view_candidate_storage(view: &mut View, metrics: &Metrics) {
+ metrics.time_prune_view_candidate_storage();
+
+ let active_leaves = &view.active_leaves;
+ let mut live_candidates = HashSet::new();
+ let mut live_paras = HashSet::new();
+ for sub_view in active_leaves.values() {
+ for (para_id, fragment_tree) in &sub_view.fragment_trees {
+ live_candidates.extend(fragment_tree.candidates());
+ live_paras.insert(*para_id);
+ }
+
+ live_candidates.extend(sub_view.pending_availability.iter().cloned());
+ }
+
+ view.candidate_storage.retain(|para_id, storage| {
+ if !live_paras.contains(¶_id) {
+ return false
+ }
+
+ storage.retain(|h| live_candidates.contains(&h));
+
+ // Even if `storage` is now empty, we retain.
+ // This maintains a convenient invariant that para-id storage exists
+ // as long as there's an active head which schedules the para.
+ true
+ })
+}
+
+struct ImportablePendingAvailability {
+ candidate: CommittedCandidateReceipt,
+ persisted_validation_data: PersistedValidationData,
+ compact: crate::fragment_tree::PendingAvailability,
+}
+
+#[overseer::contextbounds(ProspectiveParachains, prefix = self::overseer)]
+async fn preprocess_candidates_pending_availability(
+ ctx: &mut Context,
+ cache: &mut HashMap,
+ required_parent: HeadData,
+ pending_availability: Vec,
+) -> JfyiErrorResult> {
+ let mut required_parent = required_parent;
+
+ let mut importable = Vec::new();
+ let expected_count = pending_availability.len();
+
+ for (i, pending) in pending_availability.into_iter().enumerate() {
+ let relay_parent =
+ match fetch_block_info(ctx, cache, pending.descriptor.relay_parent).await? {
+ None => {
+ gum::debug!(
+ target: LOG_TARGET,
+ ?pending.candidate_hash,
+ ?pending.descriptor.para_id,
+ index = ?i,
+ ?expected_count,
+ "Had to stop processing pending candidates early due to missing info.",
+ );
+
+ break
+ },
+ Some(b) => b,
+ };
+
+ let next_required_parent = pending.commitments.head_data.clone();
+ importable.push(ImportablePendingAvailability {
+ candidate: CommittedCandidateReceipt {
+ descriptor: pending.descriptor,
+ commitments: pending.commitments,
+ },
+ persisted_validation_data: PersistedValidationData {
+ parent_head: required_parent,
+ max_pov_size: pending.max_pov_size,
+ relay_parent_number: relay_parent.number,
+ relay_parent_storage_root: relay_parent.storage_root,
+ },
+ compact: crate::fragment_tree::PendingAvailability {
+ candidate_hash: pending.candidate_hash,
+ relay_parent,
+ },
+ });
+
+ required_parent = next_required_parent;
+ }
+
+ Ok(importable)
+}
+
+#[overseer::contextbounds(ProspectiveParachains, prefix = self::overseer)]
+async fn handle_candidate_introduced(
+ _ctx: &mut Context,
+ view: &mut View,
+ request: IntroduceCandidateRequest,
+ tx: oneshot::Sender,
+) -> JfyiErrorResult<()> {
+ let IntroduceCandidateRequest {
+ candidate_para: para,
+ candidate_receipt: candidate,
+ persisted_validation_data: pvd,
+ } = request;
+
+ // Add the candidate to storage.
+ // Then attempt to add it to all trees.
+ let storage = match view.candidate_storage.get_mut(¶) {
+ None => {
+ gum::warn!(
+ target: LOG_TARGET,
+ para_id = ?para,
+ candidate_hash = ?candidate.hash(),
+ "Received seconded candidate for inactive para",
+ );
+
+ let _ = tx.send(Vec::new());
+ return Ok(())
+ },
+ Some(storage) => storage,
+ };
+
+ let candidate_hash = match storage.add_candidate(candidate, pvd) {
+ Ok(c) => c,
+ Err(CandidateStorageInsertionError::CandidateAlreadyKnown(c)) => {
+ // Candidate known - return existing fragment tree membership.
+ let _ = tx.send(fragment_tree_membership(&view.active_leaves, para, c));
+ return Ok(())
+ },
+ Err(CandidateStorageInsertionError::PersistedValidationDataMismatch) => {
+ // We can't log the candidate hash without either doing more ~expensive
+ // hashing but this branch indicates something is seriously wrong elsewhere
+ // so it's doubtful that it would affect debugging.
+
+ gum::warn!(
+ target: LOG_TARGET,
+ para = ?para,
+ "Received seconded candidate had mismatching validation data",
+ );
+
+ let _ = tx.send(Vec::new());
+ return Ok(())
+ },
+ };
+
+ let mut membership = Vec::new();
+ for (relay_parent, leaf_data) in &mut view.active_leaves {
+ if let Some(tree) = leaf_data.fragment_trees.get_mut(¶) {
+ tree.add_and_populate(candidate_hash, &*storage);
+ if let Some(depths) = tree.candidate(&candidate_hash) {
+ membership.push((*relay_parent, depths));
+ }
+ }
+ }
+
+ if membership.is_empty() {
+ storage.remove_candidate(&candidate_hash);
+ }
+
+ let _ = tx.send(membership);
+
+ Ok(())
+}
+
+fn handle_candidate_seconded(view: &mut View, para: ParaId, candidate_hash: CandidateHash) {
+ let storage = match view.candidate_storage.get_mut(¶) {
+ None => {
+ gum::warn!(
+ target: LOG_TARGET,
+ para_id = ?para,
+ ?candidate_hash,
+ "Received instruction to second unknown candidate",
+ );
+
+ return
+ },
+ Some(storage) => storage,
+ };
+
+ if !storage.contains(&candidate_hash) {
+ gum::warn!(
+ target: LOG_TARGET,
+ para_id = ?para,
+ ?candidate_hash,
+ "Received instruction to second unknown candidate",
+ );
+
+ return
+ }
+
+ storage.mark_seconded(&candidate_hash);
+}
+
+#[overseer::contextbounds(ProspectiveParachains, prefix = self::overseer)]
+async fn handle_candidate_backed(
+ _ctx: &mut Context,
+ view: &mut View,
+ para: ParaId,
+ candidate_hash: CandidateHash,
+) -> JfyiErrorResult<()> {
+ let storage = match view.candidate_storage.get_mut(¶) {
+ None => {
+ gum::warn!(
+ target: LOG_TARGET,
+ para_id = ?para,
+ ?candidate_hash,
+ "Received instruction to back unknown candidate",
+ );
+
+ return Ok(())
+ },
+ Some(storage) => storage,
+ };
+
+ if !storage.contains(&candidate_hash) {
+ gum::warn!(
+ target: LOG_TARGET,
+ para_id = ?para,
+ ?candidate_hash,
+ "Received instruction to back unknown candidate",
+ );
+
+ return Ok(())
+ }
+
+ if storage.is_backed(&candidate_hash) {
+ gum::debug!(
+ target: LOG_TARGET,
+ para_id = ?para,
+ ?candidate_hash,
+ "Received redundant instruction to mark candidate as backed",
+ );
+
+ return Ok(())
+ }
+
+ storage.mark_backed(&candidate_hash);
+ Ok(())
+}
+
+fn answer_get_backable_candidate(
+ view: &View,
+ relay_parent: Hash,
+ para: ParaId,
+ required_path: Vec,
+ tx: oneshot::Sender>,
+) {
+ let data = match view.active_leaves.get(&relay_parent) {
+ None => {
+ gum::debug!(
+ target: LOG_TARGET,
+ ?relay_parent,
+ para_id = ?para,
+ "Requested backable candidate for inactive relay-parent."
+ );
+
+ let _ = tx.send(None);
+ return
+ },
+ Some(d) => d,
+ };
+
+ let tree = match data.fragment_trees.get(¶) {
+ None => {
+ gum::debug!(
+ target: LOG_TARGET,
+ ?relay_parent,
+ para_id = ?para,
+ "Requested backable candidate for inactive para."
+ );
+
+ let _ = tx.send(None);
+ return
+ },
+ Some(tree) => tree,
+ };
+
+ let storage = match view.candidate_storage.get(¶) {
+ None => {
+ gum::warn!(
+ target: LOG_TARGET,
+ ?relay_parent,
+ para_id = ?para,
+ "No candidate storage for active para",
+ );
+
+ let _ = tx.send(None);
+ return
+ },
+ Some(s) => s,
+ };
+
+ let _ = tx.send(tree.select_child(&required_path, |candidate| storage.is_backed(candidate)));
+}
+
+fn answer_hypothetical_frontier_request(
+ view: &View,
+ request: HypotheticalFrontierRequest,
+ tx: oneshot::Sender>,
+) {
+ let mut response = Vec::with_capacity(request.candidates.len());
+ for candidate in request.candidates {
+ response.push((candidate, Vec::new()));
+ }
+
+ let required_active_leaf = request.fragment_tree_relay_parent;
+ for (active_leaf, leaf_view) in view
+ .active_leaves
+ .iter()
+ .filter(|(h, _)| required_active_leaf.as_ref().map_or(true, |x| h == &x))
+ {
+ for &mut (ref c, ref mut membership) in &mut response {
+ let fragment_tree = match leaf_view.fragment_trees.get(&c.candidate_para()) {
+ None => continue,
+ Some(f) => f,
+ };
+ let candidate_storage = match view.candidate_storage.get(&c.candidate_para()) {
+ None => continue,
+ Some(storage) => storage,
+ };
+
+ let candidate_hash = c.candidate_hash();
+ let hypothetical = match c {
+ HypotheticalCandidate::Complete { receipt, persisted_validation_data, .. } =>
+ fragment_tree::HypotheticalCandidate::Complete {
+ receipt: Cow::Borrowed(receipt),
+ persisted_validation_data: Cow::Borrowed(persisted_validation_data),
+ },
+ HypotheticalCandidate::Incomplete {
+ parent_head_data_hash,
+ candidate_relay_parent,
+ ..
+ } => fragment_tree::HypotheticalCandidate::Incomplete {
+ relay_parent: *candidate_relay_parent,
+ parent_head_data_hash: *parent_head_data_hash,
+ },
+ };
+
+ let depths = fragment_tree.hypothetical_depths(
+ candidate_hash,
+ hypothetical,
+ candidate_storage,
+ request.backed_in_path_only,
+ );
+
+ if !depths.is_empty() {
+ membership.push((*active_leaf, depths));
+ }
+ }
+ }
+
+ let _ = tx.send(response);
+}
+
+fn fragment_tree_membership(
+ active_leaves: &HashMap,
+ para: ParaId,
+ candidate: CandidateHash,
+) -> FragmentTreeMembership {
+ let mut membership = Vec::new();
+ for (relay_parent, view_data) in active_leaves {
+ if let Some(tree) = view_data.fragment_trees.get(¶) {
+ if let Some(depths) = tree.candidate(&candidate) {
+ membership.push((*relay_parent, depths));
+ }
+ }
+ }
+ membership
+}
+
+fn answer_tree_membership_request(
+ view: &View,
+ para: ParaId,
+ candidate: CandidateHash,
+ tx: oneshot::Sender,
+) {
+ let _ = tx.send(fragment_tree_membership(&view.active_leaves, para, candidate));
+}
+
+fn answer_minimum_relay_parents_request(
+ view: &View,
+ relay_parent: Hash,
+ tx: oneshot::Sender>,
+) {
+ let mut v = Vec::new();
+ if let Some(leaf_data) = view.active_leaves.get(&relay_parent) {
+ for (para_id, fragment_tree) in &leaf_data.fragment_trees {
+ v.push((*para_id, fragment_tree.scope().earliest_relay_parent().number));
+ }
+ }
+
+ let _ = tx.send(v);
+}
+
+fn answer_prospective_validation_data_request(
+ view: &View,
+ request: ProspectiveValidationDataRequest,
+ tx: oneshot::Sender>,
+) {
+ // 1. Try to get the head-data from the candidate store if known.
+ // 2. Otherwise, it might exist as the base in some relay-parent and we can find it by
+ // iterating fragment trees.
+ // 3. Otherwise, it is unknown.
+ // 4. Also try to find the relay parent block info by scanning
+ // fragment trees.
+ // 5. If head data and relay parent block info are found - success. Otherwise, failure.
+
+ let storage = match view.candidate_storage.get(&request.para_id) {
+ None => {
+ let _ = tx.send(None);
+ return
+ },
+ Some(s) => s,
+ };
+
+ let mut head_data =
+ storage.head_data_by_hash(&request.parent_head_data_hash).map(|x| x.clone());
+ let mut relay_parent_info = None;
+ let mut max_pov_size = None;
+
+ for fragment_tree in view
+ .active_leaves
+ .values()
+ .filter_map(|x| x.fragment_trees.get(&request.para_id))
+ {
+ if head_data.is_some() && relay_parent_info.is_some() && max_pov_size.is_some() {
+ break
+ }
+ if relay_parent_info.is_none() {
+ relay_parent_info =
+ fragment_tree.scope().ancestor_by_hash(&request.candidate_relay_parent);
+ }
+ if head_data.is_none() {
+ let required_parent = &fragment_tree.scope().base_constraints().required_parent;
+ if required_parent.hash() == request.parent_head_data_hash {
+ head_data = Some(required_parent.clone());
+ }
+ }
+ if max_pov_size.is_none() {
+ let contains_ancestor = fragment_tree
+ .scope()
+ .ancestor_by_hash(&request.candidate_relay_parent)
+ .is_some();
+ if contains_ancestor {
+ // We are leaning hard on two assumptions here.
+ // 1. That the fragment tree never contains allowed relay-parents whose session for children
+ // is different from that of the base block's.
+ // 2. That the max_pov_size is only configurable per session.
+ max_pov_size = Some(fragment_tree.scope().base_constraints().max_pov_size);
+ }
+ }
+ }
+
+ let _ = tx.send(match (head_data, relay_parent_info, max_pov_size) {
+ (Some(h), Some(i), Some(m)) => Some(PersistedValidationData {
+ parent_head: h,
+ relay_parent_number: i.number,
+ relay_parent_storage_root: i.storage_root,
+ max_pov_size: m as _,
+ }),
+ _ => None,
+ });
+}
+
+#[overseer::contextbounds(ProspectiveParachains, prefix = self::overseer)]
+async fn fetch_backing_state(
+ ctx: &mut Context,
+ relay_parent: Hash,
+ para_id: ParaId,
+) -> JfyiErrorResult)>> {
+ let (tx, rx) = oneshot::channel();
+ ctx.send_message(RuntimeApiMessage::Request(
+ relay_parent,
+ RuntimeApiRequest::StagingParaBackingState(para_id, tx),
+ ))
+ .await;
+
+ Ok(rx
+ .await
+ .map_err(JfyiError::RuntimeApiRequestCanceled)??
+ .map(|s| (From::from(s.constraints), s.pending_availability)))
+}
+
+#[overseer::contextbounds(ProspectiveParachains, prefix = self::overseer)]
+async fn fetch_upcoming_paras(
+ ctx: &mut Context,
+ relay_parent: Hash,
+ pending_availability: &mut HashSet,
+) -> JfyiErrorResult> {
+ let (tx, rx) = oneshot::channel();
+
+ // This'll have to get more sophisticated with parathreads,
+ // but for now we can just use the `AvailabilityCores`.
+ ctx.send_message(RuntimeApiMessage::Request(
+ relay_parent,
+ RuntimeApiRequest::AvailabilityCores(tx),
+ ))
+ .await;
+
+ let cores = rx.await.map_err(JfyiError::RuntimeApiRequestCanceled)??;
+ let mut upcoming = HashSet::new();
+ for core in cores {
+ match core {
+ CoreState::Occupied(occupied) => {
+ pending_availability.insert(occupied.candidate_hash);
+
+ if let Some(next_up_on_available) = occupied.next_up_on_available {
+ upcoming.insert(next_up_on_available.para_id);
+ }
+ if let Some(next_up_on_time_out) = occupied.next_up_on_time_out {
+ upcoming.insert(next_up_on_time_out.para_id);
+ }
+ },
+ CoreState::Scheduled(scheduled) => {
+ upcoming.insert(scheduled.para_id);
+ },
+ CoreState::Free => {},
+ }
+ }
+
+ Ok(upcoming.into_iter().collect())
+}
+
+// Fetch ancestors in descending order, up to the amount requested.
+#[overseer::contextbounds(ProspectiveParachains, prefix = self::overseer)]
+async fn fetch_ancestry(
+ ctx: &mut Context,
+ cache: &mut HashMap,
+ relay_hash: Hash,
+ ancestors: usize,
+) -> JfyiErrorResult> {
+ if ancestors == 0 {
+ return Ok(Vec::new())
+ }
+
+ let (tx, rx) = oneshot::channel();
+ ctx.send_message(ChainApiMessage::Ancestors {
+ hash: relay_hash,
+ k: ancestors,
+ response_channel: tx,
+ })
+ .await;
+
+ let hashes = rx.map_err(JfyiError::ChainApiRequestCanceled).await??;
+ let mut block_info = Vec::with_capacity(hashes.len());
+ for hash in hashes {
+ match fetch_block_info(ctx, cache, hash).await? {
+ None => {
+ gum::warn!(
+ target: LOG_TARGET,
+ relay_hash = ?hash,
+ "Failed to fetch info for hash returned from ancestry.",
+ );
+
+ // Return, however far we got.
+ return Ok(block_info)
+ },
+ Some(info) => {
+ block_info.push(info);
+ },
+ }
+ }
+
+ Ok(block_info)
+}
+
+#[overseer::contextbounds(ProspectiveParachains, prefix = self::overseer)]
+async fn fetch_block_header_with_cache(
+ ctx: &mut Context,
+ cache: &mut HashMap,
+ relay_hash: Hash,
+) -> JfyiErrorResult> {
+ if let Some(h) = cache.get(&relay_hash) {
+ return Ok(Some(h.clone()))
+ }
+
+ let (tx, rx) = oneshot::channel();
+
+ ctx.send_message(ChainApiMessage::BlockHeader(relay_hash, tx)).await;
+ let header = rx.map_err(JfyiError::ChainApiRequestCanceled).await??;
+ if let Some(ref h) = header {
+ cache.insert(relay_hash, h.clone());
+ }
+ Ok(header)
+}
+
+#[overseer::contextbounds(ProspectiveParachains, prefix = self::overseer)]
+async fn fetch_block_info(
+ ctx: &mut Context,
+ cache: &mut HashMap,
+ relay_hash: Hash,
+) -> JfyiErrorResult> {
+ let header = fetch_block_header_with_cache(ctx, cache, relay_hash).await?;
+
+ Ok(header.map(|header| RelayChainBlockInfo {
+ hash: relay_hash,
+ number: header.number,
+ storage_root: header.state_root,
+ }))
+}
diff --git a/node/core/prospective-parachains/src/metrics.rs b/node/core/prospective-parachains/src/metrics.rs
new file mode 100644
index 000000000000..d7a1760bb459
--- /dev/null
+++ b/node/core/prospective-parachains/src/metrics.rs
@@ -0,0 +1,52 @@
+// Copyright 2023 Parity Technologies (UK) Ltd.
+// This file is part of Polkadot.
+
+// Polkadot is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Polkadot is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Polkadot. If not, see .
+
+use polkadot_node_subsystem_util::metrics::{self, prometheus};
+
+#[derive(Clone)]
+pub(crate) struct MetricsInner {
+ pub(crate) prune_view_candidate_storage: prometheus::Histogram,
+}
+
+/// Candidate backing metrics.
+#[derive(Default, Clone)]
+pub struct Metrics(pub(crate) Option);
+
+impl Metrics {
+ /// Provide a timer for handling `prune_view_candidate_storage` which observes on drop.
+ pub fn time_prune_view_candidate_storage(
+ &self,
+ ) -> Option {
+ self.0
+ .as_ref()
+ .map(|metrics| metrics.prune_view_candidate_storage.start_timer())
+ }
+}
+
+impl metrics::Metrics for Metrics {
+ fn try_register(registry: &prometheus::Registry) -> Result {
+ let metrics = MetricsInner {
+ prune_view_candidate_storage: prometheus::register(
+ prometheus::Histogram::with_opts(prometheus::HistogramOpts::new(
+ "polkadot_parachain_prospective_parachains_prune_view_candidate_storage",
+ "Time spent within `prospective_parachains::prune_view_candidate_storage`",
+ ))?,
+ registry,
+ )?,
+ };
+ Ok(Metrics(Some(metrics)))
+ }
+}
diff --git a/node/core/prospective-parachains/src/tests.rs b/node/core/prospective-parachains/src/tests.rs
new file mode 100644
index 000000000000..cd1f2d494cc4
--- /dev/null
+++ b/node/core/prospective-parachains/src/tests.rs
@@ -0,0 +1,1442 @@
+// Copyright 2022 Parity Technologies (UK) Ltd.
+// This file is part of Polkadot.
+
+// Polkadot is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Polkadot is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Polkadot. If not, see .
+
+use super::*;
+use assert_matches::assert_matches;
+use polkadot_node_subsystem::{
+ errors::RuntimeApiError,
+ messages::{
+ AllMessages, HypotheticalFrontierRequest, ProspectiveParachainsMessage,
+ ProspectiveValidationDataRequest,
+ },
+};
+use polkadot_node_subsystem_test_helpers as test_helpers;
+use polkadot_node_subsystem_types::{jaeger, ActivatedLeaf, LeafStatus};
+use polkadot_primitives::{
+ vstaging::{AsyncBackingParameters, BackingState, Constraints, InboundHrmpLimitations},
+ CommittedCandidateReceipt, HeadData, Header, PersistedValidationData, ScheduledCore,
+ ValidationCodeHash,
+};
+use polkadot_primitives_test_helpers::make_candidate;
+use std::sync::Arc;
+
+const ALLOWED_ANCESTRY_LEN: u32 = 3;
+const ASYNC_BACKING_PARAMETERS: AsyncBackingParameters =
+ AsyncBackingParameters { max_candidate_depth: 4, allowed_ancestry_len: ALLOWED_ANCESTRY_LEN };
+
+const ASYNC_BACKING_DISABLED_ERROR: RuntimeApiError =
+ RuntimeApiError::NotSupported { runtime_api_name: "test-runtime" };
+
+const MAX_POV_SIZE: u32 = 1_000_000;
+
+type VirtualOverseer = test_helpers::TestSubsystemContextHandle;
+
+fn dummy_constraints(
+ min_relay_parent_number: BlockNumber,
+ valid_watermarks: Vec,
+ required_parent: HeadData,
+ validation_code_hash: ValidationCodeHash,
+) -> Constraints {
+ Constraints {
+ min_relay_parent_number,
+ max_pov_size: MAX_POV_SIZE,
+ max_code_size: 1_000_000,
+ ump_remaining: 10,
+ ump_remaining_bytes: 1_000,
+ max_ump_num_per_candidate: 10,
+ dmp_remaining_messages: vec![],
+ hrmp_inbound: InboundHrmpLimitations { valid_watermarks },
+ hrmp_channels_out: vec![],
+ max_hrmp_num_per_candidate: 0,
+ required_parent,
+ validation_code_hash,
+ upgrade_restriction: None,
+ future_validation_code: None,
+ }
+}
+
+struct TestState {
+ availability_cores: Vec,
+ validation_code_hash: ValidationCodeHash,
+}
+
+impl Default for TestState {
+ fn default() -> Self {
+ let chain_a = ParaId::from(1);
+ let chain_b = ParaId::from(2);
+
+ let availability_cores = vec![
+ CoreState::Scheduled(ScheduledCore { para_id: chain_a, collator: None }),
+ CoreState::Scheduled(ScheduledCore { para_id: chain_b, collator: None }),
+ ];
+ let validation_code_hash = Hash::repeat_byte(42).into();
+
+ Self { availability_cores, validation_code_hash }
+ }
+}
+
+fn get_parent_hash(hash: Hash) -> Hash {
+ Hash::from_low_u64_be(hash.to_low_u64_be() + 1)
+}
+
+fn test_harness>(
+ test: impl FnOnce(VirtualOverseer) -> T,
+) -> View {
+ let pool = sp_core::testing::TaskExecutor::new();
+
+ let (mut context, virtual_overseer) = test_helpers::make_subsystem_context(pool.clone());
+
+ let mut view = View::new();
+ let subsystem = async move {
+ loop {
+ match run_iteration(&mut context, &mut view, &Metrics(None)).await {
+ Ok(()) => break,
+ Err(e) => panic!("{:?}", e),
+ }
+ }
+
+ view
+ };
+
+ let test_fut = test(virtual_overseer);
+
+ futures::pin_mut!(test_fut);
+ futures::pin_mut!(subsystem);
+ let (_, view) = futures::executor::block_on(future::join(
+ async move {
+ let mut virtual_overseer = test_fut.await;
+ virtual_overseer.send(FromOrchestra::Signal(OverseerSignal::Conclude)).await;
+ },
+ subsystem,
+ ));
+
+ view
+}
+
+#[derive(Debug, Clone)]
+struct PerParaData {
+ min_relay_parent: BlockNumber,
+ head_data: HeadData,
+ pending_availability: Vec,
+}
+
+impl PerParaData {
+ pub fn new(min_relay_parent: BlockNumber, head_data: HeadData) -> Self {
+ Self { min_relay_parent, head_data, pending_availability: Vec::new() }
+ }
+
+ pub fn new_with_pending(
+ min_relay_parent: BlockNumber,
+ head_data: HeadData,
+ pending: Vec,
+ ) -> Self {
+ Self { min_relay_parent, head_data, pending_availability: pending }
+ }
+}
+
+struct TestLeaf {
+ number: BlockNumber,
+ hash: Hash,
+ para_data: Vec<(ParaId, PerParaData)>,
+}
+
+impl TestLeaf {
+ pub fn para_data(&self, para_id: ParaId) -> &PerParaData {
+ self.para_data
+ .iter()
+ .find_map(|(p_id, data)| if *p_id == para_id { Some(data) } else { None })
+ .unwrap()
+ }
+}
+
+async fn send_block_header(virtual_overseer: &mut VirtualOverseer, hash: Hash, number: u32) {
+ let header = Header {
+ parent_hash: get_parent_hash(hash),
+ number,
+ state_root: Hash::zero(),
+ extrinsics_root: Hash::zero(),
+ digest: Default::default(),
+ };
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ChainApi(
+ ChainApiMessage::BlockHeader(parent, tx)
+ ) if parent == hash => {
+ tx.send(Ok(Some(header))).unwrap();
+ }
+ );
+}
+
+async fn activate_leaf(
+ virtual_overseer: &mut VirtualOverseer,
+ leaf: &TestLeaf,
+ test_state: &TestState,
+) {
+ let TestLeaf { number, hash, .. } = leaf;
+
+ let activated = ActivatedLeaf {
+ hash: *hash,
+ number: *number,
+ status: LeafStatus::Fresh,
+ span: Arc::new(jaeger::Span::Disabled),
+ };
+
+ virtual_overseer
+ .send(FromOrchestra::Signal(OverseerSignal::ActiveLeaves(ActiveLeavesUpdate::start_work(
+ activated,
+ ))))
+ .await;
+
+ handle_leaf_activation(virtual_overseer, leaf, test_state).await;
+}
+
+async fn handle_leaf_activation(
+ virtual_overseer: &mut VirtualOverseer,
+ leaf: &TestLeaf,
+ test_state: &TestState,
+) {
+ let TestLeaf { number, hash, para_data } = leaf;
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(parent, RuntimeApiRequest::StagingAsyncBackingParameters(tx))
+ ) if parent == *hash => {
+ tx.send(Ok(ASYNC_BACKING_PARAMETERS)).unwrap();
+ }
+ );
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(parent, RuntimeApiRequest::AvailabilityCores(tx))
+ ) if parent == *hash => {
+ tx.send(Ok(test_state.availability_cores.clone())).unwrap();
+ }
+ );
+
+ send_block_header(virtual_overseer, *hash, *number).await;
+
+ // Check that subsystem job issues a request for ancestors.
+ let min_min = para_data.iter().map(|(_, data)| data.min_relay_parent).min().unwrap_or(*number);
+ let ancestry_len = number - min_min;
+ let ancestry_hashes: Vec =
+ std::iter::successors(Some(*hash), |h| Some(get_parent_hash(*h)))
+ .skip(1)
+ .take(ancestry_len as usize)
+ .collect();
+ let ancestry_numbers = (min_min..*number).rev();
+ let ancestry_iter = ancestry_hashes.clone().into_iter().zip(ancestry_numbers).peekable();
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::ChainApi(
+ ChainApiMessage::Ancestors{hash: block_hash, k, response_channel: tx}
+ ) if block_hash == *hash && k == ALLOWED_ANCESTRY_LEN as usize => {
+ tx.send(Ok(ancestry_hashes.clone())).unwrap();
+ }
+ );
+
+ for (hash, number) in ancestry_iter {
+ send_block_header(virtual_overseer, hash, number).await;
+ }
+
+ for _ in 0..test_state.availability_cores.len() {
+ let message = virtual_overseer.recv().await;
+ // Get the para we are working with since the order is not deterministic.
+ let para_id = match message {
+ AllMessages::RuntimeApi(RuntimeApiMessage::Request(
+ _,
+ RuntimeApiRequest::StagingParaBackingState(p_id, _),
+ )) => p_id,
+ _ => panic!("received unexpected message {:?}", message),
+ };
+
+ let PerParaData { min_relay_parent, head_data, pending_availability } =
+ leaf.para_data(para_id);
+ let constraints = dummy_constraints(
+ *min_relay_parent,
+ vec![*number],
+ head_data.clone(),
+ test_state.validation_code_hash,
+ );
+ let backing_state =
+ BackingState { constraints, pending_availability: pending_availability.clone() };
+
+ assert_matches!(
+ message,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(parent, RuntimeApiRequest::StagingParaBackingState(p_id, tx))
+ ) if parent == *hash && p_id == para_id => {
+ tx.send(Ok(Some(backing_state))).unwrap();
+ }
+ );
+
+ for pending in pending_availability {
+ send_block_header(
+ virtual_overseer,
+ pending.descriptor.relay_parent,
+ pending.relay_parent_number,
+ )
+ .await;
+ }
+ }
+
+ // Get minimum relay parents.
+ let (tx, rx) = oneshot::channel();
+ virtual_overseer
+ .send(overseer::FromOrchestra::Communication {
+ msg: ProspectiveParachainsMessage::GetMinimumRelayParents(*hash, tx),
+ })
+ .await;
+ let mut resp = rx.await.unwrap();
+ resp.sort();
+ let mrp_response: Vec<(ParaId, BlockNumber)> = para_data
+ .iter()
+ .map(|(para_id, data)| (*para_id, data.min_relay_parent))
+ .collect();
+ assert_eq!(resp, mrp_response);
+}
+
+async fn deactivate_leaf(virtual_overseer: &mut VirtualOverseer, hash: Hash) {
+ virtual_overseer
+ .send(FromOrchestra::Signal(OverseerSignal::ActiveLeaves(ActiveLeavesUpdate::stop_work(
+ hash,
+ ))))
+ .await;
+}
+
+async fn introduce_candidate(
+ virtual_overseer: &mut VirtualOverseer,
+ candidate: CommittedCandidateReceipt,
+ pvd: PersistedValidationData,
+) {
+ let req = IntroduceCandidateRequest {
+ candidate_para: candidate.descriptor().para_id,
+ candidate_receipt: candidate,
+ persisted_validation_data: pvd,
+ };
+ let (tx, _) = oneshot::channel();
+ virtual_overseer
+ .send(overseer::FromOrchestra::Communication {
+ msg: ProspectiveParachainsMessage::IntroduceCandidate(req, tx),
+ })
+ .await;
+}
+
+async fn second_candidate(
+ virtual_overseer: &mut VirtualOverseer,
+ candidate: CommittedCandidateReceipt,
+) {
+ virtual_overseer
+ .send(overseer::FromOrchestra::Communication {
+ msg: ProspectiveParachainsMessage::CandidateSeconded(
+ candidate.descriptor.para_id,
+ candidate.hash(),
+ ),
+ })
+ .await;
+}
+
+async fn back_candidate(
+ virtual_overseer: &mut VirtualOverseer,
+ candidate: &CommittedCandidateReceipt,
+ candidate_hash: CandidateHash,
+) {
+ virtual_overseer
+ .send(overseer::FromOrchestra::Communication {
+ msg: ProspectiveParachainsMessage::CandidateBacked(
+ candidate.descriptor.para_id,
+ candidate_hash,
+ ),
+ })
+ .await;
+}
+
+async fn get_membership(
+ virtual_overseer: &mut VirtualOverseer,
+ para_id: ParaId,
+ candidate_hash: CandidateHash,
+ expected_membership_response: Vec<(Hash, Vec)>,
+) {
+ let (tx, rx) = oneshot::channel();
+ virtual_overseer
+ .send(overseer::FromOrchestra::Communication {
+ msg: ProspectiveParachainsMessage::GetTreeMembership(para_id, candidate_hash, tx),
+ })
+ .await;
+ let resp = rx.await.unwrap();
+ assert_eq!(resp, expected_membership_response);
+}
+
+async fn get_backable_candidate(
+ virtual_overseer: &mut VirtualOverseer,
+ leaf: &TestLeaf,
+ para_id: ParaId,
+ required_path: Vec,
+ expected_candidate_hash: Option,
+) {
+ let (tx, rx) = oneshot::channel();
+ virtual_overseer
+ .send(overseer::FromOrchestra::Communication {
+ msg: ProspectiveParachainsMessage::GetBackableCandidate(
+ leaf.hash,
+ para_id,
+ required_path,
+ tx,
+ ),
+ })
+ .await;
+ let resp = rx.await.unwrap();
+ assert_eq!(resp, expected_candidate_hash);
+}
+
+async fn get_hypothetical_frontier(
+ virtual_overseer: &mut VirtualOverseer,
+ candidate_hash: CandidateHash,
+ receipt: CommittedCandidateReceipt,
+ persisted_validation_data: PersistedValidationData,
+ fragment_tree_relay_parent: Hash,
+ backed_in_path_only: bool,
+ expected_depths: Vec,
+) {
+ let hypothetical_candidate = HypotheticalCandidate::Complete {
+ candidate_hash,
+ receipt: Arc::new(receipt),
+ persisted_validation_data,
+ };
+ let request = HypotheticalFrontierRequest {
+ candidates: vec![hypothetical_candidate.clone()],
+ fragment_tree_relay_parent: Some(fragment_tree_relay_parent),
+ backed_in_path_only,
+ };
+ let (tx, rx) = oneshot::channel();
+ virtual_overseer
+ .send(overseer::FromOrchestra::Communication {
+ msg: ProspectiveParachainsMessage::GetHypotheticalFrontier(request, tx),
+ })
+ .await;
+ let resp = rx.await.unwrap();
+ let expected_frontier = if expected_depths.is_empty() {
+ vec![(hypothetical_candidate, vec![])]
+ } else {
+ vec![(hypothetical_candidate, vec![(fragment_tree_relay_parent, expected_depths)])]
+ };
+ assert_eq!(resp, expected_frontier);
+}
+
+async fn get_pvd(
+ virtual_overseer: &mut VirtualOverseer,
+ para_id: ParaId,
+ candidate_relay_parent: Hash,
+ parent_head_data: HeadData,
+ expected_pvd: Option,
+) {
+ let request = ProspectiveValidationDataRequest {
+ para_id,
+ candidate_relay_parent,
+ parent_head_data_hash: parent_head_data.hash(),
+ };
+ let (tx, rx) = oneshot::channel();
+ virtual_overseer
+ .send(overseer::FromOrchestra::Communication {
+ msg: ProspectiveParachainsMessage::GetProspectiveValidationData(request, tx),
+ })
+ .await;
+ let resp = rx.await.unwrap();
+ assert_eq!(resp, expected_pvd);
+}
+
+#[test]
+fn should_do_no_work_if_async_backing_disabled_for_leaf() {
+ async fn activate_leaf_async_backing_disabled(virtual_overseer: &mut VirtualOverseer) {
+ let hash = Hash::from_low_u64_be(130);
+
+ // Start work on some new parent.
+ virtual_overseer
+ .send(FromOrchestra::Signal(OverseerSignal::ActiveLeaves(
+ ActiveLeavesUpdate::start_work(ActivatedLeaf {
+ hash,
+ number: 1,
+ status: LeafStatus::Fresh,
+ span: Arc::new(jaeger::Span::Disabled),
+ }),
+ )))
+ .await;
+
+ assert_matches!(
+ virtual_overseer.recv().await,
+ AllMessages::RuntimeApi(
+ RuntimeApiMessage::Request(parent, RuntimeApiRequest::StagingAsyncBackingParameters(tx))
+ ) if parent == hash => {
+ tx.send(Err(ASYNC_BACKING_DISABLED_ERROR)).unwrap();
+ }
+ );
+ }
+
+ let view = test_harness(|mut virtual_overseer| async move {
+ activate_leaf_async_backing_disabled(&mut virtual_overseer).await;
+
+ virtual_overseer
+ });
+
+ assert!(view.active_leaves.is_empty());
+ assert!(view.candidate_storage.is_empty());
+}
+
+// Send some candidates and make sure all are found:
+// - Two for the same leaf A
+// - One for leaf B on parachain 1
+// - One for leaf C on parachain 2
+#[test]
+fn send_candidates_and_check_if_found() {
+ let test_state = TestState::default();
+ let view = test_harness(|mut virtual_overseer| async move {
+ // Leaf A
+ let leaf_a = TestLeaf {
+ number: 100,
+ hash: Hash::from_low_u64_be(130),
+ para_data: vec![
+ (1.into(), PerParaData::new(97, HeadData(vec![1, 2, 3]))),
+ (2.into(), PerParaData::new(100, HeadData(vec![2, 3, 4]))),
+ ],
+ };
+ // Leaf B
+ let leaf_b = TestLeaf {
+ number: 101,
+ hash: Hash::from_low_u64_be(131),
+ para_data: vec![
+ (1.into(), PerParaData::new(99, HeadData(vec![3, 4, 5]))),
+ (2.into(), PerParaData::new(101, HeadData(vec![4, 5, 6]))),
+ ],
+ };
+ // Leaf C
+ let leaf_c = TestLeaf {
+ number: 102,
+ hash: Hash::from_low_u64_be(132),
+ para_data: vec![
+ (1.into(), PerParaData::new(102, HeadData(vec![5, 6, 7]))),
+ (2.into(), PerParaData::new(98, HeadData(vec![6, 7, 8]))),
+ ],
+ };
+
+ // Activate leaves.
+ activate_leaf(&mut virtual_overseer, &leaf_a, &test_state).await;
+ activate_leaf(&mut virtual_overseer, &leaf_b, &test_state).await;
+ activate_leaf(&mut virtual_overseer, &leaf_c, &test_state).await;
+
+ // Candidate A1
+ let (candidate_a1, pvd_a1) = make_candidate(
+ leaf_a.hash,
+ leaf_a.number,
+ 1.into(),
+ HeadData(vec![1, 2, 3]),
+ HeadData(vec![1]),
+ test_state.validation_code_hash,
+ );
+ let candidate_hash_a1 = candidate_a1.hash();
+ let response_a1 = vec![(leaf_a.hash, vec![0])];
+
+ // Candidate A2
+ let (candidate_a2, pvd_a2) = make_candidate(
+ leaf_a.hash,
+ leaf_a.number,
+ 2.into(),
+ HeadData(vec![2, 3, 4]),
+ HeadData(vec![2]),
+ test_state.validation_code_hash,
+ );
+ let candidate_hash_a2 = candidate_a2.hash();
+ let response_a2 = vec![(leaf_a.hash, vec![0])];
+
+ // Candidate B
+ let (candidate_b, pvd_b) = make_candidate(
+ leaf_b.hash,
+ leaf_b.number,
+ 1.into(),
+ HeadData(vec![3, 4, 5]),
+ HeadData(vec![3]),
+ test_state.validation_code_hash,
+ );
+ let candidate_hash_b = candidate_b.hash();
+ let response_b = vec![(leaf_b.hash, vec![0])];
+
+ // Candidate C
+ let (candidate_c, pvd_c) = make_candidate(
+ leaf_c.hash,
+ leaf_c.number,
+ 2.into(),
+ HeadData(vec![6, 7, 8]),
+ HeadData(vec![4]),
+ test_state.validation_code_hash,
+ );
+ let candidate_hash_c = candidate_c.hash();
+ let response_c = vec![(leaf_c.hash, vec![0])];
+
+ // Introduce candidates.
+ introduce_candidate(&mut virtual_overseer, candidate_a1, pvd_a1).await;
+ introduce_candidate(&mut virtual_overseer, candidate_a2, pvd_a2).await;
+ introduce_candidate(&mut virtual_overseer, candidate_b, pvd_b).await;
+ introduce_candidate(&mut virtual_overseer, candidate_c, pvd_c).await;
+
+ // Check candidate tree membership.
+ get_membership(&mut virtual_overseer, 1.into(), candidate_hash_a1, response_a1).await;
+ get_membership(&mut virtual_overseer, 2.into(), candidate_hash_a2, response_a2).await;
+ get_membership(&mut virtual_overseer, 1.into(), candidate_hash_b, response_b).await;
+ get_membership(&mut virtual_overseer, 2.into(), candidate_hash_c, response_c).await;
+
+ // The candidates should not be found on other parachains.
+ get_membership(&mut virtual_overseer, 2.into(), candidate_hash_a1, vec![]).await;
+ get_membership(&mut virtual_overseer, 1.into(), candidate_hash_a2, vec![]).await;
+ get_membership(&mut virtual_overseer, 2.into(), candidate_hash_b, vec![]).await;
+ get_membership(&mut virtual_overseer, 1.into(), candidate_hash_c, vec![]).await;
+
+ virtual_overseer
+ });
+
+ assert_eq!(view.active_leaves.len(), 3);
+ assert_eq!(view.candidate_storage.len(), 2);
+ // Two parents and two candidates per para.
+ assert_eq!(view.candidate_storage.get(&1.into()).unwrap().len(), (2, 2));
+ assert_eq!(view.candidate_storage.get(&2.into()).unwrap().len(), (2, 2));
+}
+
+// Send some candidates, check if the candidate won't be found once its relay parent leaves the view.
+#[test]
+fn check_candidate_parent_leaving_view() {
+ let test_state = TestState::default();
+ let view = test_harness(|mut virtual_overseer| async move {
+ // Leaf A
+ let leaf_a = TestLeaf {
+ number: 100,
+ hash: Hash::from_low_u64_be(130),
+ para_data: vec![
+ (1.into(), PerParaData::new(97, HeadData(vec![1, 2, 3]))),
+ (2.into(), PerParaData::new(100, HeadData(vec![2, 3, 4]))),
+ ],
+ };
+ // Leaf B
+ let leaf_b = TestLeaf {
+ number: 101,
+ hash: Hash::from_low_u64_be(131),
+ para_data: vec![
+ (1.into(), PerParaData::new(99, HeadData(vec![3, 4, 5]))),
+ (2.into(), PerParaData::new(101, HeadData(vec![4, 5, 6]))),
+ ],
+ };
+ // Leaf C
+ let leaf_c = TestLeaf {
+ number: 102,
+ hash: Hash::from_low_u64_be(132),
+ para_data: vec![
+ (1.into(), PerParaData::new(102, HeadData(vec![5, 6, 7]))),
+ (2.into(), PerParaData::new(98, HeadData(vec![6, 7, 8]))),
+ ],
+ };
+
+ // Activate leaves.
+ activate_leaf(&mut virtual_overseer, &leaf_a, &test_state).await;
+ activate_leaf(&mut virtual_overseer, &leaf_b, &test_state).await;
+ activate_leaf(&mut virtual_overseer, &leaf_c, &test_state).await;
+
+ // Candidate A1
+ let (candidate_a1, pvd_a1) = make_candidate(
+ leaf_a.hash,
+ leaf_a.number,
+ 1.into(),
+ HeadData(vec![1, 2, 3]),
+ HeadData(vec![1]),
+ test_state.validation_code_hash,
+ );
+ let candidate_hash_a1 = candidate_a1.hash();
+
+ // Candidate A2
+ let (candidate_a2, pvd_a2) = make_candidate(
+ leaf_a.hash,
+ leaf_a.number,
+ 2.into(),
+ HeadData(vec![2, 3, 4]),
+ HeadData(vec![2]),
+ test_state.validation_code_hash,
+ );
+ let candidate_hash_a2 = candidate_a2.hash();
+
+ // Candidate B
+ let (candidate_b, pvd_b) = make_candidate(
+ leaf_b.hash,
+ leaf_b.number,
+ 1.into(),
+ HeadData(vec![3, 4, 5]),
+ HeadData(vec![3]),
+ test_state.validation_code_hash,
+ );
+ let candidate_hash_b = candidate_b.hash();
+ let response_b = vec![(leaf_b.hash, vec![0])];
+
+ // Candidate C
+ let (candidate_c, pvd_c) = make_candidate(
+ leaf_c.hash,
+ leaf_c.number,
+ 2.into(),
+ HeadData(vec![6, 7, 8]),
+ HeadData(vec![4]),
+ test_state.validation_code_hash,
+ );
+ let candidate_hash_c = candidate_c.hash();
+ let response_c = vec![(leaf_c.hash, vec![0])];
+
+ // Introduce candidates.
+ introduce_candidate(&mut virtual_overseer, candidate_a1, pvd_a1).await;
+ introduce_candidate(&mut virtual_overseer, candidate_a2, pvd_a2).await;
+ introduce_candidate(&mut virtual_overseer, candidate_b, pvd_b).await;
+ introduce_candidate(&mut virtual_overseer, candidate_c, pvd_c).await;
+
+ // Deactivate leaf A.
+ deactivate_leaf(&mut virtual_overseer, leaf_a.hash).await;
+
+ // Candidates A1 and A2 should be gone. Candidates B and C should remain.
+ get_membership(&mut virtual_overseer, 1.into(), candidate_hash_a1, vec![]).await;
+ get_membership(&mut virtual_overseer, 2.into(), candidate_hash_a2, vec![]).await;
+ get_membership(&mut virtual_overseer, 1.into(), candidate_hash_b, response_b).await;
+ get_membership(&mut virtual_overseer, 2.into(), candidate_hash_c, response_c.clone()).await;
+
+ // Deactivate leaf B.
+ deactivate_leaf(&mut virtual_overseer, leaf_b.hash).await;
+
+ // Candidate B should be gone, C should remain.
+ get_membership(&mut virtual_overseer, 1.into(), candidate_hash_a1, vec![]).await;
+ get_membership(&mut virtual_overseer, 2.into(), candidate_hash_a2, vec![]).await;
+ get_membership(&mut virtual_overseer, 1.into(), candidate_hash_b, vec![]).await;
+ get_membership(&mut virtual_overseer, 2.into(), candidate_hash_c, response_c).await;
+
+ // Deactivate leaf C.
+ deactivate_leaf(&mut virtual_overseer, leaf_c.hash).await;
+
+ // Candidate C should be gone.
+ get_membership(&mut virtual_overseer, 1.into(), candidate_hash_a1, vec![]).await;
+ get_membership(&mut virtual_overseer, 2.into(), candidate_hash_a2, vec![]).await;
+ get_membership(&mut virtual_overseer, 1.into(), candidate_hash_b, vec![]).await;
+ get_membership(&mut virtual_overseer, 2.into(), candidate_hash_c, vec![]).await;
+
+ virtual_overseer
+ });
+
+ assert_eq!(view.active_leaves.len(), 0);
+ assert_eq!(view.candidate_storage.len(), 0);
+}
+
+// Introduce a candidate to multiple forks, see how the membership is returned.
+#[test]
+fn check_candidate_on_multiple_forks() {
+ let test_state = TestState::default();
+ let view = test_harness(|mut virtual_overseer| async move {
+ // Leaf A
+ let leaf_a = TestLeaf {
+ number: 100,
+ hash: Hash::from_low_u64_be(130),
+ para_data: vec![
+ (1.into(), PerParaData::new(97, HeadData(vec![1, 2, 3]))),
+ (2.into(), PerParaData::new(100, HeadData(vec![2, 3, 4]))),
+ ],
+ };
+ // Leaf B
+ let leaf_b = TestLeaf {
+ number: 101,
+ hash: Hash::from_low_u64_be(131),
+ para_data: vec![
+ (1.into(), PerParaData::new(99, HeadData(vec![3, 4, 5]))),
+ (2.into(), PerParaData::new(101, HeadData(vec![4, 5, 6]))),
+ ],
+ };
+ // Leaf C
+ let leaf_c = TestLeaf {
+ number: 102,
+ hash: Hash::from_low_u64_be(132),
+ para_data: vec![
+ (1.into(), PerParaData::new(102, HeadData(vec![5, 6, 7]))),
+ (2.into(), PerParaData::new(98, HeadData(vec![6, 7, 8]))),
+ ],
+ };
+
+ // Activate leaves.
+ activate_leaf(&mut virtual_overseer, &leaf_a, &test_state).await;
+ activate_leaf(&mut virtual_overseer, &leaf_b, &test_state).await;
+ activate_leaf(&mut virtual_overseer, &leaf_c, &test_state).await;
+
+ // Candidate on leaf A.
+ let (candidate_a, pvd_a) = make_candidate(
+ leaf_a.hash,
+ leaf_a.number,
+ 1.into(),
+ HeadData(vec![1, 2, 3]),
+ HeadData(vec![1]),
+ test_state.validation_code_hash,
+ );
+ let candidate_hash_a = candidate_a.hash();
+ let response_a = vec![(leaf_a.hash, vec![0])];
+
+ // Candidate on leaf B.
+ let (candidate_b, pvd_b) = make_candidate(
+ leaf_b.hash,
+ leaf_b.number,
+ 1.into(),
+ HeadData(vec![3, 4, 5]),
+ HeadData(vec![1]),
+ test_state.validation_code_hash,
+ );
+ let candidate_hash_b = candidate_b.hash();
+ let response_b = vec![(leaf_b.hash, vec![0])];
+
+ // Candidate on leaf C.
+ let (candidate_c, pvd_c) = make_candidate(
+ leaf_c.hash,
+ leaf_c.number,
+ 1.into(),
+ HeadData(vec![5, 6, 7]),
+ HeadData(vec![1]),
+ test_state.validation_code_hash,
+ );
+ let candidate_hash_c = candidate_c.hash();
+ let response_c = vec![(leaf_c.hash, vec![0])];
+
+ // Introduce candidates on all three leaves.
+ introduce_candidate(&mut virtual_overseer, candidate_a.clone(), pvd_a).await;
+ introduce_candidate(&mut virtual_overseer, candidate_b.clone(), pvd_b).await;
+ introduce_candidate(&mut virtual_overseer, candidate_c.clone(), pvd_c).await;
+
+ // Check candidate tree membership.
+ get_membership(&mut virtual_overseer, 1.into(), candidate_hash_a, response_a).await;
+ get_membership(&mut virtual_overseer, 1.into(), candidate_hash_b, response_b).await;
+ get_membership(&mut virtual_overseer, 1.into(), candidate_hash_c, response_c).await;
+
+ virtual_overseer
+ });
+
+ assert_eq!(view.active_leaves.len(), 3);
+ assert_eq!(view.candidate_storage.len(), 2);
+ // Three parents and three candidates on para 1.
+ assert_eq!(view.candidate_storage.get(&1.into()).unwrap().len(), (3, 3));
+ assert_eq!(view.candidate_storage.get(&2.into()).unwrap().len(), (0, 0));
+}
+
+// Backs some candidates and tests `GetBackableCandidate`.
+#[test]
+fn check_backable_query() {
+ let test_state = TestState::default();
+ let view = test_harness(|mut virtual_overseer| async move {
+ // Leaf A
+ let leaf_a = TestLeaf {
+ number: 100,
+ hash: Hash::from_low_u64_be(130),
+ para_data: vec![
+ (1.into(), PerParaData::new(97, HeadData(vec![1, 2, 3]))),
+ (2.into(), PerParaData::new(100, HeadData(vec![2, 3, 4]))),
+ ],
+ };
+
+ // Activate leaves.
+ activate_leaf(&mut virtual_overseer, &leaf_a, &test_state).await;
+
+ // Candidate A
+ let (candidate_a, pvd_a) = make_candidate(
+ leaf_a.hash,
+ leaf_a.number,
+ 1.into(),
+ HeadData(vec![1, 2, 3]),
+ HeadData(vec![1]),
+ test_state.validation_code_hash,
+ );
+ let candidate_hash_a = candidate_a.hash();
+
+ // Candidate B
+ let (mut candidate_b, pvd_b) = make_candidate(
+ leaf_a.hash,
+ leaf_a.number,
+ 1.into(),
+ HeadData(vec![1]),
+ HeadData(vec![2]),
+ test_state.validation_code_hash,
+ );
+ // Set a field to make this candidate unique.
+ candidate_b.descriptor.para_head = Hash::from_low_u64_le(1000);
+ let candidate_hash_b = candidate_b.hash();
+
+ // Introduce candidates.
+ introduce_candidate(&mut virtual_overseer, candidate_a.clone(), pvd_a).await;
+ introduce_candidate(&mut virtual_overseer, candidate_b.clone(), pvd_b).await;
+
+ // Should not get any backable candidates.
+ get_backable_candidate(
+ &mut virtual_overseer,
+ &leaf_a,
+ 1.into(),
+ vec![candidate_hash_a],
+ None,
+ )
+ .await;
+
+ // Second candidates.
+ second_candidate(&mut virtual_overseer, candidate_a.clone()).await;
+ second_candidate(&mut virtual_overseer, candidate_b.clone()).await;
+
+ // Should not get any backable candidates.
+ get_backable_candidate(
+ &mut virtual_overseer,
+ &leaf_a,
+ 1.into(),
+ vec![candidate_hash_a],
+ None,
+ )
+ .await;
+
+ // Back candidates.
+ back_candidate(&mut virtual_overseer, &candidate_a, candidate_hash_a).await;
+ back_candidate(&mut virtual_overseer, &candidate_b, candidate_hash_b).await;
+
+ // Get backable candidate.
+ get_backable_candidate(
+ &mut virtual_overseer,
+ &leaf_a,
+ 1.into(),
+ vec![],
+ Some(candidate_hash_a),
+ )
+ .await;
+ get_backable_candidate(
+ &mut virtual_overseer,
+ &leaf_a,
+ 1.into(),
+ vec![candidate_hash_a],
+ Some(candidate_hash_b),
+ )
+ .await;
+
+ // Should not get anything at the wrong path.
+ get_backable_candidate(
+ &mut virtual_overseer,
+ &leaf_a,
+ 1.into(),
+ vec![candidate_hash_b],
+ None,
+ )
+ .await;
+
+ virtual_overseer
+ });
+
+ assert_eq!(view.active_leaves.len(), 1);
+ assert_eq!(view.candidate_storage.len(), 2);
+ // Two parents and two candidates on para 1.
+ assert_eq!(view.candidate_storage.get(&1.into()).unwrap().len(), (2, 2));
+ assert_eq!(view.candidate_storage.get(&2.into()).unwrap().len(), (0, 0));
+}
+
+// Test depth query.
+#[test]
+fn check_hypothetical_frontier_query() {
+ let test_state = TestState::default();
+ let view = test_harness(|mut virtual_overseer| async move {
+ // Leaf A
+ let leaf_a = TestLeaf {
+ number: 100,
+ hash: Hash::from_low_u64_be(130),
+ para_data: vec![
+ (1.into(), PerParaData::new(97, HeadData(vec![1, 2, 3]))),
+ (2.into(), PerParaData::new(100, HeadData(vec![2, 3, 4]))),
+ ],
+ };
+
+ // Activate leaves.
+ activate_leaf(&mut virtual_overseer, &leaf_a, &test_state).await;
+
+ // Candidate A.
+ let (candidate_a, pvd_a) = make_candidate(
+ leaf_a.hash,
+ leaf_a.number,
+ 1.into(),
+ HeadData(vec![1, 2, 3]),
+ HeadData(vec![1]),
+ test_state.validation_code_hash,
+ );
+ let candidate_hash_a = candidate_a.hash();
+
+ // Candidate B.
+ let (candidate_b, pvd_b) = make_candidate(
+ leaf_a.hash,
+ leaf_a.number,
+ 1.into(),
+ HeadData(vec![1]),
+ HeadData(vec![2]),
+ test_state.validation_code_hash,
+ );
+ let candidate_hash_b = candidate_b.hash();
+
+ // Candidate C.
+ let (candidate_c, pvd_c) = make_candidate(
+ leaf_a.hash,
+ leaf_a.number,
+ 1.into(),
+ HeadData(vec![2]),
+ HeadData(vec![3]),
+ test_state.validation_code_hash,
+ );
+ let candidate_hash_c = candidate_c.hash();
+
+ // Get hypothetical frontier of candidate A before adding it.
+ get_hypothetical_frontier(
+ &mut virtual_overseer,
+ candidate_hash_a,
+ candidate_a.clone(),
+ pvd_a.clone(),
+ leaf_a.hash,
+ false,
+ vec![0],
+ )
+ .await;
+ // Should work with `backed_in_path_only: true`, too.
+ get_hypothetical_frontier(
+ &mut virtual_overseer,
+ candidate_hash_a,
+ candidate_a.clone(),
+ pvd_a.clone(),
+ leaf_a.hash,
+ true,
+ vec![0],
+ )
+ .await;
+
+ // Add candidate A.
+ introduce_candidate(&mut virtual_overseer, candidate_a.clone(), pvd_a.clone()).await;
+
+ // Get frontier of candidate A after adding it.
+ get_hypothetical_frontier(
+ &mut virtual_overseer,
+ candidate_hash_a,
+ candidate_a.clone(),
+ pvd_a.clone(),
+ leaf_a.hash,
+ false,
+ vec![0],
+ )
+ .await;
+
+ // Get hypothetical frontier of candidate B before adding it.
+ get_hypothetical_frontier(
+ &mut virtual_overseer,
+ candidate_hash_b,
+ candidate_b.clone(),
+ pvd_b.clone(),
+ leaf_a.hash,
+ false,
+ vec![1],
+ )
+ .await;
+
+ // Add candidate B.
+ introduce_candidate(&mut virtual_overseer, candidate_b.clone(), pvd_b.clone()).await;
+
+ // Get frontier of candidate B after adding it.
+ get_hypothetical_frontier(
+ &mut virtual_overseer,
+ candidate_hash_b,
+ candidate_b,
+ pvd_b.clone(),
+ leaf_a.hash,
+ false,
+ vec![1],
+ )
+ .await;
+
+ // Get hypothetical frontier of candidate C before adding it.
+ get_hypothetical_frontier(
+ &mut virtual_overseer,
+ candidate_hash_c,
+ candidate_c.clone(),
+ pvd_c.clone(),
+ leaf_a.hash,
+ false,
+ vec![2],
+ )
+ .await;
+ // Should be empty with `backed_in_path_only` because we haven't backed anything.
+ get_hypothetical_frontier(
+ &mut virtual_overseer,
+ candidate_hash_c,
+ candidate_c.clone(),
+ pvd_c.clone(),
+ leaf_a.hash,
+ true,
+ vec![],
+ )
+ .await;
+
+ // Add candidate C.
+ introduce_candidate(&mut virtual_overseer, candidate_c.clone(), pvd_c.clone()).await;
+
+ // Get frontier of candidate C after adding it.
+ get_hypothetical_frontier(
+ &mut virtual_overseer,
+ candidate_hash_c,
+ candidate_c.clone(),
+ pvd_c.clone(),
+ leaf_a.hash,
+ false,
+ vec![2],
+ )
+ .await;
+ // Should be empty with `backed_in_path_only` because we haven't backed anything.
+ get_hypothetical_frontier(
+ &mut virtual_overseer,
+ candidate_hash_c,
+ candidate_c.clone(),
+ pvd_c.clone(),
+ leaf_a.hash,
+ true,
+ vec![],
+ )
+ .await;
+
+ virtual_overseer
+ });
+
+ assert_eq!(view.active_leaves.len(), 1);
+ assert_eq!(view.candidate_storage.len(), 2);
+}
+
+#[test]
+fn check_pvd_query() {
+ let test_state = TestState::default();
+ let view = test_harness(|mut virtual_overseer| async move {
+ // Leaf A
+ let leaf_a = TestLeaf {
+ number: 100,
+ hash: Hash::from_low_u64_be(130),
+ para_data: vec![
+ (1.into(), PerParaData::new(97, HeadData(vec![1, 2, 3]))),
+ (2.into(), PerParaData::new(100, HeadData(vec![2, 3, 4]))),
+ ],
+ };
+
+ // Activate leaves.
+ activate_leaf(&mut virtual_overseer, &leaf_a, &test_state).await;
+
+ // Candidate A.
+ let (candidate_a, pvd_a) = make_candidate(
+ leaf_a.hash,
+ leaf_a.number,
+ 1.into(),
+ HeadData(vec![1, 2, 3]),
+ HeadData(vec![1]),
+ test_state.validation_code_hash,
+ );
+
+ // Candidate B.
+ let (candidate_b, pvd_b) = make_candidate(
+ leaf_a.hash,
+ leaf_a.number,
+ 1.into(),
+ HeadData(vec![1]),
+ HeadData(vec![2]),
+ test_state.validation_code_hash,
+ );
+
+ // Candidate C.
+ let (candidate_c, pvd_c) = make_candidate(
+ leaf_a.hash,
+ leaf_a.number,
+ 1.into(),
+ HeadData(vec![2]),
+ HeadData(vec![3]),
+ test_state.validation_code_hash,
+ );
+
+ // Get pvd of candidate A before adding it.
+ get_pvd(
+ &mut virtual_overseer,
+ 1.into(),
+ leaf_a.hash,
+ HeadData(vec![1, 2, 3]),
+ Some(pvd_a.clone()),
+ )
+ .await;
+
+ // Add candidate A.
+ introduce_candidate(&mut virtual_overseer, candidate_a.clone(), pvd_a.clone()).await;
+ back_candidate(&mut virtual_overseer, &candidate_a, candidate_a.hash()).await;
+
+ // Get pvd of candidate A after adding it.
+ get_pvd(
+ &mut virtual_overseer,
+ 1.into(),
+ leaf_a.hash,
+ HeadData(vec![1, 2, 3]),
+ Some(pvd_a.clone()),
+ )
+ .await;
+
+ // Get pvd of candidate B before adding it.
+ get_pvd(
+ &mut virtual_overseer,
+ 1.into(),
+ leaf_a.hash,
+ HeadData(vec![1]),
+ Some(pvd_b.clone()),
+ )
+ .await;
+
+ // Add candidate B.
+ introduce_candidate(&mut virtual_overseer, candidate_b, pvd_b.clone()).await;
+
+ // Get pvd of candidate B after adding it.
+ get_pvd(
+ &mut virtual_overseer,
+ 1.into(),
+ leaf_a.hash,
+ HeadData(vec![1]),
+ Some(pvd_b.clone()),
+ )
+ .await;
+
+ // Get pvd of candidate C before adding it.
+ get_pvd(
+ &mut virtual_overseer,
+ 1.into(),
+ leaf_a.hash,
+ HeadData(vec![2]),
+ Some(pvd_c.clone()),
+ )
+ .await;
+
+ // Add candidate C.
+ introduce_candidate(&mut virtual_overseer, candidate_c, pvd_c.clone()).await;
+
+ // Get pvd of candidate C after adding it.
+ get_pvd(
+ &mut virtual_overseer,
+ 1.into(),
+ leaf_a.hash,
+ HeadData(vec![2]),
+ Some(pvd_c.clone()),
+ )
+ .await;
+
+ virtual_overseer
+ });
+
+ assert_eq!(view.active_leaves.len(), 1);
+ assert_eq!(view.candidate_storage.len(), 2);
+}
+
+// Test simultaneously activating and deactivating leaves, and simultaneously deactivating multiple
+// leaves.
+#[test]
+fn correctly_updates_leaves() {
+ let test_state = TestState::default();
+ let view = test_harness(|mut virtual_overseer| async move {
+ // Leaf A
+ let leaf_a = TestLeaf {
+ number: 100,
+ hash: Hash::from_low_u64_be(130),
+ para_data: vec![
+ (1.into(), PerParaData::new(97, HeadData(vec![1, 2, 3]))),
+ (2.into(), PerParaData::new(100, HeadData(vec![2, 3, 4]))),
+ ],
+ };
+ // Leaf B
+ let leaf_b = TestLeaf {
+ number: 101,
+ hash: Hash::from_low_u64_be(131),
+ para_data: vec![
+ (1.into(), PerParaData::new(99, HeadData(vec![3, 4, 5]))),
+ (2.into(), PerParaData::new(101, HeadData(vec![4, 5, 6]))),
+ ],
+ };
+ // Leaf C
+ let leaf_c = TestLeaf {
+ number: 102,
+ hash: Hash::from_low_u64_be(132),
+ para_data: vec![
+ (1.into(), PerParaData::new(102, HeadData(vec![5, 6, 7]))),
+ (2.into(), PerParaData::new(98, HeadData(vec![6, 7, 8]))),
+ ],
+ };
+
+ // Activate leaves.
+ activate_leaf(&mut virtual_overseer, &leaf_a, &test_state).await;
+ activate_leaf(&mut virtual_overseer, &leaf_b, &test_state).await;
+
+ // Try activating a duplicate leaf.
+ activate_leaf(&mut virtual_overseer, &leaf_b, &test_state).await;
+
+ // Pass in an empty update.
+ let update = ActiveLeavesUpdate::default();
+ virtual_overseer
+ .send(FromOrchestra::Signal(OverseerSignal::ActiveLeaves(update)))
+ .await;
+
+ // Activate a leaf and remove one at the same time.
+ let activated = ActivatedLeaf {
+ hash: leaf_c.hash,
+ number: leaf_c.number,
+ span: Arc::new(jaeger::Span::Disabled),
+ status: LeafStatus::Fresh,
+ };
+ let update = ActiveLeavesUpdate {
+ activated: Some(activated),
+ deactivated: [leaf_b.hash][..].into(),
+ };
+ virtual_overseer
+ .send(FromOrchestra::Signal(OverseerSignal::ActiveLeaves(update)))
+ .await;
+ handle_leaf_activation(&mut virtual_overseer, &leaf_c, &test_state).await;
+
+ // Remove all remaining leaves.
+ let update = ActiveLeavesUpdate {
+ deactivated: [leaf_a.hash, leaf_c.hash][..].into(),
+ ..Default::default()
+ };
+ virtual_overseer
+ .send(FromOrchestra::Signal(OverseerSignal::ActiveLeaves(update)))
+ .await;
+
+ // Activate and deactivate the same leaf.
+ let activated = ActivatedLeaf {
+ hash: leaf_a.hash,
+ number: leaf_a.number,
+ span: Arc::new(jaeger::Span::Disabled),
+ status: LeafStatus::Fresh,
+ };
+ let update = ActiveLeavesUpdate {
+ activated: Some(activated),
+ deactivated: [leaf_a.hash][..].into(),
+ };
+ virtual_overseer
+ .send(FromOrchestra::Signal(OverseerSignal::ActiveLeaves(update)))
+ .await;
+ handle_leaf_activation(&mut virtual_overseer, &leaf_a, &test_state).await;
+
+ // Remove the leaf again. Send some unnecessary hashes.
+ let update = ActiveLeavesUpdate {
+ deactivated: [leaf_a.hash, leaf_b.hash, leaf_c.hash][..].into(),
+ ..Default::default()
+ };
+ virtual_overseer
+ .send(FromOrchestra::Signal(OverseerSignal::ActiveLeaves(update)))
+ .await;
+
+ virtual_overseer
+ });
+
+ assert_eq!(view.active_leaves.len(), 0);
+ assert_eq!(view.candidate_storage.len(), 0);
+}
+
+#[test]
+fn persists_pending_availability_candidate() {
+ let mut test_state = TestState::default();
+ let para_id = ParaId::from(1);
+ test_state.availability_cores = test_state
+ .availability_cores
+ .into_iter()
+ .filter(|core| core.para_id().map_or(false, |id| id == para_id))
+ .collect();
+ assert_eq!(test_state.availability_cores.len(), 1);
+
+ test_harness(|mut virtual_overseer| async move {
+ let para_head = HeadData(vec![1, 2, 3]);
+
+ // Min allowed relay parent for leaf `a` which goes out of scope in the test.
+ let candidate_relay_parent = Hash::from_low_u64_be(5);
+ let candidate_relay_parent_number = 97;
+
+ let leaf_a = TestLeaf {
+ number: candidate_relay_parent_number + ALLOWED_ANCESTRY_LEN,
+ hash: Hash::from_low_u64_be(2),
+ para_data: vec![(
+ para_id,
+ PerParaData::new(candidate_relay_parent_number, para_head.clone()),
+ )],
+ };
+
+ let leaf_b_hash = Hash::from_low_u64_be(1);
+ let leaf_b_number = leaf_a.number + 1;
+
+ // Activate leaf.
+ activate_leaf(&mut virtual_overseer, &leaf_a, &test_state).await;
+
+ // Candidate A
+ let (candidate_a, pvd_a) = make_candidate(
+ candidate_relay_parent,
+ candidate_relay_parent_number,
+ para_id,
+ para_head.clone(),
+ HeadData(vec![1]),
+ test_state.validation_code_hash,
+ );
+ let candidate_hash_a = candidate_a.hash();
+
+ // Candidate B, built on top of the candidate which is out of scope but pending availability.
+ let (candidate_b, pvd_b) = make_candidate(
+ leaf_b_hash,
+ leaf_b_number,
+ para_id,
+ HeadData(vec![1]),
+ HeadData(vec![2]),
+ test_state.validation_code_hash,
+ );
+ let candidate_hash_b = candidate_b.hash();
+
+ introduce_candidate(&mut virtual_overseer, candidate_a.clone(), pvd_a).await;
+ second_candidate(&mut virtual_overseer, candidate_a.clone()).await;
+ back_candidate(&mut virtual_overseer, &candidate_a, candidate_hash_a).await;
+
+ let candidate_a_pending_av = CandidatePendingAvailability {
+ candidate_hash: candidate_hash_a,
+ descriptor: candidate_a.descriptor.clone(),
+ commitments: candidate_a.commitments.clone(),
+ relay_parent_number: candidate_relay_parent_number,
+ max_pov_size: MAX_POV_SIZE,
+ };
+ let leaf_b = TestLeaf {
+ number: leaf_b_number,
+ hash: leaf_b_hash,
+ para_data: vec![(
+ 1.into(),
+ PerParaData::new_with_pending(
+ candidate_relay_parent_number + 1,
+ para_head.clone(),
+ vec![candidate_a_pending_av],
+ ),
+ )],
+ };
+ activate_leaf(&mut virtual_overseer, &leaf_b, &test_state).await;
+
+ introduce_candidate(&mut virtual_overseer, candidate_b.clone(), pvd_b).await;
+ second_candidate(&mut virtual_overseer, candidate_b.clone()).await;
+ back_candidate(&mut virtual_overseer, &candidate_b, candidate_hash_b).await;
+
+ get_backable_candidate(
+ &mut virtual_overseer,
+ &leaf_b,
+ para_id,
+ vec![candidate_hash_a],
+ Some(candidate_hash_b),
+ )
+ .await;
+
+ virtual_overseer
+ });
+}
diff --git a/node/core/provisioner/src/error.rs b/node/core/provisioner/src/error.rs
index de520fc1fe04..8a53370b9c87 100644
--- a/node/core/provisioner/src/error.rs
+++ b/node/core/provisioner/src/error.rs
@@ -28,6 +28,10 @@ pub type Result = std::result::Result;
#[allow(missing_docs)]
#[fatality::fatality(splitable)]
pub enum Error {
+ #[fatal(forward)]
+ #[error("Error while accessing runtime information")]
+ Runtime(#[from] util::runtime::Error),
+
#[error(transparent)]
Util(#[from] util::Error),
@@ -46,11 +50,14 @@ pub enum Error {
#[error("failed to get votes on dispute")]
CanceledCandidateVotes(#[source] oneshot::Canceled),
+ #[error("failed to get backable candidate from prospective parachains")]
+ CanceledBackableCandidate(#[source] oneshot::Canceled),
+
#[error(transparent)]
ChainApi(#[from] ChainApiError),
#[error(transparent)]
- Runtime(#[from] RuntimeApiError),
+ RuntimeApi(#[from] RuntimeApiError),
#[error("failed to send message to ChainAPI")]
ChainApiMessageSend(#[source] mpsc::SendError),
diff --git a/node/core/provisioner/src/lib.rs b/node/core/provisioner/src/lib.rs
index be0b051a107c..cea96667eccf 100644
--- a/node/core/provisioner/src/lib.rs
+++ b/node/core/provisioner/src/lib.rs
@@ -28,18 +28,20 @@ use futures_timer::Delay;
use polkadot_node_subsystem::{
jaeger,
messages::{
- CandidateBackingMessage, ChainApiMessage, ProvisionableData, ProvisionerInherentData,
- ProvisionerMessage, RuntimeApiMessage, RuntimeApiRequest,
+ CandidateBackingMessage, ChainApiMessage, ProspectiveParachainsMessage, ProvisionableData,
+ ProvisionerInherentData, ProvisionerMessage, RuntimeApiMessage, RuntimeApiRequest,
},
overseer, ActivatedLeaf, ActiveLeavesUpdate, FromOrchestra, LeafStatus, OverseerSignal,
PerLeafSpan, RuntimeApiError, SpawnedSubsystem, SubsystemError,
};
use polkadot_node_subsystem_util::{
- request_availability_cores, request_persisted_validation_data, TimeoutExt,
+ request_availability_cores, request_persisted_validation_data,
+ runtime::{prospective_parachains_mode, ProspectiveParachainsMode},
+ TimeoutExt,
};
use polkadot_primitives::{
- BackedCandidate, BlockNumber, CandidateReceipt, CoreState, Hash, OccupiedCoreAssumption,
- SignedAvailabilityBitfield, ValidatorIndex,
+ BackedCandidate, BlockNumber, CandidateHash, CandidateReceipt, CoreState, Hash, Id as ParaId,
+ OccupiedCoreAssumption, SignedAvailabilityBitfield, ValidatorIndex,
};
use std::collections::{BTreeMap, HashMap};
@@ -79,6 +81,7 @@ impl ProvisionerSubsystem {
pub struct PerRelayParent {
leaf: ActivatedLeaf,
backed_candidates: Vec,
+ prospective_parachains_mode: ProspectiveParachainsMode,
signed_bitfields: Vec,
is_inherent_ready: bool,
awaiting_inherent: Vec>,
@@ -86,12 +89,13 @@ pub struct PerRelayParent {
}
impl PerRelayParent {
- fn new(leaf: ActivatedLeaf) -> Self {
+ fn new(leaf: ActivatedLeaf, prospective_parachains_mode: ProspectiveParachainsMode) -> Self {
let span = PerLeafSpan::new(leaf.span.clone(), "provisioner");
Self {
leaf,
backed_candidates: Vec::new(),
+ prospective_parachains_mode,
signed_bitfields: Vec::new(),
is_inherent_ready: false,
awaiting_inherent: Vec::new(),
@@ -146,7 +150,7 @@ async fn run_iteration(
from_overseer = ctx.recv().fuse() => {
match from_overseer? {
FromOrchestra::Signal(OverseerSignal::ActiveLeaves(update)) =>
- handle_active_leaves_update(update, per_relay_parent, inherent_delays),
+ handle_active_leaves_update(ctx.sender(), update, per_relay_parent, inherent_delays).await?,
FromOrchestra::Signal(OverseerSignal::BlockFinalized(..)) => {},
FromOrchestra::Signal(OverseerSignal::Conclude) => return Ok(()),
FromOrchestra::Communication { msg } => {
@@ -174,11 +178,12 @@ async fn run_iteration(
}
}
-fn handle_active_leaves_update(
+async fn handle_active_leaves_update(
+ sender: &mut impl overseer::ProvisionerSenderTrait,
update: ActiveLeavesUpdate,
per_relay_parent: &mut HashMap,
inherent_delays: &mut InherentDelays,
-) {
+) -> Result<(), Error> {
gum::trace!(target: LOG_TARGET, "Handle ActiveLeavesUpdate");
for deactivated in &update.deactivated {
per_relay_parent.remove(deactivated);
@@ -186,10 +191,13 @@ fn handle_active_leaves_update(
if let Some(leaf) = update.activated {
gum::trace!(target: LOG_TARGET, leaf_hash=?leaf.hash, "Adding delay");
+ let prospective_parachains_mode = prospective_parachains_mode(sender, leaf.hash).await?;
let delay_fut = Delay::new(PRE_PROPOSE_TIMEOUT).map(move |_| leaf.hash).boxed();
- per_relay_parent.insert(leaf.hash, PerRelayParent::new(leaf));
+ per_relay_parent.insert(leaf.hash, PerRelayParent::new(leaf, prospective_parachains_mode));
inherent_delays.push(delay_fut);
}
+
+ Ok(())
}
#[overseer::contextbounds(Provisioner, prefix = self::overseer)]
@@ -243,6 +251,7 @@ async fn send_inherent_data_bg(
let leaf = per_relay_parent.leaf.clone();
let signed_bitfields = per_relay_parent.signed_bitfields.clone();
let backed_candidates = per_relay_parent.backed_candidates.clone();
+ let mode = per_relay_parent.prospective_parachains_mode;
let span = per_relay_parent.span.child("req-inherent-data");
let mut sender = ctx.sender().clone();
@@ -261,6 +270,7 @@ async fn send_inherent_data_bg(
&leaf,
&signed_bitfields,
&backed_candidates,
+ mode,
return_senders,
&mut sender,
&metrics,
@@ -289,7 +299,6 @@ async fn send_inherent_data_bg(
gum::debug!(
target: LOG_TARGET,
signed_bitfield_count = signed_bitfields.len(),
- backed_candidates_count = backed_candidates.len(),
leaf_hash = ?leaf.hash,
"inherent data sent successfully"
);
@@ -324,7 +333,7 @@ fn note_provisionable_data(
.child("provisionable-backed")
.with_candidate(candidate_hash)
.with_para_id(backed_candidate.descriptor().para_id);
- per_relay_parent.backed_candidates.push(backed_candidate)
+ per_relay_parent.backed_candidates.push(backed_candidate);
},
// We choose not to punish these forms of misbehavior for the time being.
// Risks from misbehavior are sufficiently mitigated at the protocol level
@@ -372,6 +381,7 @@ async fn send_inherent_data(
leaf: &ActivatedLeaf,
bitfields: &[SignedAvailabilityBitfield],
candidates: &[CandidateReceipt],
+ prospective_parachains_mode: ProspectiveParachainsMode,
return_senders: Vec>,
from_job: &mut impl overseer::ProvisionerSenderTrait,
metrics: &Metrics,
@@ -422,8 +432,16 @@ async fn send_inherent_data(
relay_parent = ?leaf.hash,
"Selected bitfields"
);
- let candidates =
- select_candidates(&availability_cores, &bitfields, candidates, leaf.hash, from_job).await?;
+
+ let candidates = select_candidates(
+ &availability_cores,
+ &bitfields,
+ candidates,
+ prospective_parachains_mode,
+ leaf.hash,
+ from_job,
+ )
+ .await?;
gum::trace!(
target: LOG_TARGET,
@@ -530,14 +548,16 @@ fn select_availability_bitfields(
selected.into_values().collect()
}
-/// Determine which cores are free, and then to the degree possible, pick a candidate appropriate to each free core.
-async fn select_candidates(
+/// Selects candidates from tracked ones to note in a relay chain block.
+///
+/// Should be called when prospective parachains are disabled.
+async fn select_candidate_hashes_from_tracked(
availability_cores: &[CoreState],
bitfields: &[SignedAvailabilityBitfield],
candidates: &[CandidateReceipt],
relay_parent: Hash,
sender: &mut impl overseer::ProvisionerSenderTrait,
-) -> Result, Error> {
+) -> Result, Error> {
let block_number = get_block_number_under_construction(relay_parent, sender).await?;
let mut selected_candidates =
@@ -611,10 +631,105 @@ async fn select_candidates(
}
}
+ Ok(selected_candidates)
+}
+
+/// Requests backable candidates from Prospective Parachains subsystem
+/// based on core states.
+///
+/// Should be called when prospective parachains are enabled.
+async fn request_backable_candidates(
+ availability_cores: &[CoreState],
+ bitfields: &[SignedAvailabilityBitfield],
+ relay_parent: Hash,
+ sender: &mut impl overseer::ProvisionerSenderTrait,
+) -> Result, Error> {
+ let block_number = get_block_number_under_construction(relay_parent, sender).await?;
+
+ let mut selected_candidates = Vec::with_capacity(availability_cores.len());
+
+ for (core_idx, core) in availability_cores.iter().enumerate() {
+ let (para_id, required_path) = match core {
+ CoreState::Scheduled(scheduled_core) => {
+ // The core is free, pick the first eligible candidate from
+ // the fragment tree.
+ (scheduled_core.para_id, Vec::new())
+ },
+ CoreState::Occupied(occupied_core) => {
+ if bitfields_indicate_availability(core_idx, bitfields, &occupied_core.availability)
+ {
+ if let Some(ref scheduled_core) = occupied_core.next_up_on_available {
+ // The candidate occupying the core is available, choose its
+ // child in the fragment tree.
+ //
+ // TODO: doesn't work for parathreads. We lean hard on the assumption
+ // that cores are fixed to specific parachains within a session.
+ // https://github.com/paritytech/polkadot/issues/5492
+ (scheduled_core.para_id, vec![occupied_core.candidate_hash])
+ } else {
+ continue
+ }
+ } else {
+ if occupied_core.time_out_at != block_number {
+ continue
+ }
+ if let Some(ref scheduled_core) = occupied_core.next_up_on_time_out {
+ // Candidate's availability timed out, practically same as scheduled.
+ (scheduled_core.para_id, Vec::new())
+ } else {
+ continue
+ }
+ }
+ },
+ CoreState::Free => continue,
+ };
+
+ let candidate_hash =
+ get_backable_candidate(relay_parent, para_id, required_path, sender).await?;
+
+ match candidate_hash {
+ Some(hash) => selected_candidates.push(hash),
+ None => {
+ gum::debug!(
+ target: LOG_TARGET,
+ leaf_hash = ?relay_parent,
+ core = core_idx,
+ "No backable candidate returned by prospective parachains",
+ );
+ },
+ }
+ }
+
+ Ok(selected_candidates)
+}
+
+/// Determine which cores are free, and then to the degree possible, pick a candidate appropriate to each free core.
+async fn select_candidates(
+ availability_cores: &[CoreState],
+ bitfields: &[SignedAvailabilityBitfield],
+ candidates: &[CandidateReceipt],
+ prospective_parachains_mode: ProspectiveParachainsMode,
+ relay_parent: Hash,
+ sender: &mut impl overseer::ProvisionerSenderTrait,
+) -> Result, Error> {
gum::trace!(target: LOG_TARGET,
leaf_hash=?relay_parent,
"before GetBackedCandidates");
+ let selected_candidates = match prospective_parachains_mode {
+ ProspectiveParachainsMode::Enabled { .. } =>
+ request_backable_candidates(availability_cores, bitfields, relay_parent, sender).await?,
+ ProspectiveParachainsMode::Disabled =>
+ select_candidate_hashes_from_tracked(
+ availability_cores,
+ bitfields,
+ &candidates,
+ relay_parent,
+ sender,
+ )
+ .await?,
+ };
+
// now get the backed candidates corresponding to these candidate receipts
let (tx, rx) = oneshot::channel();
sender.send_unbounded_message(CandidateBackingMessage::GetBackedCandidates(
@@ -685,6 +800,27 @@ async fn get_block_number_under_construction(
}
}
+/// Requests backable candidate from Prospective Parachains based on
+/// the given path in the fragment tree.
+async fn get_backable_candidate(
+ relay_parent: Hash,
+ para_id: ParaId,
+ required_path: Vec,
+ sender: &mut impl overseer::ProvisionerSenderTrait,
+) -> Result, Error> {
+ let (tx, rx) = oneshot::channel();
+ sender
+ .send_message(ProspectiveParachainsMessage::GetBackableCandidate(
+ relay_parent,
+ para_id,
+ required_path,
+ tx,
+ ))
+ .await;
+
+ rx.await.map_err(Error::CanceledBackableCandidate)
+}
+
/// The availability bitfield for a given core is the transpose
/// of a set of signed availability bitfields. It goes like this:
///
diff --git a/node/core/provisioner/src/tests.rs b/node/core/provisioner/src/tests.rs
index 96502b027789..fa2159378921 100644
--- a/node/core/provisioner/src/tests.rs
+++ b/node/core/provisioner/src/tests.rs
@@ -247,6 +247,7 @@ mod select_candidates {
},
};
use polkadot_node_subsystem_test_helpers::TestSubsystemSender;
+ use polkadot_node_subsystem_util::runtime::ProspectiveParachainsMode;
use polkadot_primitives::{
BlockNumber, CandidateCommitments, CommittedCandidateReceipt, PersistedValidationData,
};
@@ -332,10 +333,13 @@ mod select_candidates {
async fn mock_overseer(
mut receiver: mpsc::UnboundedReceiver,
expected: Vec,
+ prospective_parachains_mode: ProspectiveParachainsMode,
) {
use ChainApiMessage::BlockNumber;
use RuntimeApiMessage::Request;
+ let mut candidates = expected.iter().map(BackedCandidate::hash);
+
while let Some(from_job) = receiver.next().await {
match from_job {
AllMessages::ChainApi(BlockNumber(_relay_parent, tx)) =>
@@ -348,11 +352,23 @@ mod select_candidates {
tx.send(Ok(mock_availability_cores())).unwrap(),
AllMessages::CandidateBacking(CandidateBackingMessage::GetBackedCandidates(
_,
- _,
+ hashes,
sender,
)) => {
+ let expected_hashes: Vec =
+ expected.iter().map(BackedCandidate::hash).collect();
+ assert_eq!(expected_hashes, hashes);
let _ = sender.send(expected.clone());
},
+ AllMessages::ProspectiveParachains(
+ ProspectiveParachainsMessage::GetBackableCandidate(.., tx),
+ ) => match prospective_parachains_mode {
+ ProspectiveParachainsMode::Enabled { .. } => {
+ let _ = tx.send(candidates.next());
+ },
+ ProspectiveParachainsMode::Disabled =>
+ panic!("unexpected prospective parachains request"),
+ },
_ => panic!("Unexpected message: {:?}", from_job),
}
}
@@ -361,9 +377,19 @@ mod select_candidates {
#[test]
fn can_succeed() {
test_harness(
- |r| mock_overseer(r, Vec::new()),
+ |r| mock_overseer(r, Vec::new(), ProspectiveParachainsMode::Disabled),
|mut tx: TestSubsystemSender| async move {
- select_candidates(&[], &[], &[], Default::default(), &mut tx).await.unwrap();
+ let prospective_parachains_mode = ProspectiveParachainsMode::Disabled;
+ select_candidates(
+ &[],
+ &[],
+ &[],
+ prospective_parachains_mode,
+ Default::default(),
+ &mut tx,
+ )
+ .await
+ .unwrap();
},
)
}
@@ -414,6 +440,7 @@ mod select_candidates {
// why those particular indices? see the comments on mock_availability_cores()
let expected_candidates: Vec<_> =
[1, 4, 7, 8, 10].iter().map(|&idx| candidates[idx].clone()).collect();
+ let prospective_parachains_mode = ProspectiveParachainsMode::Disabled;
let expected_backed = expected_candidates
.iter()
@@ -428,12 +455,18 @@ mod select_candidates {
.collect();
test_harness(
- |r| mock_overseer(r, expected_backed),
+ |r| mock_overseer(r, expected_backed, ProspectiveParachainsMode::Disabled),
|mut tx: TestSubsystemSender| async move {
- let result =
- select_candidates(&mock_cores, &[], &candidates, Default::default(), &mut tx)
- .await
- .unwrap();
+ let result = select_candidates(
+ &mock_cores,
+ &[],
+ &candidates,
+ prospective_parachains_mode,
+ Default::default(),
+ &mut tx,
+ )
+ .await
+ .unwrap();
result.into_iter().for_each(|c| {
assert!(
@@ -455,9 +488,11 @@ mod select_candidates {
// why those particular indices? see the comments on mock_availability_cores()
// the first candidate with code is included out of [1, 4, 7, 8, 10].
- let cores = [1, 7, 10];
+ let cores = [1, 4, 7, 8, 10];
let cores_with_code = [1, 4, 8];
+ let expected_cores = [1, 7, 10];
+
let committed_receipts: Vec<_> = (0..mock_cores.len())
.map(|i| {
let mut descriptor = dummy_candidate_descriptor(dummy_hash());
@@ -478,26 +513,115 @@ mod select_candidates {
.collect();
let candidates: Vec<_> = committed_receipts.iter().map(|r| r.to_plain()).collect();
+ let backed_candidates: Vec<_> = committed_receipts
+ .iter()
+ .map(|committed_receipt| BackedCandidate {
+ candidate: committed_receipt.clone(),
+ validity_votes: Vec::new(),
+ validator_indices: default_bitvec(n_cores),
+ })
+ .collect();
+
+ // First, provisioner will request backable candidates for each scheduled core.
+ // Then, some of them get filtered due to new validation code rule.
+ let expected_backed: Vec<_> =
+ cores.iter().map(|&idx| backed_candidates[idx].clone()).collect();
+ let expected_backed_filtered: Vec<_> =
+ expected_cores.iter().map(|&idx| candidates[idx].clone()).collect();
+
+ let prospective_parachains_mode = ProspectiveParachainsMode::Disabled;
+
+ test_harness(
+ |r| mock_overseer(r, expected_backed, ProspectiveParachainsMode::Disabled),
+ |mut tx: TestSubsystemSender| async move {
+ let result = select_candidates(
+ &mock_cores,
+ &[],
+ &candidates,
+ prospective_parachains_mode,
+ Default::default(),
+ &mut tx,
+ )
+ .await
+ .unwrap();
+
+ assert_eq!(result.len(), 3);
+
+ result.into_iter().for_each(|c| {
+ assert!(
+ expected_backed_filtered.iter().any(|c2| c.candidate.corresponds_to(c2)),
+ "Failed to find candidate: {:?}",
+ c,
+ )
+ });
+ },
+ )
+ }
+
+ #[test]
+ fn request_from_prospective_parachains() {
+ let mock_cores = mock_availability_cores();
+ let n_cores = mock_cores.len();
+ let empty_hash = PersistedValidationData::::default().hash();
+
+ let mut descriptor_template = dummy_candidate_descriptor(dummy_hash());
+ descriptor_template.persisted_validation_data_hash = empty_hash;
+ let candidate_template = CandidateReceipt {
+ descriptor: descriptor_template,
+ commitments_hash: CandidateCommitments::default().hash(),
+ };
+
+ let candidates: Vec<_> = std::iter::repeat(candidate_template)
+ .take(mock_cores.len())
+ .enumerate()
+ .map(|(idx, mut candidate)| {
+ candidate.descriptor.para_id = idx.into();
+ candidate
+ })
+ .collect();
+
+ // why those particular indices? see the comments on mock_availability_cores()
let expected_candidates: Vec<_> =
- cores.iter().map(|&idx| candidates[idx].clone()).collect();
+ [1, 4, 7, 8, 10].iter().map(|&idx| candidates[idx].clone()).collect();
+ // Expect prospective parachains subsystem requests.
+ let prospective_parachains_mode =
+ ProspectiveParachainsMode::Enabled { max_candidate_depth: 0, allowed_ancestry_len: 0 };
- let expected_backed: Vec<_> = cores
+ let expected_backed = expected_candidates
.iter()
- .map(|&idx| BackedCandidate {
- candidate: committed_receipts[idx].clone(),
+ .map(|c| BackedCandidate {
+ candidate: CommittedCandidateReceipt {
+ descriptor: c.descriptor.clone(),
+ commitments: Default::default(),
+ },
validity_votes: Vec::new(),
validator_indices: default_bitvec(n_cores),
})
.collect();
test_harness(
- |r| mock_overseer(r, expected_backed),
+ |r| {
+ mock_overseer(
+ r,
+ expected_backed,
+ ProspectiveParachainsMode::Enabled {
+ max_candidate_depth: 0,
+ allowed_ancestry_len: 0,
+ },
+ )
+ },
|mut tx: TestSubsystemSender| async move {
- let result =
- select_candidates(&mock_cores, &[], &candidates, Default::default(), &mut tx)
- .await
- .unwrap();
+ let result = select_candidates(
+ &mock_cores,
+ &[],
+ &[],
+ prospective_parachains_mode,
+ Default::default(),
+ &mut tx,
+ )
+ .await
+ .unwrap();
result.into_iter().for_each(|c| {
assert!(
diff --git a/node/core/runtime-api/src/cache.rs b/node/core/runtime-api/src/cache.rs
index 63274f10c4bf..048a7a049ad1 100644
--- a/node/core/runtime-api/src/cache.rs
+++ b/node/core/runtime-api/src/cache.rs
@@ -20,11 +20,12 @@ use lru::LruCache;
use sp_consensus_babe::Epoch;
use polkadot_primitives::{
- AuthorityDiscoveryId, BlockNumber, CandidateCommitments, CandidateEvent, CandidateHash,
- CommittedCandidateReceipt, CoreState, DisputeState, ExecutorParams, GroupRotationInfo, Hash,
- Id as ParaId, InboundDownwardMessage, InboundHrmpMessage, OccupiedCoreAssumption,
- PersistedValidationData, PvfCheckStatement, ScrapedOnChainVotes, SessionIndex, SessionInfo,
- ValidationCode, ValidationCodeHash, ValidatorId, ValidatorIndex, ValidatorSignature,
+ vstaging as vstaging_primitives, AuthorityDiscoveryId, BlockNumber, CandidateCommitments,
+ CandidateEvent, CandidateHash, CommittedCandidateReceipt, CoreState, DisputeState,
+ ExecutorParams, GroupRotationInfo, Hash, Id as ParaId, InboundDownwardMessage,
+ InboundHrmpMessage, OccupiedCoreAssumption, PersistedValidationData, PvfCheckStatement,
+ ScrapedOnChainVotes, SessionIndex, SessionInfo, ValidationCode, ValidationCodeHash,
+ ValidatorId, ValidatorIndex, ValidatorSignature,
};
/// For consistency we have the same capacity for all caches. We use 128 as we'll only need that
@@ -63,6 +64,9 @@ pub(crate) struct RequestResultCache {
LruCache<(Hash, ParaId, OccupiedCoreAssumption), Option>,
version: LruCache,
disputes: LruCache)>>,
+
+ staging_para_backing_state: LruCache<(Hash, ParaId), Option>,
+ staging_async_backing_parameters: LruCache,
}
impl Default for RequestResultCache {
@@ -90,6 +94,9 @@ impl Default for RequestResultCache {
validation_code_hash: LruCache::new(DEFAULT_CACHE_CAP),
version: LruCache::new(DEFAULT_CACHE_CAP),
disputes: LruCache::new(DEFAULT_CACHE_CAP),
+
+ staging_para_backing_state: LruCache::new(DEFAULT_CACHE_CAP),
+ staging_async_backing_parameters: LruCache::new(DEFAULT_CACHE_CAP),
}
}
}
@@ -385,6 +392,36 @@ impl RequestResultCache {
) {
self.disputes.put(relay_parent, value);
}
+
+ pub(crate) fn staging_para_backing_state(
+ &mut self,
+ key: (Hash, ParaId),
+ ) -> Option<&Option> {
+ self.staging_para_backing_state.get(&key)
+ }
+
+ pub(crate) fn cache_staging_para_backing_state(
+ &mut self,
+ key: (Hash, ParaId),
+ value: Option,
+ ) {
+ self.staging_para_backing_state.put(key, value);
+ }
+
+ pub(crate) fn staging_async_backing_parameters(
+ &mut self,
+ key: &Hash,
+ ) -> Option<&vstaging_primitives::AsyncBackingParameters> {
+ self.staging_async_backing_parameters.get(key)
+ }
+
+ pub(crate) fn cache_staging_async_backing_parameters(
+ &mut self,
+ key: Hash,
+ value: vstaging_primitives::AsyncBackingParameters,
+ ) {
+ self.staging_async_backing_parameters.put(key, value);
+ }
}
pub(crate) enum RequestResult {
@@ -422,4 +459,7 @@ pub(crate) enum RequestResult {
ValidationCodeHash(Hash, ParaId, OccupiedCoreAssumption, Option),
Version(Hash, u32),
Disputes(Hash, Vec<(SessionIndex, CandidateHash, DisputeState)>),
+
+ StagingParaBackingState(Hash, ParaId, Option),
+ StagingAsyncBackingParameters(Hash, vstaging_primitives::AsyncBackingParameters),
}
diff --git a/node/core/runtime-api/src/lib.rs b/node/core/runtime-api/src/lib.rs
index 8ea9d1509bf0..614193d170c9 100644
--- a/node/core/runtime-api/src/lib.rs
+++ b/node/core/runtime-api/src/lib.rs
@@ -157,6 +157,12 @@ where
self.requests_cache.cache_version(relay_parent, version),
Disputes(relay_parent, disputes) =>
self.requests_cache.cache_disputes(relay_parent, disputes),
+
+ StagingParaBackingState(relay_parent, para_id, constraints) => self
+ .requests_cache
+ .cache_staging_para_backing_state((relay_parent, para_id), constraints),
+ StagingAsyncBackingParameters(relay_parent, params) =>
+ self.requests_cache.cache_staging_async_backing_parameters(relay_parent, params),
}
}
@@ -271,6 +277,12 @@ where
.map(|sender| Request::ValidationCodeHash(para, assumption, sender)),
Request::Disputes(sender) =>
query!(disputes(), sender).map(|sender| Request::Disputes(sender)),
+ Request::StagingParaBackingState(para, sender) =>
+ query!(staging_para_backing_state(para), sender)
+ .map(|sender| Request::StagingParaBackingState(para, sender)),
+ Request::StagingAsyncBackingParameters(sender) =>
+ query!(staging_async_backing_parameters(), sender)
+ .map(|sender| Request::StagingAsyncBackingParameters(sender)),
}
}
@@ -490,5 +502,21 @@ where
query!(ValidationCodeHash, validation_code_hash(para, assumption), ver = 2, sender),
Request::Disputes(sender) =>
query!(Disputes, disputes(), ver = Request::DISPUTES_RUNTIME_REQUIREMENT, sender),
+ Request::StagingParaBackingState(para, sender) => {
+ query!(
+ StagingParaBackingState,
+ staging_para_backing_state(para),
+ ver = Request::STAGING_BACKING_STATE,
+ sender
+ )
+ },
+ Request::StagingAsyncBackingParameters(sender) => {
+ query!(
+ StagingAsyncBackingParameters,
+ staging_async_backing_parameters(),
+ ver = Request::STAGING_BACKING_STATE,
+ sender
+ )
+ },
}
}
diff --git a/node/malus/src/variants/suggest_garbage_candidate.rs b/node/malus/src/variants/suggest_garbage_candidate.rs
index 7e1a9246bc4f..3d0af4b7ba82 100644
--- a/node/malus/src/variants/suggest_garbage_candidate.rs
+++ b/node/malus/src/variants/suggest_garbage_candidate.rs
@@ -78,7 +78,13 @@ where
) -> Option> {
match msg {
FromOrchestra::Communication {
- msg: CandidateBackingMessage::Second(relay_parent, ref candidate, ref _pov),
+ msg:
+ CandidateBackingMessage::Second(
+ relay_parent,
+ ref candidate,
+ ref _validation_data,
+ ref _pov,
+ ),
} => {
gum::debug!(
target: MALUS,
@@ -149,8 +155,10 @@ where
"Fetched validation data."
);
- let malicious_available_data =
- AvailableData { pov: Arc::new(pov.clone()), validation_data };
+ let malicious_available_data = AvailableData {
+ pov: Arc::new(pov.clone()),
+ validation_data: validation_data.clone(),
+ };
let pov_hash = pov.hash();
let erasure_root = {
@@ -204,6 +212,7 @@ where
msg: CandidateBackingMessage::Second(
relay_parent,
malicious_candidate,
+ validation_data,
pov,
),
};
diff --git a/node/network/approval-distribution/src/lib.rs b/node/network/approval-distribution/src/lib.rs
index 3c6ed8661e0e..f967c566f9a9 100644
--- a/node/network/approval-distribution/src/lib.rs
+++ b/node/network/approval-distribution/src/lib.rs
@@ -24,8 +24,9 @@ use futures::{channel::oneshot, FutureExt as _};
use polkadot_node_network_protocol::{
self as net_protocol,
grid_topology::{RandomRouting, RequiredRouting, SessionGridTopologies, SessionGridTopology},
- peer_set::MAX_NOTIFICATION_SIZE,
- v1 as protocol_v1, PeerId, UnifiedReputationChange as Rep, Versioned, View,
+ peer_set::{ValidationVersion, MAX_NOTIFICATION_SIZE},
+ v1 as protocol_v1, vstaging as protocol_vstaging, PeerId, UnifiedReputationChange as Rep,
+ Versioned, VersionedValidationProtocol, View,
};
use polkadot_node_primitives::approval::{
AssignmentCert, BlockApprovalMeta, IndirectAssignmentCert, IndirectSignedApprovalVote,
@@ -151,6 +152,15 @@ enum Resend {
No,
}
+/// Data stored on a per-peer basis.
+#[derive(Debug)]
+struct PeerData {
+ /// The peer's view.
+ view: View,
+ /// The peer's protocol version.
+ version: ValidationVersion,
+}
+
/// The [`State`] struct is responsible for tracking the overall state of the subsystem.
///
/// It tracks metadata about our view of the unfinalized chain,
@@ -170,7 +180,7 @@ struct State {
pending_known: HashMap>,
/// Peer data is partially stored here, and partially inline within the [`BlockEntry`]s
- peer_views: HashMap,
+ peer_data: HashMap,
/// Keeps a topology for various different sessions.
topologies: SessionGridTopologies,
@@ -331,14 +341,30 @@ impl State {
rng: &mut (impl CryptoRng + Rng),
) {
match event {
- NetworkBridgeEvent::PeerConnected(peer_id, role, _, _) => {
+ NetworkBridgeEvent::PeerConnected(peer_id, role, version, _) => {
// insert a blank view if none already present
gum::trace!(target: LOG_TARGET, ?peer_id, ?role, "Peer connected");
- self.peer_views.entry(peer_id).or_default();
+ let version = match ValidationVersion::try_from(version).ok() {
+ Some(v) => v,
+ None => {
+ // sanity: network bridge is supposed to detect this already.
+ gum::error!(
+ target: LOG_TARGET,
+ ?peer_id,
+ ?version,
+ "Unsupported protocol version"
+ );
+ return
+ },
+ };
+
+ self.peer_data
+ .entry(peer_id)
+ .or_insert_with(|| PeerData { version, view: Default::default() });
},
NetworkBridgeEvent::PeerDisconnected(peer_id) => {
gum::trace!(target: LOG_TARGET, ?peer_id, "Peer disconnected");
- self.peer_views.remove(&peer_id);
+ self.peer_data.remove(&peer_id);
self.blocks.iter_mut().for_each(|(_hash, entry)| {
entry.known_by.remove(&peer_id);
})
@@ -375,7 +401,7 @@ impl State {
live
});
},
- NetworkBridgeEvent::PeerMessage(peer_id, Versioned::V1(msg)) => {
+ NetworkBridgeEvent::PeerMessage(peer_id, msg) => {
self.process_incoming_peer_message(ctx, metrics, peer_id, msg, rng).await;
},
}
@@ -425,16 +451,18 @@ impl State {
{
let sender = ctx.sender();
- for (peer_id, view) in self.peer_views.iter() {
- let intersection = view.iter().filter(|h| new_hashes.contains(h));
- let view_intersection = View::new(intersection.cloned(), view.finalized_number);
+ for (peer_id, data) in self.peer_data.iter() {
+ let intersection = data.view.iter().filter(|h| new_hashes.contains(h));
+ let view_intersection =
+ View::new(intersection.cloned(), data.view.finalized_number);
Self::unify_with_peer(
sender,
metrics,
&mut self.blocks,
&self.topologies,
- self.peer_views.len(),
+ self.peer_data.len(),
*peer_id,
+ data.version,
view_intersection,
rng,
)
@@ -517,6 +545,7 @@ impl State {
adjust_required_routing_and_propagate(
ctx,
+ &self.peer_data,
&mut self.blocks,
&self.topologies,
|block_entry| block_entry.session == session,
@@ -536,13 +565,16 @@ impl State {
ctx: &mut Context,
metrics: &Metrics,
peer_id: PeerId,
- msg: protocol_v1::ApprovalDistributionMessage,
+ msg: net_protocol::ApprovalDistributionMessage,
rng: &mut R,
) where
R: CryptoRng + Rng,
{
match msg {
- protocol_v1::ApprovalDistributionMessage::Assignments(assignments) => {
+ Versioned::V1(protocol_v1::ApprovalDistributionMessage::Assignments(assignments)) |
+ Versioned::VStaging(protocol_vstaging::ApprovalDistributionMessage::Assignments(
+ assignments,
+ )) => {
gum::trace!(
target: LOG_TARGET,
peer_id = %peer_id,
@@ -581,7 +613,10 @@ impl State {
.await;
}
},
- protocol_v1::ApprovalDistributionMessage::Approvals(approvals) => {
+ Versioned::V1(protocol_v1::ApprovalDistributionMessage::Approvals(approvals)) |
+ Versioned::VStaging(protocol_vstaging::ApprovalDistributionMessage::Approvals(
+ approvals,
+ )) => {
gum::trace!(
target: LOG_TARGET,
peer_id = %peer_id,
@@ -634,9 +669,14 @@ impl State {
{
gum::trace!(target: LOG_TARGET, ?view, "Peer view change");
let finalized_number = view.finalized_number;
- let old_view =
- self.peer_views.get_mut(&peer_id).map(|d| std::mem::replace(d, view.clone()));
- let old_finalized_number = old_view.map(|v| v.finalized_number).unwrap_or(0);
+ let (peer_protocol_version, old_finalized_number) = match self
+ .peer_data
+ .get_mut(&peer_id)
+ .map(|d| (d.version, std::mem::replace(&mut d.view, view.clone())))
+ {
+ Some((v, view)) => (v, view.finalized_number),
+ None => return, // unknown peer
+ };
// we want to prune every block known_by peer up to (including) view.finalized_number
let blocks = &mut self.blocks;
@@ -661,8 +701,9 @@ impl State {
metrics,
&mut self.blocks,
&self.topologies,
- self.peer_views.len(),
+ self.peer_data.len(),
peer_id,
+ peer_protocol_version,
view,
rng,
)
@@ -904,7 +945,7 @@ impl State {
// then messages will be sent when we get it.
let assignments = vec![(assignment, claimed_candidate_index)];
- let n_peers_total = self.peer_views.len();
+ let n_peers_total = self.peer_data.len();
let source_peer = source.peer_id();
let mut peer_filter = move |peer| {
@@ -931,31 +972,53 @@ impl State {
route_random
};
- let peers = entry.known_by.keys().filter(|p| peer_filter(p)).cloned().collect::>();
+ let (v1_peers, vstaging_peers) = {
+ let peer_data = &self.peer_data;
+ let peers = entry
+ .known_by
+ .keys()
+ .filter_map(|p| peer_data.get_key_value(p))
+ .filter(|(p, _)| peer_filter(p))
+ .map(|(p, peer_data)| (*p, peer_data.version))
+ .collect::>();
- // Add the metadata of the assignment to the knowledge of each peer.
- for peer in peers.iter() {
- // we already filtered peers above, so this should always be Some
- if let Some(peer_knowledge) = entry.known_by.get_mut(peer) {
- peer_knowledge.sent.insert(message_subject.clone(), message_kind);
+ // Add the metadata of the assignment to the knowledge of each peer.
+ for (peer, _) in peers.iter() {
+ // we already filtered peers above, so this should always be Some
+ if let Some(peer_knowledge) = entry.known_by.get_mut(peer) {
+ peer_knowledge.sent.insert(message_subject.clone(), message_kind);
+ }
}
- }
- if !peers.is_empty() {
- gum::trace!(
- target: LOG_TARGET,
- ?block_hash,
- ?claimed_candidate_index,
- local = source.peer_id().is_none(),
- num_peers = peers.len(),
- "Sending an assignment to peers",
- );
+ if !peers.is_empty() {
+ gum::trace!(
+ target: LOG_TARGET,
+ ?block_hash,
+ ?claimed_candidate_index,
+ local = source.peer_id().is_none(),
+ num_peers = peers.len(),
+ "Sending an assignment to peers",
+ );
+ }
+
+ let v1_peers = filter_peers_by_version(&peers, ValidationVersion::V1);
+ let vstaging_peers = filter_peers_by_version(&peers, ValidationVersion::VStaging);
+
+ (v1_peers, vstaging_peers)
+ };
+ if !v1_peers.is_empty() {
ctx.send_message(NetworkBridgeTxMessage::SendValidationMessage(
- peers,
- Versioned::V1(protocol_v1::ValidationProtocol::ApprovalDistribution(
- protocol_v1::ApprovalDistributionMessage::Assignments(assignments),
- )),
+ v1_peers,
+ versioned_assignments_packet(ValidationVersion::V1, assignments.clone()),
+ ))
+ .await;
+ }
+
+ if !vstaging_peers.is_empty() {
+ ctx.send_message(NetworkBridgeTxMessage::SendValidationMessage(
+ vstaging_peers,
+ versioned_assignments_packet(ValidationVersion::VStaging, assignments.clone()),
))
.await;
}
@@ -1186,38 +1249,55 @@ impl State {
in_topology || knowledge.sent.contains(message_subject, MessageKind::Assignment)
};
- let peers = entry
- .known_by
- .iter()
- .filter(|(p, k)| peer_filter(p, k))
- .map(|(p, _)| p)
- .cloned()
- .collect::>();
-
- // Add the metadata of the assignment to the knowledge of each peer.
- for peer in peers.iter() {
- // we already filtered peers above, so this should always be Some
- if let Some(entry) = entry.known_by.get_mut(peer) {
- entry.sent.insert(message_subject.clone(), message_kind);
+ let (v1_peers, vstaging_peers) = {
+ let peer_data = &self.peer_data;
+ let peers = entry
+ .known_by
+ .iter()
+ .filter_map(|(p, k)| peer_data.get(&p).map(|pd| (p, k, pd.version)))
+ .filter(|(p, k, _)| peer_filter(p, k))
+ .map(|(p, _, v)| (*p, v))
+ .collect::>();
+
+ // Add the metadata of the assignment to the knowledge of each peer.
+ for (peer, _) in peers.iter() {
+ // we already filtered peers above, so this should always be Some
+ if let Some(peer_knowledge) = entry.known_by.get_mut(peer) {
+ peer_knowledge.sent.insert(message_subject.clone(), message_kind);
+ }
}
- }
- if !peers.is_empty() {
- let approvals = vec![vote];
- gum::trace!(
- target: LOG_TARGET,
- ?block_hash,
- ?candidate_index,
- local = source.peer_id().is_none(),
- num_peers = peers.len(),
- "Sending an approval to peers",
- );
+ if !peers.is_empty() {
+ gum::trace!(
+ target: LOG_TARGET,
+ ?block_hash,
+ ?candidate_index,
+ local = source.peer_id().is_none(),
+ num_peers = peers.len(),
+ "Sending an approval to peers",
+ );
+ }
+
+ let v1_peers = filter_peers_by_version(&peers, ValidationVersion::V1);
+ let vstaging_peers = filter_peers_by_version(&peers, ValidationVersion::VStaging);
+ (v1_peers, vstaging_peers)
+ };
+
+ let approvals = vec![vote];
+
+ if !v1_peers.is_empty() {
ctx.send_message(NetworkBridgeTxMessage::SendValidationMessage(
- peers,
- Versioned::V1(protocol_v1::ValidationProtocol::ApprovalDistribution(
- protocol_v1::ApprovalDistributionMessage::Approvals(approvals),
- )),
+ v1_peers,
+ versioned_approvals_packet(ValidationVersion::V1, approvals.clone()),
+ ))
+ .await;
+ }
+
+ if !vstaging_peers.is_empty() {
+ ctx.send_message(NetworkBridgeTxMessage::SendValidationMessage(
+ vstaging_peers,
+ versioned_approvals_packet(ValidationVersion::VStaging, approvals),
))
.await;
}
@@ -1273,6 +1353,7 @@ impl State {
topologies: &SessionGridTopologies,
total_peers: usize,
peer_id: PeerId,
+ peer_protocol_version: ValidationVersion,
view: View,
rng: &mut (impl CryptoRng + Rng),
) {
@@ -1382,7 +1463,8 @@ impl State {
"Sending assignments to unified peer",
);
- send_assignments_batched(sender, assignments_to_send, peer_id).await;
+ send_assignments_batched(sender, assignments_to_send, peer_id, peer_protocol_version)
+ .await;
}
if !approvals_to_send.is_empty() {
@@ -1393,7 +1475,7 @@ impl State {
"Sending approvals to unified peer",
);
- send_approvals_batched(sender, approvals_to_send, peer_id).await;
+ send_approvals_batched(sender, approvals_to_send, peer_id, peer_protocol_version).await;
}
}
@@ -1419,6 +1501,7 @@ impl State {
adjust_required_routing_and_propagate(
ctx,
+ &self.peer_data,
&mut self.blocks,
&self.topologies,
|block_entry| {
@@ -1446,6 +1529,7 @@ impl State {
adjust_required_routing_and_propagate(
ctx,
+ &self.peer_data,
&mut self.blocks,
&self.topologies,
|block_entry| {
@@ -1503,6 +1587,7 @@ impl State {
#[overseer::contextbounds(ApprovalDistribution, prefix = self::overseer)]
async fn adjust_required_routing_and_propagate(
ctx: &mut Context,
+ peer_data: &HashMap,
blocks: &mut HashMap,
topologies: &SessionGridTopologies,
block_filter: BlockFilter,
@@ -1592,11 +1677,22 @@ async fn adjust_required_routing_and_propagate continue,
+ Some(v) => v,
+ };
+
+ send_assignments_batched(ctx.sender(), assignments_packet, peer, peer_protocol_version)
+ .await;
}
for (peer, approvals_packet) in peer_approvals {
- send_approvals_batched(ctx.sender(), approvals_packet, peer).await;
+ let peer_protocol_version = match peer_data.get(&peer).map(|pd| pd.version) {
+ None => continue,
+ Some(v) => v,
+ };
+
+ send_approvals_batched(ctx.sender(), approvals_packet, peer, peer_protocol_version).await;
}
}
@@ -1725,6 +1821,49 @@ impl ApprovalDistribution {
}
}
+fn versioned_approvals_packet(
+ version: ValidationVersion,
+ approvals: Vec,
+) -> VersionedValidationProtocol {
+ match version {
+ ValidationVersion::V1 =>
+ Versioned::V1(protocol_v1::ValidationProtocol::ApprovalDistribution(
+ protocol_v1::ApprovalDistributionMessage::Approvals(approvals),
+ )),
+ ValidationVersion::VStaging =>
+ Versioned::VStaging(protocol_vstaging::ValidationProtocol::ApprovalDistribution(
+ protocol_vstaging::ApprovalDistributionMessage::Approvals(approvals),
+ )),
+ }
+}
+
+fn versioned_assignments_packet(
+ version: ValidationVersion,
+ assignments: Vec<(IndirectAssignmentCert, CandidateIndex)>,
+) -> VersionedValidationProtocol {
+ match version {
+ ValidationVersion::V1 =>
+ Versioned::V1(protocol_v1::ValidationProtocol::ApprovalDistribution(
+ protocol_v1::ApprovalDistributionMessage::Assignments(assignments),
+ )),
+ ValidationVersion::VStaging =>
+ Versioned::VStaging(protocol_vstaging::ValidationProtocol::ApprovalDistribution(
+ protocol_vstaging::ApprovalDistributionMessage::Assignments(assignments),
+ )),
+ }
+}
+
+fn filter_peers_by_version(
+ peers: &[(PeerId, ValidationVersion)],
+ version: ValidationVersion,
+) -> Vec {
+ peers
+ .iter()
+ .filter(|(_, v)| v == &version)
+ .map(|(peer_id, _)| *peer_id)
+ .collect()
+}
+
#[overseer::subsystem(ApprovalDistribution, error=SubsystemError, prefix=self::overseer)]
impl ApprovalDistribution {
fn start(self, ctx: Context) -> SpawnedSubsystem {
@@ -1767,19 +1906,16 @@ pub(crate) async fn send_assignments_batched(
sender: &mut impl overseer::ApprovalDistributionSenderTrait,
assignments: Vec<(IndirectAssignmentCert, CandidateIndex)>,
peer: PeerId,
+ protocol_version: ValidationVersion,
) {
let mut batches = assignments.into_iter().peekable();
while batches.peek().is_some() {
let batch: Vec<_> = batches.by_ref().take(MAX_ASSIGNMENT_BATCH_SIZE).collect();
+ let versioned = versioned_assignments_packet(protocol_version, batch);
sender
- .send_message(NetworkBridgeTxMessage::SendValidationMessage(
- vec![peer],
- Versioned::V1(protocol_v1::ValidationProtocol::ApprovalDistribution(
- protocol_v1::ApprovalDistributionMessage::Assignments(batch),
- )),
- ))
+ .send_message(NetworkBridgeTxMessage::SendValidationMessage(vec![peer], versioned))
.await;
}
}
@@ -1789,19 +1925,16 @@ pub(crate) async fn send_approvals_batched(
sender: &mut impl overseer::ApprovalDistributionSenderTrait,
approvals: Vec,
peer: PeerId,
+ protocol_version: ValidationVersion,
) {
let mut batches = approvals.into_iter().peekable();
while batches.peek().is_some() {
let batch: Vec<_> = batches.by_ref().take(MAX_APPROVAL_BATCH_SIZE).collect();
+ let versioned = versioned_approvals_packet(protocol_version, batch);
sender
- .send_message(NetworkBridgeTxMessage::SendValidationMessage(
- vec![peer],
- Versioned::V1(protocol_v1::ValidationProtocol::ApprovalDistribution(
- protocol_v1::ApprovalDistributionMessage::Approvals(batch),
- )),
- ))
+ .send_message(NetworkBridgeTxMessage::SendValidationMessage(vec![peer], versioned))
.await;
}
}
diff --git a/node/network/approval-distribution/src/tests.rs b/node/network/approval-distribution/src/tests.rs
index 459b9d4899fb..62a3d71ae02e 100644
--- a/node/network/approval-distribution/src/tests.rs
+++ b/node/network/approval-distribution/src/tests.rs
@@ -215,6 +215,7 @@ async fn setup_gossip_topology(
async fn setup_peer_with_view(
virtual_overseer: &mut VirtualOverseer,
peer_id: &PeerId,
+ validation_version: ValidationVersion,
view: View,
) {
overseer_send(
@@ -222,7 +223,7 @@ async fn setup_peer_with_view(
ApprovalDistributionMessage::NetworkBridgeUpdate(NetworkBridgeEvent::PeerConnected(
peer_id.clone(),
ObservedRole::Full,
- ValidationVersion::V1.into(),
+ validation_version.into(),
None,
)),
)
@@ -240,13 +241,13 @@ async fn setup_peer_with_view(
async fn send_message_from_peer(
virtual_overseer: &mut VirtualOverseer,
peer_id: &PeerId,
- msg: protocol_v1::ApprovalDistributionMessage,
+ msg: net_protocol::ApprovalDistributionMessage,
) {
overseer_send(
virtual_overseer,
ApprovalDistributionMessage::NetworkBridgeUpdate(NetworkBridgeEvent::PeerMessage(
peer_id.clone(),
- Versioned::V1(msg),
+ msg,
)),
)
.await;
@@ -304,9 +305,9 @@ fn try_import_the_same_assignment() {
let _ = test_harness(State::default(), |mut virtual_overseer| async move {
let overseer = &mut virtual_overseer;
// setup peers
- setup_peer_with_view(overseer, &peer_a, view![]).await;
- setup_peer_with_view(overseer, &peer_b, view![hash]).await;
- setup_peer_with_view(overseer, &peer_c, view![hash]).await;
+ setup_peer_with_view(overseer, &peer_a, ValidationVersion::V1, view![]).await;
+ setup_peer_with_view(overseer, &peer_b, ValidationVersion::V1, view![hash]).await;
+ setup_peer_with_view(overseer, &peer_c, ValidationVersion::V1, view![hash]).await;
// new block `hash_a` with 1 candidates
let meta = BlockApprovalMeta {
@@ -326,7 +327,7 @@ fn try_import_the_same_assignment() {
let assignments = vec![(cert.clone(), 0u32)];
let msg = protocol_v1::ApprovalDistributionMessage::Assignments(assignments.clone());
- send_message_from_peer(overseer, &peer_a, msg).await;
+ send_message_from_peer(overseer, &peer_a, Versioned::V1(msg)).await;
expect_reputation_change(overseer, &peer_a, COST_UNEXPECTED_MESSAGE).await;
@@ -359,11 +360,11 @@ fn try_import_the_same_assignment() {
);
// setup new peer
- setup_peer_with_view(overseer, &peer_d, view![]).await;
+ setup_peer_with_view(overseer, &peer_d, ValidationVersion::V1, view![]).await;
// send the same assignment from peer_d
let msg = protocol_v1::ApprovalDistributionMessage::Assignments(assignments);
- send_message_from_peer(overseer, &peer_d, msg).await;
+ send_message_from_peer(overseer, &peer_d, Versioned::V1(msg)).await;
expect_reputation_change(overseer, &peer_d, COST_UNEXPECTED_MESSAGE).await;
expect_reputation_change(overseer, &peer_d, BENEFIT_VALID_MESSAGE).await;
@@ -388,7 +389,7 @@ fn spam_attack_results_in_negative_reputation_change() {
let _ = test_harness(State::default(), |mut virtual_overseer| async move {
let overseer = &mut virtual_overseer;
let peer = &peer_a;
- setup_peer_with_view(overseer, peer, view![]).await;
+ setup_peer_with_view(overseer, peer, ValidationVersion::V1, view![]).await;
// new block `hash_b` with 20 candidates
let candidates_count = 20;
@@ -415,7 +416,7 @@ fn spam_attack_results_in_negative_reputation_change() {
.collect();
let msg = protocol_v1::ApprovalDistributionMessage::Assignments(assignments.clone());
- send_message_from_peer(overseer, peer, msg.clone()).await;
+ send_message_from_peer(overseer, peer, Versioned::V1(msg.clone())).await;
for i in 0..candidates_count {
expect_reputation_change(overseer, peer, COST_UNEXPECTED_MESSAGE).await;
@@ -447,7 +448,7 @@ fn spam_attack_results_in_negative_reputation_change() {
.await;
// send the assignments again
- send_message_from_peer(overseer, peer, msg.clone()).await;
+ send_message_from_peer(overseer, peer, Versioned::V1(msg.clone())).await;
// each of them will incur `COST_UNEXPECTED_MESSAGE`, not only the first one
for _ in 0..candidates_count {
@@ -472,7 +473,7 @@ fn peer_sending_us_the_same_we_just_sent_them_is_ok() {
let _ = test_harness(State::default(), |mut virtual_overseer| async move {
let overseer = &mut virtual_overseer;
let peer = &peer_a;
- setup_peer_with_view(overseer, peer, view![]).await;
+ setup_peer_with_view(overseer, peer, ValidationVersion::V1, view![]).await;
// new block `hash` with 1 candidates
let meta = BlockApprovalMeta {
@@ -524,12 +525,12 @@ fn peer_sending_us_the_same_we_just_sent_them_is_ok() {
// the peer could send us it as well
let assignments = vec![(cert, candidate_index)];
let msg = protocol_v1::ApprovalDistributionMessage::Assignments(assignments);
- send_message_from_peer(overseer, peer, msg.clone()).await;
+ send_message_from_peer(overseer, peer, Versioned::V1(msg.clone())).await;
assert!(overseer.recv().timeout(TIMEOUT).await.is_none(), "we should not punish the peer");
// send the assignments again
- send_message_from_peer(overseer, peer, msg).await;
+ send_message_from_peer(overseer, peer, Versioned::V1(msg)).await;
// now we should
expect_reputation_change(overseer, peer, COST_DUPLICATE_MESSAGE).await;
@@ -548,9 +549,9 @@ fn import_approval_happy_path() {
let _ = test_harness(State::default(), |mut virtual_overseer| async move {
let overseer = &mut virtual_overseer;
// setup peers
- setup_peer_with_view(overseer, &peer_a, view![]).await;
- setup_peer_with_view(overseer, &peer_b, view![hash]).await;
- setup_peer_with_view(overseer, &peer_c, view![hash]).await;
+ setup_peer_with_view(overseer, &peer_a, ValidationVersion::V1, view![]).await;
+ setup_peer_with_view(overseer, &peer_b, ValidationVersion::V1, view![hash]).await;
+ setup_peer_with_view(overseer, &peer_c, ValidationVersion::V1, view![hash]).await;
// new block `hash_a` with 1 candidates
let meta = BlockApprovalMeta {
@@ -595,7 +596,7 @@ fn import_approval_happy_path() {
signature: dummy_signature(),
};
let msg = protocol_v1::ApprovalDistributionMessage::Approvals(vec![approval.clone()]);
- send_message_from_peer(overseer, &peer_b, msg).await;
+ send_message_from_peer(overseer, &peer_b, Versioned::V1(msg)).await;
assert_matches!(
overseer_recv(overseer).await,
@@ -636,8 +637,8 @@ fn import_approval_bad() {
let _ = test_harness(State::default(), |mut virtual_overseer| async move {
let overseer = &mut virtual_overseer;
// setup peers
- setup_peer_with_view(overseer, &peer_a, view![]).await;
- setup_peer_with_view(overseer, &peer_b, view![hash]).await;
+ setup_peer_with_view(overseer, &peer_a, ValidationVersion::V1, view![]).await;
+ setup_peer_with_view(overseer, &peer_b, ValidationVersion::V1, view![hash]).await;
// new block `hash_a` with 1 candidates
let meta = BlockApprovalMeta {
@@ -663,14 +664,14 @@ fn import_approval_bad() {
signature: dummy_signature(),
};
let msg = protocol_v1::ApprovalDistributionMessage::Approvals(vec![approval.clone()]);
- send_message_from_peer(overseer, &peer_b, msg).await;
+ send_message_from_peer(overseer, &peer_b, Versioned::V1(msg)).await;
expect_reputation_change(overseer, &peer_b, COST_UNEXPECTED_MESSAGE).await;
// now import an assignment from peer_b
let assignments = vec![(cert.clone(), candidate_index)];
let msg = protocol_v1::ApprovalDistributionMessage::Assignments(assignments);
- send_message_from_peer(overseer, &peer_b, msg).await;
+ send_message_from_peer(overseer, &peer_b, Versioned::V1(msg)).await;
assert_matches!(
overseer_recv(overseer).await,
@@ -689,7 +690,7 @@ fn import_approval_bad() {
// and try again
let msg = protocol_v1::ApprovalDistributionMessage::Approvals(vec![approval.clone()]);
- send_message_from_peer(overseer, &peer_b, msg).await;
+ send_message_from_peer(overseer, &peer_b, Versioned::V1(msg)).await;
assert_matches!(
overseer_recv(overseer).await,
@@ -830,7 +831,7 @@ fn update_peer_view() {
overseer_send(overseer, ApprovalDistributionMessage::DistributeAssignment(cert_b, 0)).await;
// connect a peer
- setup_peer_with_view(overseer, peer, view![hash_a]).await;
+ setup_peer_with_view(overseer, peer, ValidationVersion::V1, view![hash_a]).await;
// we should send relevant assignments to the peer
assert_matches!(
@@ -848,7 +849,7 @@ fn update_peer_view() {
virtual_overseer
});
- assert_eq!(state.peer_views.get(peer).map(|v| v.finalized_number), Some(0));
+ assert_eq!(state.peer_data.get(peer).map(|data| data.view.finalized_number), Some(0));
assert_eq!(
state
.blocks
@@ -900,7 +901,7 @@ fn update_peer_view() {
virtual_overseer
});
- assert_eq!(state.peer_views.get(peer).map(|v| v.finalized_number), Some(2));
+ assert_eq!(state.peer_data.get(peer).map(|data| data.view.finalized_number), Some(2));
assert_eq!(
state
.blocks
@@ -930,7 +931,10 @@ fn update_peer_view() {
virtual_overseer
});
- assert_eq!(state.peer_views.get(peer).map(|v| v.finalized_number), Some(finalized_number));
+ assert_eq!(
+ state.peer_data.get(peer).map(|data| data.view.finalized_number),
+ Some(finalized_number)
+ );
assert!(state.blocks.get(&hash_c).unwrap().known_by.get(peer).is_none());
}
@@ -945,7 +949,7 @@ fn import_remotely_then_locally() {
let _ = test_harness(State::default(), |mut virtual_overseer| async move {
let overseer = &mut virtual_overseer;
// setup the peer
- setup_peer_with_view(overseer, peer, view![hash]).await;
+ setup_peer_with_view(overseer, peer, ValidationVersion::V1, view![hash]).await;
// new block `hash_a` with 1 candidates
let meta = BlockApprovalMeta {
@@ -965,7 +969,7 @@ fn import_remotely_then_locally() {
let cert = fake_assignment_cert(hash, validator_index);
let assignments = vec![(cert.clone(), candidate_index)];
let msg = protocol_v1::ApprovalDistributionMessage::Assignments(assignments.clone());
- send_message_from_peer(overseer, peer, msg).await;
+ send_message_from_peer(overseer, peer, Versioned::V1(msg)).await;
// send an `Accept` message from the Approval Voting subsystem
assert_matches!(
@@ -1000,7 +1004,7 @@ fn import_remotely_then_locally() {
signature: dummy_signature(),
};
let msg = protocol_v1::ApprovalDistributionMessage::Approvals(vec![approval.clone()]);
- send_message_from_peer(overseer, peer, msg).await;
+ send_message_from_peer(overseer, peer, Versioned::V1(msg)).await;
assert_matches!(
overseer_recv(overseer).await,
@@ -1066,7 +1070,7 @@ fn sends_assignments_even_when_state_is_approved() {
.await;
// connect the peer.
- setup_peer_with_view(overseer, peer, view![hash]).await;
+ setup_peer_with_view(overseer, peer, ValidationVersion::V1, view![hash]).await;
let assignments = vec![(cert.clone(), candidate_index)];
let approvals = vec![approval.clone()];
@@ -1130,7 +1134,7 @@ fn race_condition_in_local_vs_remote_view_update() {
};
// This will send a peer view that is ahead of our view
- setup_peer_with_view(overseer, peer, view![hash_b]).await;
+ setup_peer_with_view(overseer, peer, ValidationVersion::V1, view![hash_b]).await;
// Send our view update to include a new head
overseer_send(
@@ -1151,7 +1155,7 @@ fn race_condition_in_local_vs_remote_view_update() {
.collect();
let msg = protocol_v1::ApprovalDistributionMessage::Assignments(assignments.clone());
- send_message_from_peer(overseer, peer, msg.clone()).await;
+ send_message_from_peer(overseer, peer, Versioned::V1(msg.clone())).await;
// This will handle pending messages being processed
let msg = ApprovalDistributionMessage::NewBlocks(vec![meta]);
@@ -1194,7 +1198,7 @@ fn propagates_locally_generated_assignment_to_both_dimensions() {
// Connect all peers.
for (peer, _) in &peers {
- setup_peer_with_view(overseer, peer, view![hash]).await;
+ setup_peer_with_view(overseer, peer, ValidationVersion::V1, view![hash]).await;
}
// Set up a gossip topology.
@@ -1299,7 +1303,7 @@ fn propagates_assignments_along_unshared_dimension() {
// Connect all peers.
for (peer, _) in &peers {
- setup_peer_with_view(overseer, peer, view![hash]).await;
+ setup_peer_with_view(overseer, peer, ValidationVersion::V1, view![hash]).await;
}
// Set up a gossip topology.
@@ -1335,7 +1339,7 @@ fn propagates_assignments_along_unshared_dimension() {
// Issuer of the message is important, not the peer we receive from.
// 99 deliberately chosen because it's not in X or Y.
- send_message_from_peer(overseer, &peers[99].0, msg).await;
+ send_message_from_peer(overseer, &peers[99].0, Versioned::V1(msg)).await;
assert_matches!(
overseer_recv(overseer).await,
AllMessages::ApprovalVoting(ApprovalVotingMessage::CheckAndImportAssignment(
@@ -1384,7 +1388,7 @@ fn propagates_assignments_along_unshared_dimension() {
// Issuer of the message is important, not the peer we receive from.
// 99 deliberately chosen because it's not in X or Y.
- send_message_from_peer(overseer, &peers[99].0, msg).await;
+ send_message_from_peer(overseer, &peers[99].0, Versioned::V1(msg)).await;
assert_matches!(
overseer_recv(overseer).await,
AllMessages::ApprovalVoting(ApprovalVotingMessage::CheckAndImportAssignment(
@@ -1441,7 +1445,7 @@ fn propagates_to_required_after_connect() {
// Connect all peers except omitted.
for (i, (peer, _)) in peers.iter().enumerate() {
if !omitted.contains(&i) {
- setup_peer_with_view(overseer, peer, view![hash]).await;
+ setup_peer_with_view(overseer, peer, ValidationVersion::V1, view![hash]).await;
}
}
@@ -1530,7 +1534,7 @@ fn propagates_to_required_after_connect() {
);
for i in omitted.iter().copied() {
- setup_peer_with_view(overseer, &peers[i].0, view![hash]).await;
+ setup_peer_with_view(overseer, &peers[i].0, ValidationVersion::V1, view![hash]).await;
assert_matches!(
overseer_recv(overseer).await,
@@ -1579,7 +1583,7 @@ fn sends_to_more_peers_after_getting_topology() {
// Connect all peers except omitted.
for (peer, _) in &peers {
- setup_peer_with_view(overseer, peer, view![hash]).await;
+ setup_peer_with_view(overseer, peer, ValidationVersion::V1, view![hash]).await;
}
// new block `hash_a` with 1 candidates
@@ -1731,7 +1735,7 @@ fn originator_aggression_l1() {
// Connect all peers except omitted.
for (peer, _) in &peers {
- setup_peer_with_view(overseer, peer, view![hash]).await;
+ setup_peer_with_view(overseer, peer, ValidationVersion::V1, view![hash]).await;
}
// new block `hash_a` with 1 candidates
@@ -1889,7 +1893,7 @@ fn non_originator_aggression_l1() {
// Connect all peers except omitted.
for (peer, _) in &peers {
- setup_peer_with_view(overseer, peer, view![hash]).await;
+ setup_peer_with_view(overseer, peer, ValidationVersion::V1, view![hash]).await;
}
// new block `hash_a` with 1 candidates
@@ -1923,7 +1927,7 @@ fn non_originator_aggression_l1() {
// Issuer of the message is important, not the peer we receive from.
// 99 deliberately chosen because it's not in X or Y.
- send_message_from_peer(overseer, &peers[99].0, msg).await;
+ send_message_from_peer(overseer, &peers[99].0, Versioned::V1(msg)).await;
assert_matches!(
overseer_recv(overseer).await,
AllMessages::ApprovalVoting(ApprovalVotingMessage::CheckAndImportAssignment(
@@ -1994,7 +1998,7 @@ fn non_originator_aggression_l2() {
// Connect all peers except omitted.
for (peer, _) in &peers {
- setup_peer_with_view(overseer, peer, view![hash]).await;
+ setup_peer_with_view(overseer, peer, ValidationVersion::V1, view![hash]).await;
}
// new block `hash_a` with 1 candidates
@@ -2028,7 +2032,7 @@ fn non_originator_aggression_l2() {
// Issuer of the message is important, not the peer we receive from.
// 99 deliberately chosen because it's not in X or Y.
- send_message_from_peer(overseer, &peers[99].0, msg).await;
+ send_message_from_peer(overseer, &peers[99].0, Versioned::V1(msg)).await;
assert_matches!(
overseer_recv(overseer).await,
AllMessages::ApprovalVoting(ApprovalVotingMessage::CheckAndImportAssignment(
@@ -2153,7 +2157,7 @@ fn resends_messages_periodically() {
// Connect all peers.
for (peer, _) in &peers {
- setup_peer_with_view(overseer, peer, view![hash]).await;
+ setup_peer_with_view(overseer, peer, ValidationVersion::V1, view![hash]).await;
}
// Set up a gossip topology.
@@ -2188,7 +2192,7 @@ fn resends_messages_periodically() {
// Issuer of the message is important, not the peer we receive from.
// 99 deliberately chosen because it's not in X or Y.
- send_message_from_peer(overseer, &peers[99].0, msg).await;
+ send_message_from_peer(overseer, &peers[99].0, Versioned::V1(msg)).await;
assert_matches!(
overseer_recv(overseer).await,
AllMessages::ApprovalVoting(ApprovalVotingMessage::CheckAndImportAssignment(
@@ -2277,6 +2281,125 @@ fn resends_messages_periodically() {
});
}
+/// Tests that peers correctly receive versioned messages.
+#[test]
+fn import_versioned_approval() {
+ let peer_a = PeerId::random();
+ let peer_b = PeerId::random();
+ let peer_c = PeerId::random();
+ let parent_hash = Hash::repeat_byte(0xFF);
+ let hash = Hash::repeat_byte(0xAA);
+
+ let _ = test_harness(State::default(), |mut virtual_overseer| async move {
+ let overseer = &mut virtual_overseer;
+ // All peers are aware of relay parent.
+ setup_peer_with_view(overseer, &peer_a, ValidationVersion::VStaging, view![hash]).await;
+ setup_peer_with_view(overseer, &peer_b, ValidationVersion::V1, view![hash]).await;
+ setup_peer_with_view(overseer, &peer_c, ValidationVersion::VStaging, view![hash]).await;
+
+ // new block `hash_a` with 1 candidates
+ let meta = BlockApprovalMeta {
+ hash,
+ parent_hash,
+ number: 1,
+ candidates: vec![Default::default(); 1],
+ slot: 1.into(),
+ session: 1,
+ };
+ let msg = ApprovalDistributionMessage::NewBlocks(vec![meta]);
+ overseer_send(overseer, msg).await;
+
+ // import an assignment related to `hash` locally
+ let validator_index = ValidatorIndex(0);
+ let candidate_index = 0u32;
+ let cert = fake_assignment_cert(hash, validator_index);
+ overseer_send(
+ overseer,
+ ApprovalDistributionMessage::DistributeAssignment(cert, candidate_index),
+ )
+ .await;
+
+ assert_matches!(
+ overseer_recv(overseer).await,
+ AllMessages::NetworkBridgeTx(NetworkBridgeTxMessage::SendValidationMessage(
+ peers,
+ Versioned::V1(protocol_v1::ValidationProtocol::ApprovalDistribution(
+ protocol_v1::ApprovalDistributionMessage::Assignments(assignments)
+ ))
+ )) => {
+ assert_eq!(peers, vec![peer_b]);
+ assert_eq!(assignments.len(), 1);
+ }
+ );
+
+ assert_matches!(
+ overseer_recv(overseer).await,
+ AllMessages::NetworkBridgeTx(NetworkBridgeTxMessage::SendValidationMessage(
+ peers,
+ Versioned::VStaging(protocol_vstaging::ValidationProtocol::ApprovalDistribution(
+ protocol_vstaging::ApprovalDistributionMessage::Assignments(assignments)
+ ))
+ )) => {
+ assert_eq!(peers.len(), 2);
+ assert!(peers.contains(&peer_a));
+ assert!(peers.contains(&peer_c));
+
+ assert_eq!(assignments.len(), 1);
+ }
+ );
+
+ // send the an approval from peer_a
+ let approval = IndirectSignedApprovalVote {
+ block_hash: hash,
+ candidate_index,
+ validator: validator_index,
+ signature: dummy_signature(),
+ };
+ let msg = protocol_vstaging::ApprovalDistributionMessage::Approvals(vec![approval.clone()]);
+ send_message_from_peer(overseer, &peer_a, Versioned::VStaging(msg)).await;
+
+ assert_matches!(
+ overseer_recv(overseer).await,
+ AllMessages::ApprovalVoting(ApprovalVotingMessage::CheckAndImportApproval(
+ vote,
+ tx,
+ )) => {
+ assert_eq!(vote, approval);
+ tx.send(ApprovalCheckResult::Accepted).unwrap();
+ }
+ );
+
+ expect_reputation_change(overseer, &peer_a, BENEFIT_VALID_MESSAGE_FIRST).await;
+
+ // Peers b and c receive versioned approval messages.
+ assert_matches!(
+ overseer_recv(overseer).await,
+ AllMessages::NetworkBridgeTx(NetworkBridgeTxMessage::SendValidationMessage(
+ peers,
+ Versioned::V1(protocol_v1::ValidationProtocol::ApprovalDistribution(
+ protocol_v1::ApprovalDistributionMessage::Approvals(approvals)
+ ))
+ )) => {
+ assert_eq!(peers, vec![peer_b]);
+ assert_eq!(approvals.len(), 1);
+ }
+ );
+ assert_matches!(
+ overseer_recv(overseer).await,
+ AllMessages::NetworkBridgeTx(NetworkBridgeTxMessage::SendValidationMessage(
+ peers,
+ Versioned::VStaging(protocol_vstaging::ValidationProtocol::ApprovalDistribution(
+ protocol_vstaging::ApprovalDistributionMessage::Approvals(approvals)
+ ))
+ )) => {
+ assert_eq!(peers, vec![peer_c]);
+ assert_eq!(approvals.len(), 1);
+ }
+ );
+ virtual_overseer
+ });
+}
+
fn batch_test_round(message_count: usize) {
use polkadot_node_subsystem::SubsystemContext;
let pool = sp_core::testing::TaskExecutor::new();
@@ -2306,8 +2429,9 @@ fn batch_test_round(message_count: usize) {
.collect();
let peer = PeerId::random();
- send_assignments_batched(&mut sender, assignments.clone(), peer).await;
- send_approvals_batched(&mut sender, approvals.clone(), peer).await;
+ send_assignments_batched(&mut sender, assignments.clone(), peer, ValidationVersion::V1)
+ .await;
+ send_approvals_batched(&mut sender, approvals.clone(), peer, ValidationVersion::V1).await;
// Check expected assignments batches.
for assignment_index in (0..assignments.len()).step_by(super::MAX_ASSIGNMENT_BATCH_SIZE) {
diff --git a/node/network/bitfield-distribution/Cargo.toml b/node/network/bitfield-distribution/Cargo.toml
index 8ac7c2ac6bfb..10587b46e932 100644
--- a/node/network/bitfield-distribution/Cargo.toml
+++ b/node/network/bitfield-distribution/Cargo.toml
@@ -5,6 +5,7 @@ authors.workspace = true
edition.workspace = true
[dependencies]
+always-assert = "0.1"
futures = "0.3.21"
gum = { package = "tracing-gum", path = "../../gum" }
polkadot-primitives = { path = "../../../primitives" }
diff --git a/node/network/bitfield-distribution/src/lib.rs b/node/network/bitfield-distribution/src/lib.rs
index 63a9c4ccf091..0f5090111dc1 100644
--- a/node/network/bitfield-distribution/src/lib.rs
+++ b/node/network/bitfield-distribution/src/lib.rs
@@ -22,6 +22,7 @@
#![deny(unused_crate_dependencies)]
+use always_assert::never;
use futures::{channel::oneshot, FutureExt};
use polkadot_node_network_protocol::{
@@ -29,7 +30,9 @@ use polkadot_node_network_protocol::{
grid_topology::{
GridNeighbors, RandomRouting, RequiredRouting, SessionBoundGridTopologyStorage,
},
- v1 as protocol_v1, OurView, PeerId, UnifiedReputationChange as Rep, Versioned, View,
+ peer_set::{ProtocolVersion, ValidationVersion},
+ v1 as protocol_v1, vstaging as protocol_vstaging, OurView, PeerId,
+ UnifiedReputationChange as Rep, Versioned, View,
};
use polkadot_node_subsystem::{
jaeger, messages::*, overseer, ActiveLeavesUpdate, FromOrchestra, OverseerSignal, PerLeafSpan,
@@ -69,25 +72,63 @@ struct BitfieldGossipMessage {
}
impl BitfieldGossipMessage {
- fn into_validation_protocol(self) -> net_protocol::VersionedValidationProtocol {
- self.into_network_message().into()
+ fn into_validation_protocol(
+ self,
+ recipient_version: ProtocolVersion,
+ ) -> net_protocol::VersionedValidationProtocol {
+ self.into_network_message(recipient_version).into()
}
- fn into_network_message(self) -> net_protocol::BitfieldDistributionMessage {
- Versioned::V1(protocol_v1::BitfieldDistributionMessage::Bitfield(
- self.relay_parent,
- self.signed_availability.into(),
- ))
+ fn into_network_message(
+ self,
+ recipient_version: ProtocolVersion,
+ ) -> net_protocol::BitfieldDistributionMessage {
+ match ValidationVersion::try_from(recipient_version).ok() {
+ Some(ValidationVersion::V1) =>
+ Versioned::V1(protocol_v1::BitfieldDistributionMessage::Bitfield(
+ self.relay_parent,
+ self.signed_availability.into(),
+ )),
+ Some(ValidationVersion::VStaging) =>
+ Versioned::VStaging(protocol_vstaging::BitfieldDistributionMessage::Bitfield(
+ self.relay_parent,
+ self.signed_availability.into(),
+ )),
+ None => {
+ never!("Peers should only have supported protocol versions.");
+
+ gum::warn!(
+ target: LOG_TARGET,
+ version = ?recipient_version,
+ "Unknown protocol version provided for message recipient"
+ );
+
+ // fall back to v1 to avoid
+ Versioned::V1(protocol_v1::BitfieldDistributionMessage::Bitfield(
+ self.relay_parent,
+ self.signed_availability.into(),
+ ))
+ },
+ }
}
}
+/// Data stored on a per-peer basis.
+#[derive(Debug)]
+pub struct PeerData {
+ /// The peer's view.
+ view: View,
+ /// The peer's protocol version.
+ version: ProtocolVersion,
+}
+
/// Data used to track information of peers and relay parents the
/// overseer ordered us to work on.
#[derive(Default, Debug)]
struct ProtocolState {
/// Track all active peers and their views
/// to determine what is relevant to them.
- peer_views: HashMap,
+ peer_data: HashMap,
/// The current and previous gossip topologies
topologies: SessionBoundGridTopologyStorage,
@@ -334,7 +375,7 @@ async fn handle_bitfield_distribution(
ctx,
job_data,
topology,
- &mut state.peer_views,
+ &mut state.peer_data,
validator,
msg,
required_routing,
@@ -353,7 +394,7 @@ async fn relay_message(
ctx: &mut Context,
job_data: &mut PerRelayParentData,
topology_neighbors: &GridNeighbors,
- peer_views: &mut HashMap,
+ peers: &mut HashMap,
validator: ValidatorId,
message: BitfieldGossipMessage,
required_routing: RequiredRouting,
@@ -371,16 +412,16 @@ async fn relay_message(
.await;
drop(_span);
- let total_peers = peer_views.len();
+ let total_peers = peers.len();
let mut random_routing: RandomRouting = Default::default();
let _span = span.child("interested-peers");
// pass on the bitfield distribution to all interested peers
- let interested_peers = peer_views
+ let interested_peers = peers
.iter()
- .filter_map(|(peer, view)| {
+ .filter_map(|(peer, data)| {
// check interest in the peer in this message's relay parent
- if view.contains(&message.relay_parent) {
+ if data.view.contains(&message.relay_parent) {
let message_needed =
job_data.message_from_validator_needed_by_peer(&peer, &validator);
if message_needed {
@@ -395,7 +436,7 @@ async fn relay_message(
};
if need_routing {
- Some(*peer)
+ Some((*peer, data.version))
} else {
None
}
@@ -406,9 +447,9 @@ async fn relay_message(
None
}
})
- .collect::>();
+ .collect::>();
- interested_peers.iter().for_each(|peer| {
+ interested_peers.iter().for_each(|(peer, _)| {
// track the message as sent for this peer
job_data
.message_sent_to_peer
@@ -427,11 +468,35 @@ async fn relay_message(
);
} else {
let _span = span.child("gossip");
- ctx.send_message(NetworkBridgeTxMessage::SendValidationMessage(
- interested_peers,
- message.into_validation_protocol(),
- ))
- .await;
+
+ let filter_by_version = |peers: &[(PeerId, ProtocolVersion)],
+ version: ValidationVersion| {
+ peers
+ .iter()
+ .filter(|(_, v)| v == &version.into())
+ .map(|(peer_id, _)| *peer_id)
+ .collect::>()
+ };
+
+ let v1_interested_peers = filter_by_version(&interested_peers, ValidationVersion::V1);
+ let vstaging_interested_peers =
+ filter_by_version(&interested_peers, ValidationVersion::VStaging);
+
+ if !v1_interested_peers.is_empty() {
+ ctx.send_message(NetworkBridgeTxMessage::SendValidationMessage(
+ v1_interested_peers,
+ message.clone().into_validation_protocol(ValidationVersion::V1.into()),
+ ))
+ .await;
+ }
+
+ if !vstaging_interested_peers.is_empty() {
+ ctx.send_message(NetworkBridgeTxMessage::SendValidationMessage(
+ vstaging_interested_peers,
+ message.into_validation_protocol(ValidationVersion::VStaging.into()),
+ ))
+ .await
+ }
}
}
@@ -442,10 +507,20 @@ async fn process_incoming_peer_message(
state: &mut ProtocolState,
metrics: &Metrics,
origin: PeerId,
- message: protocol_v1::BitfieldDistributionMessage,
+ message: net_protocol::BitfieldDistributionMessage,
rng: &mut (impl CryptoRng + Rng),
) {
- let protocol_v1::BitfieldDistributionMessage::Bitfield(relay_parent, bitfield) = message;
+ let (relay_parent, bitfield) = match message {
+ Versioned::V1(protocol_v1::BitfieldDistributionMessage::Bitfield(
+ relay_parent,
+ bitfield,
+ )) => (relay_parent, bitfield),
+ Versioned::VStaging(protocol_vstaging::BitfieldDistributionMessage::Bitfield(
+ relay_parent,
+ bitfield,
+ )) => (relay_parent, bitfield),
+ };
+
gum::trace!(
target: LOG_TARGET,
peer = %origin,
@@ -544,7 +619,7 @@ async fn process_incoming_peer_message(
ctx,
job_data,
topology,
- &mut state.peer_views,
+ &mut state.peer_data,
validator,
message,
required_routing,
@@ -568,15 +643,18 @@ async fn handle_network_msg(
let _timer = metrics.time_handle_network_msg();
match bridge_message {
- NetworkBridgeEvent::PeerConnected(peer, role, _, _) => {
+ NetworkBridgeEvent::PeerConnected(peer, role, version, _) => {
gum::trace!(target: LOG_TARGET, ?peer, ?role, "Peer connected");
// insert if none already present
- state.peer_views.entry(peer).or_default();
+ state
+ .peer_data
+ .entry(peer)
+ .or_insert_with(|| PeerData { view: View::default(), version });
},
NetworkBridgeEvent::PeerDisconnected(peer) => {
gum::trace!(target: LOG_TARGET, ?peer, "Peer disconnected");
// get rid of superfluous data
- state.peer_views.remove(&peer);
+ state.peer_data.remove(&peer);
},
NetworkBridgeEvent::NewGossipTopology(gossip_topology) => {
let session_index = gossip_topology.session;
@@ -601,12 +679,21 @@ async fn handle_network_msg(
);
for new_peer in newly_added {
- // in case we already knew that peer in the past
- // it might have had an existing view, we use to initialize
- // and minimize the delta on `PeerViewChange` to be sent
- if let Some(old_view) = state.peer_views.remove(&new_peer) {
- handle_peer_view_change(ctx, state, new_peer, old_view, rng).await;
- }
+ let old_view = match state.peer_data.get_mut(&new_peer) {
+ Some(d) => {
+ // in case we already knew that peer in the past
+ // it might have had an existing view, we use to initialize
+ // and minimize the delta on `PeerViewChange` to be sent
+ std::mem::replace(&mut d.view, Default::default())
+ },
+ None => {
+ // For peers which are currently unknown, we'll send topology-related
+ // messages to them when they connect and send their first view update.
+ continue
+ },
+ };
+
+ handle_peer_view_change(ctx, state, new_peer, old_view, rng).await;
}
},
NetworkBridgeEvent::PeerViewChange(peerid, new_view) => {
@@ -617,7 +704,7 @@ async fn handle_network_msg(
gum::trace!(target: LOG_TARGET, ?new_view, "Our view change");
handle_our_view_change(state, new_view);
},
- NetworkBridgeEvent::PeerMessage(remote, Versioned::V1(message)) =>
+ NetworkBridgeEvent::PeerMessage(remote, message) =>
process_incoming_peer_message(ctx, state, metrics, remote, message, rng).await,
}
}
@@ -646,6 +733,9 @@ fn handle_our_view_change(state: &mut ProtocolState, view: OurView) {
// Send the difference between two views which were not sent
// to that particular peer.
+//
+// This requires that there is an entry in the `peer_data` field for the
+// peer.
#[overseer::contextbounds(BitfieldDistribution, prefix=self::overseer)]
async fn handle_peer_view_change(
ctx: &mut Context,
@@ -654,13 +744,20 @@ async fn handle_peer_view_change(
view: View,
rng: &mut (impl CryptoRng + Rng),
) {
- let added = state
- .peer_views
- .entry(origin)
- .or_default()
- .replace_difference(view)
- .cloned()
- .collect::