Add links to bcoin in documentation

1200wd · Apr 4, 2024 · daea13a · daea13a
1 parent 2792f0f
commit daea13a
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 14 deletions.
diff --git a/bitcoinlib/wallets.py b/bitcoinlib/wallets.py
@@ -58,8 +58,7 @@ def wallets_list(db_uri=None, include_cosigners=False, db_password=None):
     :type db_uri: str
     :param include_cosigners: Child wallets for multisig wallets are for internal use only and are skipped by default
     :type include_cosigners: bool
-    :param db_password: Password to use for encrypted database. Requires the installation of sqlcipher (see
-    documentation).
+    :param db_password: Password to use for encrypted database. Requires the installation of sqlcipher (see documentation).
     :type db_password: str
 
     :return dict: Dictionary of wallets defined in database

diff --git a/docs/_static/manuals.databases.rst b/docs/_static/manuals.databases.rst
@@ -62,6 +62,6 @@ And assume you unwisely have chosen the password 'secret' you can use the databa
 Encrypt database
 ----------------
 
-If you are using wallets with private keys it is advised to use an encrypted database.
+If you are using wallets with private keys it is advised to encrypt your database and / or private keys.
 
 Please read `Using Encrypted Databases <manuals.sqlcipher.html>`_ for more information.
diff --git a/docs/_static/manuals.install.rst b/docs/_static/manuals.install.rst
@@ -169,15 +169,19 @@ location for a config file in the BCL_CONFIG_FILE:
     os.environ['BCL_CONFIG_FILE'] = '/var/www/blocksmurfer/bitcoinlib.ini'
 
 
-Tweak BitcoinLib
-----------------
+Service providers and local nodes
+---------------------------------
 
 You can `Add another service Provider <manuals.add-provider.html>`_ to this library by updating settings
 and write a new service provider class.
 
-If you use this library in a production environment it is advised to run your own Bcoin, Bitcoin, Litecoin or Dash node,
-both for privacy and reliability reasons. More setup information:
-`Setup connection to bitcoin node <manuals.setup-bitcoind-connection.html>`_
+To increase reliability, speed and privacy or if you use this library in a production environment it
+is advised to run your own Bcoin or Bitcoin node.
+
+More setup information:
+
+* `Setup connection to Bcoin node <manuals.setup-bcoin.html>`_
+* `Setup connection to Bitcoin node <manuals.setup-bitcoind-connection.html>`_
 
 Some service providers require an API key to function or allow additional requests.
 You can add this key to the provider settings file in .bitcoinlib/providers.json
diff --git a/docs/_static/manuals.security.rst b/docs/_static/manuals.security.rst
@@ -4,7 +4,7 @@
 Ten tips for more privacy and security when using Bitcoin and Bitcoinlib:
 
 1. Run your own `Bitcoin <https://bitcoinlib.readthedocs.io/en/latest/source/_static/manuals.setup-bitcoind-connection.html>`_
-   or Bcoin node, so you are not depending on external Blockchain API service providers anymore.
+   or `Bcoin <manuals.setup-bcoin.html>`_ node, so you are not depending on external Blockchain API service providers anymore.
    This not only increases your privacy, but also makes your application much faster and more reliable. And as extra bonus
    you support the Bitcoin network.
 2. Use multi-signature wallets. So you are able to store your private keys in separate (offline) locations.

diff --git a/docs/_static/manuals.setup-bcoin.rst b/docs/_static/manuals.setup-bcoin.rst
@@ -23,7 +23,7 @@ bitcoinlib. You can install them with the following command.
 Use Bcoin node with Bitcoinlib
 ------------------------------
 
-To use Bcoin with bitcoinlib add the credentials to the providers.json configuration file in the .bitcoilib directory.
+To use Bcoin with bitcoinlib add the credentials to the providers.json configuration file in the .bitcoinlib directory.
 
 .. code-block:: text
 
@@ -34,7 +34,7 @@ To use Bcoin with bitcoinlib add the credentials to the providers.json configura
         "provider_coin_id": "",
         "url": "https://user:pass@localhost:8332/",
         "api_key": "",
-        "priority": 10,
+        "priority": 20,
         "denominator": 100000000,
         "network_overrides": null
     },

diff --git a/docs/_static/manuals.setup-bitcoind-connection.rst b/docs/_static/manuals.setup-bitcoind-connection.rst
@@ -7,9 +7,10 @@ Running your own bitcoin node allows you to create a large number of requests, f
 and more control, privacy and independence. However you need to install and maintain it and it used
 a lot of resources.
 
- Please note: With a standard Bitcoin node you can only retrieve block and transaction information. You can not
- query the node for information about specific addresses. So it not suitable to run in combination with a Bitcoinlib
- wallet. If you would like to use Bitcoinlib wallet you should use a `Bcoin <manuals.setup-bcoin.html>`_ node instead.
+.. warning::
+    With a standard Bitcoin node you can only retrieve block and transaction information. You can not
+    query the node for information about specific addresses. So it not suitable to run in combination with a Bitcoinlib
+    wallet. If you would like to use Bitcoinlib wallets and not be dependent on external providers you should use a `Bcoin <manuals.setup-bcoin.html>`_ node instead.
 
 
 Bitcoin node settings