d0s3t3ch
/
wownero-python
mirror of https://git.wownero.com/lza_menace/wownero-python.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #3 from lalanza808/documentation-backends-start 

Adding content to backend doc
This commit is contained in:
Michał Sałaban 2018-01-21 00:10:03 +01:00 committed by GitHub
parent e4eec2fa87 9a32c3cf7a
commit 2c3b53c612
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 3 deletions
Show Stats 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: