Skip to content
Snippets Groups Projects
Commit 3141c424 authored by Fabian Schuh's avatar Fabian Schuh
Browse files

[docs] add more documentation as requested #2

parent 49d2947d
No related branches found
No related tags found
No related merge requests found
*************
Configuration
*************
The pybitshares library comes with its own local configuration database
that stores information like
* API node URL
* default account name
* the encrypted master password
and potentially more.
You can access those variables like a regular dictionary by using
.. code-block:: python
from bitshares import BitShares
bitshares = BitShares()
print(bitshares.config.items())
Keys can be added and changed like they are for regular dictionaries.
If you don't want to load the :class:`bitshares.BitShares` class, you
can load the configuration directly by using:
.. code-block:: python
from bitshares.storage import configStorage as config
API
---
.. autoclass:: bitshares.storage.Configuration
:members:
......@@ -3,6 +3,13 @@ Contributing to python-bitshares
We welcome your contributions to our project.
Repository
----------
The *main* repository of python-bitshares is currently located at:
https://github.com/xeroc/python-bitshares
Flow
----
......
......@@ -103,6 +103,7 @@ General
quickstart
tutorials
contribute
support
Python-BitShares Libraries
--------------------------
......
*******
Storage
~~~~~~~~~
*******
These classes are very low level and are not well documented.
API
---
.. autoclass:: bitshares.storage.DataDir
:members:
......@@ -7,8 +13,5 @@ Storage
.. autoclass:: bitshares.storage.Key
:members:
.. autoclass:: bitshares.storage.Configuration
:members:
.. autoclass:: bitshares.storage.MasterPassword
:members:
*********************
Support and Questions
*********************
We have currently not setup a distinct channel for development around
pybitshares. However, many of the contributors are frequently reading
through these channels:
* https://bitsharestalk.org
* https://t.me/BitSharesDEX
......@@ -25,6 +25,22 @@ The wallet can be unlocked for signing using
bitshares = BitShares()
bitshares.wallet.unlock("supersecret-passphrase")
Adding a Private Key
--------------------
A private key can be added by using the
:func:`bitshares.wallet.Wallet.addPrivateKey` method that is available
**after** unlocking the wallet with the correct passphrase:
.. code-block:: python
from bitshares import BitShares
bitshares = BitShares()
bitshares.wallet.unlock("supersecret-passphrase")
bitshares.wallet.addPrivateKey("5xxxxxxxxxxxxxxxxxxxx")
.. note:: The private key has to be either in hexadecimal or in wallet
import format (wif) (starting with a ``5``).
API
---
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment