Merge pull request #4210 from eval-exec/exec/get-cells-rpc-doc

Add doc for `get_transactions` and `get_cells` RPC
nervosnetwork · Nov 1, 2023 · a888c13 · a888c13
2 parents 4da2083 + 185a406
commit a888c13
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/rpc/README.md b/rpc/README.md
@@ -2183,6 +2183,8 @@ Returns the live cells collection by the lock or type script.
 
 ###### Returns
 
+If the number of objects is less than the requested `limit`, it indicates that these are the last page of get_cells.
+
 *   objects:
     *   output: the fields of an output cell
 
@@ -2560,6 +2562,8 @@ Returns the transactions collection by the lock or type script.
 
 ###### Returns
 
+If the number of objects is less than the requested `limit`, it indicates that these are the last page of get_transactions.
+
 *   objects - enum, ungrouped TxWithCell | grouped TxWithCells
     *   TxWithCell:
         *   tx_hash: transaction hash,

diff --git a/rpc/src/module/indexer.rs b/rpc/src/module/indexer.rs
@@ -63,6 +63,8 @@ pub trait IndexerRpc {
     ///
     /// ## Returns
     ///
+    /// If the number of objects is less than the requested `limit`, it indicates that these are the last page of get_cells.
+    ///
     /// * objects:
     ///     - output: the fields of an output cell
     ///     - output_data: the cell data
@@ -409,6 +411,9 @@ pub trait IndexerRpc {
     /// * after: pagination parameter, optional
     ///
     /// ## Returns
+    ///
+    /// If the number of objects is less than the requested `limit`, it indicates that these are the last page of get_transactions.
+    ///
     ///  * objects - enum, ungrouped TxWithCell | grouped TxWithCells
     ///     - TxWithCell:
     ///         - tx_hash: transaction hash,