d0s3t3ch/wownero-python
1
0
Fork 0
mirror of https://git.wownero.com/lza_menace/wownero-python.git synced 2024-08-15 03:25:25 +00:00
Code Issues Projects Releases Wiki Activity

throwing up a quick doc about the only available backend

Browse source
This commit is contained in:
lance 2018-01-19 23:57:44 -08:00
parent 582bd1c9e4
commit e393ffe782
1 changed files with 20 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/source/backends.rst
View file

@ -1,5 +1,22 @@
JSON RPC backend
================
Backends
========
.. automodule:: monero.backends.jsonrpc
Backends are the protocols and methods used to communicate with the Monero daemon and interact with the wallet. As of the time of this writing, the only backend available in this library is for the HTTP based RPC server.
JSON RPC
----------------
This backend requires a running *monero-wallet-rpc* process with a Monero wallet file opened. This can be on your local system or a remote node, depending on where the wallet file lives and where the daemon is running. Refer to the quickstart for general setup information.
The Python `requests` library is used in order to facilitate HTTP requests to the JSON RPC interface. It makes POST requests and passes proper headers, parameters, and payload data as per the official `Wallet RPC` documentation.
.. _`requests`: http://docs.python-requests.org/
.. _`Wallet RPC`: https://getmonero.org/resources/developer-guides/wallet-rpc.html
API reference
=============
.. automodule:: monero.backends
:members: