feat: added zero-gas-tx-pool-timeout parameter (#158)

client/authorship/src/authorship.rs

@@ -82,6 +82,10 @@ pub struct ProposerFactory<A, B, C, PR> {
 	/// HTTP URL of the private pool from which the node will retrieve zero-gas transactions
 	zero_gas_tx_pool: Option<String>,
 
+	/// Timeout in milliseconds for the zero-gas transaction pool
+	/// (default: 1000)
+	zero_gas_tx_pool_timeout: u64,
+
 	/// Prometheus Link,
 	metrics: PrometheusMetrics,
 	/// The default block size limit.
@@ -115,6 +119,7 @@ impl<A, B, C> ProposerFactory<A, B, C, DisableProofRecording> {
 		transaction_pool: Arc<A>,
 		keystore: KeystorePtr,
 		zero_gas_tx_pool: Option<String>,
+		zero_gas_tx_pool_timeout: u64,
 		prometheus: Option<&PrometheusRegistry>,
 		telemetry: Option<TelemetryHandle>,
 	) -> Self {
@@ -123,6 +128,7 @@ impl<A, B, C> ProposerFactory<A, B, C, DisableProofRecording> {
 			transaction_pool,
 			keystore,
 			zero_gas_tx_pool,
+			zero_gas_tx_pool_timeout,
 			metrics: PrometheusMetrics::new(prometheus),
 			default_block_size_limit: DEFAULT_BLOCK_SIZE_LIMIT,
 			soft_deadline_percent: DEFAULT_SOFT_DEADLINE_PERCENT,
@@ -147,6 +153,7 @@ impl<A, B, C> ProposerFactory<A, B, C, EnableProofRecording> {
 		transaction_pool: Arc<A>,
 		keystore: KeystorePtr,
 		zero_gas_tx_pool: Option<String>,
+		zero_gas_tx_pool_timeout: u64,
 		prometheus: Option<&PrometheusRegistry>,
 		telemetry: Option<TelemetryHandle>,
 	) -> Self {
@@ -156,6 +163,7 @@ impl<A, B, C> ProposerFactory<A, B, C, EnableProofRecording> {
 			transaction_pool,
 			keystore,
 			zero_gas_tx_pool,
+			zero_gas_tx_pool_timeout,
 			metrics: PrometheusMetrics::new(prometheus),
 			default_block_size_limit: DEFAULT_BLOCK_SIZE_LIMIT,
 			soft_deadline_percent: DEFAULT_SOFT_DEADLINE_PERCENT,
@@ -234,6 +242,7 @@ where
 			transaction_pool: self.transaction_pool.clone(),
 			keystore: self.keystore.clone(),
 			zero_gas_tx_pool: self.zero_gas_tx_pool.clone(),
+			zero_gas_tx_pool_timeout: self.zero_gas_tx_pool_timeout,
 			now,
 			metrics: self.metrics.clone(),
 			default_block_size_limit: self.default_block_size_limit,
@@ -285,6 +294,7 @@ pub struct Proposer<B, Block: BlockT, C, A: TransactionPool, PR> {
 	transaction_pool: Arc<A>,
 	keystore: KeystorePtr,
 	zero_gas_tx_pool: Option<String>,
+	zero_gas_tx_pool_timeout: u64,
 	now: Box<dyn Fn() -> time::Instant + Send + Sync>,
 	metrics: PrometheusMetrics,
 	default_block_size_limit: usize,
@@ -444,7 +454,7 @@ where
 
 			let http_client = reqwest::Client::new();
 			let mut request = Box::pin(http_client.post(zero_gas_tx_pool).send().fuse());
-			let mut timeout = Box::pin(futures_timer::Delay::new(std::time::Duration::from_millis(500)).fuse());
+			let mut timeout = Box::pin(futures_timer::Delay::new(std::time::Duration::from_millis(self.zero_gas_tx_pool_timeout)).fuse());
 
 			let result_response_raw_zero = select! {
 				res = request => {
@@ -874,7 +884,7 @@ mod tests {
 		.expect("Creates authority key");
 
 		let mut proposer_factory =
-			ProposerFactory::new(spawner.clone(), client.clone(), txpool.clone(),keystore_container.keystore(), None, None, None);
+			ProposerFactory::new(spawner.clone(), client.clone(), txpool.clone(), keystore_container.keystore(), None, 1000, None, None);
 
 		let cell = Mutex::new((false, time::Instant::now()));
 		let proposer = proposer_factory.init_with_now(
@@ -929,7 +939,7 @@ mod tests {
 		.expect("Creates authority key");
 
 		let mut proposer_factory =
-			ProposerFactory::new(spawner.clone(), client.clone(), txpool.clone(), keystore_container.keystore(), None, None, None);
+			ProposerFactory::new(spawner.clone(), client.clone(), txpool.clone(), keystore_container.keystore(), None, 1000, None, None);
 
 		let cell = Mutex::new((false, time::Instant::now()));
 		let proposer = proposer_factory.init_with_now(
@@ -989,7 +999,7 @@ mod tests {
 		.expect("Creates authority key");
 
 		let mut proposer_factory =
-			ProposerFactory::new(spawner.clone(), client.clone(), txpool.clone(), keystore_container.keystore(), None, None, None);
+			ProposerFactory::new(spawner.clone(), client.clone(), txpool.clone(), keystore_container.keystore(), None, 1000, None, None);
 
 		let proposer = proposer_factory.init_with_now(
 			&client.header(genesis_hash).unwrap().unwrap(),
@@ -1059,7 +1069,7 @@ mod tests {
 		.expect("Creates authority key");
 
 		let mut proposer_factory =
-			ProposerFactory::new(spawner.clone(), client.clone(), txpool.clone(),keystore_container.keystore(), None, None, None);
+			ProposerFactory::new(spawner.clone(), client.clone(), txpool.clone(),keystore_container.keystore(), None, 1000, None, None);
 		let mut propose_block = |client: &TestClient,
 		                         parent_number,
 		                         expected_block_extrinsics,
@@ -1190,7 +1200,7 @@ mod tests {
 		.expect("Creates authority key");
 
 		let mut proposer_factory =
-			ProposerFactory::new(spawner.clone(), client.clone(), txpool.clone(), keystore_container.keystore(), None, None, None);
+			ProposerFactory::new(spawner.clone(), client.clone(), txpool.clone(), keystore_container.keystore(), None, 1000, None, None);
 
 		let proposer = block_on(proposer_factory.init(&genesis_header)).unwrap();
 
@@ -1234,6 +1244,7 @@ mod tests {
 			txpool.clone(),
 			keystore_container.keystore(),
 			None,
+			1000,
 			None,
 			None,
 		);
@@ -1320,7 +1331,7 @@ mod tests {
 
 
 		let mut proposer_factory =
-			ProposerFactory::new(spawner.clone(), client.clone(), txpool.clone(), keystore_container.keystore(), None, None, None);
+			ProposerFactory::new(spawner.clone(), client.clone(), txpool.clone(), keystore_container.keystore(), None, 1000, None, None);
 
 		let cell = Mutex::new(time::Instant::now());
 		let proposer = proposer_factory.init_with_now(
@@ -1404,7 +1415,7 @@ mod tests {
 		.expect("Creates authority key");
 
 		let mut proposer_factory =
-			ProposerFactory::new(spawner.clone(), client.clone(), txpool.clone(), keystore_container.keystore(), None, None, None);
+			ProposerFactory::new(spawner.clone(), client.clone(), txpool.clone(), keystore_container.keystore(), None, 1000, None, None);
 
 		let deadline = time::Duration::from_secs(600);
 		let cell = Arc::new(Mutex::new((0, time::Instant::now())));

docker/README.md

@@ -37,6 +37,7 @@ Optional environment variables:
 - BOOTNODES: This environment variable allows specifying the bootnodes to use, separated by commas. If not specified, the node will use the default bootnodes for the chain spec.
 - MODE: This environment variable allows the node to run in different pruning modes. Possible values are "full_node" or "archive". The default value is "full_node".
 - ZERO_GAS_TX_POOL: This environment variable allows the node to run with a zero gas price transaction pool. By default the feature is disabled. The expected value is a string containing an URL. Check the [Zero Gas Transaction Pool](../docs/ZERO-GAS-TRANSACTIONS.md) document for more information.
+- ZERO_GAS_TX_POOL_TIMEOUT: This environment variable allows specifying the timeout for the zero gas transaction in millisecond. If not specified, the node will use the default timeout (1000ms).
 
 To set an environment variable in the docker run, use the flag -e NAME=VALUE
 

docker/client/entrypoint.sh

@@ -54,6 +54,10 @@ if [ -n "$ZERO_GAS_TX_POOL" ]; then
   START_COMMAND="$START_COMMAND --zero-gas-tx-pool $ZERO_GAS_TX_POOL"
 fi
 
+if [ -n "$ZERO_GAS_TX_POOL_TIMEOUT"]; then
+  START_COMMAND="$START_COMMAND --zero-gas-tx-pool-timeout $ZERO_GAS_TX_POOL_TIMEOUT"
+fi
+
 if [ -n "$CUSTOM_ETH_APIS" ]; then
     START_COMMAND="$START_COMMAND --ethapi=$CUSTOM_ETH_APIS"
 else

node/src/service.rs

@@ -510,6 +510,7 @@ where
 			transaction_pool,
 			keystore_container.keystore(),
 			stability_config.zero_gas_tx_pool.clone(),
+			stability_config.zero_gas_tx_pool_timeout.clone(),
 			prometheus_registry.as_ref(),
 			telemetry.as_ref().map(|x| x.handle()),
 		);
@@ -636,6 +637,7 @@ where
 		transaction_pool.clone(),
 		keystore.keystore(),
 		stability_config.zero_gas_tx_pool.clone(),
+		stability_config.zero_gas_tx_pool_timeout.clone(),
 		prometheus_registry,
 		telemetry.as_ref().map(|x| x.handle()),
 	);

node/src/stability.rs

@@ -4,4 +4,9 @@ pub struct StabilityConfiguration {
     /// HTTP URL of the private pool from which the node will retrieve zero-gas transactions
     #[arg(long, value_name = "URL")]
 	pub zero_gas_tx_pool: Option<String>,
+
+    /// Timeout in milliseconds for the zero-gas transaction pool
+    /// (default: 1000)
+    #[arg(long, value_name = "MILLISECONDS", default_value = "1000")]
+    pub zero_gas_tx_pool_timeout: u64,
 }