Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

rpc: Add PoWHash to getblockverbose result. #3154

Merged
merged 3 commits into from
Jul 19, 2023
Merged

rpc: Add PoWHash to getblockverbose result. #3154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ec0d5d1
jsonrpc/types: Add powhash to verbose block output.
chappjc Jul 18, 2023
ec33d6e
rpc: Add PoWHash to getblock/getblockheader (verbose) results.
chappjc Jul 18, 2023
75d0b8e
docs: Update JSON-RPC API for powhash.
chappjc Jul 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/json_rpc_api.mediawiki
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -989,6 +989,7 @@ of the best block.
|
<code>(json object)</code>
: <code>hash</code>: <code>(string)</code> the hash of the block (same as provided).
: <code>powhash</code>: <code>(string)</code> the Proof-of-Work hash of the block (same as hash prior to DCP0011 activation).
: <code>confirmations</code>: <code>(numeric)</code> the number of confirmations.
: <code>size</code>: <code>(numeric)</code> the size of the block.
: <code>height</code>: <code>(numeric)</code> the height of the block in the block chain.
Expand All @@ -1015,7 +1016,7 @@ of the best block.
: <code>previousblockhash</code>: <code>(string)</code> the hash of the previous block.
: <code>nextblockhash</code>: <code>(string)</code> the hash of the next block (only if there is one).

<code>{"hash": "blockhash", "confirmations": n, "size": n, "height": n, "version": n, "merkleroot": "hash", "stakeroot": "hash", "tx": ["transactionhash", ...], "stx": ["transactionhash", ...], "time": n, "nonce": n, "votebits": n, "finalstate": "state", "voters": n, "freshstake": n, "revocations": n, "poolsize": n, "bits": n, "sbits": n.nn, "difficulty": n.nn, "chainwork": "workhex", "extradata": "data", "stakeversion": n, previousblockhash": "hash", "nextblockhash": "hash"}</code>
<code>{"hash": "blockhash", "powhash": "hash", "confirmations": n, "size": n, "height": n, "version": n, "merkleroot": "hash", "stakeroot": "hash", "tx": ["transactionhash", ...], "stx": ["transactionhash", ...], "time": n, "nonce": n, "votebits": n, "finalstate": "state", "voters": n, "freshstake": n, "revocations": n, "poolsize": n, "bits": n, "sbits": n.nn, "difficulty": n.nn, "chainwork": "workhex", "extradata": "data", "stakeversion": n, previousblockhash": "hash", "nextblockhash": "hash"}</code>
|-
!Example Return (verbose=false)
|
Expand All @@ -1033,7 +1034,7 @@ of the best block.
: <code>0000000000000000ffffffff0800002f646372642f00"</code>
|-
!Example Return (verbose=true, verbosetx=false)
|<code>"hash": "000000000000c41019872ff7db8fd2e9bfa05f42d3f8fee8e895e8c1e5b8dcba", "confirmations": 283285,"size": 382, "height": 2, "version": 1, "merkleroot": "c867d085c96604812854399bf6df63d35d857484fedfd147759ed94c3cdeca35", "stakeroot": "000000000000000000000000000000000000000000000000000000000000000", tx": ["ba8d2fcb5c705a1e5cbeda0db9dd30a521e360efd3aef75e862b2b69e0a673af", ...], "time": 1454954624, "nonce": 837992634, "votebits": 1, "finalstate": "000000000000", "voters": 0, "freshstake": 0, "revocations": 0, "poolsize": 0, "bits": "1d00ffff", "sbits": 2, "difficulty": 32767.74999809, "chainwork": "00000000000000000000000000000000000000000000000000018000c0006000", "extradata": "c84e3a6b6ad536d3010000000000000000000000000000000000000000000000", "stakeversion": 0, "previousblockhash": "000000000000437482b6d47f82f374cde539440ddb108b0a76886f0d87d126b9", "nextblockhash": "00000000000108ac3e3f51a0f4424dd757a3b0485da0ec96592f637f27bd1cf5"}</code>
|<code>"hash": "000000000000c41019872ff7db8fd2e9bfa05f42d3f8fee8e895e8c1e5b8dcba", "powhash": "000000000000c41019872ff7db8fd2e9bfa05f42d3f8fee8e895e8c1e5b8dcba", "confirmations": 283285,"size": 382, "height": 2, "version": 1, "merkleroot": "c867d085c96604812854399bf6df63d35d857484fedfd147759ed94c3cdeca35", "stakeroot": "000000000000000000000000000000000000000000000000000000000000000", tx": ["ba8d2fcb5c705a1e5cbeda0db9dd30a521e360efd3aef75e862b2b69e0a673af", ...], "time": 1454954624, "nonce": 837992634, "votebits": 1, "finalstate": "000000000000", "voters": 0, "freshstake": 0, "revocations": 0, "poolsize": 0, "bits": "1d00ffff", "sbits": 2, "difficulty": 32767.74999809, "chainwork": "00000000000000000000000000000000000000000000000000018000c0006000", "extradata": "c84e3a6b6ad536d3010000000000000000000000000000000000000000000000", "stakeversion": 0, "previousblockhash": "000000000000437482b6d47f82f374cde539440ddb108b0a76886f0d87d126b9", "nextblockhash": "00000000000108ac3e3f51a0f4424dd757a3b0485da0ec96592f637f27bd1cf5"}</code>
|}

----
Expand Down Expand Up @@ -1136,6 +1137,7 @@ of the best block.
!Returns (verbose=true)
|<code>(json object)</code>
: <code>hash</code>: <code>(string)</code> the hash of the block (same as provided).
: <code>powhash</code>: <code>(string)</code> the Proof-of-Work hash of the block (same as hash prior to DCP0011 activation).
: <code>confirmations</code>: <code>(numeric)</code> the number of confirmations.
: <code>version</code>: <code>(numeric)</code> the block version.
: <code>merkleroot</code>: <code>(string)</code> root hash of the merkle tree.
Expand All @@ -1160,7 +1162,7 @@ of the best block.
: <code>previousblockhash</code>: <code>(string)</code> the hash of the previous block.
: <code>nextblockhash</code>: <code>(string)</code> the hash of the next block (only if there is one).

<code>{"hash": "blockhash", "confirmations": n, "version": n, "merkleroot": "hash", "stakeroot": "hash", "votebits": n, "finalstate": "state", "voters": n, "freshstake": n, "revocations": n, "poolsize": n, "bits": n, "sbits": n.nn, "height": n, "size": n, "time": n, "nonce": n, "extradata": "data", "stakeversion": n, "difficulty": n.nn, "chainwork": "workhex", "previousblockhash": "hash", "nextblockhash": "hash"}</code>
<code>{"hash": "blockhash", "powhash": "hash", "confirmations": n, "version": n, "merkleroot": "hash", "stakeroot": "hash", "votebits": n, "finalstate": "state", "voters": n, "freshstake": n, "revocations": n, "poolsize": n, "bits": n, "sbits": n.nn, "height": n, "size": n, "time": n, "nonce": n, "extradata": "data", "stakeversion": n, "difficulty": n.nn, "chainwork": "workhex", "previousblockhash": "hash", "nextblockhash": "hash"}</code>
|-
!Example Return (verbose=false)
|
Expand All @@ -1172,7 +1174,7 @@ of the best block.
: <code>360000000024680140d1ec18000000000000000000000000000000000000000000000000"</code>
|-
!Example Return (verbose=true)
|<code>{"hash": "00000000000004289d9a7b0f7a332fb60a1c221faae89a107ce3ab93eead2f93", "confirmations": 183291, "version": 1, "merkleroot": "2549a4ef697c4a5e067b752bc06a32e74e56e6eddc7a6cb3e299f072469d6b26", "stakeroot":"9f40e23afeb9645f3762170a4469c812f717c71aea543ed073af02968ecc5c82", "votebits": 1, "finalstate": "8b736885bab7", "voters": 5, "freshstake": 0, "revocations": 0, "poolsize": 42567, "bits": "1a1194b4", "sbits": 86.73331302, "height": 100000, "size": 3168, "time": 1484890112, "nonce": 59487578, "stakeversion": 0, "difficulty": 954273.50809769, "chainwork": "00000000000000000000000000000000000000000000001060ad4432c4d6eff1", "previousblockhash": "00000000000000dab92a8a0c0e706eb74115f0f373669c01ffb4882f9555f494", "nextblockhash": "0000000000000578b08f22fd2bdf5f7fe5b0af1bb4928de5053a3f906b3c8f6b"}</code>
|<code>{"hash": "00000000000004289d9a7b0f7a332fb60a1c221faae89a107ce3ab93eead2f93", "powhash": "00000000000004289d9a7b0f7a332fb60a1c221faae89a107ce3ab93eead2f93", "confirmations": 183291, "version": 1, "merkleroot": "2549a4ef697c4a5e067b752bc06a32e74e56e6eddc7a6cb3e299f072469d6b26", "stakeroot":"9f40e23afeb9645f3762170a4469c812f717c71aea543ed073af02968ecc5c82", "votebits": 1, "finalstate": "8b736885bab7", "voters": 5, "freshstake": 0, "revocations": 0, "poolsize": 42567, "bits": "1a1194b4", "sbits": 86.73331302, "height": 100000, "size": 3168, "time": 1484890112, "nonce": 59487578, "stakeversion": 0, "difficulty": 954273.50809769, "chainwork": "00000000000000000000000000000000000000000000001060ad4432c4d6eff1", "previousblockhash": "00000000000000dab92a8a0c0e706eb74115f0f373669c01ffb4882f9555f494", "nextblockhash": "0000000000000578b08f22fd2bdf5f7fe5b0af1bb4928de5053a3f906b3c8f6b"}</code>
|}

----
Expand Down
24 changes: 23 additions & 1 deletion internal/rpcserver/rpcserver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ import (
// API version constants
const (
jsonrpcSemverMajor = 8
jsonrpcSemverMinor = 0
jsonrpcSemverMinor = 1
jsonrpcSemverPatch = 0
)

Expand Down Expand Up @@ -1969,8 +1969,19 @@ func handleGetBlock(_ context.Context, s *Server, cmd interface{}) (interface{},
return nil, rpcInternalError(err.Error(), "Unable to retrieve median block time")
}

isBlake3PowActive, err := s.isBlake3PowAgendaActive(&blockHeader.PrevBlock)
if err != nil {
return nil, err
}
powHashFn := blockHeader.PowHashV1
if isBlake3PowActive {
powHashFn = blockHeader.PowHashV2
}
powHash := powHashFn()

blockReply := types.GetBlockVerboseResult{
Hash: c.Hash,
PoWHash: powHash.String(),
Version: blockHeader.Version,
MerkleRoot: blockHeader.MerkleRoot.String(),
StakeRoot: blockHeader.StakeRoot.String(),
Expand Down Expand Up @@ -2249,8 +2260,19 @@ func handleGetBlockHeader(_ context.Context, s *Server, cmd interface{}) (interf
return nil, rpcInternalError(err.Error(), "Unable to retrieve median block time")
}

isBlake3PowActive, err := s.isBlake3PowAgendaActive(&blockHeader.PrevBlock)
if err != nil {
return nil, err
}
powHashFn := blockHeader.PowHashV1
if isBlake3PowActive {
powHashFn = blockHeader.PowHashV2
}
powHash := powHashFn()

blockHeaderReply := types.GetBlockHeaderVerboseResult{
Hash: c.Hash,
PowHash: powHash.String(),
Confirmations: confirmations,
Version: blockHeader.Version,
MerkleRoot: blockHeader.MerkleRoot.String(),
Expand Down
6 changes: 6 additions & 0 deletions internal/rpcserver/rpcserverhandlers_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3763,6 +3763,8 @@ func TestHandleGetBlock(t *testing.T) {
blk := dcrutil.NewBlock(&block432100)
blkHash := blk.Hash()
blkHashString := blkHash.String()
powHash := blkHeader.PowHashV1() // pre-DCP0011 activation
powHashString := powHash.String()
blkBytes, err := blk.Bytes()
if err != nil {
t.Fatalf("error serializing block: %+v", err)
Expand Down Expand Up @@ -3827,6 +3829,7 @@ func TestHandleGetBlock(t *testing.T) {
}(),
result: types.GetBlockVerboseResult{
Hash: blkHashString,
PoWHash: powHashString,
Version: blkHeader.Version,
MerkleRoot: blkHeader.MerkleRoot.String(),
StakeRoot: blkHeader.StakeRoot.String(),
Expand Down Expand Up @@ -3882,6 +3885,7 @@ func TestHandleGetBlock(t *testing.T) {
}(),
result: types.GetBlockVerboseResult{
Hash: blkHashString,
PoWHash: powHashString,
Version: blkHeader.Version,
MerkleRoot: blkHeader.MerkleRoot.String(),
StakeRoot: blkHeader.StakeRoot.String(),
Expand Down Expand Up @@ -4032,6 +4036,7 @@ func TestHandleGetBlockHeader(t *testing.T) {
t.Fatalf("error serializing block header: %+v", err)
}
blkHeaderHexString := hex.EncodeToString(blkHeaderBytes)
powHashString := blkHeader.PowHashV1().String() // pre-DCP0011 block
blk := dcrutil.NewBlock(&block432100)
blkHash := blk.Hash()
blkHashString := blkHash.String()
Expand Down Expand Up @@ -4065,6 +4070,7 @@ func TestHandleGetBlockHeader(t *testing.T) {
}(),
result: types.GetBlockHeaderVerboseResult{
Hash: blkHashString,
PowHash: powHashString,
Confirmations: confirmations,
Version: blkHeader.Version,
MerkleRoot: blkHeader.MerkleRoot.String(),
Expand Down
4 changes: 3 additions & 1 deletion internal/rpcserver/rpcserverhelp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright (c) 2015 The btcsuite developers
// Copyright (c) 2015-2022 The Decred developers
// Copyright (c) 2015-2023 The Decred developers
// Use of this source code is governed by an ISC
// license that can be found in the LICENSE file.

Expand Down Expand Up @@ -276,6 +276,7 @@ var helpDescsEnUS = map[string]string{

// GetBlockVerboseResult help.
"getblockverboseresult-hash": "The hash of the block (same as provided)",
"getblockverboseresult-powhash": "The Proof-of-Work hash of the block (same as hash prior to DCP0011 activation)",
"getblockverboseresult-confirmations": "The number of confirmations",
"getblockverboseresult-size": "The size of the block",
"getblockverboseresult-height": "The height of the block in the block chain",
Expand Down Expand Up @@ -323,6 +324,7 @@ var helpDescsEnUS = map[string]string{

// GetBlockHeaderVerboseResult help.
"getblockheaderverboseresult-hash": "The hash of the block (same as provided)",
"getblockheaderverboseresult-powhash": "The Proof-of-Work hash of the block (same as hash prior to DCP0011 activation)",
"getblockheaderverboseresult-confirmations": "The number of confirmations",
"getblockheaderverboseresult-height": "The height of the block in the block chain",
"getblockheaderverboseresult-version": "The block version",
Expand Down
4 changes: 3 additions & 1 deletion rpc/jsonrpc/types/chainsvrresults.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright (c) 2014 The btcsuite developers
// Copyright (c) 2015-2022 The Decred developers
// Copyright (c) 2015-2023 The Decred developers
// Use of this source code is governed by an ISC
// license that can be found in the LICENSE file.

Expand Down Expand Up @@ -62,6 +62,7 @@ type GetAddedNodeInfoResult struct {
// hex-encoded string. Contains Decred additions.
type GetBlockVerboseResult struct {
Hash string `json:"hash"`
PoWHash string `json:"powhash"`
jrick marked this conversation as resolved.
Show resolved Hide resolved
davecgh marked this conversation as resolved.
Show resolved Hide resolved
Confirmations int64 `json:"confirmations"`
Size int32 `json:"size"`
Height int64 `json:"height"`
Expand Down Expand Up @@ -137,6 +138,7 @@ type GetBlockChainInfoResult struct {
// returns a hex-encoded string.
type GetBlockHeaderVerboseResult struct {
Hash string `json:"hash"`
PowHash string `json:"powhash"`
Confirmations int64 `json:"confirmations"`
Version int32 `json:"version"`
MerkleRoot string `json:"merkleroot"`
Expand Down