Rename polkadot-parachain to polkadot-parachain-primitives (#1334)

* Rename `polkadot-parachain` to `polkadot-parachain-primitives`

While doing this it also fixes some last `rustdoc` issues and fixes
another Cargo warning related to `pallet-paged-list`.

* Fix compilation

* ".git/.scripts/commands/fmt/fmt.sh"

* Fix XCM docs

---------

Co-authored-by: command-bot <>

polkadot/node/core/candidate-validation/Cargo.toml

@@ -16,7 +16,7 @@ sp-maybe-compressed-blob = { package = "sp-maybe-compressed-blob", path = "../..
 parity-scale-codec = { version = "3.6.1", default-features = false, features = ["bit-vec", "derive"] }
 
 polkadot-primitives = { path = "../../../primitives" }
-polkadot-parachain = { path = "../../../parachain" }
+polkadot-parachain-primitives = { path = "../../../parachain" }
 polkadot-node-primitives = { path = "../../primitives" }
 polkadot-node-subsystem = { path = "../../subsystem" }
 polkadot-node-subsystem-util = { path = "../../subsystem-util" }

polkadot/node/core/candidate-validation/src/lib.rs

@@ -40,7 +40,9 @@ use polkadot_node_subsystem::{
 	SubsystemSender,
 };
 use polkadot_node_subsystem_util::executor_params_at_relay_parent;
-use polkadot_parachain::primitives::{ValidationParams, ValidationResult as WasmValidationResult};
+use polkadot_parachain_primitives::primitives::{
+	ValidationParams, ValidationResult as WasmValidationResult,
+};
 use polkadot_primitives::{
 	CandidateCommitments, CandidateDescriptor, CandidateReceipt, ExecutorParams, Hash,
 	OccupiedCoreAssumption, PersistedValidationData, PvfExecTimeoutKind, PvfPrepTimeoutKind,
@@ -111,10 +113,7 @@ pub struct CandidateValidationSubsystem {
 }
 
 impl CandidateValidationSubsystem {
-	/// Create a new `CandidateValidationSubsystem` with the given task spawner and isolation
-	/// strategy.
-	///
-	/// Check out [`IsolationStrategy`] to get more details.
+	/// Create a new `CandidateValidationSubsystem`.
 	pub fn with_config(
 		config: Option<Config>,
 		metrics: Metrics,

polkadot/node/core/pvf/Cargo.toml

@@ -25,7 +25,7 @@ tokio = { version = "1.24.2", features = ["fs", "process"] }
 
 parity-scale-codec = { version = "3.6.1", default-features = false, features = ["derive"] }
 
-polkadot-parachain = { path = "../../../parachain" }
+polkadot-parachain-primitives = { path = "../../../parachain" }
 polkadot-core-primitives = { path = "../../../core-primitives" }
 polkadot-node-core-pvf-common = { path = "common" }
 polkadot-node-metrics = { path = "../../metrics" }

polkadot/node/core/pvf/common/Cargo.toml

@@ -15,7 +15,7 @@ tokio = { version = "1.24.2", features = ["fs", "process", "io-util"] }
 
 parity-scale-codec = { version = "3.6.1", default-features = false, features = ["derive"] }
 
-polkadot-parachain = { path = "../../../../parachain" }
+polkadot-parachain-primitives = { path = "../../../../parachain" }
 polkadot-primitives = { path = "../../../../primitives" }
 
 sc-executor = { path = "../../../../../substrate/client/executor" }

polkadot/node/core/pvf/common/src/execute.rs

@@ -16,7 +16,7 @@
 
 use crate::error::InternalValidationError;
 use parity_scale_codec::{Decode, Encode};
-use polkadot_parachain::primitives::ValidationResult;
+use polkadot_parachain_primitives::primitives::ValidationResult;
 use polkadot_primitives::ExecutorParams;
 use std::time::Duration;
 

polkadot/node/core/pvf/common/src/pvf.rs

@@ -16,7 +16,7 @@
 
 use crate::prepare::PrepareJobKind;
 use parity_scale_codec::{Decode, Encode};
-use polkadot_parachain::primitives::ValidationCodeHash;
+use polkadot_parachain_primitives::primitives::ValidationCodeHash;
 use polkadot_primitives::ExecutorParams;
 use sp_core::blake2_256;
 use std::{

polkadot/node/core/pvf/execute-worker/Cargo.toml

@@ -16,7 +16,7 @@ tokio = { version = "1.24.2", features = ["fs", "process"] }
 parity-scale-codec = { version = "3.6.1", default-features = false, features = ["derive"] }
 
 polkadot-node-core-pvf-common = { path = "../common" }
-polkadot-parachain = { path = "../../../../parachain" }
+polkadot-parachain-primitives = { path = "../../../../parachain" }
 polkadot-primitives = { path = "../../../../primitives" }
 
 sp-core = { path = "../../../../../substrate/primitives/core" }

polkadot/node/core/pvf/execute-worker/src/lib.rs

@@ -37,7 +37,7 @@ use polkadot_node_core_pvf_common::{
 		worker_event_loop,
 	},
 };
-use polkadot_parachain::primitives::ValidationResult;
+use polkadot_parachain_primitives::primitives::ValidationResult;
 use std::{
 	path::PathBuf,
 	sync::{mpsc::channel, Arc},

polkadot/node/core/pvf/prepare-worker/Cargo.toml

@@ -17,7 +17,7 @@ tokio = { version = "1.24.2", features = ["fs", "process"] }
 parity-scale-codec = { version = "3.6.1", default-features = false, features = ["derive"] }
 
 polkadot-node-core-pvf-common = { path = "../common" }
-polkadot-parachain = { path = "../../../../parachain" }
+polkadot-parachain-primitives = { path = "../../../../parachain" }
 polkadot-primitives = { path = "../../../../primitives" }
 
 sc-executor = { path = "../../../../../substrate/client/executor" }

polkadot/node/core/pvf/src/artifacts.rs

@@ -58,7 +58,7 @@
 use crate::host::PrepareResultSender;
 use always_assert::always;
 use polkadot_node_core_pvf_common::{error::PrepareError, prepare::PrepareStats, pvf::PvfPrepData};
-use polkadot_parachain::primitives::ValidationCodeHash;
+use polkadot_parachain_primitives::primitives::ValidationCodeHash;
 use polkadot_primitives::ExecutorParamsHash;
 use std::{
 	collections::HashMap,

polkadot/node/core/pvf/src/error.rs

@@ -28,7 +28,7 @@ pub enum ValidationError {
 }
 
 /// A description of an error raised during executing a PVF and can be attributed to the combination
-/// of the candidate [`polkadot_parachain::primitives::ValidationParams`] and the PVF.
+/// of the candidate [`polkadot_parachain_primitives::primitives::ValidationParams`] and the PVF.
 #[derive(Debug, Clone)]
 pub enum InvalidCandidate {
 	/// PVF preparation ended up with a deterministic error.

polkadot/node/core/pvf/src/execute/worker_intf.rs

@@ -32,7 +32,7 @@ use polkadot_node_core_pvf_common::{
 	execute::{Handshake, Response},
 	framed_recv, framed_send,
 };
-use polkadot_parachain::primitives::ValidationResult;
+use polkadot_parachain_primitives::primitives::ValidationResult;
 use polkadot_primitives::ExecutorParams;
 use std::{path::Path, time::Duration};
 use tokio::{io, net::UnixStream};

polkadot/node/core/pvf/src/host.rs

@@ -35,7 +35,7 @@ use polkadot_node_core_pvf_common::{
 	error::{PrepareError, PrepareResult},
 	pvf::PvfPrepData,
 };
-use polkadot_parachain::primitives::ValidationResult;
+use polkadot_parachain_primitives::primitives::ValidationResult;
 use std::{
 	collections::HashMap,
 	path::{Path, PathBuf},

polkadot/node/core/pvf/src/lib.rs

@@ -33,8 +33,8 @@
 //! compile) in order to pre-check its validity.
 //!
 //! (b) PVF execution. This accepts the PVF
-//! [`params`][`polkadot_parachain::primitives::ValidationParams`]     and the `Pvf` code, prepares
-//! (verifies and compiles) the code, and then executes PVF     with the `params`.
+//! [`params`][`polkadot_parachain_primitives::primitives::ValidationParams`]     and the `Pvf`
+//! code, prepares (verifies and compiles) the code, and then executes PVF     with the `params`.
 //!
 //! (c) Heads up. This request allows to signal that the given PVF may be needed soon and that it
 //!     should be prepared for execution.
@@ -86,7 +86,7 @@
 //!
 //! The execute workers will be fed by the requests from the execution queue, which is basically a
 //! combination of a path to the compiled artifact and the
-//! [`params`][`polkadot_parachain::primitives::ValidationParams`].
+//! [`params`][`polkadot_parachain_primitives::primitives::ValidationParams`].
 
 mod artifacts;
 mod error;

polkadot/node/core/pvf/tests/it/adder.rs

@@ -17,7 +17,7 @@
 use super::TestHost;
 use adder::{hash_state, BlockData, HeadData};
 use parity_scale_codec::{Decode, Encode};
-use polkadot_parachain::primitives::{
+use polkadot_parachain_primitives::primitives::{
 	BlockData as GenericBlockData, HeadData as GenericHeadData, RelayChainBlockNumber,
 	ValidationParams,
 };

polkadot/node/core/pvf/tests/it/main.rs

@@ -21,7 +21,7 @@ use polkadot_node_core_pvf::{
 	start, Config, InvalidCandidate, Metrics, PrepareJobKind, PvfPrepData, ValidationError,
 	ValidationHost, JOB_TIMEOUT_WALL_CLOCK_FACTOR,
 };
-use polkadot_parachain::primitives::{BlockData, ValidationParams, ValidationResult};
+use polkadot_parachain_primitives::primitives::{BlockData, ValidationParams, ValidationResult};
 use polkadot_primitives::ExecutorParams;
 
 #[cfg(feature = "ci-only-tests")]

polkadot/node/network/approval-distribution/src/lib.rs

@@ -14,9 +14,9 @@
 // You should have received a copy of the GNU General Public License
 // along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
 
-//! [`ApprovalDistributionSubsystem`] implementation.
+//! [`ApprovalDistribution`] implementation.
 //!
-//! https://w3f.github.io/parachain-implementers-guide/node/approval/approval-distribution.html
+//! <https://w3f.github.io/parachain-implementers-guide/node/approval/approval-distribution.html>
 
 #![warn(missing_docs)]
 

polkadot/node/network/dispute-distribution/src/lib.rs

@@ -21,8 +21,8 @@
 //! - a sender
 //! - and a receiver
 //!
-//! The sender is responsible for getting our vote out, see [`sender`]. The receiver handles
-//! incoming [`DisputeRequest`]s and offers spam protection, see [`receiver`].
+//! The sender is responsible for getting our vote out, see `sender`. The receiver handles
+//! incoming [`DisputeRequest`](v1::DisputeRequest)s and offers spam protection, see `receiver`.
 
 use std::time::Duration;
 

polkadot/node/primitives/Cargo.toml

@@ -17,7 +17,7 @@ sp-consensus-babe = { path = "../../../substrate/primitives/consensus/babe" }
 sp-keystore = { path = "../../../substrate/primitives/keystore" }
 sp-maybe-compressed-blob = { path = "../../../substrate/primitives/maybe-compressed-blob" }
 sp-runtime = { path = "../../../substrate/primitives/runtime" }
-polkadot-parachain = { path = "../../parachain", default-features = false }
+polkadot-parachain-primitives = { path = "../../parachain", default-features = false }
 schnorrkel = "0.9.1"
 thiserror = "1.0.31"
 serde = { version = "1.0.188", features = ["derive"] }

polkadot/node/primitives/src/lib.rs

@@ -39,7 +39,9 @@ pub use sp_consensus_babe::{
 	AllowedSlots as BabeAllowedSlots, BabeEpochConfiguration, Epoch as BabeEpoch,
 };
 
-pub use polkadot_parachain::primitives::{BlockData, HorizontalMessages, UpwardMessages};
+pub use polkadot_parachain_primitives::primitives::{
+	BlockData, HorizontalMessages, UpwardMessages,
+};
 
 pub mod approval;
 

polkadot/node/service/Cargo.toml

@@ -94,7 +94,7 @@ is_executable = "1.0.1"
 polkadot-core-primitives = { path = "../../core-primitives" }
 polkadot-node-core-parachains-inherent = { path = "../core/parachains-inherent" }
 polkadot-overseer = { path = "../overseer" }
-polkadot-parachain = { path = "../../parachain" }
+polkadot-parachain-primitives = { path = "../../parachain" }
 polkadot-primitives = { path = "../../primitives" }
 polkadot-node-primitives = { path = "../primitives" }
 polkadot-rpc = { path = "../../rpc" }
@@ -200,7 +200,7 @@ runtime-benchmarks = [
 	"pallet-babe/runtime-benchmarks",
 	"pallet-im-online/runtime-benchmarks",
 	"pallet-staking/runtime-benchmarks",
-	"polkadot-parachain/runtime-benchmarks",
+	"polkadot-parachain-primitives/runtime-benchmarks",
 	"polkadot-primitives/runtime-benchmarks",
 	"polkadot-runtime-common/runtime-benchmarks",
 	"polkadot-runtime-parachains/runtime-benchmarks",

polkadot/node/subsystem-test-helpers/src/lib.rs

@@ -338,7 +338,7 @@ pub fn subsystem_test_harness<M, OverseerFactory, Overseer, TestFactory, Test>(
 	});
 }
 
-/// A forward subsystem that implements [`Subsystem`].
+/// A forward subsystem that implements [`Subsystem`](overseer::Subsystem).
 ///
 /// It forwards all communication from the overseer to the internal message
 /// channel.

polkadot/node/test/service/Cargo.toml

@@ -17,7 +17,7 @@ tokio = "1.24.2"
 # Polkadot dependencies
 polkadot-overseer = { path = "../../overseer" }
 polkadot-primitives = { path = "../../../primitives" }
-polkadot-parachain = { path = "../../../parachain" }
+polkadot-parachain-primitives = { path = "../../../parachain" }
 polkadot-rpc = { path = "../../../rpc" }
 polkadot-runtime-common = { path = "../../../runtime/common" }
 polkadot-service = { path = "../../service" }
@@ -68,7 +68,7 @@ runtime-benchmarks= [
 	"frame-system/runtime-benchmarks",
 	"pallet-balances/runtime-benchmarks",
 	"pallet-staking/runtime-benchmarks",
-	"polkadot-parachain/runtime-benchmarks",
+	"polkadot-parachain-primitives/runtime-benchmarks",
 	"polkadot-primitives/runtime-benchmarks",
 	"polkadot-runtime-common/runtime-benchmarks",
 	"polkadot-runtime-parachains/runtime-benchmarks",