Add rpc docs about shielded-only stats

5 years ago · 55258a54dc
1 changed files with 8 additions and 0 deletions
--- a/src/rpc/blockchain.cpp
+++ b/src/rpc/blockchain.cpp
@ -1916,6 +1916,14 @@ UniValue getchaintxstats(const UniValue& params, bool fHelp, const CPubKey& mypk
            "  \"window_deshielding_payments\": xxxxx,    (numeric) The total number of deshielding (containing a zaddr input) payments in the chain up to that point.\n"
            "  \"window_fully_shielded_payments\": xxxxx, (numeric) The total number of z2z, AKA fully-shielded (containing only zaddr inputs+outputs) payments in the chain up to that point.\n"
            "  \"txrate\": x.xx,                          (numeric) The average rate of transactions per second in the window. Only returned if \"window_interval\" is > 0.\n"
+            "  \"shielded\": {                            (string)  The set of stats specific to only shieled transactions. \n"
+            "      \"fully_shielded_tx_percent\":         (numeric) The percentage of fully shielded transactions.\n"
+            "      \"shielding_tx_percent\":              (numeric) The percentage of shielding transactions.\n"
+            "      \"deshielding_tx_percent\":            (numeric) The percentage of deshielding transactions.\n"
+            "      \"fully_shielded_payments_percent\":   (numeric) The percentage of fully shielded payments.\n"
+            "      \"shielding_payments_percent\":        (numeric) The percentage of shielding payments.\n"
+            "      \"deshielding_payments_percent\":      (numeric) The percentage of deshielding payments.\n"
+            "  },\n"
            "}\n"
            "\nExamples:\n"
            + HelpExampleCli("getchaintxstats", "")