Configuration

The hive-nectar library comes with its own local configuration database that stores information like

  • API node URLs

  • default account name

  • the encrypted master password

  • the default voting weight

  • if keyring should be used for unlocking the wallet

and potentially more.

You can access those variables like a regular dictionary by using

from nectar import Hive
hv = Hive()
print(hv.config.items())

Keys can be added and changed like they are for regular dictionaries.

If you don’t want to load the nectar.hive.Hive class, you can load the configuration directly by using:

from nectar.storage import configStorage as config

It is also possible to access the configuration with the commandline tool hive-nectar:

hive-nectar config

API node URLs

The default node URLs which will be used when node is None in nectar.hive.Hive class is stored in config[“nodes”] as string. The list can be get and set by:

from nectar import Hive
hv = Hive()
node_list = hv.get_default_nodes()
node_list = node_list[1:] + [node_list[0]]
hv.set_default_nodes(node_list)

hive-nectar can also be used to set nodes:

hive-nectar set nodes https://api.hive.blog

The default nodes can be reset to the default value. When the first node does not answer, hive should be set to the offline mode. This can be done by:

hive-nectar -o set nodes ""

or

from nectar import Hive
hv = Hive(offline=True)
hv.set_default_nodes("")

Default account

The default account name is used in some functions, when no account name is given. It is also used in hive-nectar for all account related functions.

from nectar import Hive
hv = Hive()
hv.set_default_account("test")
hv.config["default_account"] = "test"

or by hive-nectar with

hive-nectar set default_account test

Default voting weight

The default vote weight is used for voting, when no vote weight is given.

from nectar import Hive
hv = Hive()
hv.config["default_vote_weight"] = 100

or by hive-nectar with

hive-nectar set default_vote_weight 100

Setting password_storage

The password_storage can be set to:

  • environment, this is the default setting. The master password for the wallet can be provided in the environment variable UNLOCK.

  • keyring (when set with hive-nectar, it asks for the wallet password)

hive-nectar set password_storage environment
hive-nectar set password_storage keyring

Environment variable for storing the master password

When password_storage is set to environment, the master password can be stored in UNLOCK for unlocking automatically the wallet.

Keyring support for hive-nectar and wallet

In order to use keyring for storing the wallet password, the following steps are necessary:

  • Install keyring: pip install keyring

  • Change password_storage to keyring with hive-nectar and enter the wallet password.

It also possible to change the password in the keyring by

python -m keyring set nectar wallet

The stored master password can be displayed in the terminal by

python -m keyring get nectar wallet

When keyring is set as password_storage and the stored password in the keyring is identically to the set master password of the wallet, the wallet is automatically unlocked everytime it is used.

Testing if unlocking works

Testing if the master password is correctly provided by keyring or the UNLOCK variable:

from nectar import Hive
hv = Hive()
print(hv.wallet.locked())

When the output is False, automatic unlocking with keyring or the UNLOCK variable works. It can also tested by hive-nectar with

hive-nectar walletinfo --test-unlock

When no password prompt is shown, unlocking with keyring or the UNLOCK variable works.