-
Notifications
You must be signed in to change notification settings - Fork 392
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.
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
daemon-rpc: incorrect doc fixes #2337
base: master
Are you sure you want to change the base?
Conversation
✅ 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. |
@@ -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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* *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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this here for backward compatibility? (from when amounts were public)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I mean: it shouldn't be removed if its still needed for older parts of the bc
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a quick search returned amount being added in a related (but not exact) field monero-project/monero@11dc091#diff-da6ab0aecdf9547f57bb822783cae11fcfbaf7a2eae0d9cb5dbb69c8fc3b660aR282
- and not existing there currently https://github.com/monero-project/monero/blob/cc73fe71162d564ffda8e549b79a350bca53c454/src/rpc/core_rpc_server_commands_defs.h#L567
* *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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* *difficulty* - unsigned int; Network difficulty (analogous to the strength of the network) | |
* *difficulty* - unsigned int; Network difficulty (analogous to the strength of the network). |
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_data
difficulty
field 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_pow
block_data
isblobdata
. This is amonerod
-specific type alias tostd::string
. Documentation should explain that it is a hex-encoded string of a block./get_outs.bin
amount
/send_raw_transaction
not_rct
/mining_status
int
instead ofunsigned int
. These areunsigned int
both in code and elsewhere in documentation./get_transaction_pool
weight
field, should beunsigned int; <DESCRIPTION>
flush_txpool
""
transaction in example causes errorget_block
tx_hashes
field: "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_hashes
in thejson
field will exist, however.Simple proof for
get_block
: