monero-project / monero-site

https://getmonero.org
BSD 3-Clause "New" or "Revised" License
287 stars 391 forks source link

generateblocks is missing in daemon RPC documentation #2026

Closed dimalinux closed 1 year ago

dimalinux commented 2 years ago

Developers need to test their code and generateblocks is quite handy. I've used it a lot, but still could use the guide entry so I could finally learn what the prev_block and starting_nonce input values are used for.

Where it is missing: https://github.com/monero-project/monero-site/blob/master/resources/developer-guides/daemon-rpc.md

C++ reference: https://github.com/monero-project/monero/blob/v0.18.1.0/src/rpc/core_rpc_server_commands_defs.h#L1076-L1107

Example Use:

Start monerod in test mode:

monerod --detach --regtest --offline --fixed-difficulty=1 --rpc-bind-ip 127.0.0.1 --rpc-bind-port 18081

Request:

curl http://127.0.0.1:18081/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"generateblocks","params":{
"amount_of_blocks":1,
"wallet_address":"42eTJxqsYwsSpFCRUp19vPAXNruqAUqnFMY2XN198643Ukrera958dY4qbRdoaoCVffhbC7ro4nzVBMw1E8ip7LAKG3SrsU"}' -H 'Content-Type: application/json'

Response:

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "blocks": ["49b712db7760e3728586f8434ee8bc8d7b3d410dac6bb6e98bf5845c83b917e4"],
    "height": 9783,
    "status": "OK",
    "untrusted": false
  }
}