add comments for min_rbf_rate

nervosnetwork · Jul 26, 2023 · feb4728 · feb4728
1 parent e1904d9
commit feb4728
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 1 deletion.
diff --git a/resource/ckb.toml b/resource/ckb.toml
@@ -134,6 +134,7 @@ enable_deprecated_rpc = false # {{
 [tx_pool]
 max_tx_pool_size = 180_000_000 # 180mb
 min_fee_rate = 1_000 # Here fee_rate are calculated directly using size in units of shannons/KB
+# min_rbf_rate > min_fee_rate means RBF is enabled
 min_rbf_rate = 1_500 # Here fee_rate are calculated directly using size in units of shannons/KB
 max_tx_verify_cycles = 70_000_000
 max_ancestors_count = 25

diff --git a/rpc/README.md b/rpc/README.md
@@ -7039,7 +7039,7 @@ Transaction pool information.
 
     The unit is Shannons per 1000 bytes transaction serialization size in the block.
 
-*   `min_rbf_rate`: [`Uint64`](#type-uint64) - RBF rate threshold. The pool reject to replace for transactions which fee rate is below this threshold.
+*   `min_rbf_rate`: [`Uint64`](#type-uint64) - RBF rate threshold. The pool reject to replace for transactions which fee rate is below this threshold. if min_rbf_rate > min_fee_rate then RBF is enabled on the node.
 
     The unit is Shannons per 1000 bytes transaction serialization size in the block.
 

diff --git a/util/jsonrpc-types/src/pool.rs b/util/jsonrpc-types/src/pool.rs
@@ -41,6 +41,7 @@ pub struct TxPoolInfo {
     /// The unit is Shannons per 1000 bytes transaction serialization size in the block.
     pub min_fee_rate: Uint64,
     /// RBF rate threshold. The pool reject to replace for transactions which fee rate is below this threshold.
+    /// if min_rbf_rate > min_fee_rate then RBF is enabled on the node.
     ///
     /// The unit is Shannons per 1000 bytes transaction serialization size in the block.
     pub min_rbf_rate: Uint64,

diff --git a/util/types/src/core/tx_pool.rs b/util/types/src/core/tx_pool.rs
@@ -321,6 +321,7 @@ pub struct TxPoolInfo {
     pub min_fee_rate: FeeRate,
 
     /// Min RBF rate threshold. The pool reject RBF transactions which fee rate is below this threshold.
+    /// if min_rbf_rate > min_fee_rate then RBF is enabled on the node.
     ///
     /// The unit is Shannons per 1000 bytes transaction serialization size in the block.
     pub min_rbf_rate: FeeRate,