PoV Reclaim (Clawback) Node Side (#1462)

This PR provides the infrastructure for the pov-reclaim mechanism
discussed in #209. The goal is to provide the current proof size to the
runtime so it can be used to reclaim storage weight.

## New Host Function
- A new host function is provided
[here](https://github.com/skunert/polkadot-sdk/blob/5b317fda3be205f4136f10d4490387ccd4f9765d/cumulus/primitives/pov-reclaim/src/lib.rs#L23).
It returns the size of the current proof size to the runtime. If
recording is not enabled, it returns 0.

## Implementation Overview
- Implement option to enable proof recording during import in the
client. This is currently enabled for `polkadot-parachain`,
`parachain-template` and the cumulus test node.
- Make the proof recorder ready for no-std. It was previously only
enabled for std environments, but we need to record the proof size in
`validate_block` too.
- Provide a recorder implementation that only the records the size of
incoming nodes and does not store the nodes itself.
- Fix benchmarks that were broken by async backing changes
- Provide new externalities extension that is registered by default if
proof recording is enabled.
- I think we should discuss the naming, pov-reclaim was more intuitive
to me, but we could also go with clawback like in the issue.

## Impact of proof recording during import
With proof recording: 6.3058 Kelem/s
Without proof recording: 6.3427 Kelem/s

The measured impact on the importing performance is quite low on my
machine using the block import benchmark. With proof recording I am
seeing a performance hit of 0.585%.

---------

Co-authored-by: command-bot <>
Co-authored-by: Davide Galassi <davxy@datawok.net>
Co-authored-by: Bastian Köcher <git@kchr.de>
This commit is contained in:
Sebastian Kunert
2023-11-30 15:56:34 +01:00
committed by GitHub
parent 64361ac19a
commit 9a650c46fd
34 changed files with 895 additions and 237 deletions
+6 -1
View File
@@ -81,8 +81,13 @@ pub fn extrinsic_set_time(client: &TestClient) -> OpaqueExtrinsic {
pub fn extrinsic_set_validation_data(
parent_header: cumulus_test_runtime::Header,
) -> OpaqueExtrinsic {
let sproof_builder = RelayStateSproofBuilder { para_id: 100.into(), ..Default::default() };
let parent_head = HeadData(parent_header.encode());
let sproof_builder = RelayStateSproofBuilder {
para_id: cumulus_test_runtime::PARACHAIN_ID.into(),
included_para_head: parent_head.clone().into(),
..Default::default()
};
let (relay_parent_storage_root, relay_chain_state) = sproof_builder.into_state_root_and_proof();
let data = ParachainInherentData {
validation_data: PersistedValidationData {
+37 -17
View File
@@ -187,6 +187,7 @@ impl RecoveryHandle for FailingRecoveryHandle {
/// be able to perform chain operations.
pub fn new_partial(
config: &mut Configuration,
enable_import_proof_record: bool,
) -> Result<
PartialComponents<
Client,
@@ -214,7 +215,12 @@ pub fn new_partial(
sc_executor::NativeElseWasmExecutor::<RuntimeExecutor>::new_with_wasm_executor(wasm);
let (client, backend, keystore_container, task_manager) =
sc_service::new_full_parts::<Block, RuntimeApi, _>(config, None, executor)?;
sc_service::new_full_parts_record_import::<Block, RuntimeApi, _>(
config,
None,
executor,
enable_import_proof_record,
)?;
let client = Arc::new(client);
let block_import =
@@ -309,19 +315,21 @@ pub async fn start_node_impl<RB>(
rpc_ext_builder: RB,
consensus: Consensus,
collator_options: CollatorOptions,
proof_recording_during_import: bool,
) -> sc_service::error::Result<(
TaskManager,
Arc<Client>,
Arc<NetworkService<Block, H256>>,
RpcHandlers,
TransactionPool,
Arc<Backend>,
)>
where
RB: Fn(Arc<Client>) -> Result<jsonrpsee::RpcModule<()>, sc_service::Error> + Send + 'static,
{
let mut parachain_config = prepare_node_config(parachain_config);
let params = new_partial(&mut parachain_config)?;
let params = new_partial(&mut parachain_config, proof_recording_during_import)?;
let transaction_pool = params.transaction_pool.clone();
let mut task_manager = params.task_manager;
@@ -477,7 +485,7 @@ where
start_network.start_network();
Ok((task_manager, client, network, rpc_handlers, transaction_pool))
Ok((task_manager, client, network, rpc_handlers, transaction_pool, backend))
}
/// A Cumulus test node instance used for testing.
@@ -495,6 +503,8 @@ pub struct TestNode {
pub rpc_handlers: RpcHandlers,
/// Node's transaction pool
pub transaction_pool: TransactionPool,
/// Node's backend
pub backend: Arc<Backend>,
}
#[allow(missing_docs)]
@@ -520,6 +530,7 @@ pub struct TestNodeBuilder {
consensus: Consensus,
relay_chain_mode: RelayChainMode,
endowed_accounts: Vec<AccountId>,
record_proof_during_import: bool,
}
impl TestNodeBuilder {
@@ -544,6 +555,7 @@ impl TestNodeBuilder {
consensus: Consensus::RelayChain,
endowed_accounts: Default::default(),
relay_chain_mode: RelayChainMode::Embedded,
record_proof_during_import: true,
}
}
@@ -656,6 +668,12 @@ impl TestNodeBuilder {
self
}
/// Record proofs during import.
pub fn import_proof_recording(mut self, should_record_proof: bool) -> TestNodeBuilder {
self.record_proof_during_import = should_record_proof;
self
}
/// Build the [`TestNode`].
pub async fn build(self) -> TestNode {
let parachain_config = node_config(
@@ -684,24 +702,26 @@ impl TestNodeBuilder {
format!("{} (relay chain)", relay_chain_config.network.node_name);
let multiaddr = parachain_config.network.listen_addresses[0].clone();
let (task_manager, client, network, rpc_handlers, transaction_pool) = start_node_impl(
parachain_config,
self.collator_key,
relay_chain_config,
self.para_id,
self.wrap_announce_block,
false,
|_| Ok(jsonrpsee::RpcModule::new(())),
self.consensus,
collator_options,
)
.await
.expect("could not create Cumulus test service");
let (task_manager, client, network, rpc_handlers, transaction_pool, backend) =
start_node_impl(
parachain_config,
self.collator_key,
relay_chain_config,
self.para_id,
self.wrap_announce_block,
false,
|_| Ok(jsonrpsee::RpcModule::new(())),
self.consensus,
collator_options,
self.record_proof_during_import,
)
.await
.expect("could not create Cumulus test service");
let peer_id = network.local_peer_id();
let addr = MultiaddrWithPeerId { multiaddr, peer_id };
TestNode { task_manager, client, network, addr, rpc_handlers, transaction_pool }
TestNode { task_manager, client, network, addr, rpc_handlers, transaction_pool, backend }
}
}
+2 -1
View File
@@ -128,7 +128,7 @@ fn main() -> Result<(), sc_cli::Error> {
})
.unwrap_or(cumulus_test_service::Consensus::RelayChain);
let (mut task_manager, _, _, _, _) = tokio_runtime
let (mut task_manager, _, _, _, _, _) = tokio_runtime
.block_on(cumulus_test_service::start_node_impl(
config,
collator_key,
@@ -139,6 +139,7 @@ fn main() -> Result<(), sc_cli::Error> {
|_| Ok(jsonrpsee::RpcModule::new(())),
consensus,
collator_options,
true,
))
.expect("could not create Cumulus test service");