mirror of
https://github.com/monero-project/monero-docs.git
synced 2025-02-06 21:28:13 +00:00
4263 lines
183 KiB
HTML
4263 lines
183 KiB
HTML
|
|
|||
|
|
<!doctype html>
|
|||
|
|
<html lang="en" class="no-js">
|
|||
|
|
<head>
|
|||
|
|
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|||
|
|
|
|||
|
|
<meta name="description" content="Unofficial Monero Documentation">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<meta name="author" content="Piotr 'Qertoip' Włodarek">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="canonical" href="https://monerodocs.org/interacting/monero-wallet-rpc-reference/">
|
|||
|
|
|
|||
|
|
<link rel="shortcut icon" href="../../assets/images/favicon.png">
|
|||
|
|
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-6.2.5">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<title>monero-wallet-rpc - Reference - Monero Documentation</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" href="../../assets/stylesheets/main.15aa0b43.min.css">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" href="../../assets/stylesheets/palette.75751829.min.css">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<meta name="theme-color" content="#ffffff">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|||
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
|
|||
|
|
<style>body,input{font-family:"Roboto",-apple-system,BlinkMacSystemFont,Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono",SFMono-Regular,Consolas,Menlo,monospace}</style>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" href="../../overrides.css">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<body dir="ltr" data-md-color-scheme="" data-md-color-primary="white" data-md-color-accent="indigo">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
|||
|
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|||
|
|
<label class="md-overlay" for="__drawer"></label>
|
|||
|
|
<div data-md-component="skip">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="#monero-wallet-rpc-reference" class="md-skip">
|
|||
|
|
Skip to content
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div data-md-component="announce">
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<header class="md-header" data-md-component="header">
|
|||
|
|
<nav class="md-header-nav md-grid" aria-label="Header">
|
|||
|
|
<a href="https://monerodocs.org" title="Monero Documentation" class="md-header-nav__button md-logo" aria-label="Monero Documentation">
|
|||
|
|
|
|||
|
|
<img src="../../images/monero.svg" alt="logo">
|
|||
|
|
|
|||
|
|
</a>
|
|||
|
|
<label class="md-header-nav__button md-icon" for="__drawer">
|
|||
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
|
|||
|
|
</label>
|
|||
|
|
<div class="md-header-nav__title" data-md-component="header-title">
|
|||
|
|
<div class="md-header-nav__ellipsis">
|
|||
|
|
<div class="md-header-nav__topic">
|
|||
|
|
<span class="md-ellipsis">
|
|||
|
|
Monero Documentation
|
|||
|
|
</span>
|
|||
|
|
</div>
|
|||
|
|
<div class="md-header-nav__topic">
|
|||
|
|
<span class="md-ellipsis">
|
|||
|
|
|
|||
|
|
monero-wallet-rpc - Reference
|
|||
|
|
|
|||
|
|
</span>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<label class="md-header-nav__button md-icon" for="__search">
|
|||
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
|
|||
|
|
</label>
|
|||
|
|
|
|||
|
|
<div class="md-search" data-md-component="search" role="dialog">
|
|||
|
|
<label class="md-search__overlay" for="__search"></label>
|
|||
|
|
<div class="md-search__inner" role="search">
|
|||
|
|
<form class="md-search__form" name="search">
|
|||
|
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
|
|||
|
|
<label class="md-search__icon md-icon" for="__search">
|
|||
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
|
|||
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
|
|||
|
|
</label>
|
|||
|
|
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" data-md-component="search-reset" tabindex="-1">
|
|||
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
|
|||
|
|
</button>
|
|||
|
|
</form>
|
|||
|
|
<div class="md-search__output">
|
|||
|
|
<div class="md-search__scrollwrap" data-md-scrollfix>
|
|||
|
|
<div class="md-search-result" data-md-component="search-result">
|
|||
|
|
<div class="md-search-result__meta">
|
|||
|
|
Initializing search
|
|||
|
|
</div>
|
|||
|
|
<ol class="md-search-result__list"></ol>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="md-header-nav__source">
|
|||
|
|
|
|||
|
|
<a href="https://github.com/monerodocs/md/" title="Go to repository" class="md-source">
|
|||
|
|
<div class="md-source__icon md-icon">
|
|||
|
|
|
|||
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg>
|
|||
|
|
</div>
|
|||
|
|
<div class="md-source__repository">
|
|||
|
|
monerodocs/md
|
|||
|
|
</div>
|
|||
|
|
</a>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</nav>
|
|||
|
|
</header>
|
|||
|
|
|
|||
|
|
<div class="md-container" data-md-component="container">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<main class="md-main" data-md-component="main">
|
|||
|
|
<div class="md-main__inner md-grid">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation" >
|
|||
|
|
<div class="md-sidebar__scrollwrap">
|
|||
|
|
<div class="md-sidebar__inner">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
|||
|
|
<label class="md-nav__title" for="__drawer">
|
|||
|
|
<a href="https://monerodocs.org" title="Monero Documentation" class="md-nav__button md-logo" aria-label="Monero Documentation">
|
|||
|
|
|
|||
|
|
<img src="../../images/monero.svg" alt="logo">
|
|||
|
|
|
|||
|
|
</a>
|
|||
|
|
Monero Documentation
|
|||
|
|
</label>
|
|||
|
|
|
|||
|
|
<div class="md-nav__source">
|
|||
|
|
|
|||
|
|
<a href="https://github.com/monerodocs/md/" title="Go to repository" class="md-source">
|
|||
|
|
<div class="md-source__icon md-icon">
|
|||
|
|
|
|||
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg>
|
|||
|
|
</div>
|
|||
|
|
<div class="md-source__repository">
|
|||
|
|
monerodocs/md
|
|||
|
|
</div>
|
|||
|
|
</a>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../.." class="md-nav__link">
|
|||
|
|
Home
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2" checked>
|
|||
|
|
|
|||
|
|
<label class="md-nav__link" for="nav-2">
|
|||
|
|
Interacting
|
|||
|
|
<span class="md-nav__icon md-icon"></span>
|
|||
|
|
</label>
|
|||
|
|
<nav class="md-nav" aria-label="Interacting" data-md-level="1">
|
|||
|
|
<label class="md-nav__title" for="nav-2">
|
|||
|
|
<span class="md-nav__icon md-icon"></span>
|
|||
|
|
Interacting
|
|||
|
|
</label>
|
|||
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../download-monero-binaries/" class="md-nav__link">
|
|||
|
|
Download
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../verify-monero-binaries/" class="md-nav__link">
|
|||
|
|
Verify
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../overview/" class="md-nav__link">
|
|||
|
|
Overview
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../monero-config-file/" class="md-nav__link">
|
|||
|
|
Config file
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../monerod-reference/" class="md-nav__link">
|
|||
|
|
monerod
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../monero-wallet-cli-reference/" class="md-nav__link">
|
|||
|
|
monero-wallet-cli
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../monero-wallet-gui-reference/" class="md-nav__link">
|
|||
|
|
monero-wallet-gui
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item md-nav__item--active">
|
|||
|
|
|
|||
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|||
|
|
monero-wallet-rpc
|
|||
|
|
<span class="md-nav__icon md-icon"></span>
|
|||
|
|
</label>
|
|||
|
|
|
|||
|
|
<a href="./" class="md-nav__link md-nav__link--active">
|
|||
|
|
monero-wallet-rpc
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<label class="md-nav__title" for="__toc">
|
|||
|
|
<span class="md-nav__icon md-icon"></span>
|
|||
|
|
Table of contents
|
|||
|
|
</label>
|
|||
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#introduction" class="md-nav__link">
|
|||
|
|
Introduction
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
<nav class="md-nav" aria-label="Introduction">
|
|||
|
|
<ul class="md-nav__list">
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#index-of-json-rpc-methods" class="md-nav__link">
|
|||
|
|
Index of JSON RPC Methods:
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#json-rpc-methods" class="md-nav__link">
|
|||
|
|
JSON RPC Methods:
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
<nav class="md-nav" aria-label="JSON RPC Methods:">
|
|||
|
|
<ul class="md-nav__list">
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#add_address_book" class="md-nav__link">
|
|||
|
|
add_address_book
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#change_wallet_password" class="md-nav__link">
|
|||
|
|
change_wallet_password
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#check_reserve_proof" class="md-nav__link">
|
|||
|
|
check_reserve_proof
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#check_spend_proof" class="md-nav__link">
|
|||
|
|
check_spend_proof
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#check_tx_key" class="md-nav__link">
|
|||
|
|
check_tx_key
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#check_tx_proof" class="md-nav__link">
|
|||
|
|
check_tx_proof
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#close_wallet" class="md-nav__link">
|
|||
|
|
close_wallet
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#create_account" class="md-nav__link">
|
|||
|
|
create_account
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#create_address" class="md-nav__link">
|
|||
|
|
create_address
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#create_wallet" class="md-nav__link">
|
|||
|
|
create_wallet
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#delete_address_book" class="md-nav__link">
|
|||
|
|
delete_address_book
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#export_key_images" class="md-nav__link">
|
|||
|
|
export_key_images
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#export_multisig_info" class="md-nav__link">
|
|||
|
|
export_multisig_info
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#export_outputs" class="md-nav__link">
|
|||
|
|
export_outputs
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#finalize_multisig" class="md-nav__link">
|
|||
|
|
finalize_multisig
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_account_tags" class="md-nav__link">
|
|||
|
|
get_account_tags
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_accounts" class="md-nav__link">
|
|||
|
|
get_accounts
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_address" class="md-nav__link">
|
|||
|
|
get_address
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_address_book" class="md-nav__link">
|
|||
|
|
get_address_book
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_address_index" class="md-nav__link">
|
|||
|
|
get_address_index
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_attribute" class="md-nav__link">
|
|||
|
|
get_attribute
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_bulk_payments" class="md-nav__link">
|
|||
|
|
get_bulk_payments
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_height" class="md-nav__link">
|
|||
|
|
get_height
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_languages" class="md-nav__link">
|
|||
|
|
get_languages
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_payments" class="md-nav__link">
|
|||
|
|
get_payments
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_reserve_proof" class="md-nav__link">
|
|||
|
|
get_reserve_proof
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_spend_proof" class="md-nav__link">
|
|||
|
|
get_spend_proof
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_transfer_by_txid" class="md-nav__link">
|
|||
|
|
get_transfer_by_txid
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_transfers" class="md-nav__link">
|
|||
|
|
get_transfers
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_tx_key" class="md-nav__link">
|
|||
|
|
get_tx_key
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_tx_notes" class="md-nav__link">
|
|||
|
|
get_tx_notes
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_tx_proof" class="md-nav__link">
|
|||
|
|
get_tx_proof
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_version" class="md-nav__link">
|
|||
|
|
get_version
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#import_key_images" class="md-nav__link">
|
|||
|
|
import_key_images
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#import_multisig_info" class="md-nav__link">
|
|||
|
|
import_multisig_info
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#import_outputs" class="md-nav__link">
|
|||
|
|
import_outputs
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#incoming_transfers" class="md-nav__link">
|
|||
|
|
incoming_transfers
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#is_multisig" class="md-nav__link">
|
|||
|
|
is_multisig
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#label_account" class="md-nav__link">
|
|||
|
|
label_account
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#label_address" class="md-nav__link">
|
|||
|
|
label_address
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#make_integrated_address" class="md-nav__link">
|
|||
|
|
make_integrated_address
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#make_multisig" class="md-nav__link">
|
|||
|
|
make_multisig
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#make_uri" class="md-nav__link">
|
|||
|
|
make_uri
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#open_wallet" class="md-nav__link">
|
|||
|
|
open_wallet
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#parse_uri" class="md-nav__link">
|
|||
|
|
parse_uri
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#prepare_multisig" class="md-nav__link">
|
|||
|
|
prepare_multisig
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#query_key" class="md-nav__link">
|
|||
|
|
query_key
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#refresh" class="md-nav__link">
|
|||
|
|
refresh
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#relay_tx" class="md-nav__link">
|
|||
|
|
relay_tx
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#rescan_blockchain" class="md-nav__link">
|
|||
|
|
rescan_blockchain
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#rescan_spent" class="md-nav__link">
|
|||
|
|
rescan_spent
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#set_account_tag_description" class="md-nav__link">
|
|||
|
|
set_account_tag_description
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#set_attribute" class="md-nav__link">
|
|||
|
|
set_attribute
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#set_tx_notes" class="md-nav__link">
|
|||
|
|
set_tx_notes
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#sign" class="md-nav__link">
|
|||
|
|
sign
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#sign_multisig" class="md-nav__link">
|
|||
|
|
sign_multisig
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#sign_transfer" class="md-nav__link">
|
|||
|
|
sign_transfer
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#split_integrated_address" class="md-nav__link">
|
|||
|
|
split_integrated_address
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#start_mining" class="md-nav__link">
|
|||
|
|
start_mining
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#stop_mining" class="md-nav__link">
|
|||
|
|
stop_mining
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#stop_wallet" class="md-nav__link">
|
|||
|
|
stop_wallet
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#store" class="md-nav__link">
|
|||
|
|
store
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#submit_multisig" class="md-nav__link">
|
|||
|
|
submit_multisig
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#submit_transfer" class="md-nav__link">
|
|||
|
|
submit_transfer
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#sweep_all" class="md-nav__link">
|
|||
|
|
sweep_all
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#sweep_dust" class="md-nav__link">
|
|||
|
|
sweep_dust
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#sweep_single" class="md-nav__link">
|
|||
|
|
sweep_single
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#tag_accounts" class="md-nav__link">
|
|||
|
|
tag_accounts
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#transfer" class="md-nav__link">
|
|||
|
|
transfer
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#transfer_split" class="md-nav__link">
|
|||
|
|
transfer_split
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#untag_accounts" class="md-nav__link">
|
|||
|
|
untag_accounts
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#verify" class="md-nav__link">
|
|||
|
|
verify
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#sources" class="md-nav__link">
|
|||
|
|
Sources:
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../monero-blockchain-export-reference/" class="md-nav__link">
|
|||
|
|
monero-blockchain-export
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../monero-blockchain-import-reference/" class="md-nav__link">
|
|||
|
|
monero-blockchain-import
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
</nav>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../technical-specs/" class="md-nav__link">
|
|||
|
|
Technical specs
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item md-nav__item--nested">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4" >
|
|||
|
|
|
|||
|
|
<label class="md-nav__link" for="nav-4">
|
|||
|
|
Cryptography
|
|||
|
|
<span class="md-nav__icon md-icon"></span>
|
|||
|
|
</label>
|
|||
|
|
<nav class="md-nav" aria-label="Cryptography" data-md-level="1">
|
|||
|
|
<label class="md-nav__title" for="nav-4">
|
|||
|
|
<span class="md-nav__icon md-icon"></span>
|
|||
|
|
Cryptography
|
|||
|
|
</label>
|
|||
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../cryptography/introduction/" class="md-nav__link">
|
|||
|
|
Introduction
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item md-nav__item--nested">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-4-2" type="checkbox" id="nav-4-2" >
|
|||
|
|
|
|||
|
|
<label class="md-nav__link" for="nav-4-2">
|
|||
|
|
Asymmetric
|
|||
|
|
<span class="md-nav__icon md-icon"></span>
|
|||
|
|
</label>
|
|||
|
|
<nav class="md-nav" aria-label="Asymmetric" data-md-level="2">
|
|||
|
|
<label class="md-nav__title" for="nav-4-2">
|
|||
|
|
<span class="md-nav__icon md-icon"></span>
|
|||
|
|
Asymmetric
|
|||
|
|
</label>
|
|||
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../cryptography/asymmetric/introduction/" class="md-nav__link">
|
|||
|
|
Introduction
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../cryptography/asymmetric/private-key/" class="md-nav__link">
|
|||
|
|
Private keys
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../cryptography/asymmetric/public-key/" class="md-nav__link">
|
|||
|
|
Public keys
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../cryptography/asymmetric/edwards25519/" class="md-nav__link">
|
|||
|
|
Edwards25519 curve
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../cryptography/asymmetric/key-image/" class="md-nav__link">
|
|||
|
|
Key image
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
</nav>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../cryptography/base58/" class="md-nav__link">
|
|||
|
|
Base58
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../cryptography/prng/" class="md-nav__link">
|
|||
|
|
PRNG
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../cryptography/keccak-256/" class="md-nav__link">
|
|||
|
|
Keccak-256
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
</nav>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item md-nav__item--nested">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" >
|
|||
|
|
|
|||
|
|
<label class="md-nav__link" for="nav-5">
|
|||
|
|
Address
|
|||
|
|
<span class="md-nav__icon md-icon"></span>
|
|||
|
|
</label>
|
|||
|
|
<nav class="md-nav" aria-label="Address" data-md-level="1">
|
|||
|
|
<label class="md-nav__title" for="nav-5">
|
|||
|
|
<span class="md-nav__icon md-icon"></span>
|
|||
|
|
Address
|
|||
|
|
</label>
|
|||
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../public-address/standard-address/" class="md-nav__link">
|
|||
|
|
Standard
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../public-address/subaddress/" class="md-nav__link">
|
|||
|
|
Subaddress
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../public-address/integrated-address/" class="md-nav__link">
|
|||
|
|
Integrated
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
</nav>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item md-nav__item--nested">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6" >
|
|||
|
|
|
|||
|
|
<label class="md-nav__link" for="nav-6">
|
|||
|
|
Proof of Work
|
|||
|
|
<span class="md-nav__icon md-icon"></span>
|
|||
|
|
</label>
|
|||
|
|
<nav class="md-nav" aria-label="Proof of Work" data-md-level="1">
|
|||
|
|
<label class="md-nav__title" for="nav-6">
|
|||
|
|
<span class="md-nav__icon md-icon"></span>
|
|||
|
|
Proof of Work
|
|||
|
|
</label>
|
|||
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../proof-of-work/what-is-pow/" class="md-nav__link">
|
|||
|
|
What is PoW?
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../proof-of-work/pow-in-cryptocurrencies/" class="md-nav__link">
|
|||
|
|
PoW in Cryptocurrencies
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../proof-of-work/cryptonight/" class="md-nav__link">
|
|||
|
|
CryptoNight
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../proof-of-work/random-x/" class="md-nav__link">
|
|||
|
|
RandomX
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
</nav>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../multisignature/" class="md-nav__link">
|
|||
|
|
Multisignature
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item md-nav__item--nested">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8" >
|
|||
|
|
|
|||
|
|
<label class="md-nav__link" for="nav-8">
|
|||
|
|
Infrastructure
|
|||
|
|
<span class="md-nav__icon md-icon"></span>
|
|||
|
|
</label>
|
|||
|
|
<nav class="md-nav" aria-label="Infrastructure" data-md-level="1">
|
|||
|
|
<label class="md-nav__title" for="nav-8">
|
|||
|
|
<span class="md-nav__icon md-icon"></span>
|
|||
|
|
Infrastructure
|
|||
|
|
</label>
|
|||
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../infrastructure/networks/" class="md-nav__link">
|
|||
|
|
Mainnet, stagenet, testnet
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../infrastructure/tor-onion-p2p-seed-nodes/" class="md-nav__link">
|
|||
|
|
Tor onion seed nodes
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../infrastructure/monero-pulse/" class="md-nav__link">
|
|||
|
|
MoneroPulse
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
</nav>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item md-nav__item--nested">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9" >
|
|||
|
|
|
|||
|
|
<label class="md-nav__link" for="nav-9">
|
|||
|
|
Running a Node
|
|||
|
|
<span class="md-nav__icon md-icon"></span>
|
|||
|
|
</label>
|
|||
|
|
<nav class="md-nav" aria-label="Running a Node" data-md-level="1">
|
|||
|
|
<label class="md-nav__title" for="nav-9">
|
|||
|
|
<span class="md-nav__icon md-icon"></span>
|
|||
|
|
Running a Node
|
|||
|
|
</label>
|
|||
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../running-node/open-node-tor-onion/" class="md-nav__link">
|
|||
|
|
Open Node + Tor Onion
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
</nav>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item md-nav__item--nested">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10" >
|
|||
|
|
|
|||
|
|
<label class="md-nav__link" for="nav-10">
|
|||
|
|
Accepting Monero
|
|||
|
|
<span class="md-nav__icon md-icon"></span>
|
|||
|
|
</label>
|
|||
|
|
<nav class="md-nav" aria-label="Accepting Monero" data-md-level="1">
|
|||
|
|
<label class="md-nav__title" for="nav-10">
|
|||
|
|
<span class="md-nav__icon md-icon"></span>
|
|||
|
|
Accepting Monero
|
|||
|
|
</label>
|
|||
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="../../accepting-monero/overview/" class="md-nav__link">
|
|||
|
|
Overview
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
</nav>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
</nav>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc" >
|
|||
|
|
<div class="md-sidebar__scrollwrap">
|
|||
|
|
<div class="md-sidebar__inner">
|
|||
|
|
|
|||
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<label class="md-nav__title" for="__toc">
|
|||
|
|
<span class="md-nav__icon md-icon"></span>
|
|||
|
|
Table of contents
|
|||
|
|
</label>
|
|||
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#introduction" class="md-nav__link">
|
|||
|
|
Introduction
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
<nav class="md-nav" aria-label="Introduction">
|
|||
|
|
<ul class="md-nav__list">
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#index-of-json-rpc-methods" class="md-nav__link">
|
|||
|
|
Index of JSON RPC Methods:
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#json-rpc-methods" class="md-nav__link">
|
|||
|
|
JSON RPC Methods:
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
<nav class="md-nav" aria-label="JSON RPC Methods:">
|
|||
|
|
<ul class="md-nav__list">
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#add_address_book" class="md-nav__link">
|
|||
|
|
add_address_book
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#change_wallet_password" class="md-nav__link">
|
|||
|
|
change_wallet_password
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#check_reserve_proof" class="md-nav__link">
|
|||
|
|
check_reserve_proof
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#check_spend_proof" class="md-nav__link">
|
|||
|
|
check_spend_proof
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#check_tx_key" class="md-nav__link">
|
|||
|
|
check_tx_key
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#check_tx_proof" class="md-nav__link">
|
|||
|
|
check_tx_proof
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#close_wallet" class="md-nav__link">
|
|||
|
|
close_wallet
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#create_account" class="md-nav__link">
|
|||
|
|
create_account
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#create_address" class="md-nav__link">
|
|||
|
|
create_address
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#create_wallet" class="md-nav__link">
|
|||
|
|
create_wallet
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#delete_address_book" class="md-nav__link">
|
|||
|
|
delete_address_book
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#export_key_images" class="md-nav__link">
|
|||
|
|
export_key_images
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#export_multisig_info" class="md-nav__link">
|
|||
|
|
export_multisig_info
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#export_outputs" class="md-nav__link">
|
|||
|
|
export_outputs
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#finalize_multisig" class="md-nav__link">
|
|||
|
|
finalize_multisig
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_account_tags" class="md-nav__link">
|
|||
|
|
get_account_tags
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_accounts" class="md-nav__link">
|
|||
|
|
get_accounts
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_address" class="md-nav__link">
|
|||
|
|
get_address
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_address_book" class="md-nav__link">
|
|||
|
|
get_address_book
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_address_index" class="md-nav__link">
|
|||
|
|
get_address_index
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_attribute" class="md-nav__link">
|
|||
|
|
get_attribute
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_bulk_payments" class="md-nav__link">
|
|||
|
|
get_bulk_payments
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_height" class="md-nav__link">
|
|||
|
|
get_height
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_languages" class="md-nav__link">
|
|||
|
|
get_languages
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_payments" class="md-nav__link">
|
|||
|
|
get_payments
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_reserve_proof" class="md-nav__link">
|
|||
|
|
get_reserve_proof
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_spend_proof" class="md-nav__link">
|
|||
|
|
get_spend_proof
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_transfer_by_txid" class="md-nav__link">
|
|||
|
|
get_transfer_by_txid
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_transfers" class="md-nav__link">
|
|||
|
|
get_transfers
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_tx_key" class="md-nav__link">
|
|||
|
|
get_tx_key
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_tx_notes" class="md-nav__link">
|
|||
|
|
get_tx_notes
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_tx_proof" class="md-nav__link">
|
|||
|
|
get_tx_proof
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#get_version" class="md-nav__link">
|
|||
|
|
get_version
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#import_key_images" class="md-nav__link">
|
|||
|
|
import_key_images
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#import_multisig_info" class="md-nav__link">
|
|||
|
|
import_multisig_info
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#import_outputs" class="md-nav__link">
|
|||
|
|
import_outputs
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#incoming_transfers" class="md-nav__link">
|
|||
|
|
incoming_transfers
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#is_multisig" class="md-nav__link">
|
|||
|
|
is_multisig
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#label_account" class="md-nav__link">
|
|||
|
|
label_account
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#label_address" class="md-nav__link">
|
|||
|
|
label_address
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#make_integrated_address" class="md-nav__link">
|
|||
|
|
make_integrated_address
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#make_multisig" class="md-nav__link">
|
|||
|
|
make_multisig
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#make_uri" class="md-nav__link">
|
|||
|
|
make_uri
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#open_wallet" class="md-nav__link">
|
|||
|
|
open_wallet
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#parse_uri" class="md-nav__link">
|
|||
|
|
parse_uri
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#prepare_multisig" class="md-nav__link">
|
|||
|
|
prepare_multisig
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#query_key" class="md-nav__link">
|
|||
|
|
query_key
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#refresh" class="md-nav__link">
|
|||
|
|
refresh
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#relay_tx" class="md-nav__link">
|
|||
|
|
relay_tx
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#rescan_blockchain" class="md-nav__link">
|
|||
|
|
rescan_blockchain
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#rescan_spent" class="md-nav__link">
|
|||
|
|
rescan_spent
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#set_account_tag_description" class="md-nav__link">
|
|||
|
|
set_account_tag_description
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#set_attribute" class="md-nav__link">
|
|||
|
|
set_attribute
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#set_tx_notes" class="md-nav__link">
|
|||
|
|
set_tx_notes
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#sign" class="md-nav__link">
|
|||
|
|
sign
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#sign_multisig" class="md-nav__link">
|
|||
|
|
sign_multisig
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#sign_transfer" class="md-nav__link">
|
|||
|
|
sign_transfer
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#split_integrated_address" class="md-nav__link">
|
|||
|
|
split_integrated_address
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#start_mining" class="md-nav__link">
|
|||
|
|
start_mining
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#stop_mining" class="md-nav__link">
|
|||
|
|
stop_mining
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#stop_wallet" class="md-nav__link">
|
|||
|
|
stop_wallet
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#store" class="md-nav__link">
|
|||
|
|
store
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#submit_multisig" class="md-nav__link">
|
|||
|
|
submit_multisig
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#submit_transfer" class="md-nav__link">
|
|||
|
|
submit_transfer
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#sweep_all" class="md-nav__link">
|
|||
|
|
sweep_all
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#sweep_dust" class="md-nav__link">
|
|||
|
|
sweep_dust
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#sweep_single" class="md-nav__link">
|
|||
|
|
sweep_single
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#tag_accounts" class="md-nav__link">
|
|||
|
|
tag_accounts
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#transfer" class="md-nav__link">
|
|||
|
|
transfer
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#transfer_split" class="md-nav__link">
|
|||
|
|
transfer_split
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#untag_accounts" class="md-nav__link">
|
|||
|
|
untag_accounts
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#verify" class="md-nav__link">
|
|||
|
|
verify
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="md-nav__item">
|
|||
|
|
<a href="#sources" class="md-nav__link">
|
|||
|
|
Sources:
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
</nav>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="md-content">
|
|||
|
|
<article class="md-content__inner md-typeset">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="https://github.com/monerodocs/md/edit/master/docs/interacting/monero-wallet-rpc-reference.md" title="Edit this page" class="md-content__button md-icon">
|
|||
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<h1 id="monero-wallet-rpc-reference"><code>monero-wallet-rpc</code> - Reference<a class="headerlink" href="#monero-wallet-rpc-reference" title="Permanent link">¶</a></h1>
|
|||
|
|
<h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">¶</a></h2>
|
|||
|
|
<p>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.</p>
|
|||
|
|
<p>All monero-wallet-rpc methods use the same JSON RPC interface. For example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code><span class="nv">IP</span><span class="o">=</span><span class="m">127</span>.0.0.1
|
|||
|
|
<span class="nv">PORT</span><span class="o">=</span><span class="m">18082</span>
|
|||
|
|
<span class="nv">METHOD</span><span class="o">=</span><span class="s2">"make_integrated_address"</span>
|
|||
|
|
<span class="nv">PARAMS</span><span class="o">=</span><span class="s2">"{\"payment_id\":\"1234567890123456789012345678900012345678901234567890123456789000\"}"</span>
|
|||
|
|
curl <span class="se">\</span>
|
|||
|
|
-X POST http://<span class="nv">$IP</span>:<span class="nv">$PORT</span>/json_rpc <span class="se">\</span>
|
|||
|
|
-d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"'</span><span class="nv">$METHOD</span><span class="s1">'","params":'</span><span class="s2">"</span><span class="nv">$PARAMS</span><span class="s2">"</span><span class="s1">'}'</span> <span class="se">\</span>
|
|||
|
|
-H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<p>If the monero-wallet-rpc was executed with the <code>--rpc-login</code> argument as <code>username:password</code>, then follow this example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code><span class="nv">IP</span><span class="o">=</span><span class="m">127</span>.0.0.1
|
|||
|
|
<span class="nv">PORT</span><span class="o">=</span><span class="m">18082</span>
|
|||
|
|
<span class="nv">METHOD</span><span class="o">=</span><span class="s2">"make_integrated_address"</span>
|
|||
|
|
<span class="nv">PARAMS</span><span class="o">=</span><span class="s2">"{\"payment_id\":\"1234567890123456789012345678900012345678901234567890123456789000\"}"</span>
|
|||
|
|
curl <span class="se">\</span>
|
|||
|
|
-u username:password --digest <span class="se">\</span>
|
|||
|
|
-X POST http://<span class="nv">$IP</span>:<span class="nv">$PORT</span>/json_rpc <span class="se">\</span>
|
|||
|
|
-d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"'</span><span class="nv">$METHOD</span><span class="s1">'","params":'</span><span class="s2">"</span><span class="nv">$PARAMS</span><span class="s2">"</span><span class="s1">'}'</span> <span class="se">\</span>
|
|||
|
|
-H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<p>Note: "atomic units" refer to the smallest fraction of 1 XMR according to the monerod implementation. <strong>1 XMR = 1e12 atomic units.</strong></p>
|
|||
|
|
<h3 id="index-of-json-rpc-methods">Index of JSON RPC Methods:<a class="headerlink" href="#index-of-json-rpc-methods" title="Permanent link">¶</a></h3>
|
|||
|
|
<ul>
|
|||
|
|
<li><a href="#add_address_book">add_address_book</a></li>
|
|||
|
|
<li><a href="#change_wallet_password">change_wallet_password</a></li>
|
|||
|
|
<li><a href="#check_reserve_proof">check_reserve_proof</a></li>
|
|||
|
|
<li><a href="#check_spend_proof">check_spend_proof</a></li>
|
|||
|
|
<li><a href="#check_tx_key">check_tx_key</a></li>
|
|||
|
|
<li><a href="#check_tx_proof">check_tx_proof</a></li>
|
|||
|
|
<li><a href="#close_wallet">close_wallet</a></li>
|
|||
|
|
<li><a href="#create_account">create_account</a></li>
|
|||
|
|
<li><a href="#create_address">create_address</a></li>
|
|||
|
|
<li><a href="#create_wallet">create_wallet</a></li>
|
|||
|
|
<li><a href="#delete_address_book">delete_address_book</a></li>
|
|||
|
|
<li><a href="#export_key_images">export_key_images</a></li>
|
|||
|
|
<li><a href="#export_multisig_info">export_multisig_info</a></li>
|
|||
|
|
<li><a href="#export_outputs">export_outputs</a></li>
|
|||
|
|
<li><a href="#finalize_multisig">finalize_multisig</a></li>
|
|||
|
|
<li><a href="#get_accounts">get_accounts</a></li>
|
|||
|
|
<li><a href="#get_account_tags">get_account_tags</a></li>
|
|||
|
|
<li><a href="#get_address_book">get_address_book</a></li>
|
|||
|
|
<li><a href="#get_address">get_address</a></li>
|
|||
|
|
<li><a href="#get_address_index">get_address_index</a></li>
|
|||
|
|
<li><a href="#get_attribute">get_attribute</a></li>
|
|||
|
|
<li><a href="#get_balance">get_balance</a></li>
|
|||
|
|
<li><a href="#get_bulk_payments">get_bulk_payments</a></li>
|
|||
|
|
<li><a href="#get_height">get_height</a></li>
|
|||
|
|
<li><a href="#get_languages">get_languages</a></li>
|
|||
|
|
<li><a href="#get_payments">get_payments</a></li>
|
|||
|
|
<li><a href="#get_reserve_proof">get_reserve_proof</a></li>
|
|||
|
|
<li><a href="#get_spend_proof">get_spend_proof</a></li>
|
|||
|
|
<li><a href="#get_transfer_by_txid">get_transfer_by_txid</a></li>
|
|||
|
|
<li><a href="#get_transfers">get_transfers</a></li>
|
|||
|
|
<li><a href="#get_tx_key">get_tx_key</a></li>
|
|||
|
|
<li><a href="#get_tx_notes">get_tx_notes</a></li>
|
|||
|
|
<li><a href="#get_tx_proof">get_tx_proof</a></li>
|
|||
|
|
<li><a href="#get_version">get_version</a></li>
|
|||
|
|
<li><a href="#import_key_images">import_key_images</a></li>
|
|||
|
|
<li><a href="#import_multisig_info">import_multisig_info</a></li>
|
|||
|
|
<li><a href="#import_outputs">import_outputs</a></li>
|
|||
|
|
<li><a href="#incoming_transfers">incoming_transfers</a></li>
|
|||
|
|
<li><a href="#is_multisig">is_multisig</a></li>
|
|||
|
|
<li><a href="#label_account">label_account</a></li>
|
|||
|
|
<li><a href="#label_address">label_address</a></li>
|
|||
|
|
<li><a href="#make_integrated_address">make_integrated_address</a></li>
|
|||
|
|
<li><a href="#make_multisig">make_multisig</a></li>
|
|||
|
|
<li><a href="#make_uri">make_uri</a></li>
|
|||
|
|
<li><a href="#open_wallet">open_wallet</a></li>
|
|||
|
|
<li><a href="#parse_uri">parse_uri</a></li>
|
|||
|
|
<li><a href="#prepare_multisig">prepare_multisig</a></li>
|
|||
|
|
<li><a href="#query_key">query_key</a></li>
|
|||
|
|
<li><a href="#refresh">refresh</a></li>
|
|||
|
|
<li><a href="#relay_tx">relay_tx</a></li>
|
|||
|
|
<li><a href="#rescan_blockchain">rescan_blockchain</a></li>
|
|||
|
|
<li><a href="#rescan_spent">rescan_spent</a></li>
|
|||
|
|
<li><a href="#set_account_tag_description">set_account_tag_description</a></li>
|
|||
|
|
<li><a href="#set_attribute">set_attribute</a></li>
|
|||
|
|
<li><a href="#set_tx_notes">set_tx_notes</a></li>
|
|||
|
|
<li><a href="#sign_multisig">sign_multisig</a></li>
|
|||
|
|
<li><a href="#sign">sign</a></li>
|
|||
|
|
<li><a href="#sign_transfer">sign_transfer</a></li>
|
|||
|
|
<li><a href="#split_integrated_address">split_integrated_address</a></li>
|
|||
|
|
<li><a href="#start_mining">start_mining</a></li>
|
|||
|
|
<li><a href="#stop_mining">stop_mining</a></li>
|
|||
|
|
<li><a href="#stop_wallet">stop_wallet</a></li>
|
|||
|
|
<li><a href="#store">store</a></li>
|
|||
|
|
<li><a href="#submit_multisig">submit_multisig</a></li>
|
|||
|
|
<li><a href="#submit_transfer">submit_transfer</a></li>
|
|||
|
|
<li><a href="#sweep_all">sweep_all</a></li>
|
|||
|
|
<li><a href="#sweep_dust">sweep_dust</a></li>
|
|||
|
|
<li><a href="#sweep_single">sweep_single</a></li>
|
|||
|
|
<li><a href="#tag_accounts">tag_accounts</a></li>
|
|||
|
|
<li><a href="#transfer_split">transfer_split</a></li>
|
|||
|
|
<li><a href="#transfer">transfer</a></li>
|
|||
|
|
<li><a href="#untag_accounts">untag_accounts</a></li>
|
|||
|
|
<li><a href="#verify">verify</a></li>
|
|||
|
|
</ul>
|
|||
|
|
<h2 id="json-rpc-methods">JSON RPC Methods:<a class="headerlink" href="#json-rpc-methods" title="Permanent link">¶</a></h2>
|
|||
|
|
<h3 id="add_address_book"><strong>add_address_book</strong><a class="headerlink" href="#add_address_book" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Add an entry to the address book.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>address</em> - string;</li>
|
|||
|
|
<li><em>payment_id</em> - (optional) string, defaults to "0000000000000000000000000000000000000000000000000000000000000000";</li>
|
|||
|
|
<li><em>description</em> - (optional) string, defaults to "";</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>index</em> - unsigned int; The index of the address book entry.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"add_address_book","params":{"address":"78P16M3XmFRGcWFCcsgt1WcTntA1jzcq31seQX1Eg92j8VQ99NPivmdKam4J5CKNAD7KuNWcq5xUPgoWczChzdba5WLwQ4j","description":"Third account"}}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="s2">"index"</span>: <span class="m">1</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="change_wallet_password"><strong>change_wallet_password</strong><a class="headerlink" href="#change_wallet_password" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Change a wallet password.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>old_password</em> - string; (Optional) Current wallet password, if defined.</li>
|
|||
|
|
<li><em>new_password</em> - string; (Optional) New wallet password, if not blank.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs: <em>None</em>.</p>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"change_wallet_password","params":{"old_password":"theCurrentSecretPassPhrase","new_password":"theNewSecretPassPhrase"}}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="check_reserve_proof"><strong>check_reserve_proof</strong><a class="headerlink" href="#check_reserve_proof" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Proves a wallet has a disposable reserve using a signature.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>address</em> - string; Public address of the wallet.</li>
|
|||
|
|
<li><em>message</em> - string; (Optional) Should be the same message used in <code>get_reserve_proof</code>.</li>
|
|||
|
|
<li><em>signature</em> - string; reserve signature to confirm.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>good</em> - boolean; States if the inputs proves the reserve.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>In the example below, the reserve has been proven:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"check_reserve_proof","params":{"address":"55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt","signature":"ReserveProofV11BZ23sBt9sZJeGccf84mzyAmNCP3KzYbE1111112VKmH111118NfCYJQjZ6c46gT2kXgcHCaSSZeL8sRdzqjqx7i1e7FQfQGu2o113UYFVdwzHQi3iENDPa76Kn1BvywbKz3bMkXdZkBEEhBSF4kjjGaiMJ1ucKb6wvMVC4A8sA4nZEdL2Mk3wBucJCYTZwKqA8i1M113kqakDkG25FrjiDqdQTCYz2wDBmfKxF3eQiV5FWzZ6HmAyxnqTWUiMWukP9A3Edy3ZXqjP1b23dhz7Mbj39bBxe3ZeDNu9HnTSqYvHNRyqCkeUMJpHyQweqjGUJ1DSfFYr33J1E7MkhMnEi1o7trqWjVix32XLetYfePG73yvHbS24837L7Q64i5n1LSpd9yMiQZ3Dyaysi5y6jPx7TpAvnSqBFtuCciKoNzaXoA3dqt9cuVFZTXzdXKqdt3cXcVJMNxY8RvKPVQHhUur94Lpo1nSpxf7BN5a5rHrbZFqoZszsZmiWikYPkLX72XUdw6NWjLrTBxSy7KuPYH86c6udPEXLo2xgN6XHMBMBJzt8FqqK7EcpNUBkuHm2AtpGkf9CABY3oSjDQoRF5n4vNLd3qUaxNsG4XJ12L9gJ7GrK273BxkfEA8fDdxPrb1gpespbgEnCTuZHqj1A"}}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="s2">"good"</span>: true,
|
|||
|
|
<span class="s2">"spent"</span>: <span class="m">0</span>,
|
|||
|
|
<span class="s2">"total"</span>: <span class="m">100000000000</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<p>In the example below, all wallet reserve has been proven:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"check_reserve_proof","params":{"address":"55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt","message":"I have 10 at least","signature":"...signature..."}}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="s2">"good"</span>: true,
|
|||
|
|
<span class="s2">"spent"</span>: <span class="m">0</span>,
|
|||
|
|
<span class="s2">"total"</span>: <span class="m">164113855714662789</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<p>In the example below, the wrong message is used, avoiding the reserve to be proved:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"check_spend_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","message":"wrong message","signature":"SpendProofV1aSh8Todhk54736iXgV6vJAFP7egxByuMWZeyNDaN2JY737S95X5zz5mNMQSuCNSLjjhi5HJCsndpNWSNVsuThxwv285qy1KkUrLFRkxMSCjfL6bbycYN33ScZ5UB4Fzseceo1ndpL393T1q638VmcU3a56dhNHF1RPZFiGPS61FA78nXFSqE9uoKCCoHkEz83M1dQVhxZV5CEPF2P6VioGTKgprLCH9vvj9k1ivd4SX19L2VSMc3zD1u3mkR24ioETvxBoLeBSpxMoikyZ6inhuPm8yYo9YWyFtQK4XYfAV9mJ9knz5fUPXR8vvh7KJCAg4dqeJXTVb4mbMzYtsSZXHd6ouWoyCd6qMALdW8pKhgMCHcVYMWp9X9WHZuCo9rsRjRpg15sJUw7oJg1JoGiVgj8P4JeGDjnZHnmLVa5bpJhVCbMhyM7JLXNQJzFWTGC27TQBbthxCfQaKdusYnvZnKPDJWSeceYEFzepUnsWhQtyhbb73FzqgWC4eKEFKAZJqT2LuuSoxmihJ9acnFK7Ze23KTVYgDyMKY61VXADxmSrBvwUtxCaW4nQtnbMxiPMNnDMzeixqsFMBtN72j5UqhiLRY99k6SE7Qf5f29haNSBNSXCFFHChPKNTwJrehkofBdKUhh2VGPqZDNoefWUwfudeu83t85bmjv8Q3LrQSkFgFjRT5tLo8TMawNXoZCrQpyZrEvnodMDDUUNf3NL7rxyv3gM1KrTWjYaWXFU2RAsFee2Q2MTwUW7hR25cJvSFuB1BX2bfkoCbiMk923tHZGU2g7rSKF1GDDkXAc1EvFFD4iGbh1Q5t6hPRhBV8PEncdcCWGq5uAL5D4Bjr6VXG8uNeCy5oYWNgbZ5JRSfm7QEhPv8Fy9AKMgmCxDGMF9dVEaU6tw2BAnJavQdfrxChbDBeQXzCbCfep6oei6n2LZdE5Q84wp7eoQFE5Cwuo23tHkbJCaw2njFi3WGBbA7uGZaGHJPyB2rofTWBiSUXZnP2hiE9bjJghAcDm1M4LVLfWvhZmFEnyeru3VWMETnetz1BYLUC5MJGFXuhnHwWh7F6r74FDyhdswYop4eWPbyrXMXmUQEccTGd2NaT8g2VHADZ76gMC6BjWESvcnz2D4n8XwdmM7ZQ1jFwhuXrBfrb1dwRasyXxxHMGAC2onatNiExyeQ9G1W5LwqNLAh9hvcaNTGaYKYXoceVzLkgm6e5WMkLsCwuZXvB"}}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="s2">"good"</span>: <span class="nb">false</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="check_spend_proof"><strong>check_spend_proof</strong><a class="headerlink" href="#check_spend_proof" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Prove a spend using a signature. Unlike proving a transaction, it does not requires the destination public address.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>txid</em> - string; transaction id.</li>
|
|||
|
|
<li><em>message</em> - string; (Optional) Should be the same message used in <code>get_spend_proof</code>.</li>
|
|||
|
|
<li><em>signature</em> - string; spend signature to confirm.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>good</em> - boolean; States if the inputs proves the spend.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>In the example below, the spend has been proven:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"check_spend_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","message":"this is my transaction","signature":"SpendProofV1aSh8Todhk54736iXgV6vJAFP7egxByuMWZeyNDaN2JY737S95X5zz5mNMQSuCNSLjjhi5HJCsndpNWSNVsuThxwv285qy1KkUrLFRkxMSCjfL6bbycYN33ScZ5UB4Fzseceo1ndpL393T1q638VmcU3a56dhNHF1RPZFiGPS61FA78nXFSqE9uoKCCoHkEz83M1dQVhxZV5CEPF2P6VioGTKgprLCH9vvj9k1ivd4SX19L2VSMc3zD1u3mkR24ioETvxBoLeBSpxMoikyZ6inhuPm8yYo9YWyFtQK4XYfAV9mJ9knz5fUPXR8vvh7KJCAg4dqeJXTVb4mbMzYtsSZXHd6ouWoyCd6qMALdW8pKhgMCHcVYMWp9X9WHZuCo9rsRjRpg15sJUw7oJg1JoGiVgj8P4JeGDjnZHnmLVa5bpJhVCbMhyM7JLXNQJzFWTGC27TQBbthxCfQaKdusYnvZnKPDJWSeceYEFzepUnsWhQtyhbb73FzqgWC4eKEFKAZJqT2LuuSoxmihJ9acnFK7Ze23KTVYgDyMKY61VXADxmSrBvwUtxCaW4nQtnbMxiPMNnDMzeixqsFMBtN72j5UqhiLRY99k6SE7Qf5f29haNSBNSXCFFHChPKNTwJrehkofBdKUhh2VGPqZDNoefWUwfudeu83t85bmjv8Q3LrQSkFgFjRT5tLo8TMawNXoZCrQpyZrEvnodMDDUUNf3NL7rxyv3gM1KrTWjYaWXFU2RAsFee2Q2MTwUW7hR25cJvSFuB1BX2bfkoCbiMk923tHZGU2g7rSKF1GDDkXAc1EvFFD4iGbh1Q5t6hPRhBV8PEncdcCWGq5uAL5D4Bjr6VXG8uNeCy5oYWNgbZ5JRSfm7QEhPv8Fy9AKMgmCxDGMF9dVEaU6tw2BAnJavQdfrxChbDBeQXzCbCfep6oei6n2LZdE5Q84wp7eoQFE5Cwuo23tHkbJCaw2njFi3WGBbA7uGZaGHJPyB2rofTWBiSUXZnP2hiE9bjJghAcDm1M4LVLfWvhZmFEnyeru3VWMETnetz1BYLUC5MJGFXuhnHwWh7F6r74FDyhdswYop4eWPbyrXMXmUQEccTGd2NaT8g2VHADZ76gMC6BjWESvcnz2D4n8XwdmM7ZQ1jFwhuXrBfrb1dwRasyXxxHMGAC2onatNiExyeQ9G1W5LwqNLAh9hvcaNTGaYKYXoceVzLkgm6e5WMkLsCwuZXvB"}}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="s2">"good"</span>: <span class="nb">true</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<p>In the example below, the wrong message is used, avoiding the spend to be proved:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"check_spend_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","message":"wrong message","signature":"SpendProofV1aSh8Todhk54736iXgV6vJAFP7egxByuMWZeyNDaN2JY737S95X5zz5mNMQSuCNSLjjhi5HJCsndpNWSNVsuThxwv285qy1KkUrLFRkxMSCjfL6bbycYN33ScZ5UB4Fzseceo1ndpL393T1q638VmcU3a56dhNHF1RPZFiGPS61FA78nXFSqE9uoKCCoHkEz83M1dQVhxZV5CEPF2P6VioGTKgprLCH9vvj9k1ivd4SX19L2VSMc3zD1u3mkR24ioETvxBoLeBSpxMoikyZ6inhuPm8yYo9YWyFtQK4XYfAV9mJ9knz5fUPXR8vvh7KJCAg4dqeJXTVb4mbMzYtsSZXHd6ouWoyCd6qMALdW8pKhgMCHcVYMWp9X9WHZuCo9rsRjRpg15sJUw7oJg1JoGiVgj8P4JeGDjnZHnmLVa5bpJhVCbMhyM7JLXNQJzFWTGC27TQBbthxCfQaKdusYnvZnKPDJWSeceYEFzepUnsWhQtyhbb73FzqgWC4eKEFKAZJqT2LuuSoxmihJ9acnFK7Ze23KTVYgDyMKY61VXADxmSrBvwUtxCaW4nQtnbMxiPMNnDMzeixqsFMBtN72j5UqhiLRY99k6SE7Qf5f29haNSBNSXCFFHChPKNTwJrehkofBdKUhh2VGPqZDNoefWUwfudeu83t85bmjv8Q3LrQSkFgFjRT5tLo8TMawNXoZCrQpyZrEvnodMDDUUNf3NL7rxyv3gM1KrTWjYaWXFU2RAsFee2Q2MTwUW7hR25cJvSFuB1BX2bfkoCbiMk923tHZGU2g7rSKF1GDDkXAc1EvFFD4iGbh1Q5t6hPRhBV8PEncdcCWGq5uAL5D4Bjr6VXG8uNeCy5oYWNgbZ5JRSfm7QEhPv8Fy9AKMgmCxDGMF9dVEaU6tw2BAnJavQdfrxChbDBeQXzCbCfep6oei6n2LZdE5Q84wp7eoQFE5Cwuo23tHkbJCaw2njFi3WGBbA7uGZaGHJPyB2rofTWBiSUXZnP2hiE9bjJghAcDm1M4LVLfWvhZmFEnyeru3VWMETnetz1BYLUC5MJGFXuhnHwWh7F6r74FDyhdswYop4eWPbyrXMXmUQEccTGd2NaT8g2VHADZ76gMC6BjWESvcnz2D4n8XwdmM7ZQ1jFwhuXrBfrb1dwRasyXxxHMGAC2onatNiExyeQ9G1W5LwqNLAh9hvcaNTGaYKYXoceVzLkgm6e5WMkLsCwuZXvB"}}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="s2">"good"</span>: <span class="nb">false</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="check_tx_key"><strong>check_tx_key</strong><a class="headerlink" href="#check_tx_key" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Check a transaction in the blockchain with its secret key.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>txid</em> - string; transaction id.</li>
|
|||
|
|
<li><em>tx_key</em> - string; transaction secret key.</li>
|
|||
|
|
<li><em>address</em> - string; destination public address of the transaction.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>confirmations</em> - unsigned int; Number of block mined after the one with the transaction.</li>
|
|||
|
|
<li><em>in_pool</em> - boolean; States if the transaction is still in pool or has been added to a block.</li>
|
|||
|
|
<li><em>received</em> - unsigned int; Amount of the transaction.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"check_tx_key","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","tx_key":"feba662cf8fb6d0d0da18fc9b70ab28e01cc76311278fdd7fe7ab16360762b06","address":"7BnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o"}}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="s2">"confirmations"</span>: <span class="m">0</span>,
|
|||
|
|
<span class="s2">"in_pool"</span>: false,
|
|||
|
|
<span class="s2">"received"</span>: <span class="m">1000000000000</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="check_tx_proof"><strong>check_tx_proof</strong><a class="headerlink" href="#check_tx_proof" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Prove a transaction by checking its signature.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>txid</em> - string; transaction id.</li>
|
|||
|
|
<li><em>address</em> - string; destination public address of the transaction.</li>
|
|||
|
|
<li><em>message</em> - string; (Optional) Should be the same message used in <code>get_tx_proof</code>.</li>
|
|||
|
|
<li><em>signature</em> - string; transaction signature to confirm.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>confirmations</em> - unsigned int; Number of block mined after the one with the transaction.</li>
|
|||
|
|
<li><em>good</em> - boolean; States if the inputs proves the transaction.</li>
|
|||
|
|
<li><em>in_pool</em> - boolean; States if the transaction is still in pool or has been added to a block.</li>
|
|||
|
|
<li><em>received</em> - unsigned int; Amount of the transaction.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>In the example below, the transaction has been proven:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"check_tx_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","address":"7BnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o","message":"this is my transaction","signature":"InProofV13vqBCT6dpSAXkypZmSEMPGVnNRFDX2vscUYeVS4WnSVnV5BwLs31T9q6Etfj9Wts6tAxSAS4gkMeSYzzLS7Gt4vvCSQRh9niGJMUDJsB5hTzb2XJiCkUzWkkcjLFBBRVD5QZ"}}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="s2">"confirmations"</span>: <span class="m">482</span>,
|
|||
|
|
<span class="s2">"good"</span>: true,
|
|||
|
|
<span class="s2">"in_pool"</span>: false,
|
|||
|
|
<span class="s2">"received"</span>: <span class="m">1000000000000</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<p>In the example below, the wrong message is used, avoiding the transaction to be proved:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"check_tx_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","address":"7BnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o","message":"wrong message","signature":"InProofV13vqBCT6dpSAXkypZmSEMPGVnNRFDX2vscUYeVS4WnSVnV5BwLs31T9q6Etfj9Wts6tAxSAS4gkMeSYzzLS7Gt4vvCSQRh9niGJMUDJsB5hTzb2XJiCkUzWkkcjLFBBRVD5QZ"}}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="s2">"confirmations"</span>: <span class="m">0</span>,
|
|||
|
|
<span class="s2">"good"</span>: false,
|
|||
|
|
<span class="s2">"in_pool"</span>: false,
|
|||
|
|
<span class="s2">"received"</span>: <span class="m">0</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="close_wallet"><strong>close_wallet</strong><a class="headerlink" href="#close_wallet" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Close the currently opened wallet, after trying to save it.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs: <em>None</em>.</p>
|
|||
|
|
<p>Outputs: <em>None</em>.</p>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"close_wallet"}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="create_account"><strong>create_account</strong><a class="headerlink" href="#create_account" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Create a new account with an optional label.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>label</em> - string; (Optional) Label for the account.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>account_index</em> - unsigned int; Index of the new account.</li>
|
|||
|
|
<li><em>address</em> - string; Address for this account. Base58 representation of the public keys.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"create_account","params":{"label":"Secondary account"}}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="s2">"account_index"</span>: <span class="m">1</span>,
|
|||
|
|
<span class="s2">"address"</span>: <span class="s2">"77Vx9cs1VPicFndSVgYUvTdLCJEZw9h81hXLMYsjBCXSJfUehLa9TDW3Ffh45SQa7xb6dUs18mpNxfUhQGqfwXPSMrvKhVp"</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="create_address"><strong>create_address</strong><a class="headerlink" href="#create_address" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Create a new address for an account. Optionally, label the new address.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>account_index</em> - unsigned int; Create a new address for this account.</li>
|
|||
|
|
<li><em>label</em> - string; (Optional) Label for the new address.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>address</em> - string; Newly created address. Base58 representation of the public keys.</li>
|
|||
|
|
<li><em>address_index</em> - unsigned int; Index of the new address under the input account.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"create_address","params":{"account_index":0,"label":"new-sub"}}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="s2">"address"</span>: <span class="s2">"7BG5jr9QS5sGMdpbBrZEwVLZjSKJGJBsXdZLt8wiXyhhLjy7x2LZxsrAnHTgD8oG46ZtLjUGic2pWc96GFkGNPQQDA3Dt7Q"</span>,
|
|||
|
|
<span class="s2">"address_index"</span>: <span class="m">5</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="create_wallet"><strong>create_wallet</strong><a class="headerlink" href="#create_wallet" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Create a new wallet. You need to have set the argument "–wallet-dir" when launching monero-wallet-rpc to make this work.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>filename</em> - string; Wallet file name.</li>
|
|||
|
|
<li><em>password</em> - string; (Optional) password to protect the wallet.</li>
|
|||
|
|
<li><em>language</em> - string; Language for your wallets' seed.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs: <em>None</em>.</p>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"create_wallet","params":{"filename":"mytestwallet","password":"mytestpassword","language":"English"}}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="delete_address_book"><strong>delete_address_book</strong><a class="headerlink" href="#delete_address_book" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Delete an entry from the address book.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>index</em> - unsigned int; The index of the address book entry.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs: <em>None</em>.</p>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"delete_address_book","params":{"index":1}}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="export_key_images"><strong>export_key_images</strong><a class="headerlink" href="#export_key_images" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Export a signed set of key images.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs: <em>None</em>.</p>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>signed_key_images</em> - array of signed key images:<ul>
|
|||
|
|
<li><em>key_image</em> - string;</li>
|
|||
|
|
<li><em>signature</em> - string;</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"export_key_images"}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="s2">"signed_key_images"</span>: <span class="o">[{</span>
|
|||
|
|
<span class="s2">"key_image"</span>: <span class="s2">"cd35239b72a35e26a57ed17400c0b66944a55de9d5bda0f21190fed17f8ea876"</span>,
|
|||
|
|
<span class="s2">"signature"</span>: <span class="s2">"c9d736869355da2538ab4af188279f84138c958edbae3c5caf388a63cd8e780b8c5a1aed850bd79657df659422c463608ea4e0c730ba9b662c906ae933816d00"</span>
|
|||
|
|
<span class="o">}</span>,<span class="o">{</span>
|
|||
|
|
<span class="s2">"key_image"</span>: <span class="s2">"65158a8ee5a3b32009b85a307d85b375175870e560e08de313531c7dbbe6fc19"</span>,
|
|||
|
|
<span class="s2">"signature"</span>: <span class="s2">"c96e40d09dfc45cfc5ed0b76bfd7ca793469588bb0cf2b4d7b45ef23d40fd4036057b397828062e31700dc0c2da364f50cd142295a8405b9fe97418b4b745d0c"</span>
|
|||
|
|
<span class="o">}</span>,...<span class="o">]</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="export_multisig_info"><strong>export_multisig_info</strong><a class="headerlink" href="#export_multisig_info" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Export multisig info for other participants.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs: <em>None</em>.</p>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>info</em> - string; Multisig info in hex format for other participants.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"export_multisig_info"}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="s2">"info"</span>: <span class="s2">"4d6f6e65726f206d756c7469736967206578706f72740105cf6442b09b75f5eca9d846771fe1a879c9a97ab0553ffbcec64b1148eb7832b51e7898d7944c41cee000415c5a98f4f80dc0efdae379a98805bb6eacae743446f6f421cd03e129eb5b27d6e3b73eb6929201507c1ae706c1a9ecd26ac8601932415b0b6f49cbbfd712e47d01262c59980a8f9a8be776f2bf585f1477a6df63d6364614d941ecfdcb6e958a390eb9aa7c87f056673d73bc7c5f0ab1f74a682e902e48a3322c0413bb7f6fd67404f13fb8e313f70a0ce568c853206751a334ef490068d3c8ca0e"</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="export_outputs"><strong>export_outputs</strong><a class="headerlink" href="#export_outputs" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Export all outputs in hex format.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs: <em>None</em>.</p>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>outputs_data_hex</em> - string; wallet outputs in hex format.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"export_outputs"}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="s2">"outputs_data_hex"</span>: <span class="s2">"...outputs..."</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="finalize_multisig"><strong>finalize_multisig</strong><a class="headerlink" href="#finalize_multisig" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Turn this wallet into a multisig wallet, extra step for N-1/N wallets.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>multisig_info</em> - array of string; List of multisig string from peers.</li>
|
|||
|
|
<li><em>password</em> - string; Wallet password</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>address</em> - string; multisig wallet address.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"finalize_multisig","params":{"multisig_info":["MultisigxV1JNC6Ja2oBt5Sqea9LN2YEF7WYZCpHqr2EKvPG89Trf3X4E8RWkLaGRf29fJ3stU471MELKxwufNYeigP7LoE4tn2McPr4SbL9q15xNvZT5uwC9YRr7UwjXqSZHmTWN9PBuZEKVAQ4HPPyQciSCdNjgwsuFRBzrskMdMUwNMgKst1debYfm37i6PSzDoS2tk4kYTYj83kkAdR7kdshet1axQPd6HQ","MultisigxV1Unma7Ko4zdd8Ps3Af4oZwtj2JdWKzwNfP6s2G9ZvXhMoSscwn5g7PyCfcBc1V4ffRHY3Kxqq6VocSCUTncpVeUskMcPr4SbL9q15xNvZT5uwC9YRr7UwjXqSZHmTWN9PBuZE1LTpWxLoC3vPMSrqVVcjnmL9LYfdCZz3fECjNZbCEDq3PHDiUuY5jurQTcNoGhDTio5WM9xaAdim9YByiS5KyqF4"]}}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="s2">"address"</span>: <span class="s2">"5B9gZUTDuHTcGGuY3nL3t8K2tDnEHeRVHSBQgLZUTQxtFYVLnho5JJjWJyFp5YZgZRQ44RiviJi1sPHgLVMbckRsDqDx1gV"</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="get_account_tags"><strong>get_account_tags</strong><a class="headerlink" href="#get_account_tags" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Get a list of user-defined account tags.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs: <em>None</em>.</p>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>account_tags</em> - array of account tag information:<ul>
|
|||
|
|
<li><em>tag</em> - string; Filter tag.</li>
|
|||
|
|
<li><em>label</em> - string; Label for the tag.</li>
|
|||
|
|
<li><em>accounts</em> - array of int; List of tagged account indices.</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"get_account_tags","params":""}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="s2">"account_tags"</span>: <span class="o">[{</span>
|
|||
|
|
<span class="s2">"accounts"</span>: <span class="o">[</span><span class="m">0</span><span class="o">]</span>,
|
|||
|
|
<span class="s2">"label"</span>: <span class="s2">"Test tag"</span>,
|
|||
|
|
<span class="s2">"tag"</span>: <span class="s2">"myTag"</span>
|
|||
|
|
<span class="o">}]</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="get_accounts"><strong>get_accounts</strong><a class="headerlink" href="#get_accounts" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Get all accounts for a wallet. Optionally filter accounts by tag.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>tag</em> - string; (Optional) Tag for filtering accounts.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>subaddress_accounts</em> - array of subaddress account information:<ul>
|
|||
|
|
<li><em>account_index</em> - unsigned int; Index of the account.</li>
|
|||
|
|
<li><em>balance</em> - unsigned int; Balance of the account (locked or unlocked).</li>
|
|||
|
|
<li><em>base_address</em> - string; Base64 representation of the first subaddress in the account.</li>
|
|||
|
|
<li><em>label</em> - string; (Optional) Label of the account.</li>
|
|||
|
|
<li><em>tag</em> - string; (Optional) Tag for filtering accounts.</li>
|
|||
|
|
<li><em>unlocked_balance</em> - unsigned int; Unlocked balance for the account.</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li><em>total_balance</em> - unsigned int; Total balance of the selected accounts (locked or unlocked).</li>
|
|||
|
|
<li><em>total_unlocked_balance</em> - unsigned int; Total unlocked balance of the selected accounts.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"get_accounts","params":{"tag":"myTag"}}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="s2">"subaddress_accounts"</span>: <span class="o">[{</span>
|
|||
|
|
<span class="s2">"account_index"</span>: <span class="m">0</span>,
|
|||
|
|
<span class="s2">"balance"</span>: <span class="m">157663195572433688</span>,
|
|||
|
|
<span class="s2">"base_address"</span>: <span class="s2">"55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt"</span>,
|
|||
|
|
<span class="s2">"label"</span>: <span class="s2">"Primary account"</span>,
|
|||
|
|
<span class="s2">"tag"</span>: <span class="s2">"myTag"</span>,
|
|||
|
|
<span class="s2">"unlocked_balance"</span>: <span class="m">157443303037455077</span>
|
|||
|
|
<span class="o">}</span>,<span class="o">{</span>
|
|||
|
|
<span class="s2">"account_index"</span>: <span class="m">1</span>,
|
|||
|
|
<span class="s2">"balance"</span>: <span class="m">0</span>,
|
|||
|
|
<span class="s2">"base_address"</span>: <span class="s2">"77Vx9cs1VPicFndSVgYUvTdLCJEZw9h81hXLMYsjBCXSJfUehLa9TDW3Ffh45SQa7xb6dUs18mpNxfUhQGqfwXPSMrvKhVp"</span>,
|
|||
|
|
<span class="s2">"label"</span>: <span class="s2">"Secondary account"</span>,
|
|||
|
|
<span class="s2">"tag"</span>: <span class="s2">"myTag"</span>,
|
|||
|
|
<span class="s2">"unlocked_balance"</span>: <span class="m">0</span>
|
|||
|
|
<span class="o">}]</span>,
|
|||
|
|
<span class="s2">"total_balance"</span>: <span class="m">157663195572433688</span>,
|
|||
|
|
<span class="s2">"total_unlocked_balance"</span>: <span class="m">157443303037455077</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="get_address"><strong>get_address</strong><a class="headerlink" href="#get_address" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Return the wallet's addresses for an account. Optionally filter for specific set of subaddresses.</p>
|
|||
|
|
<p>Alias: <em>getaddress</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>account_index</em> - unsigned int; Return subaddresses for this account.</li>
|
|||
|
|
<li><em>address_index</em> - array of unsigned int; (Optional) List of subaddresses to return from an account.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>address</em> - string; The 95-character hex address string of the monero-wallet-rpc in session.</li>
|
|||
|
|
<li><em>addresses</em> array of addresses informations<ul>
|
|||
|
|
<li><em>address</em> string; The 95-character hex (sub)address string.</li>
|
|||
|
|
<li><em>label</em> string; Label of the (sub)address</li>
|
|||
|
|
<li><em>address_index</em> unsigned int; index of the subaddress</li>
|
|||
|
|
<li><em>used</em> boolean; states if the (sub)address has already received funds</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"get_address","params":{"account_index":0,"address_index":[0,1,4]}}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="s2">"address"</span>: <span class="s2">"55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt"</span>,
|
|||
|
|
<span class="s2">"addresses"</span>: <span class="o">[{</span>
|
|||
|
|
<span class="s2">"address"</span>: <span class="s2">"55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt"</span>,
|
|||
|
|
<span class="s2">"address_index"</span>: <span class="m">0</span>,
|
|||
|
|
<span class="s2">"label"</span>: <span class="s2">"Primary account"</span>,
|
|||
|
|
<span class="s2">"used"</span>: <span class="nb">true</span>
|
|||
|
|
<span class="o">}</span>,<span class="o">{</span>
|
|||
|
|
<span class="s2">"address"</span>: <span class="s2">"7BnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o"</span>,
|
|||
|
|
<span class="s2">"address_index"</span>: <span class="m">1</span>,
|
|||
|
|
<span class="s2">"label"</span>: <span class="s2">""</span>,
|
|||
|
|
<span class="s2">"used"</span>: <span class="nb">true</span>
|
|||
|
|
<span class="o">}</span>,<span class="o">{</span>
|
|||
|
|
<span class="s2">"address"</span>: <span class="s2">"77xa6Dha7kzCQuvmd8iB5VYoMkdenwCNRU9khGhExXQ8KLL3z1N1ZATBD1sFPenyHWT9cm4fVFnCAUApY53peuoZFtwZiw5"</span>,
|
|||
|
|
<span class="s2">"address_index"</span>: <span class="m">4</span>,
|
|||
|
|
<span class="s2">"label"</span>: <span class="s2">"test2"</span>,
|
|||
|
|
<span class="s2">"used"</span>: <span class="nb">true</span>
|
|||
|
|
<span class="o">}]</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="get_address_book"><strong>get_address_book</strong><a class="headerlink" href="#get_address_book" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Retrieves entries from the address book.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>entries</em> - array of unsigned int; indices of the requested address book entries</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>entries</em> - array of entries:<ul>
|
|||
|
|
<li><em>address</em> - string; Public address of the entry</li>
|
|||
|
|
<li><em>description</em> - string; Description of this address entry</li>
|
|||
|
|
<li><em>index</em> - unsigned int;</li>
|
|||
|
|
<li><em>payment_id</em> - string;</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <span class="s1">'{"jsonrpc":"2.0","id":"0","method":"get_address_book","params":{"entries":[0,1]}}'</span> -H <span class="s1">'Content-Type: application/json'</span>
|
|||
|
|
<span class="o">{</span>
|
|||
|
|
<span class="s2">"id"</span>: <span class="s2">"0"</span>,
|
|||
|
|
<span class="s2">"jsonrpc"</span>: <span class="s2">"2.0"</span>,
|
|||
|
|
<span class="s2">"result"</span>: <span class="o">{</span>
|
|||
|
|
<span class="s2">"entries"</span>: <span class="o">[{</span>
|
|||
|
|
<span class="s2">"address"</span>: <span class="s2">"77Vx9cs1VPicFndSVgYUvTdLCJEZw9h81hXLMYsjBCXSJfUehLa9TDW3Ffh45SQa7xb6dUs18mpNxfUhQGqfwXPSMrvKhVp"</span>,
|
|||
|
|
<span class="s2">"description"</span>: <span class="s2">"Second account"</span>,
|
|||
|
|
<span class="s2">"index"</span>: <span class="m">0</span>,
|
|||
|
|
<span class="s2">"payment_id"</span>: <span class="s2">"0000000000000000000000000000000000000000000000000000000000000000"</span>
|
|||
|
|
<span class="o">}</span>,<span class="o">{</span>
|
|||
|
|
<span class="s2">"address"</span>: <span class="s2">"78P16M3XmFRGcWFCcsgt1WcTntA1jzcq31seQX1Eg92j8VQ99NPivmdKam4J5CKNAD7KuNWcq5xUPgoWczChzdba5WLwQ4j"</span>,
|
|||
|
|
<span class="s2">"description"</span>: <span class="s2">"Third account"</span>,
|
|||
|
|
<span class="s2">"index"</span>: <span class="m">1</span>,
|
|||
|
|
<span class="s2">"payment_id"</span>: <span class="s2">"0000000000000000000000000000000000000000000000000000000000000000"</span>
|
|||
|
|
<span class="o">}]</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
<span class="o">}</span>
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="get_address_index"><strong>get_address_index</strong><a class="headerlink" href="#get_address_index" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Get account and address indexes from a specific (sub)address</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>address</em> - String; (sub)address to look for.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>index</em> - subaddress informations<ul>
|
|||
|
|
<li><em>major</em> unsigned int; Account index.</li>
|
|||
|
|
<li><em>minor</em> unsigned int; Address index.</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"index": {
|
|||
|
|
"major": 0,
|
|||
|
|
"minor": 1
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="get_attribute"><strong>get_attribute</strong><a class="headerlink" href="#get_attribute" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Get attribute value by name.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>key</em> - string; attribute name</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>value</em> - string; attribute value</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"value": "my_value"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="get_bulk_payments"><strong>get_bulk_payments</strong><a class="headerlink" href="#get_bulk_payments" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>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 <code>get_payments</code>because it has the same functionality but is more extendable. Either is fine for looking up transactions by a single payment ID.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>payment_ids</em> - array of: string; Payment IDs used to find the payments (16 characters hex).</li>
|
|||
|
|
<li><em>min_block_height</em> - unsigned int; The block height at which to start looking for payments.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>payments</em> - list of:<ul>
|
|||
|
|
<li><em>payment_id</em> - string; Payment ID matching one of the input IDs.</li>
|
|||
|
|
<li><em>tx_hash</em> - string; Transaction hash used as the transaction ID.</li>
|
|||
|
|
<li><em>amount</em> - unsigned int; Amount for this payment.</li>
|
|||
|
|
<li><em>block_height</em> - unsigned int; Height of the block that first confirmed this payment.</li>
|
|||
|
|
<li><em>unlock_time</em> - unsigned int; Time (in block height) until this payment is safe to spend.</li>
|
|||
|
|
<li><em>subaddr_index</em> - subaddress index:<ul>
|
|||
|
|
<li><em>major</em> - unsigned int; Account index for the subaddress.</li>
|
|||
|
|
<li><em>minor</em> - unsigned int; Index of the subaddress in the account.</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li><em>address</em> - string; Address receiving the payment; Base58 representation of the public keys.</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"payments": [{
|
|||
|
|
"address": "55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt",
|
|||
|
|
"amount": 1000000000000,
|
|||
|
|
"block_height": 127606,
|
|||
|
|
"payment_id": "60900e5603bf96e3",
|
|||
|
|
"subaddr_index": {
|
|||
|
|
"major": 0,
|
|||
|
|
"minor": 0
|
|||
|
|
},
|
|||
|
|
"tx_hash": "3292e83ad28fc1cc7bc26dbd38862308f4588680fbf93eae3e803cddd1bd614f",
|
|||
|
|
"unlock_time": 0
|
|||
|
|
}]
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="get_height"><strong>get_height</strong><a class="headerlink" href="#get_height" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Returns the wallet's current block height.</p>
|
|||
|
|
<p>Alias: <em>getheight</em>.</p>
|
|||
|
|
<p>Inputs: <em>None</em>.</p>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>height</em> - unsigned int; The current monero-wallet-rpc's blockchain height. If the wallet has been offline for a long time, it may need to catch up with the daemon.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"height": 145545
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="get_languages"><strong>get_languages</strong><a class="headerlink" href="#get_languages" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Get a list of available languages for your wallet's seed.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs: <em>None</em>.</p>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>languages</em> - array of string; List of available languages</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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","Lojban"]
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="get_payments"><strong>get_payments</strong><a class="headerlink" href="#get_payments" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Get a list of incoming payments using a given payment id.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>payment_id</em> - string; Payment ID used to find the payments (16 characters hex).</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>payments</em> - list of:<ul>
|
|||
|
|
<li><em>payment_id</em> - string; Payment ID matching the input parameter.</li>
|
|||
|
|
<li><em>tx_hash</em> - string; Transaction hash used as the transaction ID.</li>
|
|||
|
|
<li><em>amount</em> - unsigned int; Amount for this payment.</li>
|
|||
|
|
<li><em>block_height</em> - unsigned int; Height of the block that first confirmed this payment.</li>
|
|||
|
|
<li><em>unlock_time</em> - unsigned int; Time (in block height) until this payment is safe to spend.</li>
|
|||
|
|
<li><em>subaddr_index</em> - subaddress index:<ul>
|
|||
|
|
<li><em>major</em> - unsigned int; Account index for the subaddress.</li>
|
|||
|
|
<li><em>minor</em> - unsigned int; Index of the subaddress in the account.</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li><em>address</em> - string; Address receiving the payment; Base58 representation of the public keys.</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"payments": [{
|
|||
|
|
"address": "55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt",
|
|||
|
|
"amount": 1000000000000,
|
|||
|
|
"block_height": 127606,
|
|||
|
|
"payment_id": "60900e5603bf96e3",
|
|||
|
|
"subaddr_index": {
|
|||
|
|
"major": 0,
|
|||
|
|
"minor": 0
|
|||
|
|
},
|
|||
|
|
"tx_hash": "3292e83ad28fc1cc7bc26dbd38862308f4588680fbf93eae3e803cddd1bd614f",
|
|||
|
|
"unlock_time": 0
|
|||
|
|
}]
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="get_reserve_proof"><strong>get_reserve_proof</strong><a class="headerlink" href="#get_reserve_proof" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Generate a signature to prove of an available amount in a wallet.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>all</em> - boolean; Proves all wallet balance to be disposable.</li>
|
|||
|
|
<li><em>account_index</em> - unsigned int; Specify the account from witch to prove reserve. (ignored if <code>all</code> is set to true)</li>
|
|||
|
|
<li><em>amount</em> - unsigned int; Amount (in atomic units) to prove the account has for reserve. (ignored if <code>all</code> is set to true)</li>
|
|||
|
|
<li><em>message</em> - string; (Optional) add a message to the signature to further authenticate the prooving process.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>signature</em> - string; reserve signature.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"signature": "ReserveProofV11BZ23sBt9sZJeGccf84mzyAmNCP3KzYbE1111112VKmH111118NfCYJQjZ6c46gT2kXgcHCaSSZeL8sRdzqjqx7i1e7FQfQGu2o113UYFVdwzHQi3iENDPa76Kn1BvywbKz3bMkXdZkBEEhBSF4kjjGaiMJ1ucKb6wvMVC4A8sA4nZEdL2Mk3wBucJCYTZwKqA8i1M113kqakDkG25FrjiDqdQTCYz2wDBmfKxF3eQiV5FWzZ6HmAyxnqTWUiMWukP9A3Edy3ZXqjP1b23dhz7Mbj39bBxe3ZeDNu9HnTSqYvHNRyqCkeUMJpHyQweqjGUJ1DSfFYr33J1E7MkhMnEi1o7trqWjVix32XLetYfePG73yvHbS24837L7Q64i5n1LSpd9yMiQZ3Dyaysi5y6jPx7TpAvnSqBFtuCciKoNzaXoA3dqt9cuVFZTXzdXKqdt3cXcVJMNxY8RvKPVQHhUur94Lpo1nSpxf7BN5a5rHrbZFqoZszsZmiWikYPkLX72XUdw6NWjLrTBxSy7KuPYH86c6udPEXLo2xgN6XHMBMBJzt8FqqK7EcpNUBkuHm2AtpGkf9CABY3oSjDQoRF5n4vNLd3qUaxNsG4XJ12L9gJ7GrK273BxkfEA8fDdxPrb1gpespbgEnCTuZHqj1A"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="get_spend_proof"><strong>get_spend_proof</strong><a class="headerlink" href="#get_spend_proof" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Generate a signature to prove a spend. Unlike proving a transaction, it does not requires the destination public address.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>txid</em> - string; transaction id.</li>
|
|||
|
|
<li><em>message</em> - string; (Optional) add a message to the signature to further authenticate the prooving process.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>signature</em> - string; spend signature.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"signature": "SpendProofV1aSh8Todhk54736iXgV6vJAFP7egxByuMWZeyNDaN2JY737S95X5zz5mNMQSuCNSLjjhi5HJCsndpNWSNVsuThxwv285qy1KkUrLFRkxMSCjfL6bbycYN33ScZ5UB4Fzseceo1ndpL393T1q638VmcU3a56dhNHF1RPZFiGPS61FA78nXFSqE9uoKCCoHkEz83M1dQVhxZV5CEPF2P6VioGTKgprLCH9vvj9k1ivd4SX19L2VSMc3zD1u3mkR24ioETvxBoLeBSpxMoikyZ6inhuPm8yYo9YWyFtQK4XYfAV9mJ9knz5fUPXR8vvh7KJCAg4dqeJXTVb4mbMzYtsSZXHd6ouWoyCd6qMALdW8pKhgMCHcVYMWp9X9WHZuCo9rsRjRpg15sJUw7oJg1JoGiVgj8P4JeGDjnZHnmLVa5bpJhVCbMhyM7JLXNQJzFWTGC27TQBbthxCfQaKdusYnvZnKPDJWSeceYEFzepUnsWhQtyhbb73FzqgWC4eKEFKAZJqT2LuuSoxmihJ9acnFK7Ze23KTVYgDyMKY61VXADxmSrBvwUtxCaW4nQtnbMxiPMNnDMzeixqsFMBtN72j5UqhiLRY99k6SE7Qf5f29haNSBNSXCFFHChPKNTwJrehkofBdKUhh2VGPqZDNoefWUwfudeu83t85bmjv8Q3LrQSkFgFjRT5tLo8TMawNXoZCrQpyZrEvnodMDDUUNf3NL7rxyv3gM1KrTWjYaWXFU2RAsFee2Q2MTwUW7hR25cJvSFuB1BX2bfkoCbiMk923tHZGU2g7rSKF1GDDkXAc1EvFFD4iGbh1Q5t6hPRhBV8PEncdcCWGq5uAL5D4Bjr6VXG8uNeCy5oYWNgbZ5JRSfm7QEhPv8Fy9AKMgmCxDGMF9dVEaU6tw2BAnJavQdfrxChbDBeQXzCbCfep6oei6n2LZdE5Q84wp7eoQFE5Cwuo23tHkbJCaw2njFi3WGBbA7uGZaGHJPyB2rofTWBiSUXZnP2hiE9bjJghAcDm1M4LVLfWvhZmFEnyeru3VWMETnetz1BYLUC5MJGFXuhnHwWh7F6r74FDyhdswYop4eWPbyrXMXmUQEccTGd2NaT8g2VHADZ76gMC6BjWESvcnz2D4n8XwdmM7ZQ1jFwhuXrBfrb1dwRasyXxxHMGAC2onatNiExyeQ9G1W5LwqNLAh9hvcaNTGaYKYXoceVzLkgm6e5WMkLsCwuZXvB"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="get_transfer_by_txid"><strong>get_transfer_by_txid</strong><a class="headerlink" href="#get_transfer_by_txid" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Show information about a transfer to/from this address.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>txid</em> - string; Transaction ID used to find the transfer.</li>
|
|||
|
|
<li><em>account_index</em> - unsigned int; (Optional) Index of the account to query for the transfer.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>transfer</em> - JSON object containing payment information:<ul>
|
|||
|
|
<li><em>address</em> - string; Address that transferred the funds. Base58 representation of the public keys.</li>
|
|||
|
|
<li><em>amount</em> - unsigned int; Amount of this transfer.</li>
|
|||
|
|
<li><em>confirmations</em> - unsigned int; Number of block mined since the block containing this transaction (or block height at which the transaction should be added to a block if not yet confirmed).</li>
|
|||
|
|
<li><em>destinations</em> - array of JSON objects containing transfer destinations:<ul>
|
|||
|
|
<li><em>amount</em> - unsigned int; Amount transferred to this destination.</li>
|
|||
|
|
<li><em>address</em> - string; Address for this destination. Base58 representation of the public keys.</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li><em>double_spend_seen</em> - boolean; True if the key image(s) for the transfer have been seen before.</li>
|
|||
|
|
<li><em>fee</em> - unsigned int; Transaction fee for this transfer.</li>
|
|||
|
|
<li><em>height</em> - unsigned int; Height of the first block that confirmed this transfer.</li>
|
|||
|
|
<li><em>note</em> - string; Note about this transfer.</li>
|
|||
|
|
<li><em>payment_id</em> - string; Payment ID for this transfer.</li>
|
|||
|
|
<li><em>subaddr_index</em> - JSON object containing the major & minor subaddress index:<ul>
|
|||
|
|
<li><em>major</em> - unsigned int; Account index for the subaddress.</li>
|
|||
|
|
<li><em>minor</em> - unsigned int; Index of the subaddress under the account.</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li><em>suggested_confirmations_threshold</em> - unsigned int; Estimation of the confirmations needed for the transaction to be included in a block.</li>
|
|||
|
|
<li><em>timestamp</em> - unsigned int; POSIX timestamp for the block that confirmed this transfer (or timestamp submission if not mined yet).</li>
|
|||
|
|
<li><em>txid</em> - string; Transaction ID of this transfer (same as input TXID).</li>
|
|||
|
|
<li><em>type</em> - string; Type of transfer, one of the following: "in", "out", "pending", "failed", "pool"</li>
|
|||
|
|
<li><em>unlock_time</em> - unsigned int; Number of blocks until transfer is safely spendable.</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"transfer": {
|
|||
|
|
"address": "55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt",
|
|||
|
|
"amount": 300000000000,
|
|||
|
|
"confirmations": 1,
|
|||
|
|
"destinations": [{
|
|||
|
|
"address": "7BnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o",
|
|||
|
|
"amount": 100000000000
|
|||
|
|
},{
|
|||
|
|
"address": "77Vx9cs1VPicFndSVgYUvTdLCJEZw9h81hXLMYsjBCXSJfUehLa9TDW3Ffh45SQa7xb6dUs18mpNxfUhQGqfwXPSMrvKhVp",
|
|||
|
|
"amount": 200000000000
|
|||
|
|
}],
|
|||
|
|
"double_spend_seen": false,
|
|||
|
|
"fee": 21650200000,
|
|||
|
|
"height": 153624,
|
|||
|
|
"note": "",
|
|||
|
|
"payment_id": "0000000000000000",
|
|||
|
|
"subaddr_index": {
|
|||
|
|
"major": 0,
|
|||
|
|
"minor": 0
|
|||
|
|
},
|
|||
|
|
"suggested_confirmations_threshold": 1,
|
|||
|
|
"timestamp": 1535918400,
|
|||
|
|
"txid": "c36258a276018c3a4bc1f195a7fb530f50cd63a4fa765fb7c6f7f49fc051762a",
|
|||
|
|
"type": "out",
|
|||
|
|
"unlock_time": 0
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="get_transfers"><strong>get_transfers</strong><a class="headerlink" href="#get_transfers" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Returns a list of transfers.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>in</em> - boolean; (Optional) Include incoming transfers.</li>
|
|||
|
|
<li><em>out</em> - boolean; (Optional) Include outgoing transfers.</li>
|
|||
|
|
<li><em>pending</em> - boolean; (Optional) Include pending transfers.</li>
|
|||
|
|
<li><em>failed</em> - boolean; (Optional) Include failed transfers.</li>
|
|||
|
|
<li><em>pool</em> - boolean; (Optional) Include transfers from the daemon's transaction pool.</li>
|
|||
|
|
<li><em>filter_by_height</em> - boolean; (Optional) Filter transfers by block height.</li>
|
|||
|
|
<li><em>min_height</em> - unsigned int; (Optional) Minimum block height to scan for transfers, if filtering by height is enabled.</li>
|
|||
|
|
<li><em>max_height</em> - unsigned int; (Opional) Maximum block height to scan for transfers, if filtering by height is enabled (defaults to max block height).</li>
|
|||
|
|
<li><em>account_index</em> - unsigned int; (Optional) Index of the account to query for transfers. (defaults to 0)</li>
|
|||
|
|
<li><em>subaddr_indices</em> - array of unsigned int; (Optional) List of subaddress indices to query for transfers. (defaults to 0)</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>in</em> array of transfers:<ul>
|
|||
|
|
<li><em>address</em> - string; Public address of the transfer.</li>
|
|||
|
|
<li><em>amount</em> - unsigned int; Amount transferred.</li>
|
|||
|
|
<li><em>confirmations</em> - unsigned int; Number of block mined since the block containing this transaction (or block height at which the transaction should be added to a block if not yet confirmed).</li>
|
|||
|
|
<li><em>double_spend_seen</em> - boolean; True if the key image(s) for the transfer have been seen before.</li>
|
|||
|
|
<li><em>fee</em> - unsigned int; Transaction fee for this transfer.</li>
|
|||
|
|
<li><em>height</em> - unsigned int; Height of the first block that confirmed this transfer (0 if not mined yet).</li>
|
|||
|
|
<li><em>note</em> - string; Note about this transfer.</li>
|
|||
|
|
<li><em>payment_id</em> - string; Payment ID for this transfer.</li>
|
|||
|
|
<li><em>subaddr_index</em> - JSON object containing the major & minor subaddress index:<ul>
|
|||
|
|
<li><em>major</em> - unsigned int; Account index for the subaddress.</li>
|
|||
|
|
<li><em>minor</em> - unsigned int; Index of the subaddress under the account.</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li><em>suggested_confirmations_threshold</em> - unsigned int; Estimation of the confirmations needed for the transaction to be included in a block.</li>
|
|||
|
|
<li><em>timestamp</em> - unsigned int; POSIX timestamp for when this transfer was first confirmed in a block (or timestamp submission if not mined yet).</li>
|
|||
|
|
<li><em>txid</em> - string; Transaction ID for this transfer.</li>
|
|||
|
|
<li><em>type</em> - string; Transfer type: "in"</li>
|
|||
|
|
<li><em>unlock_time</em> - unsigned int; Number of blocks until transfer is safely spendable.</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li><em>out</em> array of transfers (see above).</li>
|
|||
|
|
<li><em>pending</em> array of transfers (see above).</li>
|
|||
|
|
<li><em>failed</em> array of transfers (see above).</li>
|
|||
|
|
<li><em>pool</em> array of transfers (see above).</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"in": [{
|
|||
|
|
"address": "77Vx9cs1VPicFndSVgYUvTdLCJEZw9h81hXLMYsjBCXSJfUehLa9TDW3Ffh45SQa7xb6dUs18mpNxfUhQGqfwXPSMrvKhVp",
|
|||
|
|
"amount": 200000000000,
|
|||
|
|
"confirmations": 1,
|
|||
|
|
"double_spend_seen": false,
|
|||
|
|
"fee": 21650200000,
|
|||
|
|
"height": 153624,
|
|||
|
|
"note": "",
|
|||
|
|
"payment_id": "0000000000000000",
|
|||
|
|
"subaddr_index": {
|
|||
|
|
"major": 1,
|
|||
|
|
"minor": 0
|
|||
|
|
},
|
|||
|
|
"suggested_confirmations_threshold": 1,
|
|||
|
|
"timestamp": 1535918400,
|
|||
|
|
"txid": "c36258a276018c3a4bc1f195a7fb530f50cd63a4fa765fb7c6f7f49fc051762a",
|
|||
|
|
"type": "in",
|
|||
|
|
"unlock_time": 0
|
|||
|
|
}]
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="get_tx_key"><strong>get_tx_key</strong><a class="headerlink" href="#get_tx_key" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Get transaction secret key from transaction id.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>txid</em> - string; transaction id.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>tx_key</em> - string; transaction secret key.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"tx_key": "feba662cf8fb6d0d0da18fc9b70ab28e01cc76311278fdd7fe7ab16360762b06"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="get_tx_notes"><strong>get_tx_notes</strong><a class="headerlink" href="#get_tx_notes" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Get string notes for transactions.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>txids</em> - array of string; transaction ids</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>notes</em> - array of string; notes for the transactions</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"notes": ["This is an example"]
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="get_tx_proof"><strong>get_tx_proof</strong><a class="headerlink" href="#get_tx_proof" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Get transaction signature to prove it.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>txid</em> - string; transaction id.</li>
|
|||
|
|
<li><em>address</em> - string; destination public address of the transaction.</li>
|
|||
|
|
<li><em>message</em> - string; (Optional) add a message to the signature to further authenticate the prooving process.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>signature</em> - string; transaction signature.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"signature": "InProofV13vqBCT6dpSAXkypZmSEMPGVnNRFDX2vscUYeVS4WnSVnV5BwLs31T9q6Etfj9Wts6tAxSAS4gkMeSYzzLS7Gt4vvCSQRh9niGJMUDJsB5hTzb2XJiCkUzWkkcjLFBBRVD5QZ"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="get_version"><strong>get_version</strong><a class="headerlink" href="#get_version" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Get RPC version Major & Minor integer-format, where Major is the first 16 bits and Minor the last 16 bits.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs: <em>None</em>.</p>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>version</em> - unsigned int; RPC version, formatted with <code>Major * 2^16 + Minor</code>(Major encoded over the first 16 bits, and Minor over the last 16 bits).</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_version"}' -H 'Content-Type: application/json'
|
|||
|
|
{
|
|||
|
|
"id": "0",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"version": 65539
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="import_key_images"><strong>import_key_images</strong><a class="headerlink" href="#import_key_images" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Import signed key images list and verify their spent status.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>signed_key_images</em> - array of signed key images:<ul>
|
|||
|
|
<li><em>key_image</em> - string;</li>
|
|||
|
|
<li><em>signature</em> - string;</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>height</em> - unsigned int;</li>
|
|||
|
|
<li><em>spent</em> - unsigned int; Amount (in atomic units) spent from those key images.</li>
|
|||
|
|
<li><em>unspent</em> - unsigned int; Amount (in atomic units) still available from those key images.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"height": 76428,
|
|||
|
|
"spent": 62708953408711,
|
|||
|
|
"unspent": 0
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="import_multisig_info"><strong>import_multisig_info</strong><a class="headerlink" href="#import_multisig_info" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Import multisig info from other participants.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>info</em> - array of string; List of multisig info in hex format from other participants.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>n_outputs</em> - unsigned int; Number of outputs signed with those multisig info.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"n_outputs": 35
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="import_outputs"><strong>import_outputs</strong><a class="headerlink" href="#import_outputs" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Import outputs in hex format.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>outputs_data_hex</em> - string; wallet outputs in hex format.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>num_imported</em> - unsigned int; number of outputs imported.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"num_imported": 6400
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="incoming_transfers"><strong>incoming_transfers</strong><a class="headerlink" href="#incoming_transfers" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Return a list of incoming transfers to the wallet.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>transfer_type</em> - string; "all": all the transfers, "available": only transfers which are not yet spent, OR "unavailable": only transfers which are already spent.</li>
|
|||
|
|
<li><em>account_index</em> - unsigned int; (Optional) Return transfers for this account. (defaults to 0)</li>
|
|||
|
|
<li><em>subaddr_indices</em> - array of unsigned int; (Optional) Return transfers sent to these subaddresses.</li>
|
|||
|
|
<li><em>verbose</em> - boolean; (Optional) Enable verbose output, return key image if true.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>transfers</em> - list of:<ul>
|
|||
|
|
<li><em>amount</em> - unsigned int; Amount of this transfer.</li>
|
|||
|
|
<li><em>global_index</em> - unsigned int; Mostly internal use, can be ignored by most users.</li>
|
|||
|
|
<li><em>key_image</em> - string; Key image for the incoming transfer's unspent output (empty unless verbose is true).</li>
|
|||
|
|
<li><em>spent</em> - boolean; Indicates if this transfer has been spent.</li>
|
|||
|
|
<li><em>subaddr_index</em> - unsigned int; Subaddress index for incoming transfer.</li>
|
|||
|
|
<li><em>tx_hash</em> - string; Several incoming transfers may share the same hash if they were in the same transaction.</li>
|
|||
|
|
<li><em>tx_size</em> - unsigned int; Size of transaction in bytes.</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example, get all transfers:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"transfers": [{
|
|||
|
|
"amount": 60000000000000,
|
|||
|
|
"global_index": 122405,
|
|||
|
|
"key_image": "768f5144777eb23477ab7acf83562581d690abaf98ca897c03a9d2b900eb479b",
|
|||
|
|
"spent": true,
|
|||
|
|
"subaddr_index": 3,
|
|||
|
|
"tx_hash": "f53401f21c6a43e44d5dd7a90eba5cf580012ad0e15d050059136f8a0da34f6b",
|
|||
|
|
"tx_size": 159
|
|||
|
|
},{
|
|||
|
|
"amount": 27126892247503,
|
|||
|
|
"global_index": 594994,
|
|||
|
|
"key_image": "7e561394806afd1be61980cc3431f6ef3569fa9151cd8d234f8ec13aa145695e",
|
|||
|
|
"spent": false,
|
|||
|
|
"subaddr_index": 3,
|
|||
|
|
"tx_hash": "106d4391a031e5b735ded555862fec63233e34e5fa4fc7edcfdbe461c275ae5b",
|
|||
|
|
"tx_size": 157
|
|||
|
|
},{
|
|||
|
|
"amount": 27169374733655,
|
|||
|
|
"global_index": 594997,
|
|||
|
|
"key_image": "e76c0a3bfeaae35e4173712f782eb34011198e26b990225b71aa787c8ba8a157",
|
|||
|
|
"spent": false,
|
|||
|
|
"subaddr_index": 3,
|
|||
|
|
"tx_hash": "0bd959b59117ee1254bd8e5aa8e77ec04ef744144a1ffb2d5c1eb9380a719621",
|
|||
|
|
"tx_size": 158
|
|||
|
|
}]
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<p>Example, get available transfers:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"transfers": [{
|
|||
|
|
"amount": 27126892247503,
|
|||
|
|
"global_index": 594994,
|
|||
|
|
"key_image": "7e561394806afd1be61980cc3431f6ef3569fa9151cd8d234f8ec13aa145695e",
|
|||
|
|
"spent": false,
|
|||
|
|
"subaddr_index": 3,
|
|||
|
|
"tx_hash": "106d4391a031e5b735ded555862fec63233e34e5fa4fc7edcfdbe461c275ae5b",
|
|||
|
|
"tx_size": 157
|
|||
|
|
},{
|
|||
|
|
"amount": 27169374733655,
|
|||
|
|
"global_index": 594997,
|
|||
|
|
"key_image": "e76c0a3bfeaae35e4173712f782eb34011198e26b990225b71aa787c8ba8a157",
|
|||
|
|
"spent": false,
|
|||
|
|
"subaddr_index": 3,
|
|||
|
|
"tx_hash": "0bd959b59117ee1254bd8e5aa8e77ec04ef744144a1ffb2d5c1eb9380a719621",
|
|||
|
|
"tx_size": 158
|
|||
|
|
}]
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<p>Example, get unavailable transfers:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"transfers": [{
|
|||
|
|
"amount": 60000000000000,
|
|||
|
|
"global_index": 122405,
|
|||
|
|
"key_image": "768f5144777eb23477ab7acf83562581d690abaf98ca897c03a9d2b900eb479b",
|
|||
|
|
"spent": true,
|
|||
|
|
"subaddr_index": 3,
|
|||
|
|
"tx_hash": "f53401f21c6a43e44d5dd7a90eba5cf580012ad0e15d050059136f8a0da34f6b",
|
|||
|
|
"tx_size": 159
|
|||
|
|
}]
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="is_multisig"><strong>is_multisig</strong><a class="headerlink" href="#is_multisig" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Check if a wallet is a multisig one.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs: <em>None</em>.</p>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>multisig</em> - boolean; States if the wallet is multisig</li>
|
|||
|
|
<li><em>ready</em> - boolean;</li>
|
|||
|
|
<li><em>threshold</em> - unsigned int; Amount of signature needed to sign a transfer.</li>
|
|||
|
|
<li><em>total</em> - unsigned int; Total amount of signature in the multisig wallet.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example for a non-multisig wallet:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"result": {
|
|||
|
|
"multisig": false,
|
|||
|
|
"ready": false,
|
|||
|
|
"threshold": 0,
|
|||
|
|
"total": 0
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<p>Example for a multisig wallet:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"result": {
|
|||
|
|
"multisig": true,
|
|||
|
|
"ready": true,
|
|||
|
|
"threshold": 2,
|
|||
|
|
"total": 2
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="label_account"><strong>label_account</strong><a class="headerlink" href="#label_account" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Label an account.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>account_index</em> - unsigned int; Apply label to account at this index.</li>
|
|||
|
|
<li><em>label</em> - string; Label for the account.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs: <em>None</em>.</p>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"account_tags": [{
|
|||
|
|
"accounts": [0,1],
|
|||
|
|
"label": "",
|
|||
|
|
"tag": "myTag"
|
|||
|
|
}]
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="label_address"><strong>label_address</strong><a class="headerlink" href="#label_address" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Label an address.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>index</em> - subaddress index; JSON Object containing the major & minor address index:<ul>
|
|||
|
|
<li><em>major</em> - unsigned int; Account index for the subaddress.</li>
|
|||
|
|
<li><em>minor</em> - unsigned int; Index of the subaddress in the account.</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li><em>label</em> - string; Label for the address.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs: <em>None</em>.</p>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="make_integrated_address"><strong>make_integrated_address</strong><a class="headerlink" href="#make_integrated_address" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Make an integrated address from the wallet address and a payment id.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>standard_address</em> - string; (Optional, defaults to primary address) Destination public address.</li>
|
|||
|
|
<li><em>payment_id</em> - string; (Optional, defaults to a random ID) 16 characters hex encoded.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>integrated_address</em> - string</li>
|
|||
|
|
<li><em>payment_id</em> - string; hex encoded;</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example (Payment ID is empty, use a random ID):</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"integrated_address": "5F38Rw9HKeaLQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZXCkbHUXdPHyiUeRyokn",
|
|||
|
|
"payment_id": "420fa29b2d9a49f5"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="make_multisig"><strong>make_multisig</strong><a class="headerlink" href="#make_multisig" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Make a wallet multisig by importing peers multisig string.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>multisig_info</em> - array of string; List of multisig string from peers.</li>
|
|||
|
|
<li><em>threshold</em> - unsigned int; Amount of signatures needed to sign a transfer. Must be less or equal than the amount of signature in <code>multisig_info</code>.</li>
|
|||
|
|
<li><em>password</em> - string; Wallet password</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>address</em> - string; multisig wallet address.</li>
|
|||
|
|
<li><em>multisig_info</em> - string; Multisig string to share with peers to create the multisig wallet (extra step for N-1/N wallets).</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example for 2/2 Multisig Wallet:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"address": "55SoZTKH7D39drxfgT62k8T4adVFjmDLUXnbzEKYf1MoYwnmTNKKaqGfxm4sqeKCHXQ5up7PVxrkoeRzXu83d8xYURouMod",
|
|||
|
|
"multisig_info": ""
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<p>Example for 2/3 Multisig Wallet:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"address": "51sLpF8fWaK1111111111111111111111111111111111ABVbHNf1JFWJyFp5YZgZRQ44RiviJi1sPHgLVMbckRsDkTRgKS",
|
|||
|
|
"multisig_info": "MultisigxV18jCaYAQQvzCMUJaAWMCaAbAoHpAD6WPmYDmLtBtazD654E8RWkLaGRf29fJ3stU471MELKxwufNYeigP7LoE4tn2Sscwn5g7PyCfcBc1V4ffRHY3Kxqq6VocSCUTncpVeUskaDKuTAWtdB9VTBGW7iG1cd7Zm1dYgur3CiemkGjRUAj9bL3xTEuyaKGYSDhtpFZFp99HQX57EawhiRHk3qq4hjWX"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="make_uri"><strong>make_uri</strong><a class="headerlink" href="#make_uri" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Create a payment URI using the official URI spec.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>address</em> - string; Wallet address</li>
|
|||
|
|
<li><em>amount</em> - unsigned int; (optional) the integer amount to receive, in <strong>atomic</strong>units</li>
|
|||
|
|
<li><em>payment_id</em> - string; (optional) 16 or 64 character hexadecimal payment id</li>
|
|||
|
|
<li><em>recipient_name</em> - string; (optional) name of the payment recipient</li>
|
|||
|
|
<li><em>tx_description</em> - string; (optional) Description of the reason for the tx</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>uri</em> - string; This contains all the payment input information as a properly formatted payment URI</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"uri": "monero:55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt?tx_payment_id=420fa29b2d9a49f5&tx_amount=0.000000000010&recipient_name=el00ruobuob%20Stagenet%20wallet&tx_description=Testing%20out%20the%20make_uri%20function."
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="open_wallet"><strong>open_wallet</strong><a class="headerlink" href="#open_wallet" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Open a wallet. You need to have set the argument "–wallet-dir" when launching monero-wallet-rpc to make this work.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>filename</em> - string; wallet name stored in –wallet-dir.</li>
|
|||
|
|
<li><em>password</em> - string; (Optional) only needed if the wallet has a password defined.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs: <em>None</em>.</p>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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": {
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="parse_uri"><strong>parse_uri</strong><a class="headerlink" href="#parse_uri" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Parse a payment URI to get payment information.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>uri</em> - string; This contains all the payment input information as a properly formatted payment URI</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>uri</em> - JSON object containing payment information:<ul>
|
|||
|
|
<li><em>address</em> - string; Wallet address</li>
|
|||
|
|
<li><em>amount</em> - unsigned int; Decimal amount to receive, in <strong>coin</strong> units (0 if not provided)</li>
|
|||
|
|
<li><em>payment_id</em> - string; 16 or 64 character hexadecimal payment id (empty if not provided)</li>
|
|||
|
|
<li><em>recipient_name</em> - string; Name of the payment recipient (empty if not provided)</li>
|
|||
|
|
<li><em>tx_description</em> - string; Description of the reason for the tx (empty if not provided)</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"uri": {
|
|||
|
|
"address": "55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt",
|
|||
|
|
"amount": 10,
|
|||
|
|
"payment_id": "420fa29b2d9a49f5",
|
|||
|
|
"recipient_name": "el00ruobuob Stagenet wallet",
|
|||
|
|
"tx_description": "Testing out the make_uri function."
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="prepare_multisig"><strong>prepare_multisig</strong><a class="headerlink" href="#prepare_multisig" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Prepare a wallet for multisig by generating a multisig string to share with peers.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs: <em>None</em>.</p>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>multisig_info</em> - string; Multisig string to share with peers to create the multisig wallet.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"prepare_multisig"}' -H 'Content-Type: application/json'
|
|||
|
|
{
|
|||
|
|
"id": "0",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"multisig_info": "MultisigV1BFdxQ653cQHB8wsj9WJQd2VdnjxK89g5M94dKPBNw22reJnyJYKrz6rJeXdjFwJ3Mz6n4qNQLd6eqUZKLiNzJFi3UPNVcTjtkG2aeSys9sYkvYYKMZ7chCxvoEXVgm74KKUcUu4V8xveCBFadFuZs8shnxBWHbcwFr5AziLr2mE7KHJT"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="query_key"><strong>query_key</strong><a class="headerlink" href="#query_key" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Return the spend or view private key.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>key_type</em> - string; Which key to retrieve: "mnemonic" - the mnemonic seed (older wallets do not have one) OR "view_key" - the view key</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>key</em> - string; The view key will be hex encoded, while the mnemonic will be a string of words.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example (Query view key):</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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": "0a1a38f6d246e894600a3e27238a064bf5e8d91801df47a17107596b1378e501"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<p>Example (Query mnemonic key):</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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": "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"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="refresh"><strong>refresh</strong><a class="headerlink" href="#refresh" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Refresh a wallet after openning.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>start_height</em> - unsigned int; (Optional) The block height from which to start refreshing.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>blocks_fetched</em> - unsigned int; Number of new blocks scanned.</li>
|
|||
|
|
<li><em>received_money</em> - boolean; States if transactions to the wallet have been found in the blocks.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"blocks_fetched": 24,
|
|||
|
|
"received_money": true
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="relay_tx"><strong>relay_tx</strong><a class="headerlink" href="#relay_tx" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Relay a transaction previously created with <code>"do_not_relay":true</code>.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>hex</em> - string; transaction metadata returned from a <code>transfer</code> method with <code>get_tx_metadata</code> set to <code>true</code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>tx_hash</em> - String for the publically searchable transaction hash.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"tx_hash": "1c42dcc5672bb09bccf33fb1e9ab4a498af59a6dbd33b3d0cfb289b9e0e25fa5"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="rescan_blockchain"><strong>rescan_blockchain</strong><a class="headerlink" href="#rescan_blockchain" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Rescan the blockchain from scratch, losing any information which can not be recovered from the blockchain itself.<br />
|
|||
|
|
This includes destination addresses, tx secret keys, tx notes, etc.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs: <em>None</em>.</p>
|
|||
|
|
<p>Outputs: <em>None</em>.</p>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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": {
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="rescan_spent"><strong>rescan_spent</strong><a class="headerlink" href="#rescan_spent" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Rescan the blockchain for spent outputs.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs: <em>None</em>.</p>
|
|||
|
|
<p>Outputs: <em>None</em>.</p>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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": {
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="set_account_tag_description"><strong>set_account_tag_description</strong><a class="headerlink" href="#set_account_tag_description" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Set description for an account tag.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>tag</em> - string; Set a description for this tag.</li>
|
|||
|
|
<li><em>description</em> - string; Description for the tag.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs: <em>None</em>.</p>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="set_attribute"><strong>set_attribute</strong><a class="headerlink" href="#set_attribute" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Set arbitrary attribute.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>key</em> - string; attribute name</li>
|
|||
|
|
<li><em>value</em> - string; attribute value</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs: <em>None</em>.</p>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="set_tx_notes"><strong>set_tx_notes</strong><a class="headerlink" href="#set_tx_notes" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Set arbitrary string notes for transactions.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>txids</em> - array of string; transaction ids</li>
|
|||
|
|
<li><em>notes</em> - array of string; notes for the transactions</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs: <em>None</em>.</p>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="sign"><strong>sign</strong><a class="headerlink" href="#sign" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Sign a string.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>data</em> - string; Anything you need to sign.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>signature</em> - string; Signature generated against the "data" and the account public address.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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": "SigV14K6G151gycjiGxjQ74tKX6A2LwwghvuHjcDeuRFQio5LS6Gb27BNxjYQY1dPuUvXkEbGQUkiHSVLPj4nJAHRrrw3"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="sign_multisig"><strong>sign_multisig</strong><a class="headerlink" href="#sign_multisig" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Sign a transaction in multisig.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>tx_data_hex</em> - string; Multisig transaction in hex format, as returned by <code>transfer</code> under <code>multisig_txset</code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>tx_data_hex</em> - string; Multisig transaction in hex format.</li>
|
|||
|
|
<li><em>tx_hash_list</em> - array of string; List of transaction Hash.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"tx_data_hex": "...multisig_txset...",
|
|||
|
|
"tx_hash_list": ["4996091b61c1be112c1097fd5e97d8ff8b28f0e5e62e1137a8c831bacf034f2d"]
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="sign_transfer"><strong>sign_transfer</strong><a class="headerlink" href="#sign_transfer" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Sign a transaction created on a read-only wallet (in cold-signing process)</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>unsigned_txset</em> - string. Set of unsigned tx returned by "transfer" or "transfer_split" methods.</li>
|
|||
|
|
<li><em>export_raw</em> - boolean; (Optional) If true, return the raw transaction data. (Defaults to false)</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>signed_txset</em> - string. Set of signed tx to be used for submitting transfer.</li>
|
|||
|
|
<li><em>tx_hash_list</em> - array of: string. The tx hashes of every transaction.</li>
|
|||
|
|
<li><em>tx_raw_list</em> - array of: string. The tx raw data of every transaction.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>In the example below, we first generate an unsigned_txset on a read only wallet before signing it:</p>
|
|||
|
|
<p>Generate unsigned_txset using the above "transfer" method on read-only wallet:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"amount": 1000000000000,
|
|||
|
|
"fee": 15202740000,
|
|||
|
|
"multisig_txset": "",
|
|||
|
|
"tx_blob": "...long_hex...",
|
|||
|
|
"tx_hash": "c648ba0a049e5ce4ec21361dbf6e4b21eac0f828eea9090215de86c76b31d0a4",
|
|||
|
|
"tx_key": "",
|
|||
|
|
"tx_metadata": "",
|
|||
|
|
"unsigned_txset": "...long_hex..."
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<p>Sign tx using the previously generated unsigned_txset</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"signed_txset": "...long_hex...",
|
|||
|
|
"tx_hash_list": ["ff2e2d49fbfb1c9a55754f786576e171c8bf21b463a74438df604b7fa6cebc6d"]
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="split_integrated_address"><strong>split_integrated_address</strong><a class="headerlink" href="#split_integrated_address" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Retrieve the standard address and payment id corresponding to an integrated address.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>integrated_address</em> - string</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>is_subaddress</em> - boolean; States if the address is a subaddress</li>
|
|||
|
|
<li><em>payment</em> - string; hex encoded</li>
|
|||
|
|
<li><em>standard_address</em> - string</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"is_subaddress": false,
|
|||
|
|
"payment_id": "420fa29b2d9a49f5",
|
|||
|
|
"standard_address": "55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="start_mining"><strong>start_mining</strong><a class="headerlink" href="#start_mining" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Start mining in the Monero daemon.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>threads_count</em> - unsigned int; Number of threads created for mining.</li>
|
|||
|
|
<li><em>do_background_mining</em> - boolean; Allow to start the miner in <a href="https://ww.getmonero.org/resources/moneropedia/smartmining.html">smart mining</a>mode.</li>
|
|||
|
|
<li><em>ignore_battery</em> - boolean; Ignore battery status (for <a href="https://ww.getmonero.org/resources/moneropedia/smartmining.html">smart mining</a> only)</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs: <em>None</em>.</p>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="stop_mining"><strong>stop_mining</strong><a class="headerlink" href="#stop_mining" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Stop mining in the Monero daemon.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs: <em>None</em>.</p>
|
|||
|
|
<p>Outputs: <em>None</em>.</p>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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": {
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="stop_wallet"><strong>stop_wallet</strong><a class="headerlink" href="#stop_wallet" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Stops the wallet, storing the current state.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs: <em>None</em>.</p>
|
|||
|
|
<p>Outputs: <em>None</em>.</p>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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": {
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="store"><strong>store</strong><a class="headerlink" href="#store" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Save the wallet file.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs: <em>None</em>.</p>
|
|||
|
|
<p>Outputs: <em>None</em>.</p>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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": {
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="submit_multisig"><strong>submit_multisig</strong><a class="headerlink" href="#submit_multisig" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Submit a signed multisig transaction.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>tx_data_hex</em> - string; Multisig transaction in hex format, as returned by <code>sign_multisig</code> under <code>tx_data_hex</code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>tx_hash_list</em> - array of string; List of transaction Hash.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"tx_hash_list": ["4996091b61c1be112c1097fd5e97d8ff8b28f0e5e62e1137a8c831bacf034f2d"]
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="submit_transfer"><strong>submit_transfer</strong><a class="headerlink" href="#submit_transfer" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Submit a previously signed transaction on a read-only wallet (in cold-signing process).</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>tx_data_hex</em> - string; Set of signed tx returned by "sign_transfer"</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>tx_hash_list</em> - array of: string. The tx hashes of every transaction.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>In the example below, we submit the transfer using the signed_txset generated above:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"tx_hash_list": ["40fad7c828bb383ac02648732f7afce9adc520ba5629e1f5d9c03f584ac53d74"]
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="sweep_all"><strong>sweep_all</strong><a class="headerlink" href="#sweep_all" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Send all unlocked balance to an address.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>address</em> - string; Destination public address.</li>
|
|||
|
|
<li><em>account_index</em> - unsigned int; Sweep transactions from this account.</li>
|
|||
|
|
<li><em>subaddr_indices</em> - array of unsigned int; (Optional) Sweep from this set of subaddresses in the account.</li>
|
|||
|
|
<li><em>priority</em> - unsigned int; (Optional) Priority for sending the sweep transfer, partially determines fee.</li>
|
|||
|
|
<li><em>mixin</em> - unsigned int; Number of outputs from the blockchain to mix with (0 means no mixing).</li>
|
|||
|
|
<li><em>ring_size</em> - unsigned int; Sets ringsize to n (mixin + 1).</li>
|
|||
|
|
<li><em>unlock_time</em> - unsigned int; Number of blocks before the monero can be spent (0 to not add a lock).</li>
|
|||
|
|
<li><em>payment_id</em> - string; (Optional) Random 32-byte/64-character hex string to identify a transaction.</li>
|
|||
|
|
<li><em>get_tx_keys</em> - boolean; (Optional) Return the transaction keys after sending.</li>
|
|||
|
|
<li><em>below_amount</em> - unsigned int; (Optional) Include outputs below this amount.</li>
|
|||
|
|
<li><em>do_not_relay</em> - boolean; (Optional) If true, do not relay this sweep transfer. (Defaults to false)</li>
|
|||
|
|
<li><em>get_tx_hex</em> - boolean; (Optional) return the transactions as hex encoded string. (Defaults to false)</li>
|
|||
|
|
<li><em>get_tx_metadata</em> - boolean; (Optional) return the transaction metadata as a string. (Defaults to false)</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>tx_hash_list</em> - array of: string. The tx hashes of every transaction.</li>
|
|||
|
|
<li><em>tx_key_list</em> - array of: string. The transaction keys for every transaction.</li>
|
|||
|
|
<li><em>amount_list</em> - array of: integer. The amount transferred for every transaction.</li>
|
|||
|
|
<li><em>fee_list</em> - array of: integer. The amount of fees paid for every transaction.</li>
|
|||
|
|
<li><em>tx_blob_list</em> - array of: string. The tx as hex string for every transaction.</li>
|
|||
|
|
<li><em>tx_metadata_list</em> - array of: string. List of transaction metadata needed to relay the transactions later.</li>
|
|||
|
|
<li><em>multisig_txset</em> - string. The set of signing keys used in a multisig transaction (empty for non-multisig).</li>
|
|||
|
|
<li><em>unsigned_txset</em> - string. Set of unsigned tx for cold-signing purposes.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"amount_list": [9985885770000],
|
|||
|
|
"fee_list": [14114230000],
|
|||
|
|
"multisig_txset": "",
|
|||
|
|
"tx_hash_list": ["ab4b6b65cc8cd8c9dd317d0b90d97582d68d0aa1637b0065b05b61f9a66ea5c5"],
|
|||
|
|
"tx_key_list": ["b9b4b39d3bb3062ddb85ec0266d4df39058f4c86077d99309f218ce4d76af607"],
|
|||
|
|
"unsigned_txset": ""
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="sweep_dust"><strong>sweep_dust</strong><a class="headerlink" href="#sweep_dust" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Send all dust outputs back to the wallet's, to make them easier to spend (and mix).</p>
|
|||
|
|
<p>Alias: <em>sweep_unmixable</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>get_tx_keys</em> - boolean; (Optional) Return the transaction keys after sending.</li>
|
|||
|
|
<li><em>do_not_relay</em> - boolean; (Optional) If true, the newly created transaction will not be relayed to the monero network. (Defaults to false)</li>
|
|||
|
|
<li><em>get_tx_hex</em> - boolean; (Optional) Return the transactions as hex string after sending. (Defaults to false)</li>
|
|||
|
|
<li><em>get_tx_metadata</em> - boolean; (Optional) Return list of transaction metadata needed to relay the transfer later. (Defaults to false)</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>tx_hash_list</em> - array of: string. The tx hashes of every transaction.</li>
|
|||
|
|
<li><em>tx_key_list</em> - array of: string. The transaction keys for every transaction.</li>
|
|||
|
|
<li><em>amount_list</em> - array of: integer. The amount transferred for every transaction.</li>
|
|||
|
|
<li><em>fee_list</em> - array of: integer. The amount of fees paid for every transaction.</li>
|
|||
|
|
<li><em>tx_blob_list</em> - array of: string. The tx as hex string for every transaction.</li>
|
|||
|
|
<li><em>tx_metadata_list</em> - array of: string. List of transaction metadata needed to relay the transactions later.</li>
|
|||
|
|
<li><em>multisig_txset</em> - string. The set of signing keys used in a multisig transaction (empty for non-multisig).</li>
|
|||
|
|
<li><em>unsigned_txset</em> - string. Set of unsigned tx for cold-signing purposes.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example (In this example, <code>sweep_dust</code> returns nothing because there are no funds to sweep):</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"multisig_txset": "",
|
|||
|
|
"unsigned_txset": ""
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="sweep_single"><strong>sweep_single</strong><a class="headerlink" href="#sweep_single" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Send all of a specific unlocked output to an address.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>address</em> - string; Destination public address.</li>
|
|||
|
|
<li><em>account_index</em> - unsigned int; Sweep transactions from this account.</li>
|
|||
|
|
<li><em>subaddr_indices</em> - array of unsigned int; (Optional) Sweep from this set of subaddresses in the account.</li>
|
|||
|
|
<li><em>priority</em> - unsigned int; (Optional) Priority for sending the sweep transfer, partially determines fee.</li>
|
|||
|
|
<li><em>mixin</em> - unsigned int; Number of outputs from the blockchain to mix with (0 means no mixing).</li>
|
|||
|
|
<li><em>ring_size</em> - unsigned int; Sets ringsize to n (mixin + 1).</li>
|
|||
|
|
<li><em>unlock_time</em> - unsigned int; Number of blocks before the monero can be spent (0 to not add a lock).</li>
|
|||
|
|
<li><em>payment_id</em> - string; (Optional) Random 32-byte/64-character hex string to identify a transaction.</li>
|
|||
|
|
<li><em>get_tx_keys</em> - boolean; (Optional) Return the transaction keys after sending.</li>
|
|||
|
|
<li><em>key_image</em> - string; Key image of specific output to sweep.</li>
|
|||
|
|
<li><em>below_amount</em> - unsigned int; (Optional) Include outputs below this amount.</li>
|
|||
|
|
<li><em>do_not_relay</em> - boolean; (Optional) If true, do not relay this sweep transfer. (Defaults to false)</li>
|
|||
|
|
<li><em>get_tx_hex</em> - boolean; (Optional) return the transactions as hex encoded string. (Defaults to false)</li>
|
|||
|
|
<li><em>get_tx_metadata</em> - boolean; (Optional) return the transaction metadata as a string. (Defaults to false)</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>tx_hash_list</em> - array of: string. The tx hashes of every transaction.</li>
|
|||
|
|
<li><em>tx_key_list</em> - array of: string. The transaction keys for every transaction.</li>
|
|||
|
|
<li><em>amount_list</em> - array of: integer. The amount transferred for every transaction.</li>
|
|||
|
|
<li><em>fee_list</em> - array of: integer. The amount of fees paid for every transaction.</li>
|
|||
|
|
<li><em>tx_blob_list</em> - array of: string. The tx as hex string for every transaction.</li>
|
|||
|
|
<li><em>tx_metadata_list</em> - array of: string. List of transaction metadata needed to relay the transactions later.</li>
|
|||
|
|
<li><em>multisig_txset</em> - string. The set of signing keys used in a multisig transaction (empty for non-multisig).</li>
|
|||
|
|
<li><em>unsigned_txset</em> - string. Set of unsigned tx for cold-signing purposes.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"amount": 27126892247503,
|
|||
|
|
"fee": 14111630000,
|
|||
|
|
"multisig_txset": "",
|
|||
|
|
"tx_blob": "",
|
|||
|
|
"tx_hash": "106d4391a031e5b735ded555862fec63233e34e5fa4fc7edcfdbe461c275ae5b",
|
|||
|
|
"tx_key": "",
|
|||
|
|
"tx_metadata": "",
|
|||
|
|
"unsigned_txset": ""
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="tag_accounts"><strong>tag_accounts</strong><a class="headerlink" href="#tag_accounts" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Apply a filtering tag to a list of accounts.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>tag</em> - string; Tag for the accounts.</li>
|
|||
|
|
<li><em>accounts</em> - array of unsigned int; Tag this list of accounts.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs: <em>None</em>.</p>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="transfer"><strong>transfer</strong><a class="headerlink" href="#transfer" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Send monero to a number of recipients.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>destinations</em> - array of destinations to receive XMR:<ul>
|
|||
|
|
<li><em>amount</em> - unsigned int; Amount to send to each destination, in atomic units.</li>
|
|||
|
|
<li><em>address</em> - string; Destination public address.</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li><em>account_index</em> - unsigned int; (Optional) Transfer from this account index. (Defaults to 0)</li>
|
|||
|
|
<li><em>subaddr_indices</em> - array of unsigned int; (Optional) Transfer from this set of subaddresses. (Defaults to 0)</li>
|
|||
|
|
<li><em>priority</em> - unsigned int; Set a priority for the transaction. Accepted Values are: 0-3 for: default, unimportant, normal, elevated, priority.</li>
|
|||
|
|
<li><em>mixin</em> - unsigned int; Number of outputs from the blockchain to mix with (0 means no mixing).</li>
|
|||
|
|
<li><em>ring_size</em> - unsigned int; Number of outputs to mix in the transaction (this output + N decoys from the blockchain).</li>
|
|||
|
|
<li><em>unlock_time</em> - unsigned int; Number of blocks before the monero can be spent (0 to not add a lock).</li>
|
|||
|
|
<li><em>payment_id</em> - string; (Optional) Random 32-byte/64-character hex string to identify a transaction.</li>
|
|||
|
|
<li><em>get_tx_key</em> - boolean; (Optional) Return the transaction key after sending.</li>
|
|||
|
|
<li><em>do_not_relay</em> - boolean; (Optional) If true, the newly created transaction will not be relayed to the monero network. (Defaults to false)</li>
|
|||
|
|
<li><em>get_tx_hex</em> - boolean; Return the transaction as hex string after sending (Defaults to false)</li>
|
|||
|
|
<li><em>get_tx_metadata</em> - boolean; Return the metadata needed to relay the transaction. (Defaults to false)</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>amount</em> - Amount transferred for the transaction.</li>
|
|||
|
|
<li><em>fee</em> - Integer value of the fee charged for the txn.</li>
|
|||
|
|
<li><em>multisig_txset</em> - Set of multisig transactions in the process of being signed (empty for non-multisig).</li>
|
|||
|
|
<li><em>tx_blob</em> - Raw transaction represented as hex string, if get_tx_hex is true.</li>
|
|||
|
|
<li><em>tx_hash</em> - String for the publically searchable transaction hash.</li>
|
|||
|
|
<li><em>tx_key</em> - String for the transaction key if get_tx_key is true, otherwise, blank string.</li>
|
|||
|
|
<li><em>tx_metadata</em> - Set of transaction metadata needed to relay this transfer later, if get_tx_metadata is true.</li>
|
|||
|
|
<li><em>unsigned_txset</em> - String. Set of unsigned tx for cold-signing purposes.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"amount": 300000000000,
|
|||
|
|
"fee": 86897600000,
|
|||
|
|
"multisig_txset": "",
|
|||
|
|
"tx_blob": "",
|
|||
|
|
"tx_hash": "7663438de4f72b25a0e395b770ea9ecf7108cd2f0c4b75be0b14a103d3362be9",
|
|||
|
|
"tx_key": "25c9d8ec20045c80c93d665c9d3684aab7335f8b2cd02e1ba2638485afd1c70e236c4bdd7a2f1cb511dbf466f13421bdf8df988b7b969c448ca6239d7251490e4bf1bbf9f6ffacffdcdc93b9d1648ec499eada4d6b4e02ce92d4a1c0452e5d009fbbbf15b549df8856205a4c7bda6338d82c823f911acd00cb75850b198c5803",
|
|||
|
|
"tx_metadata": "",
|
|||
|
|
"unsigned_txset": ""
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="transfer_split"><strong>transfer_split</strong><a class="headerlink" href="#transfer_split" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Same as transfer, but can split into more than one tx if necessary.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>destinations</em> - array of destinations to receive XMR:<ul>
|
|||
|
|
<li><em>amount</em> - unsigned int; Amount to send to each destination, in atomic units.</li>
|
|||
|
|
<li><em>address</em> - string; Destination public address.</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li><em>account_index</em> - unsigned int; (Optional) Transfer from this account index. (Defaults to 0)</li>
|
|||
|
|
<li><em>subaddr_indices</em> - array of unsigned int; (Optional) Transfer from this set of subaddresses. (Defaults to 0)</li>
|
|||
|
|
<li><em>mixin</em> - unsigned int; Number of outputs from the blockchain to mix with (0 means no mixing).</li>
|
|||
|
|
<li><em>ring_size</em> - unsigned int; Sets ringsize to n (mixin + 1).</li>
|
|||
|
|
<li><em>unlock_time</em> - unsigned int; Number of blocks before the monero can be spent (0 to not add a lock).</li>
|
|||
|
|
<li><em>payment_id</em> - string; (Optional) Random 32-byte/64-character hex string to identify a transaction.</li>
|
|||
|
|
<li><em>get_tx_keys</em> - boolean; (Optional) Return the transaction keys after sending.</li>
|
|||
|
|
<li><em>priority</em> - unsigned int; Set a priority for the transactions. Accepted Values are: 0-3 for: default, unimportant, normal, elevated, priority.</li>
|
|||
|
|
<li><em>do_not_relay</em> - boolean; (Optional) If true, the newly created transaction will not be relayed to the monero network. (Defaults to false)</li>
|
|||
|
|
<li><em>get_tx_hex</em> - boolean; Return the transactions as hex string after sending</li>
|
|||
|
|
<li><em>new_algorithm</em> - boolean; True to use the new transaction construction algorithm, defaults to false.</li>
|
|||
|
|
<li><em>get_tx_metadata</em> - boolean; Return list of transaction metadata needed to relay the transfer later.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>tx_hash_list</em> - array of: string. The tx hashes of every transaction.</li>
|
|||
|
|
<li><em>tx_key_list</em> - array of: string. The transaction keys for every transaction.</li>
|
|||
|
|
<li><em>amount_list</em> - array of: integer. The amount transferred for every transaction.</li>
|
|||
|
|
<li><em>fee_list</em> - array of: integer. The amount of fees paid for every transaction.</li>
|
|||
|
|
<li><em>tx_blob_list</em> - array of: string. The tx as hex string for every transaction.</li>
|
|||
|
|
<li><em>tx_metadata_list</em> - array of: string. List of transaction metadata needed to relay the transactions later.</li>
|
|||
|
|
<li><em>multisig_txset</em> - string. The set of signing keys used in a multisig transaction (empty for non-multisig).</li>
|
|||
|
|
<li><em>unsigned_txset</em> - string. Set of unsigned tx for cold-signing purposes.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"amount_list": [3000000000000],
|
|||
|
|
"fee_list": [85106400000],
|
|||
|
|
"multisig_txset": "",
|
|||
|
|
"tx_hash_list": ["c8d815f48f27d53fdaf198a74b292a91bfaf87529a9a9a9ee66079a890b3b58b"],
|
|||
|
|
"unsigned_txset": ""
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="untag_accounts"><strong>untag_accounts</strong><a class="headerlink" href="#untag_accounts" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Remove filtering tag from a list of accounts.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>accounts</em> - array of unsigned int; Remove tag from this list of accounts.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs: <em>None</em>.</p>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h3 id="verify"><strong>verify</strong><a class="headerlink" href="#verify" title="Permanent link">¶</a></h3>
|
|||
|
|
<p>Verify a signature on a string.</p>
|
|||
|
|
<p>Alias: <em>None</em>.</p>
|
|||
|
|
<p>Inputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>data</em> - string; What should have been signed.</li>
|
|||
|
|
<li><em>address</em> - string; Public address of the wallet used to <code>sign</code> the data.</li>
|
|||
|
|
<li><em>signature</em> - string; signature generated by <code>sign</code> method.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Outputs:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><em>good</em> - boolean;</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<div class="highlight"><pre><span></span><code>$ 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",
|
|||
|
|
"jsonrpc": "2.0",
|
|||
|
|
"result": {
|
|||
|
|
"good": true
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre></div>
|
|||
|
|
<h2 id="sources">Sources:<a class="headerlink" href="#sources" title="Permanent link">¶</a></h2>
|
|||
|
|
<p>Reworked from <a href="https://ww.getmonero.org/resources/developer-guides/wallet-rpc.html">GetMonero.org</a></p>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</article>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</main>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<footer class="md-footer">
|
|||
|
|
|
|||
|
|
<div class="md-footer-nav">
|
|||
|
|
<nav class="md-footer-nav__inner md-grid" aria-label="Footer">
|
|||
|
|
|
|||
|
|
<a href="../monero-wallet-gui-reference/" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
|
|||
|
|
<div class="md-footer-nav__button md-icon">
|
|||
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
|
|||
|
|
</div>
|
|||
|
|
<div class="md-footer-nav__title">
|
|||
|
|
<div class="md-ellipsis">
|
|||
|
|
<span class="md-footer-nav__direction">
|
|||
|
|
Previous
|
|||
|
|
</span>
|
|||
|
|
monero-wallet-gui
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="../monero-blockchain-export-reference/" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
|
|||
|
|
<div class="md-footer-nav__title">
|
|||
|
|
<div class="md-ellipsis">
|
|||
|
|
<span class="md-footer-nav__direction">
|
|||
|
|
Next
|
|||
|
|
</span>
|
|||
|
|
monero-blockchain-export
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="md-footer-nav__button md-icon">
|
|||
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
|
|||
|
|
</div>
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</nav>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="md-footer-meta md-typeset">
|
|||
|
|
<div class="md-footer-meta__inner md-grid">
|
|||
|
|
<div class="md-footer-copyright">
|
|||
|
|
|
|||
|
|
Made with
|
|||
|
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|||
|
|
Material for MkDocs
|
|||
|
|
</a>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</footer>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<script src="../../assets/javascripts/vendor.93c04032.min.js"></script>
|
|||
|
|
<script src="../../assets/javascripts/bundle.83e5331e.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}</script>
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
app = initialize({
|
|||
|
|
base: "../..",
|
|||
|
|
features: [],
|
|||
|
|
search: Object.assign({
|
|||
|
|
worker: "../../assets/javascripts/worker/search.8c7e0a7e.min.js"
|
|||
|
|
}, typeof search !== "undefined" && search)
|
|||
|
|
})
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|