daemon-rpc: doc undocumented fields #2340
Open
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
25 tasks
✅ Deploy Preview for barolo-time-757cf9 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
FYI migrating docs elsewhere is considered |
|
lgtm |
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.
What
Adds documentation for undocumented request/response fields within daemon RPC calls; requires review into
monerod.Some of these are lacking descriptions as I'm not sure what the behavior is for some of the fields. I will know after Cuprate/cuprate#244 and may add more docs then.
Fixes
Table of fixes in this PR, originally tracked here: Cuprate/cuprate#159.
Request fields
These endpoints/methods have undocumented request fields.
get_block_header_by_hashhashes. This field lets you specify multiple block hashes.hard_fork_infoversion. This field lets you specify which hardfork info to retrieve.get_output_distributiontop_hash,credits/get_blocks.binrequested_info,no_miner_tx,pool_info_since/send_raw_transactiondo_sanity_checks/get_peer_listpublic_only,include_blocked/out_peerssetResponse fields
These endpoints/methods have undocumented response fields.
get_block_header_by_hashblock_headers. This method will return ablock_headerANDblock_headersif the request only provided ahashes. Theblock_headerstruct is a bunch of default values (0, "", false).get_block_header_by_heighttop_hash,creditsget_output_distributionstruct output_distribution:cumulativeget_connectionsstruct connection_info:address_type,rpc_port,rpc_credits_per_hash,pruning_seedset_bansuntrustedget_versioncurrent_height,hard_forks,target_heightsync_infountrustedget_txpool_backlogblob_size->weightget_output_distributiontop_hash,creditsadd_aux_powstatus,untrusted/get_blocks.bindaemon_time,credits,top_hash/get_blocks_by_height.bincredits,top_hash/get_hashes_fast.bincredits,top_hash/get_o_indexes.bincredits,top_hash/get_transactionscredits,confirmations/send_raw_transactionnonzero_unlock_time,sanity_check_failed,too_few_outputs,tx_extra_too_big/get_peer_listuntrusted/stop_daemonuntrustedsubmit_blockblock_id,status,untrustedOther
The
get_output_distributionmethod has 2 undocumented fields,binaryandcompress. The current documentation is also incorrect as the output is not an array ofdistributionJSON objects, but rather, either raw binary or a JSON byte array. This may change with monero-project/monero#9422 so it is not changed in this PR.