rpcserver: Update gettxout params and result. #2517
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Upcoming changes constitute breaking public API changes to the rpc/jsonrpc/types module, therefore, this follows the process for introducing major API breaks which consists of: - Bump the major version in the go.mod of the affected module if not already done since the last release tag - Add a replacement to the go.mod in the main module if not already done since the last release tag - Update all imports in the repo to use the new major version as necessary - Make necessary modifications to allow all other modules to use the new version in the same commit - Repeat the process for any other modules the require a new major as a result of consuming the new major(s)
This removes version from the gettxout result, since upcoming changes will be modifying utxo entries to no longer store the tx version.
davecgh
reviewed
Dec 23, 2020
This adds a required tree parameter to gettxout, since upcoming changes will be modifying utxo entries to be keyed by an outpoint which includes the txhash, index, and tree. For any case where the tree is unknown it will now be expected that the caller would have to check both trees by calling gettxout for each tree.
rstaudt2
force-pushed
the
gettxout-updates
branch
from
2837b65
to
ac28957
Compare
davecgh
approved these changes
Dec 23, 2020
davecgh
added
the
rpc server api change
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This requires #2516.
This updates the
gettxoutcall to add a requiredtreeparameter and removeversionfrom the result. The changes include:rpc/jsonrpc/types.versionfrom thegettxoutresult.treeparam togettxout.txhash,index, andtree, which brought up the question of whether we want the server to check both trees ingettxout(as it does today) or require the client to pass thetree.treeshould be known to the caller most of the time, and in the case where it is not,gettxoutcan be called with each tree to check both trees, so we will require thetreeparam.Note: If testing with
dcrctl, you'll want to add a replace directive to use the updated types module:go mod edit -replace=github.com/decred/dcrd/rpc/jsonrpc/types/v2=../dcrd/rpc/jsonrpc/types