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

Update docs

Browse source
This commit is contained in:
Michał Sałaban 2019-01-03 18:04:42 +00:00
parent d9c68a86c6
commit c51e3672a6
3 changed files with 36 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

27
docs/source/backends.rst
View file

@ -2,8 +2,10 @@ Backends
========
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.
the wallet. As of the time of this writing, the only backends available in this library are:
* ``jsonrpc`` for the HTTP based RPC server,
* ``offline`` for running the wallet without Internet connection and even without the wallet file.
JSON RPC
----------------
@ -20,9 +22,22 @@ the official `Wallet RPC`_ documentation.
.. _`Wallet RPC`: https://getmonero.org/resources/developer-guides/wallet-rpc.html
API reference
-------------
.. automodule:: monero.backends.jsonrpc
:members:
Offline
----------------
This backend allows creating a `Wallet` instance without network connection or even without the
wallet itself. In version 0.5 the only practical use is to cold-generate
:doc:`subaddresses <address>` like in the example below:
.. code-block:: python
In [8]: w = Wallet(OfflineWallet('47ewoP19TN7JEEnFKUJHAYhGxkeTRH82sf36giEp9AcNfDBfkAtRLX7A6rZz18bbNHPNV7ex6WYbMN3aKisFRJZ8Ebsmgef', view_key='6d9056aa2c096bfcd2f272759555e5764ba204dd362604a983fa3e0aafd35901'))
In [9]: w.get_address(100,37847)
Out[9]: 883Gcsq65iqh4UL3fJTWLxY45skXyFVNQJZ4bdw4TJcqd8vafvtpX4p6HNmawqFMQ6TwJP7adzyLT1fbU6z1n9dqB9bJrfn
.. automodule:: monero.backends.offline
:members: