From e393ffe7826b1ca49dea8593af5d1b7325f009b9 Mon Sep 17 00:00:00 2001 From: lance Date: Fri, 19 Jan 2018 23:57:44 -0800 Subject: [PATCH] throwing up a quick doc about the only available backend --- docs/source/backends.rst | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/docs/source/backends.rst b/docs/source/backends.rst index 0892269..b9cccb7 100644 --- a/docs/source/backends.rst +++ b/docs/source/backends.rst @@ -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: