diff --git a/cumulus/client/consensus/aura/src/collators/lookahead.rs b/cumulus/client/consensus/aura/src/collators/lookahead.rs
index 8427a40419986ebe4012b86001838718855ea460..17c4059b114662434bdcd770952c80b48a2a3c98 100644
--- a/cumulus/client/consensus/aura/src/collators/lookahead.rs
+++ b/cumulus/client/consensus/aura/src/collators/lookahead.rs
@@ -40,14 +40,14 @@ use cumulus_primitives_aura::AuraUnincludedSegmentApi;
use cumulus_primitives_core::{ClaimQueueOffset, CollectCollationInfo, PersistedValidationData};
use cumulus_relay_chain_interface::RelayChainInterface;
-use polkadot_node_primitives::{PoV, SubmitCollationParams};
+use polkadot_node_primitives::SubmitCollationParams;
use polkadot_node_subsystem::messages::CollationGenerationMessage;
use polkadot_overseer::Handle as OverseerHandle;
use polkadot_primitives::{
- vstaging::DEFAULT_CLAIM_QUEUE_OFFSET, BlockNumber as RBlockNumber, CollatorPair, Hash as RHash,
- HeadData, Id as ParaId, OccupiedCoreAssumption,
+ vstaging::DEFAULT_CLAIM_QUEUE_OFFSET, CollatorPair, Id as ParaId, OccupiedCoreAssumption,
};
+use crate::{collator as collator_util, export_pov_to_path};
use futures::prelude::*;
use sc_client_api::{backend::AuxStore, BlockBackend, BlockOf};
use sc_consensus::BlockImport;
@@ -58,49 +58,8 @@ use sp_consensus_aura::{AuraApi, Slot};
use sp_core::crypto::Pair;
use sp_inherents::CreateInherentDataProviders;
use sp_keystore::KeystorePtr;
-use sp_runtime::traits::{Block as BlockT, Header as HeaderT, Member, NumberFor};
-use std::{
- fs::{self, File},
- path::PathBuf,
- sync::Arc,
- time::Duration,
-};
-
-use crate::{collator as collator_util, LOG_TARGET};
-
-/// Export the given `pov` to the file system at `path`.
-///
-/// The file will be named `block_hash_block_number.pov`.
-///
-/// The `parent_header`, `relay_parent_storage_root` and `relay_parent_number` will also be
-/// stored in the file alongside the `pov`. This enables stateless validation of the `pov`.
-fn export_pov_to_path<Block: BlockT>(
- path: PathBuf,
- pov: PoV,
- block_hash: Block::Hash,
- block_number: NumberFor<Block>,
- parent_header: Block::Header,
- relay_parent_storage_root: RHash,
- relay_parent_number: RBlockNumber,
-) {
- if let Err(error) = fs::create_dir_all(&path) {
- tracing::error!(target: LOG_TARGET, %error, path = %path.display(), "Failed to create PoV export directory");
- return
- }
-
- let mut file = match File::create(path.join(format!("{block_hash:?}_{block_number}.pov"))) {
- Ok(f) => f,
- Err(error) => {
- tracing::error!(target: LOG_TARGET, %error, "Failed to export PoV.");
- return
- },
- };
-
- pov.encode_to(&mut file);
- HeadData(parent_header.encode()).encode_to(&mut file);
- relay_parent_storage_root.encode_to(&mut file);
- relay_parent_number.encode_to(&mut file);
-}
+use sp_runtime::traits::{Block as BlockT, Header as HeaderT, Member};
+use std::{path::PathBuf, sync::Arc, time::Duration};
/// Parameters for [`run`].
pub struct Params<BI, CIDP, Client, Backend, RClient, CHP, Proposer, CS> {
diff --git a/cumulus/client/consensus/aura/src/collators/slot_based/collation_task.rs b/cumulus/client/consensus/aura/src/collators/slot_based/collation_task.rs
index eb48494cf6dcda718061e8467b64b448da0fad3a..d92cfb044b836c6ba35dc92915b72cdeb622149a 100644
--- a/cumulus/client/consensus/aura/src/collators/slot_based/collation_task.rs
+++ b/cumulus/client/consensus/aura/src/collators/slot_based/collation_task.rs
@@ -16,6 +16,7 @@
// along with Cumulus. If not, see <https://www.gnu.org/licenses/>.
use codec::Encode;
+use std::path::PathBuf;
use cumulus_client_collator::service::ServiceInterface as CollatorServiceInterface;
use cumulus_relay_chain_interface::RelayChainInterface;
@@ -25,8 +26,10 @@ use polkadot_node_subsystem::messages::CollationGenerationMessage;
use polkadot_overseer::Handle as OverseerHandle;
use polkadot_primitives::{CollatorPair, Id as ParaId};
+use cumulus_primitives_core::relay_chain::BlockId;
use futures::prelude::*;
+use crate::export_pov_to_path;
use sc_utils::mpsc::TracingUnboundedReceiver;
use sp_runtime::traits::{Block as BlockT, Header};
@@ -50,6 +53,8 @@ pub struct Params<Block: BlockT, RClient, CS> {
pub collator_receiver: TracingUnboundedReceiver<CollatorMessage<Block>>,
/// The handle from the special slot based block import.
pub block_import_handle: super::SlotBasedBlockImportHandle<Block>,
+ /// When set, the collator will export every produced `POV` to this folder.
+ pub export_pov: Option<PathBuf>,
}
/// Asynchronously executes the collation task for a parachain.
@@ -67,6 +72,7 @@ pub async fn run_collation_task<Block, RClient, CS>(
collator_service,
mut collator_receiver,
mut block_import_handle,
+ export_pov,
}: Params<Block, RClient, CS>,
) where
Block: BlockT,
@@ -93,7 +99,7 @@ pub async fn run_collation_task<Block, RClient, CS>(
return;
};
- handle_collation_message(message, &collator_service, &mut overseer_handle).await;
+ handle_collation_message(message, &collator_service, &mut overseer_handle,relay_client.clone(),export_pov.clone()).await;
},
block_import_msg = block_import_handle.next().fuse() => {
// TODO: Implement me.
@@ -107,10 +113,12 @@ pub async fn run_collation_task<Block, RClient, CS>(
/// Handle an incoming collation message from the block builder task.
/// This builds the collation from the [`CollatorMessage`] and submits it to
/// the collation-generation subsystem of the relay chain.
-async fn handle_collation_message<Block: BlockT>(
+async fn handle_collation_message<Block: BlockT, RClient: RelayChainInterface + Clone + 'static>(
message: CollatorMessage<Block>,
collator_service: &impl CollatorServiceInterface<Block>,
overseer_handle: &mut OverseerHandle,
+ relay_client: RClient,
+ export_pov: Option<PathBuf>,
) {
let CollatorMessage {
parent_header,
@@ -140,6 +148,24 @@ async fn handle_collation_message<Block: BlockT>(
);
if let MaybeCompressedPoV::Compressed(ref pov) = collation.proof_of_validity {
+ if let Some(pov_path) = export_pov {
+ if let Ok(Some(relay_parent_header)) =
+ relay_client.header(BlockId::Hash(relay_parent)).await
+ {
+ export_pov_to_path::<Block>(
+ pov_path.clone(),
+ pov.clone(),
+ block_data.header().hash(),
+ *block_data.header().number(),
+ parent_header.clone(),
+ relay_parent_header.state_root,
+ relay_parent_header.number,
+ );
+ } else {
+ tracing::error!(target: LOG_TARGET, "Failed to get relay parent header from hash: {relay_parent:?}");
+ }
+ }
+
tracing::info!(
target: LOG_TARGET,
"Compressed PoV size: {}kb",
diff --git a/cumulus/client/consensus/aura/src/collators/slot_based/mod.rs b/cumulus/client/consensus/aura/src/collators/slot_based/mod.rs
index f72960fe4c2e1ba83638547b85f8873f482b81bd..6839b3882b2cba5e966dbd282e7f2ed8dbfedf44 100644
--- a/cumulus/client/consensus/aura/src/collators/slot_based/mod.rs
+++ b/cumulus/client/consensus/aura/src/collators/slot_based/mod.rs
@@ -54,7 +54,7 @@ use sp_core::{crypto::Pair, traits::SpawnNamed, U256};
use sp_inherents::CreateInherentDataProviders;
use sp_keystore::KeystorePtr;
use sp_runtime::traits::{Block as BlockT, Member, NumberFor, One};
-use std::{sync::Arc, time::Duration};
+use std::{path::PathBuf, sync::Arc, time::Duration};
pub use block_import::{SlotBasedBlockImport, SlotBasedBlockImportHandle};
@@ -100,28 +100,13 @@ pub struct Params<Block, BI, CIDP, Client, Backend, RClient, CHP, Proposer, CS,
pub block_import_handle: SlotBasedBlockImportHandle<Block>,
/// Spawner for spawning futures.
pub spawner: Spawner,
+ /// When set, the collator will export every produced `POV` to this folder.
+ pub export_pov: Option<PathBuf>,
}
/// Run aura-based block building and collation task.
pub fn run<Block, P, BI, CIDP, Client, Backend, RClient, CHP, Proposer, CS, Spawner>(
- Params {
- create_inherent_data_providers,
- block_import,
- para_client,
- para_backend,
- relay_client,
- code_hash_provider,
- keystore,
- collator_key,
- para_id,
- proposer,
- collator_service,
- authoring_duration,
- reinitialize,
- slot_drift,
- block_import_handle,
- spawner,
- }: Params<Block, BI, CIDP, Client, Backend, RClient, CHP, Proposer, CS, Spawner>,
+ params: Params<Block, BI, CIDP, Client, Backend, RClient, CHP, Proposer, CS, Spawner>,
) where
Block: BlockT,
Client: ProvideRuntimeApi<Block>
@@ -148,6 +133,26 @@ pub fn run<Block, P, BI, CIDP, Client, Backend, RClient, CHP, Proposer, CS, Spaw
P::Signature: TryFrom<Vec<u8>> + Member + Codec,
Spawner: SpawnNamed,
{
+ let Params {
+ create_inherent_data_providers,
+ block_import,
+ para_client,
+ para_backend,
+ relay_client,
+ code_hash_provider,
+ keystore,
+ collator_key,
+ para_id,
+ proposer,
+ collator_service,
+ authoring_duration,
+ reinitialize,
+ slot_drift,
+ block_import_handle,
+ spawner,
+ export_pov,
+ } = params;
+
let (tx, rx) = tracing_unbounded("mpsc_builder_to_collator", 100);
let collator_task_params = collation_task::Params {
relay_client: relay_client.clone(),
@@ -157,6 +162,7 @@ pub fn run<Block, P, BI, CIDP, Client, Backend, RClient, CHP, Proposer, CS, Spaw
collator_service: collator_service.clone(),
collator_receiver: rx,
block_import_handle,
+ export_pov,
};
let collation_task_fut = run_collation_task::<Block, _, _>(collator_task_params);
diff --git a/cumulus/client/consensus/aura/src/lib.rs b/cumulus/client/consensus/aura/src/lib.rs
index 0e404541ab9a6099e8f69fdd38fd5743fa9b3c52..2e9b4b702344bea3434627493c69ef4c5e6440ac 100644
--- a/cumulus/client/consensus/aura/src/lib.rs
+++ b/cumulus/client/consensus/aura/src/lib.rs
@@ -23,13 +23,15 @@
//!
//! For more information about AuRa, the Substrate crate should be checked.
-use codec::Codec;
+use codec::{Codec, Encode};
use cumulus_client_consensus_common::{
ParachainBlockImportMarker, ParachainCandidate, ParachainConsensus,
};
use cumulus_primitives_core::{relay_chain::Hash as PHash, PersistedValidationData};
+use cumulus_primitives_core::relay_chain::HeadData;
use futures::lock::Mutex;
+use polkadot_primitives::{BlockNumber as RBlockNumber, Hash as RHash};
use sc_client_api::{backend::AuxStore, BlockOf};
use sc_consensus::BlockImport;
use sc_consensus_slots::{BackoffAuthoringBlocksStrategy, SimpleSlotWorker, SlotInfo};
@@ -45,7 +47,10 @@ use sp_keystore::KeystorePtr;
use sp_runtime::traits::{Block as BlockT, Header as HeaderT, Member, NumberFor};
use std::{
convert::TryFrom,
+ fs,
+ fs::File,
marker::PhantomData,
+ path::PathBuf,
sync::{
atomic::{AtomicU64, Ordering},
Arc,
@@ -55,6 +60,7 @@ use std::{
mod import_queue;
pub use import_queue::{build_verifier, import_queue, BuildVerifierParams, ImportQueueParams};
+use polkadot_node_primitives::PoV;
pub use sc_consensus_aura::{
slot_duration, standalone::slot_duration_at, AuraVerifier, BuildAuraWorkerParams,
SlotProportion,
@@ -252,3 +258,37 @@ where
Some(ParachainCandidate { block: res.block, proof: res.storage_proof })
}
}
+
+/// Export the given `pov` to the file system at `path`.
+///
+/// The file will be named `block_hash_block_number.pov`.
+///
+/// The `parent_header`, `relay_parent_storage_root` and `relay_parent_number` will also be
+/// stored in the file alongside the `pov`. This enables stateless validation of the `pov`.
+pub(crate) fn export_pov_to_path<Block: BlockT>(
+ path: PathBuf,
+ pov: PoV,
+ block_hash: Block::Hash,
+ block_number: NumberFor<Block>,
+ parent_header: Block::Header,
+ relay_parent_storage_root: RHash,
+ relay_parent_number: RBlockNumber,
+) {
+ if let Err(error) = fs::create_dir_all(&path) {
+ tracing::error!(target: LOG_TARGET, %error, path = %path.display(), "Failed to create PoV export directory");
+ return
+ }
+
+ let mut file = match File::create(path.join(format!("{block_hash:?}_{block_number}.pov"))) {
+ Ok(f) => f,
+ Err(error) => {
+ tracing::error!(target: LOG_TARGET, %error, "Failed to export PoV.");
+ return
+ },
+ };
+
+ pov.encode_to(&mut file);
+ HeadData(parent_header.encode()).encode_to(&mut file);
+ relay_parent_storage_root.encode_to(&mut file);
+ relay_parent_number.encode_to(&mut file);
+}
diff --git a/cumulus/polkadot-omni-node/lib/src/nodes/aura.rs b/cumulus/polkadot-omni-node/lib/src/nodes/aura.rs
index 0d526b09834e9035ac02faa167cd4f0b6ffaecb1..60c75464ae3ec2bfadb19a6497523d0f78b10125 100644
--- a/cumulus/polkadot-omni-node/lib/src/nodes/aura.rs
+++ b/cumulus/polkadot-omni-node/lib/src/nodes/aura.rs
@@ -250,7 +250,7 @@ where
{
#[docify::export_content]
fn launch_slot_based_collator<CIDP, CHP, Proposer, CS, Spawner>(
- params: SlotBasedParams<
+ params_with_export: SlotBasedParams<
Block,
ParachainBlockImport<
Block,
@@ -277,7 +277,9 @@ where
CS: CollatorServiceInterface<Block> + Send + Sync + Clone + 'static,
Spawner: SpawnNamed,
{
- slot_based::run::<Block, <AuraId as AppCrypto>::Pair, _, _, _, _, _, _, _, _, _>(params);
+ slot_based::run::<Block, <AuraId as AppCrypto>::Pair, _, _, _, _, _, _, _, _, _>(
+ params_with_export,
+ );
}
}
@@ -319,7 +321,7 @@ where
_overseer_handle: OverseerHandle,
announce_block: Arc<dyn Fn(Hash, Option<Vec<u8>>) + Send + Sync>,
backend: Arc<ParachainBackend<Block>>,
- _node_extra_args: NodeExtraArgs,
+ node_extra_args: NodeExtraArgs,
block_import_handle: SlotBasedBlockImportHandle<Block>,
) -> Result<(), Error> {
let proposer_factory = sc_basic_authorship::ProposerFactory::with_proof_recording(
@@ -358,10 +360,12 @@ where
slot_drift: Duration::from_secs(1),
block_import_handle,
spawner: task_manager.spawn_handle(),
+ export_pov: node_extra_args.export_pov,
};
// We have a separate function only to be able to use `docify::export` on this piece of
// code.
+
Self::launch_slot_based_collator(params);
Ok(())
diff --git a/cumulus/test/service/src/lib.rs b/cumulus/test/service/src/lib.rs
index f3f04cbb63835fb2dc2926b1e3b50a320e39794d..075258fe25b98e33ce1833467d5744a9ca085f59 100644
--- a/cumulus/test/service/src/lib.rs
+++ b/cumulus/test/service/src/lib.rs
@@ -506,6 +506,7 @@ where
slot_drift: Duration::from_secs(1),
block_import_handle: slot_based_handle,
spawner: task_manager.spawn_handle(),
+ export_pov: None,
};
slot_based::run::<Block, AuthorityPair, _, _, _, _, _, _, _, _, _>(params);
diff --git a/prdoc/pr_7585.prdoc b/prdoc/pr_7585.prdoc
new file mode 100644
index 0000000000000000000000000000000000000000..1d6b69e8df63bad46fc566d602acf60c7eca69c7
--- /dev/null
+++ b/prdoc/pr_7585.prdoc
@@ -0,0 +1,11 @@
+title: 'Add export PoV on slot base collator'
+doc:
+- audience: [Node Dev, Node Operator]
+ description: Add functionality to export the Proof of Validity (PoV) when the slot-based collator is used.
+crates:
+- name: cumulus-test-service
+ bump: major
+- name: cumulus-client-consensus-aura
+ bump: major
+- name: polkadot-omni-node-lib
+ bump: major
\ No newline at end of file