2022 02 12 cleanup example config (#4082)

* Make example configuration better so that the node starts up if you just copy and paste the example configuration into your bitcoin-s.conf file

* More clarificatoin

docs/config/configuration.md

@@ -98,33 +98,15 @@ to ensure the entire module is initialized correctly.
 
 ```$xslt
 bitcoin-s {
-    datadir = ${HOME}/.bitcoin-s
+    # the network your bitcoin-s node is running on
-    network = regtest # regtest, testnet3, mainnet, signet
+    network = "testnet3" # regtest, testnet3, mainnet, signet
-    dbDefault = {
+
-      dataSourceClass = slick.jdbc.DatabaseUrlDataSource
+    # specify what backend you are using with bitcoin-s
-      profile = "slick.jdbc.SQLiteProfile$"
+    # by default we do neutrino, but you can also connect
-  
+    # bitcoind with the configuration settings in bitcoin-s.bitcoind-rpc
-      db {
+    node.mode = neutrino # neutrino, bitcoind
-        # for information on parameters available here see
-        # https://scala-slick.org/doc/3.3.1/api/index.html#slick.jdbc.JdbcBackend$DatabaseFactoryDef@forConfig(String,Config,Driver,ClassLoader):Database
-        path = ${bitcoin-s.datadir}/${bitcoin-s.network}/
-        driver = org.sqlite.JDBC
-        user = ""
-        password = ""
-        host = localhost
-        port = 5432
-  
-        # this needs to be set to 1 for SQLITE as it does not support concurrent database operations
-        # see: https://github.com/bitcoin-s/bitcoin-s/pull/1840
-        numThreads = 1
-        queueSize=5000
-        connectionPool = "HikariCP"
-        registerMbeans = true
-      }
-      hikari-logging = false
-      hikari-logging-interval = 10 minute
-    }
     
+    # configurations for connecting to bitcoind
     bitcoind-rpc {
         # bitcoind rpc username
         rpcuser = user
@@ -160,14 +142,16 @@ bitcoin-s {
         #If you have a bitcoind instance that is running remotely on another machine, you should set it to true
         isRemote = false
     }
-
+    
+    # settings if you are using a neutrino node in bitcoin-s
     node {
-        mode = neutrino # neutrino, spv, bitcoind
 
-        peers = [] # a list of peer addresses in form "hostname:portnumber"
+        # a list of peer addresses in form "hostname:portnumber"
-        # (e.g. "neutrino.testnet3.suredbits.com:18333")
         # Port number is optional, the default value is 8333 for mainnet,
         # 18333 for testnet and 18444 for regtest.
+        # by default we provide a testnet peer to connect to
+        peers = ["neutrino.testnet3.suredbits.com:18333"] 
+
         
         hikari-logging = true
         hikari-logging-interval = 10 minute
@@ -182,6 +166,7 @@ bitcoin-s {
         socks5 = "127.0.0.1:9050"
     }
 
+    # tor settings
     tor {
         # You can enable Tor for incoming connections
         enabled = false
@@ -207,6 +192,7 @@ bitcoin-s {
         # privateKeyPath = /path/to/priv/key
     }
     
+    # settings for the chain module
     chain {
         force-recalc-chainwork = false
         neutrino {
@@ -268,12 +254,12 @@ bitcoin-s {
         # bip39password = "changeMe"
 
         # Password that your seed is encrypted with
-        aesPassword = changeMe
+        # aesPassword = changeMe
         
         # At least 16 bytes of entropy encoded in hex
         # This will be used as the seed for any
         # project that is dependent on the keymanager
-        entropy = ""
+        # entropy = ""
     }
 
     # Bitcoin-S provides manny different fee providers
@@ -303,7 +289,7 @@ bitcoin-s {
         # The address we are listening on for incoming connections for DLCs
         # Binding to 0.0.0.0 makes us listen to all incoming connections
         # Consider using 127.0.0.1 listen address if Tor is enabled.
-        listen = "0.0.0.0:2862"
+        # listen = "0.0.0.0:2862"
         
         # The address our peers use to connect to our node. 
         # By default it's the same as the listen address, 
@@ -348,6 +334,31 @@ bitcoin-s {
         }
     }
     
+    dbDefault = {
+      dataSourceClass = slick.jdbc.DatabaseUrlDataSource
+      profile = "slick.jdbc.SQLiteProfile$"
+  
+      db {
+        # for information on parameters available here see
+        # https://scala-slick.org/doc/3.3.1/api/index.html#slick.jdbc.JdbcBackend$DatabaseFactoryDef@forConfig(String,Config,Driver,ClassLoader):Database
+        path = ${bitcoin-s.datadir}/${bitcoin-s.network}/
+        driver = org.sqlite.JDBC
+        user = ""
+        password = ""
+        host = localhost
+        port = 5432
+  
+        # this needs to be set to 1 for SQLITE as it does not support concurrent database operations
+        # see: https://github.com/bitcoin-s/bitcoin-s/pull/1840
+        numThreads = 1
+        queueSize=5000
+        connectionPool = "HikariCP"
+        registerMbeans = true
+      }
+      hikari-logging = false
+      hikari-logging-interval = 10 minute
+    }
+    
     testkit {
       pg {
         #enabled postgres backend database for all test cases

docs/getting-setup.md

@@ -89,7 +89,7 @@ Now that we have the bitcoin-s repo setup, we want to create our application con
 
 First, create a `$HOME/.bitcoin-s` directory via `mkdir` or an equivalent command. 
 
-Next, create a `bitcoin-s.conf` file in `$HOME/.bitcoin-s`. [Here is an example configuration file](config/configuration.md#example-configuration-file). The only thing that you will _need_ to change is the `peers` list to which you will want to add `"localhost:18444"` if you want to run in regtest.
+Next, create a `bitcoin-s.conf` file in `$HOME/.bitcoin-s`. [Here is an example configuration file](config/configuration.md#example-configuration-file).
 
 ## Step 4: Building the Server and Setting Up the CLI