跳到主要内容

Daemon RPC

This document provides a comprehensive reference to Chia's Daemon RPC API.

Note about Windows command escaping

This document will use Linux/MacOS RPC syntax. When running rpc commands on Windows, you'll need to escape all quotes with backslashes.

For example, here is a typical RPC command on Linux and MacOS:

chia rpc daemon get_keys_for_plotting '{"fingerprints":[2104826454]}'

To run the same command on Windows, you need to escape the quotes with backslashes. In other words, add a \ before each double quote, such that:

"fingerprints" becomes \"fingerprints\" etc

wscat usage

This reference contains examples that make RPC calls directly from a terminal window on a running node.

You can also make the same RPC calls to the daemon over a websocket. To do this, first you will need to install wscat, for example by running:

npm install -g wscat

Once wscat is installed, you can open a connection to the daemon. The command to run depends on your OS:

Be sure to replace username with your actual username for both the .crt and .key file.

wscat -n --cert C:\Users\<username>\.chia\mainnet\config\ssl\daemon\private_daemon.crt --key C:\Users\<username>\.chia\mainnet\config\ssl\daemon\private_daemon.key -c wss://0.0.0.0:55400

Once connected, you will see a > prompt from wscat.

To submit a request, run something like the following command, which calls get_wallet_addresses, with request parameters contained inside the data parameter:

{"ack": false, "command": "get_wallet_addresses", "data": {"fingerprints":[2104826454], "index": 100, "count": 2}, "destination": "daemon", "origin": "whatever", "request_id": "also_whatever"}

Response:

{"ack": true, "command": "get_wallet_addresses", "data": {"success": true, "wallet_addresses": {"2104826454": [{"address": "xch12yjgrn6m4eyszt9e3v3thczn2d6jlzvh2zjhnp0ar4kxhll8942sqq4s93", "hd_path": "m/12381/8444/2/100"}, {"address": "xch12hqq8g35gprs5r4vz366sf4r0mcvpmcy28a4tcfyda75avur4sas5vzvuj", "hd_path": "m/12381/8444/2/101"}]}}, "destination": "whatever", "origin": "daemon", "request_id": "also_whatever"}

You can also use this websocket connection with the daemon to call RPCs on other services via the daemon. This is how the Chia GUI operates. It only has a websocket connection open to the daemon -- all other RPCs are dispatched by the daemon and routed back to the wallet_ui service (the service name for the Chia GUI).

To make this work, there's an extra step. You need to first call the register_service command to give your websocket connection a name.

For example, to register the websocket connect with the service name my_fancy_service, run:

{"ack": false, "command": "register_service", "data": {"service": "my_fancy_service"}, "destination": "daemon", "origin": "my_fancy_service", "request_id": "abc123"}

Response:

{"ack": true, "command": "register_service", "data": {"success": true}, "destination": "my_fancy_service", "origin": "daemon", "request_id": "abc123"}

At this point, you can call other service RPCs:

{"ack": false, "command": "get_blockchain_state", "data": {}, "destination": "chia_full_node", "origin": "my_fancy_service", "request_id": "def456"}

Response:

{"ack": true, "command": "get_blockchain_state", "data": {"blockchain_state": {"average_block_time": 18, "block_max_cost": 11000000000, "difficulty": 2528, "genesis_challenge_initialized": true, "mempool_cost": 129478906, "mempool_fees": 100000, "mempool_max_total_cost": 550000000000, "mempool_min_fees": {"cost_5000000": 0}, "mempool_size": 3, "node_id": "b3d9de85d29931c10050b56c7afb91c99141943fc81ff2d1a8425e52be0d08ab", "peak": {"challenge_block_info_hash": "0x5b489143d48665e38ea306b1998f2873a6caa9113dc7374b55c5b7c17cf24936", "challenge_vdf_output": {"data": "0x02007d3c3fe1a93f60c475d5627a78358eb704f14002fc1862ec9746793ae4f4416ddaac8fe09c5a7fdbb71432be9bfbb41c4b383754889a55ae9b4d12dab4dac920676e873d2785860b054a2a618d8ee07a866c6bebab1338fa419d3c6bcea4e9000201"}, "deficit": 0, "farmer_puzzle_hash": "0x780c9bf0c48ea993c59ed0fd7687417be48233d916827c63157bd6a867d930aa", "fees": null, "finished_challenge_slot_hashes": null, "finished_infused_challenge_slot_hashes": null, "finished_reward_slot_hashes": null, "header_hash": "0x76fdf9c8090985de6bb537ba4d429462dffc5673cfe963dbe5369e95661d6a7a", "height": 4154084, "infused_challenge_vdf_output": {"data": "0x0000ee9f4f1b5f8c5d4c56a0c8f4977a091aef061f190cac00d80ef449d9221f2c46c22dc5f7ba30f0f9eeef2ee68d347f1765c6e44101aa4fc33ae968698e997d0095c5ddd4bc5dcdc23b54dd909fac3d03285df19ebffc5a9ef2e5442935d302040500"}, "overflow": false, "pool_puzzle_hash": "0x95023147c517f9be14037dbbeb105adb48942e036e0df8ab2962d53800a4b925", "prev_hash": "0x2283b7875556deedbc4ca7a874476ae6930769c18a7f6e1b3bdb2c04b9a1a4ce", "prev_transaction_block_hash": null, "prev_transaction_block_height": 4154081, "required_iters": 1092462, "reward_claims_incorporated": null, "reward_infusion_new_challenge": "0xfffc3371c8521a13c97e75e0412186bb6e53424ef807272d6fdda5f57e591254", "signage_point_index": 25, "sub_epoch_summary_included": null, "sub_slot_iters": 147849216, "timestamp": null, "total_iters": 17563259743086, "weight": 8641556544}, "space": 33037817585788604416, "sub_slot_iters": 147849216, "sync": {"sync_mode": false, "sync_progress_height": 0, "sync_tip_height": 0, "synced": true}}, "success": true}, "destination": "my_fancy_service", "origin": "chia_full_node", "request_id": "def456"}

Note that if you skip the register_service step and attempt to make such a call, the call will go through, but you won't see the response.


Daemon Server RPCs

exit

Functionality: Stop the daemon and all of its running services

Usage: chia rpc daemon [OPTIONS] exit [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters: None

Example
chia rpc daemon exit

Response:

{
"services_stopped": [
"chia_wallet",
"chia_full_node",
"chia_farmer",
"chia_harvester"
],
"success": true
}

get_routes

Functionality: List all available Daemon RPC routes

Usage: chia rpc daemon [OPTIONS] get_routes [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters: None

Example
chia rpc daemon get_routes

Response:

{
"routes": [
"start_service",
"start_plotting",
"stop_plotting",
"stop_service",
"is_running",
"running_services",
"is_keyring_locked",
"keyring_status",
"unlock_keyring",
"validate_keyring_passphrase",
"set_keyring_passphrase",
"remove_keyring_passphrase",
"exit",
"register_service",
"get_status",
"get_version",
"get_plotters",
"get_routes",
"get_wallet_addresses",
"get_keys_for_plotting"
],
"success": true
}

get_status

Functionality: Show the status of the daemon

Usage: chia rpc daemon [OPTIONS] get_status [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters: None

Example
chia rpc daemon get_status

Response:

{
"genesis_initialized": true,
"success": true
}

get_version

Functionality: Show the version of the daemon

Usage: chia rpc daemon [OPTIONS] get_version [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters: None

Example
chia rpc daemon get_version

Response:

{
"success": true,
"version": "2.0.0"
}

get_wallet_addresses

Functionality: List one or more addresses from one or more keys

Usage: chia rpc daemon [OPTIONS] get_wallet_addresses [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
fingerprintsNUMBERFalseList the keys for the specified fingerprints only [Default: list keys for all fingerprints]
indexNUMBERFalseStarting index for addresses to list [Default: 0]
countNUMBERFalseNumber of addresses to list [Default: 1]
non_observer_derivationBOOLEANFalseSet to True to use non-observer derivation [Default: False]
Example 1: default

The default behavior is to show the first address for all fingerprints.

chia rpc daemon get_wallet_addresses

Response:

{
"success": true,
"wallet_addresses": {
"2104826454": [
{
"address": "xch1xdm7s8fq4kdrq28lulnhxcxq8h6gcsf0y5j643vqx4ec3z9dhq7sqxsa9j",
"hd_path": "m/12381/8444/2/0"
}
],
"3792481086": [
{
"address": "xch1a99ua7jp6kegtxm74yhk3ggttnat9kcjq8dtt7g2mlkd3rl9an9q5xgt35",
"hd_path": "m/12381/8444/2/0"
}
]
}
}
Example 2: custom

Show two addresses from one fingerprint, starting at index 100:

chia rpc daemon get_wallet_addresses '{"fingerprints":[2104826454], "index": 100, "count": 2}'

Response:

{
"success": true,
"wallet_addresses": {
"2104826454": [
{
"address": "xch12yjgrn6m4eyszt9e3v3thczn2d6jlzvh2zjhnp0ar4kxhll8942sqq4s93",
"hd_path": "m/12381/8444/2/100"
},
{
"address": "xch12hqq8g35gprs5r4vz366sf4r0mcvpmcy28a4tcfyda75avur4sas5vzvuj",
"hd_path": "m/12381/8444/2/101"
}
]
}
}

is_keyring_locked

Functionality: Show whether the keyring is locked

Usage: chia rpc daemon [OPTIONS] is_keyring_locked [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters: None

Example
chia rpc daemon is_keyring_locked

Response:

{
"is_keyring_locked": false,
"success": true
}

is_running

Functionality:

Usage: chia rpc daemon [OPTIONS] is_running [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
serviceSTRINGTRUEThe service to query; valid examples include, but are not limited to, "chia_data_layer", "chia_data_layer_http", "chia_wallet", "chia_full_node", "chia_harvester", "chia_farmer", "chia_introducer", "chia_timelord", "chia_timelord_launcher", "chia_full_node_simulator", "chia_seeder", "chia_crawler", "wallet_ui"
Example

Query whether the Chia wallet service is running:

chia rpc daemon is_running '{"service": "chia_wallet"}'

Response:

{
"is_running": true,
"service_name": "chia_wallet",
"success": true
}

keyring_status

Functionality: Show a snapshot of the keyring status

Usage: chia rpc daemon [OPTIONS] keyring_status [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters: None

Example
chia rpc daemon keyring_status

Response:

{
"can_save_passphrase": true,
"can_set_passphrase_hint": true,
"is_keyring_locked": false,
"passphrase_hint": "",
"passphrase_requirements": {
"is_optional": true,
"min_length": 8
},
"success": true,
"user_passphrase_is_set": true
}

register_service

Functionality: Register a service

Usage: chia rpc daemon [OPTIONS] register_service [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
serviceSTRINGTRUEThe name of the service to register
Example
chia rpc daemon register_service '{"service": "chia_wallet"}'

Response:

{
"success": true
}

remove_keyring_passphrase

Functionality: Remove a passphrase from the keyring

Usage: chia rpc daemon [OPTIONS] remove_keyring_passphrase [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
current_passphraseSTRINGTrueThe current passphrase; if entered correctly, it will be removed from the keyring
Example 1

Remove the real passphrase:

chia rpc daemon remove_keyring_passphrase '{"current_passphrase": "12345678"}'

Response:

{
"error": null,
"success": true
}
Example 2

Attempt to remove a fake passphrase:

chia rpc daemon remove_keyring_passphrase '{"current_passphrase": "12345"}'

Response:

{
"error": "current passphrase is invalid",
"success": false
}

running_services

Functionality: Show all services that are currently running

Usage: chia rpc daemon [OPTIONS] running_services [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters: None

Example
chia rpc daemon running_services

Response:

{
"running_services": [
"chia_full_node",
"chia_farmer",
"chia_harvester",
"chia_wallet",
"wallet_ui"
],
"success": true
}

set_keyring_passphrase

Functionality:

Usage: chia rpc daemon [OPTIONS] set_keyring_passphrase [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
current_passphraseSTRINGTrueThe current passphrase (if none, use an empty string)
new_passphraseSTRINGTrueThe new passphrase, by default must be at least 8 characters long
passphrase_hintSTRINGFalseThe new passphrase hint, if one is desired
save_passphraseBOOLEANFalseWhether to save the new passphrase to your system's secure credential store, thus allowing Chia to access your keys without prompting for your passphrase. [Default: False]
Example
chia rpc daemon set_keyring_passphrase '{"current_passphrase": "", "new_passphrase": "12345678", "passphrase_hint": "It has eight characters"}'

Response:

{
"error": null,
"success": true
}

start_service

Functionality: Start a service

Usage: chia rpc daemon [OPTIONS] start_service [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
serviceSTRINGTrueThe service to start
testingBooleanFalseIf true, then test the start_service RPC [Default: false]
Example

Start the wallet service:

chia rpc daemon start_service '{"service": "chia_wallet"}'

Response:

{
"error": null,
"service": "chia_wallet",
"success": true
}

stop_service

Functionality: Stop a service

Usage: chia rpc daemon [OPTIONS] stop_service [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
serviceSTRINGTrueThe service to stop
Example

Stop the wallet service:

chia rpc daemon stop_service '{"service": "chia_wallet"}'

Response:

{
"service_name": "chia_wallet",
"success": true
}

unlock_keyring

Functionality: Unlock the keyring

Usage: chia rpc daemon [OPTIONS] unlock_keyring [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
keySTRINGFalseThe key to unlock [Default: None]
Example
chia rpc daemon unlock_keyring '{"key": "12345678"}'

Response:

{
"error": null,
"success": true
}

validate_keyring_passphrase

Functionality: Verify whether the input passphrase is correct

Usage: chia rpc daemon [OPTIONS] validate_keyring_passphrase [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
keySTRINGTrueThe key to check
Example
chia rpc daemon validate_keyring_passphrase '{"key": "12345678"}'

Response:

{
"error": null,
"success": true
}

Plotter RPCs

get_keys_for_plotting

Functionality: Show the farmer_public_key and pool_public_key for one or more wallet fingerprints

Usage: chia rpc daemon [OPTIONS] get_keys_for_plotting [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
fingerprintsNUMBERFalseList the keys for the specified fingerprints only [Default: list keys for all fingerprints]
Example

Show the keys for one specific fingerprint:

chia rpc daemon get_keys_for_plotting '{"fingerprints":[2104826454]}'

Response:

{
"keys": {
"2104826454": {
"farmer_public_key": "82e79f17419e953da439bb9f5c40df4a26c0bbe2c1124178855a24067a6b8f3af8070dade09ca4c75fe3ba100e94fde6",
"pool_public_key": "a3ef6951a9351239bdfff028825e4c2f659487eb3d0f25e50da6f1801bca9ab0c2e6a07a7f4e58b82ffd6c75be05e75f"
}
},
"success": true
}

get_plotters

Functionality: List all available plotters

Usage: chia rpc daemon [OPTIONS] get_plotters [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters: None

Example
chia rpc daemon get_plotters

Response:

{
"plotters": {
"bladebit": {
"bladebit_memory_warning": "BladeBit requires at least 416 GiB of RAM to operate",
"cuda_support": true,
"display_name": "BladeBit Plotter",
"installed": true,
"version": "3.0.0"
},
"chiapos": {
"display_name": "Chia Proof of Space",
"installed": true,
"version": "2.0.2"
},
"madmax": {
"display_name": "madMAx Plotter",
"installed": true,
"version": "1.1.6-2092041"
}
},
"success": true
}

start_plotting

Functionality: Create one or more plots with the desired plotter

Usage: chia rpc daemon [OPTIONS] start_plotting [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
serviceSTRINGTrueThe plotting service to use
plotterSTRINGFalseThe plotter to use [Default: "chiapos"]
delayINTEGERFalseThe number of seconds to delay before starting to plot [Default: 0]
parallelBOOLEANFalseSet to create multiple plots in parallel [Default: false]
kINTEGERTrueThe k-size of the plot to create
overrideKBOOLEANTrueSet to true to create a plot smaller than k-32
rINTEGERTrueThe number of threads to use for creating the plot(s)
bINTEGERTrueSize of the buffer, in MB
uINTEGERTrueNumber of buckets
eBOOLEANTrueSet to true to disable bitfield
tSTRINGTrueThe temporary directory where the plot will be created
dSTRINGTrueThe destination where the plot will be moved after it has been created
xBOOLEANTrueSet to true to skip moving the plot after it has been created
nINTEGERFalseThe number of plots to create [Default: 1]
queueSTRINGFalseThe type of plotting queue [Default: "default"]

stop_plotting

Functionality:

Usage: chia rpc daemon [OPTIONS] stop_plotting [REQUEST]

Options: Stop creating a plot

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
idSTRINGTrueThe ID of the plot to stop creating
Example
chia rpc daemon stop_plotting '{"id": "68607640-4dfc-4946-9a0d-186beec3b8f8"}'

Response:

{
"success": true
}

Keychain Server RPCs

add_private_key

Functionality: Add a new private key from a mnemonic word list

Usage: chia rpc daemon [OPTIONS] add_private_key [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
mnemonicSTRINGTrueThe mnemonic word list (see below for details)
labelSTRINGFalseThe label to assign for this key [Default: None]

Requirements for the mnemonic word list:

  • Must be input as a single string
  • Order is important
  • Must be delineated by spaces
  • Must be either 12 or 24 words long
  • Each word must be in the BIP-39 word list
  • The mnemonic must form a valid private key
Example 1: success

The following example adheres to each of the above rules:

chia rpc daemon add_private_key '{"mnemonic": "concert tooth egg defy journey lottery deposit market share lion diesel hand", "label": "Example Key"}'

Response:

{
"fingerprint": 1542304282,
"success": true
}
Example 2: invalid length

The mnemonic must be either 12 or 24 words. Else, an error will be returned. For example:

chia rpc daemon add_private_key '{"mnemonic": "1 2 3 4 5 6 7 8 9 10 11 12 13", "label": "Example Key"}'

Response:

{
"error": "Invalid mnemonic length",
"success": false
}
Example 3: invalid word

Each word must be in the BIP-39 word list. Else, an error will be returned. For example:

chia rpc daemon add_private_key '{"mnemonic": "1 2 3 4 5 6 7 8 9 10 11 12", "label": "Example Key"}'

Response:

{
"error": "'1' is not in the mnemonic dictionary; may be misspelled",
"success": false
}
Example 4: Invalid word order

If the mnemonic is 12 or 24 words, and each word is in the BIP-39 word list, the final check is that the words form a valid mnemonic phrase. For example:

chia rpc daemon add_private_key '{"mnemonic": "you can test this example word list because they tell you stuff", "label": "Example Key"}'

Response:

{
"error": "Invalid order of mnemonic words",
"success": false
}

check_keys

Functionality:

Usage: chia rpc daemon [OPTIONS] check_keys [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequired
root_pathSTRINGTrue

delete_all_keys

Functionality: Delete all keys

Usage: chia rpc daemon [OPTIONS] delete_all_keys [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters: None

Note that this command will fail if the OS key ring is locked.

注意

This command will delete all of your local Chia keys. Use with caution.


delete_key_by_fingerprint

Functionality: Delete the key corresponding to the input fingerprint

Usage: chia rpc daemon [OPTIONS] delete_key_by_fingerprint [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
fingerprintINTEGERTrueThe fingerprint whose key you want to delete

Note that this command will fail if the OS key ring is locked.

Example
chia rpc daemon delete_key_by_fingerprint '{"fingerprint": 1542304282}'

Response:

{
"success": true
}

To verify that the key was deleted, you can call get_public_key. For example:

chia rpc daemon get_public_key '{"fingerprint": 1542304282}'

Response:

{
"error": "key not found",
"error_details": {
"fingerprint": 1542304282
},
"success": false
}

get_all_private_keys

Functionality: List all private keys, along with their respective entropies

Usage: chia rpc daemon [OPTIONS] get_all_private_keys [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters: None

Note that this command will fail if the OS key ring is locked.

Example
chia rpc daemon get_all_private_keys

Response:

{
"private_keys": [
{
"entropy": "2ebc991b1cd787080ec441c53044f634",
"pk": "a2cc00aff448432ef72e7c60ef4ef6f39ce72748c91f1ec15262821cf7f56bcf0a509c9354ec5104604ebbe276511263",
}
{
"entropy": "entropy of pk2",
"pk": "pk2"
}
],
"success": true
}

get_first_private_key

Functionality: Obtain the first private key, along with its entropy

Usage: chia rpc daemon [OPTIONS] get_first_private_key [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters: None

Note that this command will fail if the OS key ring is locked.

Example
chia rpc daemon get_first_private_key

Response:

{
"entropy": "2ebc991b1cd787080ec441c53044f634",
"pk": "a2cc00aff448432ef72e7c60ef4ef6f39ce72748c91f1ec15262821cf7f56bcf0a509c9354ec5104604ebbe276511263",
"success": true
}

get_key_for_fingerprint

Functionality: Given a fingerprint, list the corresponding private key and entropy

Usage: chia rpc daemon [OPTIONS] get_key_for_fingerprint [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
fingerprintINTEGERFalseThe fingerprint to look up [Default: get the first key]
Example
chia rpc daemon get_key_for_fingerprint '{"fingerprint": 1542304282}'

Response:

{
"entropy": "2ebc991b1cd787080ec441c53044f634",
"pk": "a2cc00aff448432ef72e7c60ef4ef6f39ce72748c91f1ec15262821cf7f56bcf0a509c9354ec5104604ebbe276511263",
"success": true
}

get_key

Functionality: Given a fingerprint, retrieve the corresponding key

Usage: chia rpc daemon [OPTIONS] get_key [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
fingerprintINTEGERTrueThe fingerprint whose key you want to look up
include_secretsBOOLEANFalseSet to true to include secrets in the response [Default: false]
Example
chia rpc daemon get_key '{"fingerprint": 1542304282}'

Response:

{
"key": {
"fingerprint": 1542304282,
"label": "Example Key",
"public_key": "0xa2cc00aff448432ef72e7c60ef4ef6f39ce72748c91f1ec15262821cf7f56bcf0a509c9354ec5104604ebbe276511263",
"secrets": null
},
"success": true
}

get_keys

Functionality: Get all public keys, with the option of including secrets

Usage: chia rpc daemon [OPTIONS] get_keys [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
include_secretsBOOLEANFalseSet to true to include secrets in the response [Default: false]
Example
chia rpc daemon get_keys

Response:

{
"keys": [
{
"fingerprint": 1542304282,
"label": "Example Key",
"public_key": "0xa2cc00aff448432ef72e7c60ef4ef6f39ce72748c91f1ec15262821cf7f56bcf0a509c9354ec5104604ebbe276511263",
"secrets": null
}
],
"success": true
}

get_public_key

Functionality: Get the public key from a specified fingerprint

Usage: chia rpc daemon [OPTIONS] get_public_key [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
fingerprintINTEGERTrueThe fingerprint whose key you want to look up
Example
chia rpc daemon get_public_key '{"fingerprint": 1542304282}'

Response:

{
"key": {
"fingerprint": 1542304282,
"label": "Example Key",
"public_key": "0xa2cc00aff448432ef72e7c60ef4ef6f39ce72748c91f1ec15262821cf7f56bcf0a509c9354ec5104604ebbe276511263"
},
"success": true
}

get_public_keys

Functionality: Get all public keys

Usage: chia rpc daemon [OPTIONS] get_public_keys [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters: None

Example
chia rpc daemon get_public_keys

Response:

{
"keys": [
{
"fingerprint": 1542304282,
"label": "Example Key",
"public_key": "0xa2cc00aff448432ef72e7c60ef4ef6f39ce72748c91f1ec15262821cf7f56bcf0a509c9354ec5104604ebbe276511263"
}
],
"success": true
}

set_label

Functionality: Set the label for the specified key

Usage: chia rpc daemon [OPTIONS] set_label [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
fingerprintINTEGERTrueThe fingerprint whose label you want to set
labelSTRINGTrueThe new label
Example
chia rpc daemon set_label '{"fingerprint": 1542304282, "label": "New Label"}'

Response:

{
"success": true
}

To verify that the label was set, you can call get_public_key. For example:

chia rpc daemon get_public_key '{"fingerprint": 1542304282}'

Response:

{
"key": {
"fingerprint": 1542304282,
"label": "New Label",
"public_key": "0xa2cc00aff448432ef72e7c60ef4ef6f39ce72748c91f1ec15262821cf7f56bcf0a509c9354ec5104604ebbe276511263"
},
"success": true
}

delete_label

Functionality: Delete the label for the specified fingerprint

Usage: chia rpc daemon [OPTIONS] delete_label [REQUEST]

Options:

Short CommandLong CommandTypeRequiredDescription
-j--json-fileFILENAMEFalseOptionally instead of REQUEST you can provide a json file containing the request data
-h--helpNoneFalseShow a help message and exit

Request Parameters:

FlagTypeRequiredDescription
fingerprintINTEGERTrueThe fingerprint whose label you want to delete
Example
chia rpc daemon delete_label '{"fingerprint": 1542304282}'

Response:

{
"success": true
}

To verify that the label was set, you can call get_public_key. For example:

chia rpc daemon get_public_key '{"fingerprint": 1542304282}'

Response:

{
"key": {
"fingerprint": 1542304282,
"label": null,
"public_key": "0xa2cc00aff448432ef72e7c60ef4ef6f39ce72748c91f1ec15262821cf7f56bcf0a509c9354ec5104604ebbe276511263"
},
"success": true
}