feat: add client-side code for HOP promotion

Author: franciscoaguirre

Cargo.lock

@@ -277,8 +277,8 @@ members = [
 	"substrate/client/executor/polkavm",
 	"substrate/client/executor/runtime-test",
 	"substrate/client/executor/wasmtime",
-	"substrate/client/informant",
 	"substrate/client/hop",
+	"substrate/client/informant",
 	"substrate/client/keystore",
 	"substrate/client/merkle-mountain-range",
 	"substrate/client/merkle-mountain-range/rpc",
@@ -509,6 +509,7 @@ members = [
 	"substrate/primitives/ethereum-standards",
 	"substrate/primitives/externalities",
 	"substrate/primitives/genesis-builder",
+	"substrate/primitives/hop",
 	"substrate/primitives/inherents",
 	"substrate/primitives/io",
 	"substrate/primitives/keyring",
@@ -1363,6 +1364,7 @@ sp-database = { path = "substrate/primitives/database", default-features = false
 sp-debug-derive = { path = "substrate/primitives/debug-derive", default-features = false }
 sp-externalities = { path = "substrate/primitives/externalities", default-features = false }
 sp-genesis-builder = { path = "substrate/primitives/genesis-builder", default-features = false }
+sp-hop = { path = "substrate/primitives/hop", default-features = false }
 sp-inherents = { path = "substrate/primitives/inherents", default-features = false }
 sp-io = { path = "substrate/primitives/io", default-features = false }
 sp-keyring = { path = "substrate/primitives/keyring", default-features = false }

Cargo.toml

@@ -72,6 +72,7 @@ sp-consensus = { workspace = true, default-features = true }
 sp-consensus-aura = { workspace = true, default-features = true }
 sp-core = { workspace = true, default-features = true }
 sp-genesis-builder = { workspace = true }
+sp-hop = { workspace = true, default-features = true }
 sp-inherents = { workspace = true, default-features = true }
 sp-keystore = { workspace = true, default-features = true }
 sp-offchain = { workspace = true, default-features = true }

cumulus/polkadot-omni-node/lib/Cargo.toml

@@ -266,6 +266,13 @@ pub struct Cli<Config: CliConfig> {
 	#[arg(long, default_value_t = 60)]
 	pub hop_check_interval: u64,
 
+	/// How many blocks before expiry to start promoting entries to chain storage.
+	///
+	/// At 6 seconds per block, 1200 blocks is approximately 2 hours.
+	/// Only relevant when `--enable-hop` is used.
+	#[arg(long, default_value_t = 1200)]
+	pub hop_buffer_blocks: u32,
+
 	/// Directory for HOP persistent data storage.
 	///
 	/// If not specified, defaults to `<chain-data-dir>/hop`.
@@ -325,6 +332,7 @@ impl<Config: CliConfig> Cli<Config> {
 			hop_max_pool_size_mb: self.hop_max_pool_size,
 			hop_retention_blocks: self.hop_retention_blocks,
 			hop_check_interval: self.hop_check_interval,
+			hop_buffer_blocks: self.hop_buffer_blocks,
 			hop_data_dir: self.hop_data_dir.clone(),
 		}
 	}

cumulus/polkadot-omni-node/lib/src/cli.rs

@@ -36,6 +36,7 @@ use sc_offchain::OffchainWorkerApi;
 use serde::de::DeserializeOwned;
 use sp_api::{ApiExt, CallApiAt, ConstructRuntimeApi, Metadata};
 use sp_block_builder::BlockBuilder;
+use sp_hop::HopPromotionApi;
 use sp_runtime::{
 	traits::{Block as BlockT, BlockNumber, Header as HeaderT, NumberFor},
 	OpaqueExtrinsic,
@@ -76,6 +77,7 @@ pub trait NodeRuntimeApi<Block: BlockT>:
 	+ GetParachainInfo<Block>
 	+ TransactionStorageApi<Block>
 	+ RelayParentOffsetApi<Block>
+	+ HopPromotionApi<Block>
 	+ Sized
 {
 }
@@ -91,6 +93,7 @@ impl<T, Block: BlockT> NodeRuntimeApi<Block> for T where
 		+ CollectCollationInfo<Block>
 		+ GetParachainInfo<Block>
 		+ TransactionStorageApi<Block>
+		+ HopPromotionApi<Block>
 {
 }
 
@@ -149,6 +152,9 @@ pub struct NodeExtraArgs {
 	/// HOP promotion check interval in seconds.
 	pub hop_check_interval: u64,
 
+	/// How many blocks before expiry to start promoting entries to chain storage.
+	pub hop_buffer_blocks: u32,
+
 	/// Directory for HOP persistent data storage.
 	pub hop_data_dir: Option<PathBuf>,
 }

cumulus/polkadot-omni-node/lib/src/common/mod.rs

@@ -83,8 +83,7 @@ where
 			if let Some(hop_pool) = hop_pool {
 				use sc_hop::{HopApiServer, HopRpcServer, NoopVerifier};
 				module.merge(
-					HopRpcServer::new(hop_pool, client.clone(), Arc::new(NoopVerifier))
-						.into_rpc(),
+					HopRpcServer::new(hop_pool, client.clone(), Arc::new(NoopVerifier)).into_rpc(),
 				)?;
 			}
 			module.merge(Dev::new(client).into_rpc())?;

cumulus/polkadot-omni-node/lib/src/common/rpc.rs

@@ -426,26 +426,18 @@ pub(crate) trait NodeSpec: BaseNodeSpec {
 				parachain_config.database.path().map(|p| p.to_path_buf()),
 			)?;
 			if let Some(ref pool) = hop_pool {
-				let task_pool = pool.clone();
+				let promoter = sc_hop::try_build_promoter(&client, &transaction_pool);
 				let task_client = client.clone();
-				let check_interval = node_extra_args.hop_check_interval;
-				task_manager.spawn_handle().spawn("hop-promotion", None, async move {
-					loop {
-						futures_timer::Delay::new(Duration::from_secs(check_interval)).await;
-						let block = task_client
-							.info()
-							.best_number
-							.saturated_into::<u32>();
-						let freed = task_pool.cleanup_expired(block);
-						if freed > 0 {
-							log::info!(
-								target: "hop",
-								"Cleaned up expired HOP entries, freed {} bytes",
-								freed,
-							);
-						}
-					}
-				});
+				let best_block: Arc<dyn Fn() -> u32 + Send + Sync> =
+					Arc::new(move || task_client.info().best_number.saturated_into::<u32>());
+				let maintenance = sc_hop::HopMaintenanceTask::new(
+					pool.clone(),
+					promoter,
+					best_block,
+					node_extra_args.hop_buffer_blocks,
+					node_extra_args.hop_check_interval,
+				);
+				task_manager.spawn_handle().spawn("hop-maintenance", None, maintenance.run());
 			}
 
 			if parachain_config.offchain_worker.enabled {

cumulus/polkadot-omni-node/lib/src/common/spec.rs

@@ -252,6 +252,16 @@ macro_rules! impl_node_runtime_apis {
 					unimplemented!()
 				}
 			}
+
+			impl sp_hop::HopPromotionApi<$block> for $runtime {
+				fn create_promotion_extrinsic(_: Vec<u8>) -> <$block as BlockT>::Extrinsic {
+					unimplemented!()
+				}
+
+				fn max_promotion_size() -> u32 {
+					unimplemented!()
+				}
+			}
 		}
 	};
 }

cumulus/polkadot-omni-node/lib/src/fake_runtime_api/utils.rs

@@ -13,24 +13,31 @@ workspace = true
 [dependencies]
 # Core
 codec = { workspace = true, features = ["derive"] }
+hex = { workspace = true }
 parking_lot = { workspace = true }
+serde = { workspace = true, features = ["derive"] }
 thiserror = { workspace = true }
-hex = { workspace = true }
 tracing = { workspace = true }
-serde = { workspace = true, features = ["derive"] }
 
 # CLI
 clap = { workspace = true, features = ["derive"] }
 
 # RPC
-jsonrpsee = { workspace = true, features = ["server", "client", "macros"] }
+jsonrpsee = { workspace = true, features = ["client", "macros", "server"] }
+
+# Async
+futures-timer = { workspace = true }
 
 # Substrate primitives (client-side, always with std)
-sp-core = { workspace = true, default-features = true }
+polkadot-primitives = { workspace = true, default-features = true }
 sp-api = { workspace = true, default-features = true }
 sp-blockchain = { workspace = true, default-features = true }
+sp-core = { workspace = true, default-features = true }
+sp-hop = { workspace = true, default-features = true }
 sp-runtime = { workspace = true, default-features = true }
-polkadot-primitives = { workspace = true, default-features = true }
+
+# Substrate client
+sc-transaction-pool-api = { workspace = true, default-features = true }
 
 [dev-dependencies]
 tempfile = { workspace = true }

substrate/client/hop/Cargo.toml

@@ -54,6 +54,13 @@ pub struct HopParams {
 	#[arg(long, default_value = "60")]
 	pub hop_check_interval: u64,
 
+	/// How many blocks before expiry to start promoting entries to chain storage.
+	///
+	/// At 6 seconds per block, 1200 blocks is approximately 2 hours.
+	/// Only relevant when `--enable-hop` is used.
+	#[arg(long, default_value = "1200")]
+	pub hop_buffer_blocks: u32,
+
 	/// Directory for HOP persistent data storage.
 	///
 	/// If not specified, defaults to `<chain-data-dir>/hop`.
@@ -68,6 +75,7 @@ impl Default for HopParams {
 			hop_max_pool_size: (DEFAULT_MAX_POOL_SIZE / (1024 * 1024)), // Convert to MiB
 			hop_retention_blocks: DEFAULT_RETENTION_BLOCKS,             // 24 hours
 			hop_check_interval: 60,                                     // 1 minute
+			hop_buffer_blocks: 1200,                                    // ~2 hours
 			hop_data_dir: None,
 		}
 	}