Wallet RPC dokumentace (peněženka)

Úvod

Zde je seznam monero-wallet-rpc volání, jejich vstupů a výstupů a u každého je navíc uveden příklad. Program monero-wallet-rpc nahradil rpc rozhraní v simplewallet a později monero-wallet-cli.

Všechny monero-wallet-rpc metody používají stejné JSON RPC rozhraní. Například:

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'

Pokud byl vykonán příkaz monero-wallet-rpc pomocí --rpc-login argumentu v podobě username:password, pak se řiďte tímto příkladem:

IP=127.0.0.1
PORT=18082
METHOD="make_integrated_address"
PARAMS="{\"payment_id\":\"1234567890123456789012345678900012345678901234567890123456789000\"}"
curl \
    -u username:password --digest \
    -X POST http://$IP:$PORT/json_rpc \
    -d '{"jsonrpc":"2.0","id":"0","method":"'$METHOD'","params":'"$PARAMS"'}' \
    -H 'Content-Type: application/json'

Poznámka: "atomické jednotky" představují nejmenší zlomek 1 XMR dle monerod implementace. 1 XMR = 1e12 atomických jednotek.

Seznam JSON RPC metod:


JSON RPC Metody:

getbalance

Return v podobě zůstatku peněženky.

Vstupy: None.

Výstupy:

  • balance - unsigned int; celkový zůstatek současné session monero-wallet-rpc in session.
  • unlocked_balance - unsigned int; Odemčené prostředky jsou takové, které jsou dostatečně hluboko v Monero blockchainu na to, aby byly považovány za vhodné k útratě.

Příklad:

$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"getbalance"}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "balance": 140000000000,
    "unlocked_balance": 50000000000
  }
}

getaddress

Return v podobě adresy peněženky.

Vstupy: Žádné.

Výstupy:

  • address - string; 95 znakový hex string adresy monero-wallet-rpc in session.

Příklad:

$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"getaddress"}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "address": "427ZuEhNJQRXoyJAeEoBaNW56ScQaLXyyQWgxeRL9KgAUhVzkvfiELZV7fCPBuuB2CGuJiWFQjhnhhwiH1FsHYGQGaDsaBA"
  }
}

getheight

Return v podobě aktuální výšky bloku.

Vstupy: Žádné.

Výstupy:

  • height - unsigned int; Současná výška bloku v monero-wallet-rpc. Pokud byla peněženka dlouho offline, bude potřebovat dohnat úroveň daemona.

Příklad:

$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"getheight"}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "height": 994310
  }
}

transfer

Pošlete Monero několika příjemcům.

Vstupy:

  • destinations - přehled cílových destinací pro příjem XMR:
    • amount - unsigned int; Množství, které má být odesláno do jednotlivých cílů, udáno v atomických jednotkách.
    • address - string; veřejná adresa cíle.
  • fee - unsigned int; Ignorujte, bude spočítáno automaticky.
  • mixin - unsigned int; počet výstupů z blockchainu pro mix (0 znamená no mixing).
  • unlock_time - unsigned int; Počet bloků které musí být vytěženy aby mohlo být Monero utraceno (0 znamená bez zámku).
  • payment_id - string; (Volitelné) Náhodný 32-bajtový / 64-znakový hex string pro identifikaci transakce.
  • get_tx_key - boolean; (Volitelný) po odeslání vrátit klíč transakce.
  • priority - unsigned int; Určete prioritu transkace. Přijatelné hodnoty jsou následující: 0-3 pro: výchozí, nedůležité, normální, zvýšená priorita.
  • do_not_relay - boolean; (Volitelné) Pokud true pak tato nově vytvořená transakce nebude předána do Monero sítě. (Výchozí hodnota je false).
  • get_tx_hex - boolean; Po odeslání vrátit transakci jako hex string

Výstupy:

  • fee - Integer hodnota poplatku za txn.
  • tx_hash - String pro veřejně prohledatelný hash transkace
  • tx_key - String pro klíč transakce je-li get_tx_key true, jinak, prázdný řetězec.
  • tx_blob - Transakce jako hex string pokud je get_tx_hex true

Příklad:

$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"transfer","params":{"destinations":[{"amount":100000000,"address":"9wNgSYy2F9qPZu7KBjvsFgZLTKE2TZgEpNFbGka9gA5zPmAXS35QzzYaLKJRkYTnzgArGNX7TvSqZC87tBLwtaC5RQgJ8rm"},{"amount":200000000,"address":"9vH5D7Fv47mbpCpdcthcjU34rqiiAYRCh1tYywmhqnEk9iwCE9yppgNCXAyVHG5qJt2kExa42TuhzQfJbmbpeGLkVbg8xit"}],"mixin":4,"get_tx_key": true}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "fee": 48958481211,
    "tx_hash": "985180f468637bc6d2f72ee054e1e34b8d5097988bb29a2e0cb763e4464db23c",
    "tx_key": "8d62e5637f1fcc9a8904057d6bed6c697618507b193e956f77c31ce662b2ee07"
  }
}

transfer_split

Stejné jako transfer, ale může být rozloženo na více tx, pokud je to třeba.

Vstupy:

  • destinations - přehled cílových destinací pro příjem XMR:
    • amount - unsigned int; Množství, které má být odesláno do jednotlivých cílů, udáno v atomických jednotkách.
    • address - string; veřejná adresa cíle.
  • fee - unsigned int; Ignorujte, bude spočítáno automaticky.
  • mixin - unsigned int; počet výstupů z blockchainu pro mix (0 znamená no mixing).
  • unlock_time - unsigned int; Počet bloků které musí být vytěženy aby mohlo být Monero utraceno (0 znamená bez zámku).
  • payment_id - string; (Volitelné) Náhodný 32-bajtový / 64-znakový hex string pro identifikaci transakce.
  • get_tx_keys - boolean; (Volitelný) po odeslání vrátit klíč transakce. - Ignored
  • priority - unsigned int; Určuje prioritu transakce. Přijatelné hodnoty jsou následující: 0-3 pro: výchozí, nedůležité, normální, zvýšená priorita,
  • do_not_relay - boolean; (Volitelné) Pokud true pak tato nově vytvořená transakce nebude předána do Monero sítě. (Výchozí hodnota je false).
  • get_tx_hex - boolean; Po odeslání vrátit transakci jako hex string
  • new_algorithm - boolean; True pro použití nových konstrukčních algoritmů pro transakce, defaultně jako false.

Výstupy:

  • fee_list - array of: integer. Hodnota poplatků zaplacených za každou transakci.
  • tx_hash_list - array of: string. Tx hashe každé transakce,
  • tx_blob_list - array of: string. Tx jako hex string pro každou transakci.
  • amount_list - array of: integer. Množství převedeno pro každou transakci
  • tx_key_list - array of: string. Klíče transakcí pro každou transakci.

Příklad:

$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"transfer_split","params":{"destinations":[{"amount":100000000,"address":"9wNgSYy2F9qPZu7KBjvsFgZLTKE2TZgEpNFbGka9gA5zPmAXS35QzzYaLKJRkYTnzgArGNX7TvSqZC87tBwtaC5RQgJ8rm"},{"amount":200000000,"address":"9vH5D7Fv47mbpCpdcthcjU34rqiiAYRCh1tYywmhqnEk9iwCE9yppgNCXAyVHG5qJt2kExa42TuhzQfJbmbpeGLkVbg8xit"},{"amount":200000000,"address":"9vC5Q25cR1d3WzKX6dpTaLJaqZyDrtTnfadTmVuB1Wue2tyFGxUhiE4RGa74pEDJv7gSySzcd1Ao6G1nzSaqp78vLfP6MPj"},{"amount":200000000,"address":"A2MSrn49ziBPJBh8ZNEhhbfyLMou6mao4C1F5TLGUatmUnCxZArDYkcbAnVkVEopWVeak2rKDrmc8JpoS7n5dvfN9YDPBTG"},{"amount":200000000,"address":"9tEDyVQ8zgRQbDYiykTdpw5kZ6qWQWcKfExEj9eQshjpGb3sdr3UyWE2AHWzUGzJjaH9HN1DdGBdyQQ4AqGMc7rr5xYwZWW"}],"mixin":4,"get_tx_key": true, "new_algorithm": true}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "fee_list": [97916962422],
    "tx_hash_list": ["c5c389846e701c27aaf1f7ab8b9dc457b471fcea5bc9710e8020d51275afbc54"]
  }
}

sweep_dust

Poslat všechny dust výstupy zpět do peněženky pro snadnější útratu (a mixování).

Vstupy: Žádné.

Výstupy:

  • tx_hash_list - list of: string

Příklad (v tomto příkladě sweep_dust odpoví errorem kvůli nedostatečnému zůstatku pro sweep):

$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"sweep_dust"}' -H 'Content-Type: application/json'

{
  "error": {
    "code": -4,
    "message": "not enough money"
  },
  "id": "0",
  "jsonrpc": "2.0"
}

sweep_all

Odeslat celý odemčený zůstatek na adresu.

Vstupy:

  • address - string; veřejná adresa cíle.
  • priority - unsigned int; (Volitelné)
  • mixin - unsigned int; počet výstupů z blockchainu pro mix (0 znamená no mixing).
  • unlock_time - unsigned int; Počet bloků které musí být vytěženy aby mohlo být Monero utraceno (0 znamená bez zámku).
  • payment_id - string; (Volitelné) Náhodný 32-bajtový / 64-znakový hex string pro identifikaci transakce.
  • get_tx_keys - boolean; (Volitelné) po odeslání vrátit klíč transakce.
  • below_amount - unsigned int; (Volitelné)
  • do_not_relay - boolean; (Volitelné)
  • get_tx_hex - boolean; (Volitelné) vrátí transakci jako hex šifrovaný řetězec.

Výstupy:

  • tx_hash_list - array of string;
  • tx_key_list - array of string;
  • tx_blob_list - array of string;

Příklad:

$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"sweep_all","params":{"address":"9sS8eRU2b5ZbN2FPSrpkiab1bjbHE5XtL6Ti6We3Fhw5aQPudRfVVypjgzKDNkxtvTQSPs122NKggb2mqcqkKSeMNVu59S","mixin":2,"unlock_time":0,"get_tx_keys":true}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "tx_hash_list": ["53a3648797d5524dd037d4105e067fa61468faecab41927fc43adbb26c202d22"],
    "tx_key_list": ["e83b3b78235e36cd7e4d9695efd81a3b3e64c7d1f1ebd61892f0a7add6a50301"]
  }
}

store

Uložit blockchain.

Vstupy: Žádné.

Výstupy: Žádné.

Příklad:

$ 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",
  "jsonrpc": "2.0",
  "result": {
  }
}

get_payments

Získejte seznam příchozích plateb pomocí payment id.

Vstupy:

  • payment_id - string

Výstupy:

  • payments - list of:
    • payment_id - string
    • tx_hash - string
    • amount - unsigned int
    • block_height - unsigned int
    • unlock_time - unsigned int

Příklad:

$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_payments","params":{"payment_id":"4279257e0a20608e25dba8744949c9e1caff4fcdafc7d5362ecf14225f3d9030"}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "payments": [{
      "amount": 10350000000000,
      "block_height": 994327,
      "payment_id": "4279257e0a20608e25dba8744949c9e1caff4fcdafc7d5362ecf14225f3d9030",
      "tx_hash": "c391089f5b1b02067acc15294e3629a463412af1f1ed0f354113dd4467e4f6c1",
      "unlock_time": 0
    }]
  }
}

get_bulk_payments

Získejte seznam příchozích plateb pomocí payment ID nebo pomocí seznamu payment IDs a to od určité výšky bloku. Tato metoda je preferovaná oproti get_payments protože má stejnou funkci, ale je více rozšiřitelný. Obě jsou ale použitelné pro účely vyhledávání transakcí pomocí jednoho payment ID.

Vstupy:

  • payment_ids - array of: string
  • min_block_height - unsigned int; Výška bloku, od které se bude prohledávat za účelem najití plateb.

Výstupy:

  • payments - list of:
    • payment_id - string
    • tx_hash - string
    • amount - unsigned int
    • block_height - unsigned int
    • unlock_time - unsigned int

Příklad:

$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_bulk_payments","params":{"payment_ids":["4279257e0a20608e25dba8744949c9e1caff4fcdafc7d5362ecf14225f3d9030"],"min_block_height":990000}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "payments": [{
      "amount": 10350000000000,
      "block_height": 994327,
      "payment_id": "4279257e0a20608e25dba8744949c9e1caff4fcdafc7d5362ecf14225f3d9030",
      "tx_hash": "c391089f5b1b02067acc15294e3629a463412af1f1ed0f354113dd4467e4f6c1",
      "unlock_time": 0
    }]
  }
}

get_transfers

Výstup v podobě seznamu převodů.

Vstupy:

  • in - boolean;
  • out - boolean;
  • pending - boolean;
  • failed - boolean;
  • pool - boolean;
  • filter_by_height - boolean;
  • min_height - unsigned int;
  • max_height - unsigned int;

Výstupy:

  • in array of transfers:
    • txid - string;
    • payment_id - string;
    • height - unsigned int;
    • timestamp - unsigned int;
    • amount - unsigned int;
    • fee - unsigned int;
    • note - string;
    • destinations - std::list;
    • type - string;
  • out array of transfers
  • pending array of transfers
  • failed array of transfers
  • pool array of transfers

Příklad:

$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_transfers","params":{"pool":true}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "pool": [{
      "amount": 500000000000,
      "fee": 0,
      "height": 0,
      "note": "",
      "payment_id": "758d9b225fda7b7f",
      "timestamp": 1488312467,
      "txid": "da7301d5423efa09fabacb720002e978d114ff2db6a1546f8b820644a1b96208",
      "type": "pool"
    }]
  }
}

get_transfer_by_txid

Zobrazit informace o převodu do/z této adresy

Vstupy:

  • txid - string

Výstupy:

  • transfer - JSON object obsahující informace o platbě:
    • amount - unsigned int
    • fee - unsigned int
    • height - unsigned int
    • note - string
    • payment_id - string
    • timestamp - unsigned int
    • txid - string
    • type - string

Příklad:

$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_transfer_by_txid","params":{"txid":"f2d33ba969a09941c6671e6dfe7e9456e5f686eca72c1a94a3e63ac6d7f27baf"}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "transfer": {
      "amount": 10000000000000,
      "fee": 0,
      "height": 1316388,
      "note": "",
      "payment_id": "0000000000000000",
      "timestamp": 1495539310,
      "txid": "f2d33ba969a09941c6671e6dfe7e9456e5f686eca72c1a94a3e63ac6d7f27baf",
      "type": "in"
    }
  }
}

incoming_transfers

Vrátit seznam příchozích plateb do peněženky

Vstupy:

  • transfer_type - string; "all": všechny pževody, "available": pouze neutracené převody NEBO "unavailable": již utracené převody

Výstupy:

  • transfers - list of:
    • amount - unsigned int
    • spent - boolean
    • global_index - unsigned int; Zpravidla pro interní užití, uživatelé mohou ignorovat.
    • tx_hash - string; Několik příchozích převodů může sdílet stejný hash, pokud byly ve stejné transakci.
    • tx_size - unsigned int

Příklad (Výpis "všech" typů transakcí):

$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"incoming_transfers","params":{"transfer_type":"all"}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "transfers": [{
      "amount": 10000000000000,
      "global_index": 711506,
      "spent": false,
      "tx_hash": "<c391089f5b1b02067acc15294e3629a463412af1f1ed0f354113dd4467e4f6c1>",
      "tx_size": 5870
    },{
      "amount": 300000000000,
      "global_index": 794232,
      "spent": false,
      "tx_hash": "<c391089f5b1b02067acc15294e3629a463412af1f1ed0f354113dd4467e4f6c1>",
      "tx_size": 5870
    },{
      "amount": 50000000000,
      "global_index": 213659,
      "spent": false,
      "tx_hash": "<c391089f5b1b02067acc15294e3629a463412af1f1ed0f354113dd4467e4f6c1>",
      "tx_size": 5870
    }]
  }
}

Příklad (Výpis "available" transakcí):

$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"incoming_transfers","params":{"transfer_type":"available"}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "transfers": [{
      "amount": 10000000000000,
      "global_index": 711506,
      "spent": false,
      "tx_hash": "<c391089f5b1b02067acc15294e3629a463412af1f1ed0f354113dd4467e4f6c1>",
      "tx_size": 5870
    },{
      "amount": 300000000000,
      "global_index": 794232,
      "spent": false,
      "tx_hash": "<c391089f5b1b02067acc15294e3629a463412af1f1ed0f354113dd4467e4f6c1>",
      "tx_size": 5870
    },{
      "amount": 50000000000,
      "global_index": 213659,
      "spent": false,
      "tx_hash": "<c391089f5b1b02067acc15294e3629a463412af1f1ed0f354113dd4467e4f6c1>",
      "tx_size": 5870
    }]
  }
}

Příklad (výpis "unavailable" transakcí. Tento konkrétní příklad poskytné 0 unavailable transakcí):

$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"incoming_transfers","params":{"transfer_type":"unavailable"}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
  }
}

query_key

Výstup v podobě spend key nebo view private key

Vstupy:

  • key_type - jaký klíč má být načten: "mnemonic" - mnemonický seed (starší peněženky ho nemají) NEBO "view_key" - view key

Výstupy:

  • key - string; TView key bude hex šifrován, zatímco mnemonický seed bude řetězec slov.

Příklad (Query view key):

$ 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",
  "jsonrpc": "2.0",
  "result": {
    "key": "7e341d..."
  }
}

Příklad (Query mnemonic key):

$ 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",
  "jsonrpc": "2.0",
  "result": {
    "key": "adapt adapt nostril ..."
  }
}

make_integrated_address

Vytvořte integrovanou adresu z adresy peněženky a payment ID.

Vstupy:

  • payment_id - string; hex šifrováno; může být ponecháno prázdné, pak bude generováno náhodné

Výstupy:

  • integrated_address - string

Příklad (Payment ID je prázdné , použito random ID):

$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"make_integrated_address","params":{"payment_id":""}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "integrated_address": "4BpEv3WrufwXoyJAeEoBaNW56ScQaLXyyQWgxeRL9KgAUhVzkvfiELZV7fCPBuuB2CGuJiWFQjhnhhwiH1FsHYGQQ8H2RRJveAtUeiFs6J"
  }
}

split_integrated_address

Získat standardní adresu a payment ID korespondující s integrovanou adresou

Vstupy:

  • integrated_address - string

Výstupy:

  • standard_address - string
  • payment - string; hex encoded

Příklad:

$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"split_integrated_address","params":{"integrated_address": "4BpEv3WrufwXoyJAeEoBaNW56ScQaLXyyQWgxeRL9KgAUhVzkvfiELZV7fCPBuuB2CGuJiWFQjhnhhwiH1FsHYGQQ8H2RRJveAtUeiFs6J"}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "payment_id": "<420fa29b2d9a49f5>",
    "standard_address": "427ZuEhNJQRXoyJAeEoBaNW56ScQaLXyyQWgxeRL9KgAUhVzkvfiELZV7fCPBuuB2CGuJiWFQjhnhhwiH1FsHYGQGaDsaBA"
  }
}

stop_wallet

Vypne peněženku, uloží soušasný stav.

Vstupy: Žádné.

Výstupy: Žádné.

Příklad:

$ 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",
  "jsonrpc": "2.0",
  "result": {
  }
}

make_uri

Vytvořit platební URI pomocí oficiálních URI specs.

Vstupy:

  • address - adresa peněženky
  • amount (volitelné) - integer množství, které má být obdrženo atomických jednotkách
  • payment_id (volitelné) - 16 nebo 64 znakové hexadecimální payment id string
  • recipient_name (volitelné) - string jméno příjemce platby
  • tx_description (volitelné) - string popisující důvod pro tx

Výstupy:

  • uri - string obsahující všechny informace o platebních vstupech ve správném formátu payment URI

Příklad:

$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"make_uri","params":{"address":"44AFFq5kSiGBoZ4NMDwYtN18obc8AemS33DBLWs3H7otXft3XjrpDtQGv7SqSsaBYBb98uNbr2VBBEt7f2wfn3RVGQBEP3A","amount":10,"payment_id":"0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef","tx_description":"Testing out the make_uri function.","recipient_name":"Monero Project donation address"}}'  -H 'Content-Type: application/json'

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "uri": "monero:44AFFq5kSiGBoZ4NMDwYtN18obc8AemS33DBLWs3H7otXft3XjrpDtQGv7SqSsaBYBb98uNbr2VBBEt7f2wfn3RVGQBEP3A?tx_payment_id=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef&tx_amount=0.000000000010&recipient_name=Monero%20Project%20donation%20address&tx_description=Testing%20out%20the%20make_uri%20function."
  }
}

parse_uri

Rozebrat payment URI pro získání informací o platbě

Vstupy:

  • uri - string obsahující všechny informace o platebních vstupech ve správném formátu payment URI

Výstupy:

  • uri - JSON object obsahující informace o platbě:
    • address - adresa peněženky
    • amount - množství (na desetinná čísla) měny, které má být obdrženo (0 pokud nevyplněno)
    • payment_id - 16 nebo 64 znakový hexadecimální payment id string (pokud nezadáno pak prázdný)
    • recipient_name - string nnázev příjemce (pokud nezadáno pak prázdný)
    • tx_description - string popisující důvod pro tx (pokud nezadáno pak prázdný)

Příklad:

$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"parse_uri","params":{"uri":"monero:44AFFq5kSiGBoZ4NMDwYtN18obc8AemS33DBLWs3H7otXft3XjrpDtQGv7SqSsaBYBb98uNbr2VBBEt7f2wfn3RVGQBEP3A?tx_payment_id=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef&tx_amount=0.000000000010&recipient_name=Monero%20Project%20donation%20address&tx_description=Testing%20out%20the%20make_uri%20function."}}' -H 'Content-Type: application/json'

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "uri": {
      "address": "44AFFq5kSiGBoZ4NMDwYtN18obc8AemS33DBLWs3H7otXft3XjrpDtQGv7SqSsaBYBb98uNbr2VBBEt7f2wfn3RVGQBEP3A",
      "amount": 10,
      "payment_id": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
      "recipient_name": "Monero Project donation address",
      "tx_description": "Testing out the make_uri function."
    }
  }
}

rescan_blockchain

Znovu prohledst blockchain od začátku.

Vstupy: Žádné.

Výstupy: Žádné.

Příklad:

$ 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",
  "jsonrpc": "2.0",
  "result": {
  }
}

set_tx_notes

Nastavit doplňkové string notes pro transakce.

Vstupy:

  • txids - array of string; ID transakce
  • notes - array of string; poznámky k dané transakci

Výstupy: Žádné.

Příklad:

$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"set_tx_notes","params":{"txids":["6a1a100c079c236e2cbf36f7760e8ef1a9e8357c434aa790a8c78de653ec4cf2"],"notes":["This is an example"]}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
  }
}

get_tx_notes

Získat string notes pro transakce.

Vstupy:

  • txids - array of string; ID transakce

Výstupy:

  • notes - array of string; poznámky k dané transakci

Příklad:

$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_tx_notes","params":{"txids":["6a1a100c079c236e2cbf36f7760e8ef1a9e8357c434aa790a8c78de653ec4cf2"]}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "notes": ["This is an example"]
  }
}

sign

Podepsat string.

Vstupy:

  • data - string;

Výstupy:

  • signature - string;

Příklad:

$ 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",
  "jsonrpc": "2.0",
  "result": {
    "signature": "SigV1Xp61ZkGguxSCHpkYEVw9eaWfRfSoAf36PCsSCApx4DUrKWHEqM9CdNwjeuhJii6LHDVDFxvTPijFsj3L8NDQp1TV"
  }
}

verify

Potvrdit podpis na řetězci..

Vstupy:

  • data - string;
  • address - string;
  • signature - string;

Výstupy:

  • good - boolean;

Příklad:

$ 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":"9sS8eRU2b5ZbN2FPSrpkiab1bjbHE5XtL6Ti6We3Fhw5aQPudRfVVypjgzKDNkxtvTQZSPs122NKggb2mqcqkKSeMNVu59S","signature":"SigV1Xp61ZkGguxSCHpkYEVw9eaWfRfSoAf36PCsSCApx4DUrKWHEqM9CdNwjeuhJii6LHDVDFxvTPijFsj3L8NDQp1TV"}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "good": true
  }
}

export_key_images

Exportovat podepsaný set key images

Vstupy: Žádné.

Výstupy:

  • signed_key_images - array of signed key images:
    • key_image - string;
    • signature - string;

Příklad:

$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"export_key_images"}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "signed_key_images": [{
      "key_image": "62b83df78baad99e23b5ad3f667bc6f8d388a13d9e84c7bb6c223a556dfd34af",
      "signature": "b87b7e989aa85aa3a2a7cd8adcb3a848d3512ff718b168e15217ff3e5da29c0183c0328b97cc052fcb5ee3548aa5e41e530ba9d854199ea19d7ddaf6a54a4c0a"
    }]
  }
}

import_key_images

Importovat podepsané key images seznamy a ověřit spent status.

Vstupy:

  • signed_key_images - array of signed key images:
    • key_image - string;
    • signature - string;

Výstupy:

  • height - unsigned int;
  • spent - unsigned int;
  • unspent - unsigned int;

Příklad:

$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"import_key_images", "params":{"signed_key_images":[{"key_image":"63b83df78cafd99e23b5ad3f667bc6f8d38813d9e84c7bb6c223a556dfd34af","signature":"b87b7e989aa86aa2a7a7cd8adcb3a848d3512ff718b168e15217ff3e5da29c0183c0328b97cc052fcb5ee3548aa5e41e530ba9d854199ea19d7ddaf6a54a4c0a"},{"key_image":"44ec12fbc56c533a30b09de8ae26febd515528c4957dfe875430377a7e212b4e","signature":"91105f15be0b25bc2a94bd78a7e261608974d6d888080b9f1815655b98af190340325ea1a0840a5951dacf913d4de1b2bd33ea59c1cb7bce1b6648afa7133d03"}]}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "height": 986050,
    "spent": 10000100000000,
    "unspent": 4979852760000
  }
}

get_address_book

Získat vstupy z adresáře

Vstupy:

  • entries - array of unsigned int; rejstřík požadovaných vstupů do adresáře

Výstupy:

  • entries - array of entries:
    • address - string;
    • description - string;
    • index - unsigned int;
    • payment_id - string;

Příklad:

$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_address_book","params":{"entries":[1,2]}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "entries": [{
      "address": "A135xq3GVMdU5qtAm4hN7zjPgz8bRaiSUQmtuDdjZ6CgXayvQruJy3WPe95qj873JhK4YdTQjoR39Leg6esznQk8PckhjRN",
      "description": "",
      "index": 1,
      "payment_id": "0000000000000000000000000000000000000000000000000000000000000000"
    },{
      "address": "A135xq3GVMdU5qtAm4hN7zjPgz8bRaiSUQmtuDdjZ6CgXayvQruJy3WPe95qj873JhK4YdTQjoR39Leg6esznQk8PckhjRN",
      "description": "",
      "index": 2,
      "payment_id": "0000000000000000000000000000000000000000000000000000000000000000"
    }]
  }
}

add_address_book

Přidat záznam do adresáře.

Vstupy:

  • address - string;
  • payment_id - (optional) string, defaultní hodnota je "0000000000000000000000000000000000000000000000000000000000000000";
  • description - (optional) string, defaultní hodnota"";

Výstupy:

  • index - unsigned int; Rejstřík záznamů v adresáři.

Příklad:

$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"add_address_book","params":{"address":"44AFFq5kSiGBoZ4NMDwYtN18obc8AemS33DBLWs3H7otXft3XjrpDtQGv7SqSsBYBb98uNbr2VBBEt7f2wfn3RVGQBEP3A","description":"Donation address for the Monero project"}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "index": 2
  }
}

delete_address_book

Smazat záznam z adresáře.

Vstupy:

  • index - unsigned int; Rejstřík záznamů v adresáři.

Výstupy: Žádné.

Příklad:

$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"delete_address_book","params":{"index":0}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
  }
}

rescan_spent

Znovu prohledat blok pro utracené výstupy.

Vstupy: Žádné.

Výstupy: Žádné.

Příklad:

$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"rescan_spent"}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
  }
}

start_mining

Začít těžit přes Monero daemon.

Vstupy:

  • threads_count - unsigned int; Počet vláken procesoru pro těžbu
  • do_background_mining - boolean;
  • ignore_battery - boolean;

Výstupy: Žádné.

Příklad:

$ 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":true}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
  }
}

stop_mining

Zastavit těžbu v Monero Daemon.

Vstupy: Žádné.

Výstupy: Žádné.

Příklad:

$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"stop_mining"}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
  }
}

get_languages

Získat seznam dostupných jazykových verzí pro seed peněženky.

Vstupy: Žádné.

Výstupy:

  • languages - array of string; Seznam dostupných jazykových verzí

Příklad:

$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_languages"}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
    "languages": ["Deutsch","English","Español","Français","Italiano","Nederlands","Português","русский язык","日本語","简体中文 (中国)","Esperanto"]
  }
}

create_wallet

Vytvořit novou peněženku Je potřeba mít nastaven výrok "–wallet-dir" při spuštění monero-wallet-rpc aby to fungovalo.

Vstupy:

  • filename - string;
  • password - string;
  • language - string; Jazyk pro seed peněženky

Výstupy: Žádné.

Příklad:

$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"create_wallet","params":{"filename":"mytestwallet","password":"mytestpassword","language":"English"}}' -H 'Content-Type: application/json'

{
  "id": "0",
  "jsonrpc": "2.0",
  "result": {
  }
}

open_wallet

Otevřít peněženku. Je potřeba mít nastaven výrok "–wallet-dir" při spuštění monero-wallet-rpc aby to fungovalo.

Vstupy:

  • filename - string;
  • password - string;

Výstupy: Žádné.

Příklad:

$ 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",
  "jsonrpc": "2.0",
  "result": {
  }
}