Add optional parameter get_logs_filter_max_epoch_gap. (#1768)

* Add optional parameter `get_logs_filter_max_epoch_range`.

* Fix name.

Author: peilun-conflux

client/src/configuration.rs

@@ -229,6 +229,7 @@ build_config! {
         (enable_optimistic_execution, (bool), true)
         (future_block_buffer_capacity, (usize), 32768)
         (get_logs_filter_max_limit, (Option<usize>), None)
+        (get_logs_filter_max_epoch_range, (Option<u64>), None)
         (get_logs_epoch_batch_size, (usize), 32)
         (max_trans_count_received_in_catch_up, (u64), 60_000)
         (persist_tx_index, (bool), false)
@@ -443,6 +444,7 @@ impl Configuration {
             transaction_epoch_bound: self.raw_conf.transaction_epoch_bound,
             referee_bound: self.raw_conf.referee_bound,
             get_logs_epoch_batch_size: self.raw_conf.get_logs_epoch_batch_size,
+            get_logs_filter_max_epoch_range: self.raw_conf.get_logs_filter_max_epoch_range
         }
     }
 

core/src/consensus/mod.rs

@@ -95,6 +95,7 @@ pub struct ConsensusConfig {
     /// Larger batch sizes may improve performance but might also prevent
     /// consensus from making progress under high RPC load.
     pub get_logs_epoch_batch_size: usize,
+    pub get_logs_filter_max_epoch_range: Option<u64>,
 }
 
 #[derive(Debug)]
@@ -981,6 +982,17 @@ impl ConsensusGraph {
             });
         }
 
+        if let Some(max_gap) = self.config.get_logs_filter_max_epoch_range {
+            // The range includes both ends.
+            if to_epoch - from_epoch + 1 > max_gap {
+                return Err(FilterError::EpochNumberGapTooLarge {
+                    from_epoch,
+                    to_epoch,
+                    max_gap,
+                });
+            }
+        }
+
         return Ok((from_epoch..=to_epoch).rev());
     }
 

core/src/sync/utils.rs

@@ -207,6 +207,7 @@ pub fn initialize_synchronization_graph_with_data_manager(
             transaction_epoch_bound: TRANSACTION_DEFAULT_EPOCH_BOUND,
             referee_bound: REFEREE_DEFAULT_BOUND,
             get_logs_epoch_batch_size: 32,
+            get_logs_filter_max_epoch_range: None,
         },
         vm.clone(),
         txpool.clone(),

primitives/src/filter.rs

@@ -38,6 +38,12 @@ pub enum FilterError {
         max_epoch: u64,
     },
 
+    EpochNumberGapTooLarge {
+        from_epoch: u64,
+        to_epoch: u64,
+        max_gap: u64,
+    },
+
     /// Roots for verifying the requested epochs are unavailable.
     UnableToVerify {
         epoch: u64,
@@ -89,6 +95,17 @@ impl fmt::Display for FilterError {
                 "Filter to_epoch is larger than the current best_epoch (to: {}, max: {})",
                 to_epoch, max_epoch,
             },
+            EpochNumberGapTooLarge {
+                from_epoch,
+                to_epoch,
+                max_gap,
+            } => {
+                format! {
+                    "The gap between from_epoch and to_epoch is larger than max_gap \
+                    (from: {}, to: {}, max_gap: {})",
+                    from_epoch, to_epoch, max_gap
+                }
+            }
             UnableToVerify {
                 epoch,
                 latest_verifiable,

run/default.toml

@@ -421,6 +421,12 @@ jsonrpc_local_http_port=12539
 #
 # get_logs_epoch_batch_size = 32
 
+# The maximal allowed number of epochs between `from_epoch` and `to_epoch` in the filter to call `cfx_getLogs`.
+# If not set, there is no limit on the gap.
+# By default it is not set.
+#
+# get_logs_filter_max_epoch_range = 10000
+
 # Maximum number of transactions allowed for peers to send to a catch-up node.
 #
 # max_trans_count_received_in_catch_up = 60_000

src/cli.yaml

@@ -163,6 +163,11 @@ args:
         long: get-logs-epoch-batch-size
         value_name: SIZE
         takes_value: true
+    - get-logs-filter-max-epoch-range:
+          help: Sets the maximum number of allowed epochs during log filtering.
+          long: get-logs-filter-max-epoch-range
+          value_name: SIZE
+          takes_value: true
     - account-provider-refresh-time-ms:
         help: Sets the time after which accounts are re-read from disk.
         long: account-provider-refresh-time-ms

tests/log_filtering_test.py

@@ -215,6 +215,15 @@ def run_test(self):
             assert_equal(logs[ii]["topics"][1], self.address_to_topic(sender))
             assert_equal(logs[ii]["topics"][2], self.number_to_topic(NUM_CALLS // 2 + ii))
 
+        # get-logs-filter-max-epoch-range should limit the number of epochs queried.
+        self.stop_node(0)
+        self.start_node(0, ["--get-logs-filter-max-epoch-range", "16"])
+        filter = Filter(from_epoch="0x0", to_epoch="0x0f", topics=[BAR_TOPIC])
+        # should not raise error
+        self.rpc.get_logs(filter)
+        filter = Filter(from_epoch="0x0", to_epoch="0x10", topics=[BAR_TOPIC])
+        assert_raises_rpc_error(None, None, self.rpc.get_logs, filter)
+
         self.log.info("Pass")
 
     def address_to_topic(self, address):