From 6bb8e0adee93bb6eec2cf51dbb7610c1557abc3d Mon Sep 17 00:00:00 2001 From: teor Date: Thu, 31 Aug 2023 10:52:04 +1000 Subject: [PATCH] Fix RPC comments --- zebra-rpc/src/methods.rs | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/zebra-rpc/src/methods.rs b/zebra-rpc/src/methods.rs index f53fecd06..647d24fd6 100644 --- a/zebra-rpc/src/methods.rs +++ b/zebra-rpc/src/methods.rs @@ -180,7 +180,7 @@ pub trait Rpc { #[rpc(name = "z_gettreestate")] fn z_get_treestate(&self, hash_or_height: String) -> BoxFuture>; - /// Returns information about a range of Sapling & Orchard subtrees. + /// Returns information about a range of Sapling or Orchard subtrees. /// /// zcashd reference: [`z_getsubtreesbyindex`](https://zcash.github.io/rpc/z_getsubtreesbyindex.html) /// @@ -194,8 +194,9 @@ pub trait Rpc { /// # Notes /// /// While Zebra is doing its initial subtree index rebuild, subtrees will become available - /// starting at the chain tip. This RPC will return an error if the `start_index` subtree - /// exists, but has not been rebuilt yet. + /// starting at the chain tip. This RPC will return an empty list if the `start_index` subtree + /// exists, but has not been rebuilt yet. This matches `zcashd`'s behaviour when subtrees aren't + /// available yet. (But `zcashd` does its rebuild before syncing any blocks.) #[rpc(name = "z_getsubtreesbyindex")] fn z_get_subtrees_by_index( &self,