Improve the code based on feedback

nervosnetwork · Sep 7, 2023 · 8a0ed56 · 8a0ed56
1 parent 0cca328
commit 8a0ed56
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 11 deletions.
diff --git a/rpc/README.md b/rpc/README.md
@@ -3220,9 +3220,7 @@ Response
     * `num_epochs`: [`EpochNumberWithFraction`](#type-epochnumberwithfraction)
 * result: [`EpochNumberWithFraction`](#type-epochnumberwithfraction)
 
-Generate epochs during development, can be useful for scenarios
-
-like testing DAO-related functionalities.
+Generate epochs during development, can be useful for scenarios like testing DAO-related functionalities.
 
 Returns the updated epoch number after generating the specified number of epochs.
 
@@ -3234,7 +3232,7 @@ Returns the updated epoch number after generating the specified number of epochs
 
 Request
 
-generating 2 epochs:
+Generating 2 epochs:
 
 
 ```
@@ -3247,7 +3245,9 @@ generating 2 epochs:
 ```
 
 
-generating 1/2 epoch:
+The input parameter “0x2” will be normalized to “0x10000000002”(the correct [`EpochNumberWithFraction`](#type-epochnumberwithfraction) type) within the method. Therefore, if you want to generate epochs as integers, you can simply pass an integer as long as it does not exceed 16777215 (24 bits).
+
+Generating 1/2 epoch:
 
 
 ```

diff --git a/rpc/src/module/test.rs b/rpc/src/module/test.rs
@@ -171,7 +171,6 @@ pub trait IntegrationTestRpc {
     fn generate_block(&self) -> Result<H256>;
 
     /// Generate epochs during development, can be useful for scenarios
-    ///
     /// like testing DAO-related functionalities.
     ///
     /// Returns the updated epoch number after generating the specified number of epochs.
@@ -184,7 +183,7 @@ pub trait IntegrationTestRpc {
     ///
     /// Request
     ///
-    /// generating 2 epochs:
+    /// Generating 2 epochs:
     ///
     /// ```json
     /// {
@@ -195,7 +194,12 @@ pub trait IntegrationTestRpc {
     /// }
     /// ```
     ///
-    /// generating 1/2 epoch:
+    /// The input parameter "0x2" will be normalized to "0x10000000002"(the correct
+    /// [`EpochNumberWithFraction`](#type-epochnumberwithfraction) type) within the method.
+    /// Therefore, if you want to generate epochs as integers, you can simply pass an integer
+    /// as long as it does not exceed 16777215 (24 bits).
+    ///
+    /// Generating 1/2 epoch:
     ///
     /// ```text
     /// {

diff --git a/rpc/src/tests/module/test.rs b/rpc/src/tests/module/test.rs
@@ -5,7 +5,6 @@ use ckb_store::ChainStore;
 use ckb_test_chain_utils::always_success_consensus;
 use ckb_types::{
     core::{Capacity, EpochNumberWithFraction},
-    prelude::Unpack,
     utilities::DIFF_TWO,
 };
 
@@ -40,6 +39,10 @@ fn test_generate_epochs() {
         method: "generate_epochs".to_string(),
         params: vec!["0x10000000001".into()],
     });
+    assert_eq!(
+        "0x10000000001".to_string(),
+        Into::<ckb_jsonrpc_types::Uint64>::into(EpochNumberWithFraction::new(1, 0, 1)).to_string(),
+    );
     assert_eq!(
         get_current_epoch(&suite),
         EpochNumberWithFraction::new(2, 20, GENESIS_EPOCH_LENGTH)
@@ -104,9 +107,9 @@ fn setup_rpc() -> RpcTestSuite {
 
 fn get_current_epoch(suite: &RpcTestSuite) -> EpochNumberWithFraction {
     let store = suite.shared.store();
-    let tip_block_number = store.get_tip_header().unwrap().data().raw().number();
+    let tip_block_number = store.get_tip_header().unwrap().number();
     store
         .get_current_epoch_ext()
         .unwrap()
-        .number_with_fraction(tip_block_number.unpack())
+        .number_with_fraction(tip_block_number)
 }