daemon-rpc: incorrect doc fixes #2337
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
✅ 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. |
25 tasks
nahuhh
reviewed
Aug 10, 2024
| @@ -604,7 +604,7 @@ Outputs: | |||
| * *view_tag* - The 1st byte of a shared secret (used for reducing synchronization time) | |||
| * *extra* - Usually called the "transaction ID" but can be used to include any random 32 byte/64 character hex string. | |||
| * *rct_signatures* - Contain signatures of tx signers. Coinbased txs do not have signatures. | |||
| * *tx_hashes* - List of hashes of non-coinbase transactions in the block. If there are no other transactions, this will be an empty list. | |||
| * *tx_hashes* - List of hashes of non-coinbase transactions in the block. If there are no transactions, this field not not be present. | |||
There was a problem hiding this comment.
Suggested change
| * *tx_hashes* - List of hashes of non-coinbase transactions in the block. If there are no transactions, this field not not be present. | |
| * *tx_hashes* - List of hashes of non-coinbase transactions in the block. If there are no transactions, this field will not be present. |
| @@ -1887,7 +1887,6 @@ Inputs: | |||
| Outputs: | |||
|
|
|||
| * *outs* - array of structure *outkey* as follows: | |||
| * *amount* - unsigned int; | |||
There was a problem hiding this comment.
Is this here for backward compatibility? (from when amounts were public)
There was a problem hiding this comment.
iirc we have a few instances of supporting backward compatibility for devs experimenting at different points of the blockchain
There was a problem hiding this comment.
I mean: it shouldn't be removed if its still needed for older parts of the bc
There was a problem hiding this comment.
a quick search returned amount being added in a related (but not exact) field monero-project/monero@11dc091#diff-da6ab0aecdf9547f57bb822783cae11fcfbaf7a2eae0d9cb5dbb69c8fc3b660aR282
| * *bg_min_idle_seconds* - unsigned int; Minimum lookback interval in seconds for determining whether the device is idle or not. | ||
| * *bg_target* - unsigned int; Maximum percentage cpu use by miner. | ||
| * *block_reward* - unsigned int; Base block reward for the next block to be mined. | ||
| * *block_target* - unsigned int; The target number of seconds between blocks. | ||
| * *difficulty* - unsigned int; Network difficulty (analogous to the strength of the network) |
There was a problem hiding this comment.
Suggested change
| * *difficulty* - unsigned int; Network difficulty (analogous to the strength of the network) | |
| * *difficulty* - unsigned int; Network difficulty (analogous to the strength of the network). |
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
Fixes incorrect documentation for daemon RPC calls; requires review into
monerod.Fixes
Table of fixes in this PR, originally tracked here: Cuprate/cuprate#159.
get_miner_datadifficultyfield is noted asunsigned int, although it is actually a JSON string containing an unsigned int in hex form. Other documentation describes these hex int strings asstring.calc_powblock_dataisblobdata. This is amonerod-specific type alias tostd::string. Documentation should explain that it is a hex-encoded string of a block./get_outs.binamount/send_raw_transactionnot_rct/mining_statusintinstead ofunsigned int. These areunsigned intboth in code and elsewhere in documentation./get_transaction_poolweightfield, should beunsigned int; <DESCRIPTION>flush_txpool""transaction in example causes errorget_blocktx_hashesfield: "If there are no other transactions, this will be an empty list." This is not true,monerod's serializer will omit fields completely if the container is empty. Thetx_hashesin thejsonfield will exist, however.Simple proof for
get_block:curl \ http://127.0.0.1:18081/json_rpc \ -d '{"jsonrpc":"2.0","id":"0","method":"get_block","params":{"height":0}}' \ -H 'Content-Type: application/json'