Generating

The following RPC calls interact with the komodod software, and are made available through the komodo-cli software.

generate

generate numblocks

::: tip This function can only be used in the regtest mode (for testing purposes). :::

The generate method instructs the coin daemon to immediately mine the indicated number of blocks.

Arguments

Name	Type	Description
numblocks	(numeric)	the desired number of blocks to generate

Response

Name	Type	Description
blockhashes	(array)	hashes of blocks generated

📌 Examples

Command:

./komodo-cli generate 2

[
  "0475316d63fe48bb9d58373595cb334fc2553f65496edfb2fb17b9ed06f4c480",
  "00d29a2b7dec52baa9ab8e4264363f32b4989eef7dbb0a9932fbc11274195b5a"
]

getgenerate

getgenerate

The getgenerate method returns a boolean value indicating the server's mining status.

The default value is false.

::: tip See also gen. :::

Arguments

Name	Type	Description
(none)	(none)

Response

Name	Type	Description
true/false	(boolean)	indicates whether the server is set to generate coins

📌 Examples

Command:

./komodo-cli getgenerate

false

You can find your rpcuser, rpcpassword, and rpcport in the coin's .conf file.

Command:

curl --user $rpcuser:$rpcpassword --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getgenerate", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:$rpcport/

{
  "result": false,
  "error": null,
  "id": "curltest"
}

setgenerate

setgenerate generate ( genproclimit )

The setgenerate method allows the user to set the generate property in the coin daemon to true or false, thus turning generation (mining/staking) on or off.

Generation is limited to genproclimit processors. Set genproclimit to -1 to use maximum available processors.

::: tip See also the getgenerate method to query the current setting, and genproclimit for setting the default number of processors the daemon uses through the .conf file. :::

Arguments

Name	Type	Description
generate	(boolean, required)	set to true to turn on generation; set to off to turn off generation
genproclimit	(numeric, optional)	set the processor limit for when generation is on; use value "-1" for unlimited

Response

Name	Type	Description
(none)	(none)

📌 Examples

Activate mining with maximum available processors

Command:

./komodo-cli setgenerate true -1

(none)

Activate staking

Command:

./komodo-cli setgenerate true 0

(none)

Activate mining with 4 threads

Command:

./komodo-cli setgenerate true 4

(none)

Check the setting

Command:

./komodo-cli getgenerate

true

Turn off generation

Command:

./komodo-cli setgenerate false

(none)

Turning the setting on via json RPC

Command:

curl --user $rpcuser:$rpcpassword --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "setgenerate", "params": [true, 1] }' -H 'content-type: text/plain;' http://127.0.0.1:$rpcport/

{
  "result": null,
  "error": null,
  "id": "curltest"
}