From 07a8605b1ca4e49707bb70c13199a3d310bdbd9f Mon Sep 17 00:00:00 2001 From: Elijah Lopez Date: Mon, 15 Nov 2021 15:08:07 -0500 Subject: [PATCH] Add command line arguments and examples to monero-wallet-rpc.reference.md --- .../monero-wallet-cli-reference.md | 22 +- .../monero-wallet-rpc-reference.md | 518 ++++++++++-------- 2 files changed, 300 insertions(+), 240 deletions(-) diff --git a/docs/interacting/monero-wallet-cli-reference.md b/docs/interacting/monero-wallet-cli-reference.md index 646de32..79cf8d8 100644 --- a/docs/interacting/monero-wallet-cli-reference.md +++ b/docs/interacting/monero-wallet-cli-reference.md @@ -19,11 +19,11 @@ transactions history, and to facilitate creating transactions. However, wallet does not store the blockchain and does not directly participate in the p2p network. -The CLI wallet is the most reliable and most feature complete wallet for Monero. +The CLI wallet is the most reliable and most feature complete wallet for Monero. -### Depends on the full node +### Depends on the full node -Wallet connects to a [full node](/interacting/monerod-reference) to scan the blockchain for your transaction outputs and to send your transactions out to the network. +Wallet connects to a [full node](/interacting/monerod-reference) to scan the blockchain for your transaction outputs and to send your transactions out to the network. The full node can be either local (same computer) or remote. @@ -34,7 +34,7 @@ Connection happens over HTTP and uses [this API](https://www.getmonero.org/resou Any transaction leaving the wallet is already blinded by all Monero privacy features. This means plain text HTTP communication isn't an issue on its own even if you connect to a remote node. -However, connecting to a remote node has other nuanced trade-offs, which is a topic for a separate article. +However, connecting to a remote node has other nuanced trade-offs, which is a topic for a separate article. ## Syntax @@ -79,7 +79,7 @@ In a separate terminal window, run the wallet: |-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------- | `--log-file ` | Full path to the log file. | `--log-level ` | `0-4` with `0` being minimal logging and `4` being full tracing. Defaults to `0`. These are general presets and do not directly map to severity levels. For example, even with minimal `0`, you may see some most important `INFO` entries. -| `--max-log-file-size ` | Soft limit in bytes for the log file (=104850000 by default, which is just under 100MB). Once log file grows past that limit, monero creates the next log file with a UTC timestamp postfix `-YYYY-MM-DD-HH-MM-SS`.

In production deployments, you would probably prefer to use established solutions like logrotate instead. In that case, set `--max-log-file-size 0` to prevent monero from managing the log files. +| `--max-log-file-size ` | Soft limit in bytes for the log file (=104850000 by default, which is just under 100MB). Once log file grows past that limit, monero creates the next log file with a UTC timestamp postfix `-YYYY-MM-DD-HH-MM-SS`.

In production deployments, you would probably prefer to use established solutions like logrotate instead. In that case, set `--max-log-file-size 0` to prevent monero from managing the log files. | `--max-log-files ` | Limit on the number of log files (=50 by default). The oldest log files are removed. In production deployments, you would probably prefer to use established solutions like logrotate instead. #### Full node connection @@ -160,7 +160,7 @@ These options are either legacy or rarely useful. | `--shared-ringdb-dir ` | Set shared ring database path. [No longer worthwhile](https://www.reddit.com/r/Monero/comments/9rtnpx/are_there_any_updated_blackball_databases/). | `--create-address-file` | Has no effect. The `*.address.txt` file is created regardless of this option. | `--electrum-seed ` | Provide mnemonic seed as a commandline option for `--restore-deterministic-wallet` instead of interactively. This is not recommended b/c the seed will be saved in your command history and also visible in the process list. -| `--generate-from-json ` | You would run `monero-wallet-rpc` to use this option. It seems exposed in `monero-wallet-cli` by accident. +| `--generate-from-json ` | You would run `monero-wallet-rpc` to use this option. It seems exposed in `monero-wallet-cli` by accident. | `--tx-notify ` | You would run `monero-wallet-rpc` to use this option. It seems exposed in `monero-wallet-cli` by accident. ## Defaults @@ -195,12 +195,12 @@ Use `help command_name` to learn more. `fee` - show current fee-per-byte and full node's mempool (the backlog of transactions depending on the priority) `wallet_info` - show wallet file path, standard address, type and network - + ### Balance `account` - total balance; list accounts with respective balances -`balance detail` - within the current account, list addresses with respective balances +`balance detail` - within the current account, list addresses with respective balances `refresh` - force refresh the balance and transactions by pulling latest blocks from the full node; this is often useful because auto-refresh only kicks in once in 90 seconds @@ -256,7 +256,7 @@ Use `help command_name` to learn more. `get_spend_proof` -> `check_spend_proof` - prove you made the payment -`sign ` -> `verify
` - prove ownership of the address; allows to verify the file was signed by the owner of specific Monero address +`sign ` -> `verify
` - prove ownership of the address; allows to verify the file was signed by the owner of specific Monero address `get_tx_proof` -> `check_tx_proof` @@ -320,7 +320,7 @@ Use `help command_name` to learn more. These allow to learn and verify transaction's private key `r`. This was useful to create a [proof of payment](https://www.getmonero.org/resources/user-guides/prove-payment.html) but got superseded by `get_spend_proof`. - + `get_tx_key ` `check_tx_key
` @@ -338,7 +338,7 @@ but got superseded by `get_spend_proof`. `address_book [(add ((
[pid ])|) [])|(delete )]` `set_description [free text note]` -> `get_description` - manage convenience description of the wallet (the information is local) - + ### Legacy `save` - this now happens automatically diff --git a/docs/interacting/monero-wallet-rpc-reference.md b/docs/interacting/monero-wallet-rpc-reference.md index 4240cda..13316b2 100644 --- a/docs/interacting/monero-wallet-rpc-reference.md +++ b/docs/interacting/monero-wallet-rpc-reference.md @@ -1,27 +1,15 @@ --- title: monero-wallet-rpc - Reference --- + # `monero-wallet-rpc` - Reference -## Introduction +## Overview -This is a list of the monero-wallet-rpc calls, their inputs and outputs, and examples of each. The program monero-wallet-rpc replaced the rpc interface that was in simplewallet and then monero-wallet-cli. +This is a documentation for how to use `monero-wallet-rpc` which replaced the rpc interface that was in `simplewallet` and then `monero-wallet-cli`. All monero-wallet-rpc methods use the same JSON RPC interface. For example: -``` Bash -IP=127.0.0.1 -PORT=18082 -METHOD="make_integrated_address" -PARAMS="{\"payment_id\":\"1234567890123456789012345678900012345678901234567890123456789000\"}" -curl \ - -X POST http://$IP:$PORT/json_rpc \ - -d '{"jsonrpc":"2.0","id":"0","method":"'$METHOD'","params":'"$PARAMS"'}' \ - -H 'Content-Type: application/json' -``` - -If the monero-wallet-rpc was executed with the `--rpc-login` argument as `username:password`, then follow this example: - ``` Bash IP=127.0.0.1 PORT=18082 @@ -32,90 +20,239 @@ curl \ -X POST http://$IP:$PORT/json_rpc \ -d '{"jsonrpc":"2.0","id":"0","method":"'$METHOD'","params":'"$PARAMS"'}' \ -H 'Content-Type: application/json' - ``` -Note: "atomic units" refer to the smallest fraction of 1 XMR according to the monerod implementation. **1 XMR = 1e12 atomic units.** +**1 XMR = 1e12 atomic units** where "atomic units" is the smallest fraction of 1 XMR according to the monerod implementation. -### Index of JSON RPC Methods: +## Syntax -- [add_address_book](#add_address_book) -- [change_wallet_password](#change_wallet_password) -- [check_reserve_proof](#check_reserve_proof) -- [check_spend_proof](#check_spend_proof) -- [check_tx_key](#check_tx_key) -- [check_tx_proof](#check_tx_proof) -- [close_wallet](#close_wallet) -- [create_account](#create_account) -- [create_address](#create_address) -- [create_wallet](#create_wallet) -- [delete_address_book](#delete_address_book) -- [export_key_images](#export_key_images) -- [export_multisig_info](#export_multisig_info) -- [export_outputs](#export_outputs) -- [finalize_multisig](#finalize_multisig) -- [get_accounts](#get_accounts) -- [get_account_tags](#get_account_tags) -- [get_address_book](#get_address_book) -- [get_address](#get_address) -- [get_address_index](#get_address_index) -- [get_attribute](#get_attribute) -- [get_balance](#get_balance) -- [get_bulk_payments](#get_bulk_payments) -- [get_height](#get_height) -- [get_languages](#get_languages) -- [get_payments](#get_payments) -- [get_reserve_proof](#get_reserve_proof) -- [get_spend_proof](#get_spend_proof) -- [get_transfer_by_txid](#get_transfer_by_txid) -- [get_transfers](#get_transfers) -- [get_tx_key](#get_tx_key) -- [get_tx_notes](#get_tx_notes) -- [get_tx_proof](#get_tx_proof) -- [get_version](#get_version) -- [import_key_images](#import_key_images) -- [import_multisig_info](#import_multisig_info) -- [import_outputs](#import_outputs) -- [incoming_transfers](#incoming_transfers) -- [is_multisig](#is_multisig) -- [label_account](#label_account) -- [label_address](#label_address) -- [make_integrated_address](#make_integrated_address) -- [make_multisig](#make_multisig) -- [make_uri](#make_uri) -- [open_wallet](#open_wallet) -- [parse_uri](#parse_uri) -- [prepare_multisig](#prepare_multisig) -- [query_key](#query_key) -- [refresh](#refresh) -- [relay_tx](#relay_tx) -- [rescan_blockchain](#rescan_blockchain) -- [rescan_spent](#rescan_spent) -- [set_account_tag_description](#set_account_tag_description) -- [set_attribute](#set_attribute) -- [set_tx_notes](#set_tx_notes) -- [sign_multisig](#sign_multisig) -- [sign](#sign) -- [sign_transfer](#sign_transfer) -- [split_integrated_address](#split_integrated_address) -- [start_mining](#start_mining) -- [stop_mining](#stop_mining) -- [stop_wallet](#stop_wallet) -- [store](#store) -- [submit_multisig](#submit_multisig) -- [submit_transfer](#submit_transfer) -- [sweep_all](#sweep_all) -- [sweep_dust](#sweep_dust) -- [sweep_single](#sweep_single) -- [tag_accounts](#tag_accounts) -- [transfer_split](#transfer_split) -- [transfer](#transfer) -- [untag_accounts](#untag_accounts) -- [verify](#verify) +`./monero-wallet-rpc --rpc-bind-port (--wallet-file |--generate-from-json |--wallet-dir ) [options]` +### With Config File +`./monero-wallet-rpc --config-file ` -## JSON RPC Methods: +### Examples + +#### Unix (Production Example) + +`./monero-wallet-rpc --rpc-bind-port 28088 --wallet-file wallets/main/main --password walletPassword --rpc-login monero:rpcPassword --log-file logs/monero-wallet-rpc.log --max-log-files 2 --trusted-daemon --non-interactive` + +- If the RPC is used to retrieve information not dependent on any spending, consider using a view-only to prevent abuse. +- `--rpc-login` should be used in production to protect against any network attacks. An uncommon password protects against the case where the RPC port is open to the public +- A good place to keep Monero binaries is `~/bin/monero`, in order to be used by many programs without needing root to update it. + +#### Windows (Development Example) + +`monero-wallet-rpc --rpc-bind-port 28088 --wallet-file wallets\main\main --password walletPassword --daemon-address http://node.supportxmr.com:18081 --untrusted-daemon --disable-rpc-login` + +- Specifying `--untrusted-daemon` is not necessary but tells yourself that the daemon is untrusted and that commands requiring a trusted daemon will be disabled +- Default installation on Windows is `"C:\Program Files\Monero GUI Wallet"` + +## Running + +Make sure you are running a locally synced `monerod` or have a daemon address to supply to `--daemon-address` + +### Trouble Shooting + +If the expected RPC URL, say [http://127.0.0.1:28088/json_rpc](http://127.0.0.1:28088/json_rpc), is unavailabe, or there is no terminal output saying that the server has been started, `monero-wallet-rpc` might be trying to synchronize the wallet. In that case, you should use the GUI or CLI to sync that wallet file because using the GUI/CLI results in faster and measurable syncing. + +The recommended way is to have two wallet files for the same keys. One that is used manually (synced often), and one that is used by `monero-wallet-rpc`. Whenever you decide to use `monero-wallet-rpc` and encounter the unresponsive issue, simply copy the files of the GUI/CLI wallet and replace the ones that were being used by `monero-wallet-rpc`. This problem should only occur on the development system where `monerod` or `monero-wallet-rpc` might not have been running for weeks. In production, `monerod` and `monero-wallet-rpc` should have minimal downtimes, ensuring that the wallet is always synchronized. + +## Options + +### Help and Version + +| Option | Description +|--------------|------------ +| `--help` | Produce help message +| `--version` | Output version information + +### Pick Network + +| Option | Description +|---------------|------------ +| `--testnet` | For testnet. Daemon must also be launched with --testnet flag +| `--stagenet` | For stagenet. Daemon must also be launched with --stagenet flag + +### Logging + +| Option | Description +|----------------------------------------|------------ +| `--log-file ` | Specify log file +| `--log-level ` | 0-4 or categories +| `--max-log-file-size ` | Specify maximum log file size in bytes +| `--max-log-files ` | Specify maximum number of rotated log files to be saved (no limit by setting to 0) + +### Daemon (Node) + +| Option | Description +|--------------------------------------------|----- +| `--daemon-address ` | Use daemon instance at \:\ +| `--daemon-host ` | Use daemon instance at host \ instead of localhost +| `--proxy ` | \[\:]\ socks proxy to use for daemon connections +| `--trusted-daemon` | Enable commands which rely on a trusted daemon +| `--untrusted-daemon` | Disable commands which rely on a trusted daemon +| `--password ` | Wallet password (escape/quote as \| needed) +| `--password-file ` | Wallet password file +| `--daemon-port ` | Use daemon instance at port \ instead of 18081 +| `--daemon-login ` | Specify username\[:password] for daemon RPC client +| `--daemon-ssl ` | Path to a PEM format private key +| `--daemon-ssl-certificate ` | Path to a PEM format certificate +| `--daemon-ssl-ca-certificates ` | Path to file containing concatenated PEM format certificate(s) to replace system CA(s). +| `--daemon-ssl-allowed-fingerprints ` | List of valid fingerprints of allowed RPC servers +| `--daemon-ssl-allow-any-cert` | Allow any SSL certificate from the daemon +| `--daemon-ssl-allow-chained` | Allow user (via --daemon-ssl-ca-certificates) chain certificates + +### Other Useful + +| Option | Description +|-----------------------|----- +| `--tx-notify ` | Run a program for each new incoming transaction, '%s' will be replaced by the transaction hash +| `--non-interactive` | Run non-interactive (useful when input is DEVNULL) +| `--config-file ` | Config file + +### RPC + +| Option | Description +|-------------------------------------------------|----- +| `--rpc-bind-port ` | Sets bind port for server +| `--disable-rpc-login` | Disable HTTP authentication for RPC connections served by this process +| `--restricted-rpc` | Restricts to view-only commands +| `--rpc-bind-ip ` | Specify IP to bind RPC server +| `--rpc-bind-ipv6-address ` | Specify IPv6 address to bind RPC server +| `--rpc-restricted-bind-ip ` | Specify IP to bind restricted RPC server +| `--rpc-restricted-bind-ipv6-address ` | Specify IPv6 address to bind restricted RPC server +| `--rpc-use-ipv6` | Allow IPv6 for RPC +| `--rpc-ignore-ipv4` | Ignore unsuccessful IPv4 bind for RPC +| `--rpc-login ` | Specify username\[:password] required for RPC server +| `--confirm-external-bind` | Confirm rpc-bind-ip value is NOT a loopback (local) IP +| `--rpc-access-control-origins ` | Specify a comma separated list of origins to allow cross origin resource sharing +| `--rpc-ssl ` | Enable SSL on RPC connections: enabled\|disabled\|autodetect +| `--rpc-ssl-private-key ` | Path to a PEM format private key +| `--rpc-ssl-certificate ` | Path to a PEM format certificate +| `--rpc-ssl-ca-certificates ` | Path to file containing concatenated PEM format certificate(s) to replace system CA(s). +| `--rpc-ssl-allowed-fingerprints ` | List of certificate fingerprints to allow +| `--rpc-ssl-allow-chained` | Allow user (via --rpc-ssl-certificates) chain certificates +| `--disable-rpc-ban` | Do not ban hosts on RPC errors +| `--rpc-client-secret-key ` | Set RPC client secret key for RPC payments + +### Open Existing Wallet + +| Option | Description +|-----------------------------|----- +| `--wallet-file ` | Use wallet \ +| `--wallet-dir ` | Directory for newly created wallets +| `--prompt-for-password` | Prompts for password when not provided +| `--max-concurrency ` | Max number of threads to use for a parallel job + +### Create new Wallet + +| Option | Description +|--------------------------------|----- +| `--kdf-rounds ` | Number of rounds for the key derivation function +| `--hw-device ` | HW device to use +| `--hw-device-deriv-path ` | HW device wallet derivation path (e.g., SLIP-10) +| `--extra-entropy ` | File containing extra entropy to initialize the PRNG (any data, aim for 256 bits of entropy to be useful, which typically means more than 256 its of data) +| `--generate-from-json ` | Generate wallet from JSON format file + +### Windows Service + +| Option | Description +|------------------------|----- +| `--run-as-service` | true if running as windows service +| `--install-service` | Install Windows service +| `--uninstall-service` | Uninstall Windows service +| `--start-service` | Start Windows service +| `--stop-service` | Stop Windows service + +### Legacy and Rare Uses + +| Option | Description +|-----------------------------------------------------|----- +| `--shared-ringdb-dir ` | Set shared ring database path +| `--no-dns` | Do not use DNS +| `--offline` | Do not connect to a daemon, nor use DNS +| `--bitmessage-address ` | Use PyBitmessage instance at URL \ +| `--bitmessage-login ` | Specify \ as username:password for PyBitmessage API + +## Index of JSON RPC Methods + +- [**add_address_book**](#add_address_book) +- [**change_wallet_password**](#change_wallet_password) +- [**check_reserve_proof**](#check_reserve_proof) +- [**check_spend_proof**](#check_spend_proof) +- [**check_tx_key**](#check_tx_key) +- [**check_tx_proof**](#check_tx_proof) +- [**close_wallet**](#close_wallet) +- [**create_account**](#create_account) +- [**create_address**](#create_address) +- [**create_wallet**](#create_wallet) +- [**delete_address_book**](#delete_address_book) +- [**export_key_images**](#export_key_images) +- [**export_multisig_info**](#export_multisig_info) +- [**export_outputs**](#export_outputs) +- [**finalize_multisig**](#finalize_multisig) +- [**get_account_tags**](#get_account_tags) +- [**get_accounts**](#get_accounts) +- [**get_address**](#get_address) +- [**get_address_book**](#get_address_book) +- [**get_address_index**](#get_address_index) +- [**get_attribute**](#get_attribute) +- [**get_bulk_payments**](#get_bulk_payments) +- [**get_height**](#get_height) +- [**get_languages**](#get_languages) +- [**get_payments**](#get_payments) +- [**get_reserve_proof**](#get_reserve_proof) +- [**get_spend_proof**](#get_spend_proof) +- [**get_transfer_by_txid**](#get_transfer_by_txid) +- [**get_transfers**](#get_transfers) +- [**get_tx_key**](#get_tx_key) +- [**get_tx_notes**](#get_tx_notes) +- [**get_tx_proof**](#get_tx_proof) +- [**get_version**](#get_version) +- [**import_key_images**](#import_key_images) +- [**import_multisig_info**](#import_multisig_info) +- [**import_outputs**](#import_outputs) +- [**incoming_transfers**](#incoming_transfers) +- [**is_multisig**](#is_multisig) +- [**label_account**](#label_account) +- [**label_address**](#label_address) +- [**make_integrated_address**](#make_integrated_address) +- [**make_multisig**](#make_multisig) +- [**make_uri**](#make_uri) +- [**open_wallet**](#open_wallet) +- [**parse_uri**](#parse_uri) +- [**prepare_multisig**](#prepare_multisig) +- [**query_key**](#query_key) +- [**refresh**](#refresh) +- [**relay_tx**](#relay_tx) +- [**rescan_blockchain**](#rescan_blockchain) +- [**rescan_spent**](#rescan_spent) +- [**set_account_tag_description**](#set_account_tag_description) +- [**set_attribute**](#set_attribute) +- [**set_tx_notes**](#set_tx_notes) +- [**sign**](#sign) +- [**sign_multisig**](#sign_multisig) +- [**sign_transfer**](#sign_transfer) +- [**split_integrated_address**](#split_integrated_address) +- [**start_mining**](#start_mining) +- [**stop_mining**](#stop_mining) +- [**stop_wallet**](#stop_wallet) +- [**store**](#store) +- [**submit_multisig**](#submit_multisig) +- [**submit_transfer**](#submit_transfer) +- [**sweep_all**](#sweep_all) +- [**sweep_dust**](#sweep_dust) +- [**sweep_single**](#sweep_single) +- [**tag_accounts**](#tag_accounts) +- [**transfer**](#transfer) +- [**transfer_split**](#transfer_split) +- [**untag_accounts**](#untag_accounts) +- [**verify**](#verify) + +## JSON RPC Methods ### **add_address_book** @@ -665,7 +802,6 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me ``` - ### **get_accounts** Get all accounts for a wallet. Optionally filter accounts by tag. @@ -831,7 +967,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_address_index","params":{"address":"7BnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o"}}' -H 'Content-Type: application/json' { "id": "0", @@ -843,10 +979,8 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me } } } - ``` - ### **get_attribute** Get attribute value by name. @@ -863,7 +997,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_attribute","params":{"key":"my_attribute"}}' -H 'Content-Type: application/json' { "id": "0", @@ -872,10 +1006,8 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "value": "my_value" } } - ``` - ### **get_bulk_payments** Get a list of incoming payments using a given payment id, or a list of payments ids, from a given height. This method is the preferred method over `get_payments`because it has the same functionality but is more extendable. Either is fine for looking up transactions by a single payment ID. @@ -902,7 +1034,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_bulk_payments","params":{"payment_ids":["60900e5603bf96e3"],"min_block_height":"120000"}}' -H 'Content-Type: application/json' { "id": "0", @@ -922,10 +1054,8 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me }] } } - ``` - ### **get_height** Returns the wallet's current block height. @@ -940,7 +1070,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_height"}' -H 'Content-Type: application/json' { "id": "0", @@ -949,10 +1079,8 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "height": 145545 } } - ``` - ### **get_languages** Get a list of available languages for your wallet's seed. @@ -967,7 +1095,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_languages"}' -H 'Content-Type: application/json' { "id": "0", @@ -976,10 +1104,8 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "languages": ["Deutsch","English","Español","Français","Italiano","Nederlands","Português","русский язык","日本語","简体中文 (中国)","Esperanto","Lojban"] } } - ``` - ### **get_payments** Get a list of incoming payments using a given payment id. @@ -1005,7 +1131,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_payments","params":{"payment_id":"60900e5603bf96e3"}}' -H 'Content-Type: application/json' { "id": "0", @@ -1025,10 +1151,8 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me }] } } - ``` - ### **get_reserve_proof** Generate a signature to prove of an available amount in a wallet. @@ -1048,7 +1172,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_reserve_proof","params":{"all":false,"account_index":0,"amount":100000000000}}' -H 'Content-Type: application/json' { "id": "0", @@ -1057,10 +1181,8 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "signature": "ReserveProofV11BZ23sBt9sZJeGccf84mzyAmNCP3KzYbE1111112VKmH111118NfCYJQjZ6c46gT2kXgcHCaSSZeL8sRdzqjqx7i1e7FQfQGu2o113UYFVdwzHQi3iENDPa76Kn1BvywbKz3bMkXdZkBEEhBSF4kjjGaiMJ1ucKb6wvMVC4A8sA4nZEdL2Mk3wBucJCYTZwKqA8i1M113kqakDkG25FrjiDqdQTCYz2wDBmfKxF3eQiV5FWzZ6HmAyxnqTWUiMWukP9A3Edy3ZXqjP1b23dhz7Mbj39bBxe3ZeDNu9HnTSqYvHNRyqCkeUMJpHyQweqjGUJ1DSfFYr33J1E7MkhMnEi1o7trqWjVix32XLetYfePG73yvHbS24837L7Q64i5n1LSpd9yMiQZ3Dyaysi5y6jPx7TpAvnSqBFtuCciKoNzaXoA3dqt9cuVFZTXzdXKqdt3cXcVJMNxY8RvKPVQHhUur94Lpo1nSpxf7BN5a5rHrbZFqoZszsZmiWikYPkLX72XUdw6NWjLrTBxSy7KuPYH86c6udPEXLo2xgN6XHMBMBJzt8FqqK7EcpNUBkuHm2AtpGkf9CABY3oSjDQoRF5n4vNLd3qUaxNsG4XJ12L9gJ7GrK273BxkfEA8fDdxPrb1gpespbgEnCTuZHqj1A" } } - ``` - ### **get_spend_proof** Generate a signature to prove a spend. Unlike proving a transaction, it does not requires the destination public address. @@ -1078,7 +1200,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_spend_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","message":"this is my transaction"}}' -H 'Content-Type: application/json' { "id": "0", @@ -1087,10 +1209,8 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "signature": "SpendProofV1aSh8Todhk54736iXgV6vJAFP7egxByuMWZeyNDaN2JY737S95X5zz5mNMQSuCNSLjjhi5HJCsndpNWSNVsuThxwv285qy1KkUrLFRkxMSCjfL6bbycYN33ScZ5UB4Fzseceo1ndpL393T1q638VmcU3a56dhNHF1RPZFiGPS61FA78nXFSqE9uoKCCoHkEz83M1dQVhxZV5CEPF2P6VioGTKgprLCH9vvj9k1ivd4SX19L2VSMc3zD1u3mkR24ioETvxBoLeBSpxMoikyZ6inhuPm8yYo9YWyFtQK4XYfAV9mJ9knz5fUPXR8vvh7KJCAg4dqeJXTVb4mbMzYtsSZXHd6ouWoyCd6qMALdW8pKhgMCHcVYMWp9X9WHZuCo9rsRjRpg15sJUw7oJg1JoGiVgj8P4JeGDjnZHnmLVa5bpJhVCbMhyM7JLXNQJzFWTGC27TQBbthxCfQaKdusYnvZnKPDJWSeceYEFzepUnsWhQtyhbb73FzqgWC4eKEFKAZJqT2LuuSoxmihJ9acnFK7Ze23KTVYgDyMKY61VXADxmSrBvwUtxCaW4nQtnbMxiPMNnDMzeixqsFMBtN72j5UqhiLRY99k6SE7Qf5f29haNSBNSXCFFHChPKNTwJrehkofBdKUhh2VGPqZDNoefWUwfudeu83t85bmjv8Q3LrQSkFgFjRT5tLo8TMawNXoZCrQpyZrEvnodMDDUUNf3NL7rxyv3gM1KrTWjYaWXFU2RAsFee2Q2MTwUW7hR25cJvSFuB1BX2bfkoCbiMk923tHZGU2g7rSKF1GDDkXAc1EvFFD4iGbh1Q5t6hPRhBV8PEncdcCWGq5uAL5D4Bjr6VXG8uNeCy5oYWNgbZ5JRSfm7QEhPv8Fy9AKMgmCxDGMF9dVEaU6tw2BAnJavQdfrxChbDBeQXzCbCfep6oei6n2LZdE5Q84wp7eoQFE5Cwuo23tHkbJCaw2njFi3WGBbA7uGZaGHJPyB2rofTWBiSUXZnP2hiE9bjJghAcDm1M4LVLfWvhZmFEnyeru3VWMETnetz1BYLUC5MJGFXuhnHwWh7F6r74FDyhdswYop4eWPbyrXMXmUQEccTGd2NaT8g2VHADZ76gMC6BjWESvcnz2D4n8XwdmM7ZQ1jFwhuXrBfrb1dwRasyXxxHMGAC2onatNiExyeQ9G1W5LwqNLAh9hvcaNTGaYKYXoceVzLkgm6e5WMkLsCwuZXvB" } } - ``` - ### **get_transfer_by_txid** Show information about a transfer to/from this address. @@ -1127,7 +1247,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_transfer_by_txid","params":{"txid":"c36258a276018c3a4bc1f195a7fb530f50cd63a4fa765fb7c6f7f49fc051762a"}}' -H 'Content-Type: application/json' { "id": "0", @@ -1161,10 +1281,8 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me } } } - ``` - ### **get_transfers** Returns a list of transfers. @@ -1210,7 +1328,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_transfers","params":{"in":true,"account_index":1}}' -H 'Content-Type: application/json' { "id": "0", @@ -1237,10 +1355,8 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me }] } } - ``` - ### **get_tx_key** Get transaction secret key from transaction id. @@ -1257,7 +1373,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_tx_key","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be"}}' -H 'Content-Type: application/json' { "id": "0", @@ -1266,10 +1382,8 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "tx_key": "feba662cf8fb6d0d0da18fc9b70ab28e01cc76311278fdd7fe7ab16360762b06" } } - ``` - ### **get_tx_notes** Get string notes for transactions. @@ -1286,7 +1400,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_tx_notes","params":{"txids":["3292e83ad28fc1cc7bc26dbd38862308f4588680fbf93eae3e803cddd1bd614f"]}}' -H 'Content-Type: application/json' { "id": "0", @@ -1295,10 +1409,8 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "notes": ["This is an example"] } } - ``` - ### **get_tx_proof** Get transaction signature to prove it. @@ -1317,7 +1429,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_tx_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","address":"7BnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o","message":"this is my transaction"}}' -H 'Content-Type: application/json' { "id": "0", @@ -1326,10 +1438,8 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "signature": "InProofV13vqBCT6dpSAXkypZmSEMPGVnNRFDX2vscUYeVS4WnSVnV5BwLs31T9q6Etfj9Wts6tAxSAS4gkMeSYzzLS7Gt4vvCSQRh9niGJMUDJsB5hTzb2XJiCkUzWkkcjLFBBRVD5QZ" } } - ``` - ### **get_version** Get RPC version Major & Minor integer-format, where Major is the first 16 bits and Minor the last 16 bits. @@ -1344,7 +1454,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_version"}' -H 'Content-Type: application/json' { "id": "0", @@ -1355,7 +1465,6 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me } ``` - ### **import_key_images** Import signed key images list and verify their spent status. @@ -1376,7 +1485,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"import_key_images", "params":{"signed_key_images":[{"key_image":"cd35239b72a35e26a57ed17400c0b66944a55de9d5bda0f21190fed17f8ea876","signature":"c9d736869355da2538ab4af188279f84138c958edbae3c5caf388a63cd8e780b8c5a1aed850bd79657df659422c463608ea4e0c730ba9b662c906ae933816d00"},{"key_image":"65158a8ee5a3b32009b85a307d85b375175870e560e08de313531c7dbbe6fc19","signature":"c96e40d09dfc45cfc5ed0b76bfd7ca793469588bb0cf2b4d7b45ef23d40fd4036057b397828062e31700dc0c2da364f50cd142295a8405b9fe97418b4b745d0c"}]}}' -H 'Content-Type: application/json' { "id": "0", @@ -1387,10 +1496,8 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "unspent": 0 } } - ``` - ### **import_multisig_info** Import multisig info from other participants. @@ -1407,7 +1514,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"import_multisig_info","params":{"info":["...multisig_info..."]}}' -H 'Content-Type: application/json' { "id": "0", @@ -1416,10 +1523,8 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "n_outputs": 35 } } - ``` - ### **import_outputs** Import outputs in hex format. @@ -1436,7 +1541,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"import_outputs","params":{"outputs_data_hex":"...outputs..."}}' -H 'Content-Type: application/json' { "id": "0", @@ -1445,10 +1550,8 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "num_imported": 6400 } } - ``` - ### **incoming_transfers** Return a list of incoming transfers to the wallet. @@ -1473,7 +1576,7 @@ Outputs: Example, get all transfers: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"incoming_transfers","params":{"transfer_type":"all","account_index":0,"subaddr_indices":[3],"verbose":true}}' -H 'Content-Type: application/json' { "id": "0", @@ -1506,12 +1609,11 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me }] } } - ``` Example, get available transfers: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"incoming_transfers","params":{"transfer_type":"available","account_index":0,"subaddr_indices":[3],"verbose":true}}' -H 'Content-Type: application/json' { "id": "0", @@ -1536,12 +1638,11 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me }] } } - ``` Example, get unavailable transfers: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"incoming_transfers","params":{"transfer_type":"unavailable","account_index":0,"subaddr_indices":[3],"verbose":true}}' -H 'Content-Type: application/json' { "id": "0", @@ -1558,10 +1659,8 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me }] } } - ``` - ### **is_multisig** Check if a wallet is a multisig one. @@ -1579,7 +1678,7 @@ Outputs: Example for a non-multisig wallet: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"is_multisig"}' -H 'Content-Type: application/json' { "id": "0", @@ -1591,12 +1690,11 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "total": 0 } } - ``` Example for a multisig wallet: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"is_multisig"}' -H 'Content-Type: application/json' { "id": "0", "jsonrpc": "2.0", @@ -1607,10 +1705,8 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "total": 2 } } - ``` - ### **label_account** Label an account. @@ -1626,7 +1722,7 @@ Outputs: _None_. Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"label_account","params":{"account_index":0,"label":"Primary account"}}' -H 'Content-Type: application/json' { "id": "0", @@ -1639,10 +1735,8 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me }] } } - ``` - ### **label_address** Label an address. @@ -1660,7 +1754,7 @@ Outputs: _None_. Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"label_address","params":{"index":{"major":0,"minor":5},"label":"myLabel"}}' -H 'Content-Type: application/json' { "id": "0", @@ -1668,10 +1762,8 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "result": { } } - ``` - ### **make_integrated_address** Make an integrated address from the wallet address and a payment id. @@ -1690,7 +1782,7 @@ Outputs: Example (Payment ID is empty, use a random ID): -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"make_integrated_address","params":{"standard_address":"55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt"}}' -H 'Content-Type: application/json' { "id": "0", @@ -1700,10 +1792,8 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "payment_id": "420fa29b2d9a49f5" } } - ``` - ### **make_multisig** Make a wallet multisig by importing peers multisig string. @@ -1723,7 +1813,7 @@ Outputs: Example for 2/2 Multisig Wallet: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"make_multisig","params":{"multisig_info":["MultisigV1K4tGGe8QirZdHgTYoBZMumSug97fdDyM3Z63M3ZY5VXvAdoZvx16HJzPCP4Rp2ABMKUqLD2a74ugMdBfrVpKt4BwD8qCL5aZLrsYWoHiA7JJwDESuhsC3eF8QC9UMvxLXEMsMVh16o98GnKRYz1HCKXrAEWfcrCHyz3bLW1Pdggyowop"],"threshold":2}}' -H 'Content-Type: application/json' { "id": "0", @@ -1733,12 +1823,11 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "multisig_info": "" } } - ``` Example for 2/3 Multisig Wallet: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"make_multisig","params":{"multisig_info":["MultisigV1MTVm4DZAdJw1PyVutpSy8Q4WisZBCFRAaZY7hhQnMwr5AZ4swzThyaSiVVQM5FHj1JQi3zPKhQ4k81BZkPSEaFjwRJtbfqfJcVvCqRnmBVcWVxhnihX5s8fZWBCjKrzT3CS95spG4dzNzJSUcjheAkLzCpVmSzGtgwMhAS3Vuz9Pas24","MultisigV1TEx58ycKCd6ADCfxF8hALpcdSRAkhZTi1bu4Rs6FdRC98EdB1LY7TAkMxasM55khFgcxrSXivaSr5FCMyJGHmojm1eE4HpGWPeZKv6cgCTThRzC4u6bkkSoFQdbzWN92yn1XEjuP2XQrGHk81mG2LMeyB51MWKJAVF99Pg9mX2BpmYFj"],"threshold":2}}' -H 'Content-Type: application/json' { "id": "0", @@ -1748,10 +1837,8 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "multisig_info": "MultisigxV18jCaYAQQvzCMUJaAWMCaAbAoHpAD6WPmYDmLtBtazD654E8RWkLaGRf29fJ3stU471MELKxwufNYeigP7LoE4tn2Sscwn5g7PyCfcBc1V4ffRHY3Kxqq6VocSCUTncpVeUskaDKuTAWtdB9VTBGW7iG1cd7Zm1dYgur3CiemkGjRUAj9bL3xTEuyaKGYSDhtpFZFp99HQX57EawhiRHk3qq4hjWX" } } - ``` - ### **make_uri** Create a payment URI using the official URI spec. @@ -1772,7 +1859,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"make_uri","params":{"address":"55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt","amount":10,"payment_id":"420fa29b2d9a49f5","tx_description":"Testing out the make_uri function.","recipient_name":"el00ruobuob Stagenet wallet"}}' -H 'Content-Type: application/json' { "id": "0", @@ -1781,10 +1868,8 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "uri": "monero:55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt?tx_payment_id=420fa29b2d9a49f5&tx_amount=0.000000000010&recipient_name=el00ruobuob%20Stagenet%20wallet&tx_description=Testing%20out%20the%20make_uri%20function." } } - ``` - ### **open_wallet** Open a wallet. You need to have set the argument "–wallet-dir" when launching monero-wallet-rpc to make this work. @@ -1800,7 +1885,7 @@ Outputs: _None_. Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"open_wallet","params":{"filename":"mytestwallet","password":"mytestpassword"}}' -H 'Content-Type: application/json' { "id": "0", @@ -1808,10 +1893,8 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "result": { } } - ``` - ### **parse_uri** Parse a payment URI to get payment information. @@ -1833,7 +1916,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"parse_uri","params":{"uri":"monero:55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt?tx_payment_id=420fa29b2d9a49f5&tx_amount=0.000000000010&recipient_name=el00ruobuob%20Stagenet%20wallet&tx_description=Testing%20out%20the%20make_uri%20function."}}' -H 'Content-Type: application/json' { "id": "0", @@ -1848,10 +1931,8 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me } } } - ``` - ### **prepare_multisig** Prepare a wallet for multisig by generating a multisig string to share with peers. @@ -1866,7 +1947,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"prepare_multisig"}' -H 'Content-Type: application/json' { "id": "0", @@ -1875,10 +1956,8 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "multisig_info": "MultisigV1BFdxQ653cQHB8wsj9WJQd2VdnjxK89g5M94dKPBNw22reJnyJYKrz6rJeXdjFwJ3Mz6n4qNQLd6eqUZKLiNzJFi3UPNVcTjtkG2aeSys9sYkvYYKMZ7chCxvoEXVgm74KKUcUu4V8xveCBFadFuZs8shnxBWHbcwFr5AziLr2mE7KHJT" } } - ``` - ### **query_key** Return the spend or view private key. @@ -1895,7 +1974,7 @@ Outputs: Example (Query view key): -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"query_key","params":{"key_type":"view_key"}}' -H 'Content-Type: application/json' { "id": "0", @@ -1904,12 +1983,11 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "key": "0a1a38f6d246e894600a3e27238a064bf5e8d91801df47a17107596b1378e501" } } - ``` Example (Query mnemonic key): -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"query_key","params":{"key_type":"mnemonic"}}' -H 'Content-Type: application/json' { "id": "0", @@ -1918,10 +1996,8 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "key": "vocal either anvil films dolphin zeal bacon cuisine quote syndrome rejoices envy okay pancakes tulips lair greater petals organs enmity dedicated oust thwart tomorrow tomorrow" } } - ``` - ### **refresh** Refresh a wallet after openning. @@ -1939,7 +2015,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"refresh","params":{"start_height":100000}}' -H 'Content-Type: application/json' { "id": "0", @@ -1952,7 +2028,6 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me ``` - ### **relay_tx** Relay a transaction previously created with `"do_not_relay":true`. @@ -1969,7 +2044,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"relay_tx","params":{"hex":"...tx_metadata..."}}' -H 'Content-Type: application/json' { "id": "0", @@ -1978,13 +2053,11 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "tx_hash": "1c42dcc5672bb09bccf33fb1e9ab4a498af59a6dbd33b3d0cfb289b9e0e25fa5" } } - ``` - ### **rescan_blockchain** -Rescan the blockchain from scratch, losing any information which can not be recovered from the blockchain itself. +Rescan the blockchain from scratch, losing any information which can not be recovered from the blockchain itself. This includes destination addresses, tx secret keys, tx notes, etc. Alias: _None_. @@ -1995,7 +2068,7 @@ Outputs: _None_. Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"rescan_blockchain"}' -H 'Content-Type: application/json' { "id": "0", @@ -2003,10 +2076,8 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "result": { } } - ``` - ### **rescan_spent** Rescan the blockchain for spent outputs. @@ -2019,7 +2090,7 @@ Outputs: _None_. Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"rescan_spent"}' -H 'Content-Type: application/json' { @@ -2031,7 +2102,6 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me ``` - ### **set_account_tag_description** Set description for an account tag. @@ -2047,7 +2117,7 @@ Outputs: _None_. Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"set_account_tag_description","params":{"tag":"myTag","description":"Test tag"}}' -H 'Content-Type: application/json' { "id": "0", @@ -2058,7 +2128,6 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me ``` - ### **set_attribute** Set arbitrary attribute. @@ -2074,7 +2143,7 @@ Outputs: _None_. Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"set_attribute","params":{"key":"my_attribute","value":"my_value"}}' -H 'Content-Type: application/json' { "id": "0", @@ -2085,7 +2154,6 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me ``` - ### **set_tx_notes** Set arbitrary string notes for transactions. @@ -2101,7 +2169,7 @@ Outputs: _None_. Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"set_tx_notes","params":{"txids":["3292e83ad28fc1cc7bc26dbd38862308f4588680fbf93eae3e803cddd1bd614f"],"notes":["This is an example"]}}' -H 'Content-Type: application/json' { "id": "0", @@ -2112,7 +2180,6 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me ``` - ### **sign** Sign a string. @@ -2129,7 +2196,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"sign","params":{"data":"This is sample data to be signed"}}' -H 'Content-Type: application/json' { "id": "0", @@ -2141,7 +2208,6 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me ``` - ### **sign_multisig** Sign a transaction in multisig. @@ -2159,7 +2225,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"sign_multisig","params":{"tx_data_hex":"...multisig_txset..."}}' -H 'Content-Type: application/json' { "id": "0", @@ -2172,7 +2238,6 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me ``` - ### **sign_transfer** Sign a transaction created on a read-only wallet (in cold-signing process) @@ -2194,7 +2259,7 @@ In the example below, we first generate an unsigned_txset on a read only wallet Generate unsigned_txset using the above "transfer" method on read-only wallet: -``` +```Bash curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"transfer","params":{"destinations":[{"amount":1000000000000,"address":"7BnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o"}],"account_index":0,"subaddr_indices":[0],"priority":0,"ring_size":7,"do_not_relay":true,"get_tx_hex":true}}' -H 'Content-Type: application/json' { "id": "0", @@ -2215,7 +2280,7 @@ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","meth Sign tx using the previously generated unsigned_txset -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"sign_transfer","params":{"unsigned_txset":...long_hex..."}}' -H 'Content-Type: application/json' { "id": "0", @@ -2228,7 +2293,6 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me ``` - ### **split_integrated_address** Retrieve the standard address and payment id corresponding to an integrated address. @@ -2247,7 +2311,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"split_integrated_address","params":{"integrated_address": "5F38Rw9HKeaLQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZXCkbHUXdPHyiUeRyokn"}}' -H 'Content-Type: application/json' { "id": "0", @@ -2261,7 +2325,6 @@ $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me ``` - ### **start_mining** Start mining in the Monero daemon. @@ -2278,7 +2341,7 @@ Outputs: _None_. Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"start_mining","params":{"threads_count":1,"do_background_mining":true,"ignore_battery":false}}' -H 'Content-Type: application/json' { "id": "0", @@ -2289,7 +2352,6 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me ``` - ### **stop_mining** Stop mining in the Monero daemon. @@ -2302,7 +2364,7 @@ Outputs: _None_. Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"stop_mining"}' -H 'Content-Type: application/json' { "id": "0", @@ -2313,7 +2375,6 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me ``` - ### **stop_wallet** Stops the wallet, storing the current state. @@ -2326,7 +2387,7 @@ Outputs: _None_. Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"stop_wallet"}' -H 'Content-Type: application/json' { "id": "0", @@ -2350,7 +2411,7 @@ Outputs: _None_. Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"store"}' -H 'Content-Type: application/json' { "id": "0", @@ -2378,7 +2439,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"submit_multisig","params":{"tx_data_hex":"...tx_data_hex..."}}' -H 'Content-Type: application/json' { "id": "0", @@ -2407,7 +2468,7 @@ Outputs: In the example below, we submit the transfer using the signed_txset generated above: -``` +```Bash curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"submit_transfer","params":{"tx_data_hex":...long_hex..."}}' -H 'Content-Type: application/json' { "id": "0", @@ -2455,7 +2516,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"sweep_all","params":{"address":"55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt","subaddr_indices":[4],"ring_size":7,"unlock_time":0,"get_tx_keys":true}}' -H 'Content-Type: application/json' { "id": "0", @@ -2469,7 +2530,6 @@ $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","me "unsigned_txset": "" } } - ``` @@ -2499,7 +2559,7 @@ Outputs: Example (In this example, `sweep_dust` returns nothing because there are no funds to sweep): -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"sweep_dust","params":{"get_tx_keys":true}}' -H 'Content-Type: application/json' { "id": "0", @@ -2549,7 +2609,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"sweep_single","params":{"address":"74Jsocx8xbpTBEjm3ncKE5LBQbiJouyCDaGhgSiebpvNDXZnTAbW2CmUR5SsBeae2pNk9WMVuz6jegkC4krUyqRjA6VjoLD","ring_size":7,"unlock_time":0,"key_image":"a7834459ef795d2efb6f665d2fd758c8d9288989d8d4c712a68f8023f7804a5e","get_tx_keys":true}}' -H 'Content-Type: application/json' { "id": "0", @@ -2584,7 +2644,7 @@ Outputs: _None_. Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"tag_accounts","params":{"tag":"myTag","accounts":[0,1]}}' -H 'Content-Type: application/json' { "id": "0", @@ -2632,7 +2692,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"transfer","params":{"destinations":[{"amount":100000000000,"address":"7BnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o"},{"amount":200000000000,"address":"75sNpRwUtekcJGejMuLSGA71QFuK1qcCVLZnYRTfQLgFU5nJ7xiAHtR5ihioS53KMe8pBhH61moraZHyLoG4G7fMER8xkNv"}],"account_index":0,"subaddr_indices":[0],"priority":0,"ring_size":7,"get_tx_key": true}}' -H 'Content-Type: application/json' { "id": "0", @@ -2689,7 +2749,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"transfer_split","params":{"destinations":[{"amount":1000000000000,"address":"7BnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o"},{"amount":2000000000000,"address":"75sNpRwUtekcJGejMuLSGA71QFuK1qcCVLZnYRTfQLgFU5nJ7xiAHtR5ihioS53KMe8pBhH61moraZHyLoG4G7fMER8xkNv"}],"account_index":0,"subaddr_indices":[0],"priority":0,"ring_size":7,"get_tx_key": true}}' -H 'Content-Type: application/json' { "id": "0", @@ -2720,7 +2780,7 @@ Outputs: _None_. Example: -``` +```Bash $ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"untag_accounts","params":{"accounts":[1]}}' -H 'Content-Type: application/json' { "id": "0", @@ -2750,7 +2810,7 @@ Outputs: Example: -``` +```Bash $ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"verify","params":{"data":"This is sample data to be signed","address":"55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt","signature":"SigV14K6G151gycjiGxjQ74tKX6A2LwwghvuHjcDeuRFQio5LS6Gb27BNxjYQY1dPuUvXkEbGQUkiHSVLPj4nJAHRrrw3"}}' -H 'Content-Type: application/json' { "id": "0",