Adds some notes on running bitcoind and how to change networks

This commit is contained in:
Sergi Delgado Segura
2020-03-18 18:26:37 +01:00
parent 6f8af947ae
commit 6e06c87cf5
2 changed files with 38 additions and 0 deletions

View File

@@ -54,6 +54,36 @@ And, if it happens to be installed, change the alias to `pip3`, or use `pip3` in
You can get Bitcoin Core from [bitcoin.org](https://bitcoin.org/en/download). You can get Bitcoin Core from [bitcoin.org](https://bitcoin.org/en/download).
Bitcoin needs to be running with the following options enables:
- `zmq` for rawblockhash notifications
- `txindex` to be able to look for non-wallet transactions
- `server` to run rpc commands
Here's an example of a `bitcoin.conf` you can use:
```
# [debug]
regtest=1
daemon=1
debug=1
logips=1
# [rpc]
server=1
rpcuser=user
rpcpassword=passwd
# [blockchain]
txindex=1
# [ZMQ]
zmqpubhashblock=tcp://127.0.0.1:28332
zmqpubrawblock=tcp://127.0.0.1:28332
zmqpubhashtx=tcp://127.0.0.1:28333
zmqpubrawtx=tcp://127.0.0.1:28333
```
### Installing the dependencies ### Installing the dependencies
`python3` ca be downloaded from the [Python official website](https://www.python.org/downloads/) or installed using a package manager, depending on your distribution. Examples for both UNIX-like and OSX systems are provided. `python3` ca be downloaded from the [Python official website](https://www.python.org/downloads/) or installed using a package manager, depending on your distribution. Examples for both UNIX-like and OSX systems are provided.

View File

@@ -14,6 +14,14 @@ TEOS consists in three main modules:
Additionally, tests for every module can be found at `tests`. Additionally, tests for every module can be found at `tests`.
By default, `teos` will run on `regtest`. In order to run it on another network you need to change your `bitcoin.conf` (to run in the proper network) and your `conf.py` to match the network name and rpc port:
```
BTC_RPC_PORT = 18443
BTC_NETWORK = "regtest"
```
### Running TEOS ### Running TEOS
In order to run `teos` you will need to create a configuration file (follow [INSTALL.md](INSTALL.md)) and run `teosd.py`. Currently you will also need a set of keys (to sign appointments) stored in your data directory. In order to run `teos` you will need to create a configuration file (follow [INSTALL.md](INSTALL.md)) and run `teosd.py`. Currently you will also need a set of keys (to sign appointments) stored in your data directory.