change(rpc): Adds `getmininginfo`, `getnetworksolps` and `getnetworkhashps` methods #5808

arya2 · 2022-12-07T01:48:49Z

Motivation

We want to support the getnetworksolps, getnetworkhashps, and getmininginfo RPCs.

Solution

Adds a state request for getting the chain solution rate
- Sums up total work for a range of blocks
- Divides it by number of seconds elapsed between the first and last block in the range
Adds RPC getmininginfo, getnetworksolps and getnetworkhashps RPCs

Review

Part of regular scheduled work.

Reviewer Checklist

Will the PR name make sense to users?
- Does it need extra CHANGELOG info? (new features, breaking changes, large changes)
Are the PR labels correct?
Does the code do what the ticket and PR says?
How do you know it works? Does it have tests?

Follow Up Work

Populate other fields for the getmininginfo response

teor2345

Thanks, this looks great!

I can see some places where the argument handling and result format doesn't seem to match the RPC reference. But I understand the reference might be different from what zcashd actually does.

Can you document each new argument and field with its description from the reference, and document any changes from zcashd or special processing that we do?

I'd also like to see the manual test results from zcash-rpc-diff, that will show up any differences.

zebra-rpc/src/methods/get_block_template_rpcs.rs

zebra-state/src/request.rs

zebra-state/src/service.rs

zebra-rpc/src/methods/get_block_template_rpcs/types/get_mining_info.rs

zebra-state/src/service/read/difficulty.rs

codecov · 2022-12-07T03:56:51Z

Codecov Report

Merging #5808 (94db8f2) into main (678c519) will increase coverage by 0.07%.
The diff coverage is 25.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5808      +/-   ##
==========================================
+ Coverage   78.82%   78.90%   +0.07%     
==========================================
  Files         307      308       +1     
  Lines       38737    38685      -52     
==========================================
- Hits        30536    30523      -13     
+ Misses       8201     8162      -39

teor2345 · 2022-12-07T19:25:16Z

I did a zcash-rpc-diff, and it seemed to be the same, good work!

But since it's a manual test, we'll need to do it again before we merge.

- SolutionRate state request - getnetworksolps, getnetworkhashps, & getmininginfo RPCs - vectors tests

updates ReadRequest::SolutionRate doc link

moves snapshot tests up where it can use the populated state service

…r is not added to `total_work`

zebra-chain/src/work/difficulty.rs

zebra-rpc/src/methods/get_block_template_rpcs.rs

zebra-rpc/src/methods/tests/snapshot/snapshots/get_mining_info@mainnet_10.snap

zebra-rpc/src/methods/get_block_template_rpcs/types/get_mining_info.rs

teor2345 · 2022-12-08T02:00:06Z

It looks like we've hit a GitHub API rate limit, causing CI jobs across multiple PRs to fail:
https://github.com/ZcashFoundation/zebra/actions/runs/3644298974/jobs/6153406794#step:3:13

it should reset within an hour or so.

I'll ask Gustavo to look into this next week. But until then, please push your commits in batches, rather than one at a time. (Each push runs about 50 jobs.)

Adds "arbitrary_precision" feature to serde_json in zebra-rpc

arya2 · 2022-12-08T03:05:05Z

It looks like we've hit a GitHub API rate limit, causing CI jobs across multiple PRs to fail:
https://github.com/ZcashFoundation/zebra/actions/runs/3644298974/jobs/6153406794#step:3:13

it should reset within an hour or so.

I'll ask Gustavo to look into this next week. But until then, please push your commits in batches, rather than one at a time. (Each push runs about 50 jobs.)

🤦 Whoops. Okay, noted.

Response diffs:

WARNING: comparing RPC responses from different heights:
zcashd is at: 107837
zebrad is at: 1905342

Request: getnetworkhashps

Querying zebrad main chain at height >=1905342...
time: real 0m0.005s, user 0m0.002s, sys 0m0.000s

Querying zcashd main chain at height >=107837...
time: real 0m0.003s, user 0m0.003s, sys 0m0.000s

Response diff between zcashd and zebrad:
-12139905448
+56199849

WARNING: comparing RPC responses from different heights:
zcashd is at: 146135
zebrad is at: 1905349

Request:
getnetworksolps

Querying zebrad main chain at height >=1905349...
time: real 0m0.005s, user 0m0.002s, sys 0m0.000s

Querying zcashd main chain at height >=146135...
time: real 0m0.063s, user 0m0.003s, sys 0m0.000s

Response diff between zcashd and zebrad:
-12224410071
+201076157

WARNING: comparing RPC responses from different heights:
zcashd is at: 108810
zebrad is at: 1905347

Request: getmininginfo

Querying zebrad main chain at height >=1905347...
time: real 0m0.006s, user 0m0.003s, sys 0m0.000s

Querying zcashd main chain at height >=108810...
time: real 0m0.002s, user 0m0.002s, sys 0m0.000s

Response diff between zcashd and zebrad:
{
-  "networksolps": 12413336220,
-  "networkhashps": 12413336220,
+  "blocks": 108810,
+  "difficulty": 1348528.045183577,
+  "errors": "Your computer's date and time may be behind the rest of the network! If your clock is wrong Zcash will not work properly.",
+  "errorstimestamp": 1670465885,
+  "genproclimit": 1,
+  "localsolps": 0,
+  "networksolps": 81163088,
+  "networkhashps": 81163088,
+  "pooledtx": 0,
+  "testnet": false,
   "chain": "main",
-  "testnet": false
+  "generate": false
 }

I'll update these diffs when the zcashd node finishes syncing.

teor2345 · 2022-12-08T06:32:10Z

WARNING: comparing RPC responses from different heights:
zcashd is at: 107837
zebrad is at: 1905342

The different heights are going to make some fields different, even if the calculations in Zebra and zcashd are exactly the same.

Here it is with them both synced:

$ zcash-rpc-diff 28232 getnetworkhashps
Checking first node release info...
Checking second node release info...
Connected to zebrad (port 28232) and zcashd (zcash-cli zcash.conf port).

Checking zebrad network and tip height...
Checking zcashd network and tip height...

Request:
getnetworkhashps

Querying zebrad main chain at height >=1905507...

real    0m0.009s
user    0m0.003s
sys     0m0.004s

Querying zcashd main chain at height >=1905507...

real    0m0.007s
user    0m0.004s
sys     0m0.003s


Response diff between zebrad and zcashd:
RPC responses were identical

/run/user/1000/tmp.50psuVx1Eh.rpc-diff/zebrad-main-1905507-getnetworkhashps.json:
11061724042

$ zcash-rpc-diff 28232 getnetworksolps
Checking first node release info...
Checking second node release info...
Connected to zebrad (port 28232) and zcashd (zcash-cli zcash.conf port).

Checking zebrad network and tip height...
Checking zcashd network and tip height...

Request:
getnetworksolps

Querying zebrad main chain at height >=1905507...

real    0m0.009s
user    0m0.005s
sys     0m0.002s

Querying zcashd main chain at height >=1905507...

real    0m0.007s
user    0m0.004s
sys     0m0.003s


Response diff between zebrad and zcashd:
RPC responses were identical

/run/user/1000/tmp.Xn2Omwyuvf.rpc-diff/zebrad-main-1905507-getnetworksolps.json:
11061724042

$ zcash-rpc-diff 28232 getmininginfo
Checking first node release info...
Checking second node release info...
Connected to zebrad (port 28232) and zcashd (zcash-cli zcash.conf port).

Checking zebrad network and tip height...
Checking zcashd network and tip height...

Request:
getmininginfo

Querying zebrad main chain at height >=1905507...

real    0m0.009s
user    0m0.005s
sys     0m0.002s

Querying zcashd main chain at height >=1905507...

real    0m0.007s
user    0m0.004s
sys     0m0.003s


Response diff between zebrad and zcashd:
--- /run/user/1000/tmp.bzO2k7ujrN.rpc-diff/zebrad-main-1905507-getmininginfo.json       2022-12-08 16:30:55.620302894 +1000
+++ /run/user/1000/tmp.bzO2k7ujrN.rpc-diff/zcashd-main-1905507-getmininginfo.json       2022-12-08 16:30:55.628302836 +1000
@@ -1,6 +1,16 @@
 {
+  "blocks": 1905507,
+  "currentblocksize": 2128,
+  "currentblocktx": 1,
+  "difficulty": 97409482.22582503,
+  "errors": "",
+  "errorstimestamp": 1670481055,
+  "genproclimit": 0,
+  "localsolps": 0,
   "networksolps": 11061724042,
   "networkhashps": 11061724042,
+  "pooledtx": 7,
+  "testnet": false,
   "chain": "main",
-  "testnet": false
+  "generate": false
 }

In this last one, all the differences are due to extra fields (including the line deletion for the trailing comma).

Great work, thanks for making this all match up!

zebra-rpc/Cargo.toml

teor2345 · 2022-12-08T06:38:39Z

@Mergifyio refresh

mergify · 2022-12-08T06:38:59Z

refresh

✅ Pull request refreshed

arya2 · 2022-12-08T17:16:40Z

@Mergifyio refresh

mergify · 2022-12-08T17:17:20Z

refresh

✅ Pull request refreshed

arya2 added A-rust Area: Updates to Rust code P-Medium ⚡ A-rpc Area: Remote Procedure Call interfaces A-state Area: State / database changes labels Dec 7, 2022

arya2 self-assigned this Dec 7, 2022

github-actions bot added C-enhancement Category: This is an improvement C-feature Category: New features labels Dec 7, 2022

arya2 marked this pull request as ready for review December 7, 2022 02:33

arya2 requested a review from a team as a code owner December 7, 2022 02:33

arya2 requested review from dconnolly and removed request for a team December 7, 2022 02:33

teor2345 suggested changes Dec 7, 2022

View reviewed changes

arya2 added 7 commits December 7, 2022 18:57

adds type and stub

a3c62dc

adds:

4bedb5c

- SolutionRate state request - getnetworksolps, getnetworkhashps, & getmininginfo RPCs - vectors tests

adds snapshot tests

72326cd

updates ReadRequest::SolutionRate doc link

removes random slash in doc comment

2f5b76b

moves snapshot tests up where it can use the populated state service

adds snapshots

cef341b

updates doc comments

40f180a

applies num_blocks default in RPC instead of solution_rate

194ed46

arya2 removed the request for review from dconnolly December 8, 2022 00:23

adds # Correctness comment

e4833b4

arya2 force-pushed the getmininginfo branch from 443d1ed to cef341b Compare December 8, 2022 00:30

arya2 added 6 commits December 7, 2022 19:32

Add testnet field to getmininginfo response

190b622

use PartialCumulativeWork instead of u128

f90ede8

document why solution_rate takes an extra block

333ef9e

add comment explaining why the work for the last block in the iterato…

51a66f0

…r is not added to `total_work`

use as_u128 method instead of deref for PartialCumulativeWork

814ce64

Updates chain field of getmininginfo response

6e94c14