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

daemon-rpc: expand documentation for get_output_distribution #2320

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

daemon-rpc: expand documentation for get_output_distribution #2320

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 7 additions & 5 deletions resources/developer-guides/daemon-rpc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1472,24 +1472,26 @@ $ curl http://127.0.0.1:18081/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"g

### **get_output_distribution**

Get the number of transaction outputs per-block for given cleartext amounts (0 meaning RingCT) within a specified range.

If the distribution is "cumulative", then each value in the array represents the number of transaction outputs in that block plus all total outputs of that amount before that block.

Alias: *None*.

Inputs:

* *amounts* - array of unsigned int; amounts to look for
* *amounts* - array of unsigned int; cleartext amounts to look for (0 gets all RingCT outputs)
* *cumulative* - boolean; (optional, default is `false`) States if the result should be cumulative (`true`) or not (`false`)
* *from_height* - unsigned int; (optional, default is 0) starting height to check from
* *to_height* - unsigned int; (optional, default is 0) ending height to check up to
* *from_height* - unsigned int; (optional, default is 0) Starting height to check from, inclusive
* *to_height* - unsigned int; (optional, default is 0) Ending height to check up to, inclusive. Set to 0 to get entire chain after *from_height*

Outputs:

* *distributions* - array of structure distribution as follows:
* *amount* - unsigned int
* *base* - unsigned int
* *base* - unsigned int; The total number of outputs of *amount* in the chain before, not including, the block at *start_height*
* *distribution* - array of unsigned int
* *start_height* - unsigned int
* *start_height* - unsigned int; Note that this is not necessarily equal to *from_height*, especially for *amount*=`0` where *start_height* will be no less than the height of the v4 hardfork
* *status* - string; General RPC error code. "OK" means everything looks good.

Example:
Expand Down
Loading