diff --git a/README.md b/README.md index fb86aa96..ac91c75c 100644 --- a/README.md +++ b/README.md @@ -7,25 +7,25 @@ Node for Squeak protocol #### Requirements * a bitcoin node * an LND node -* Python 3.7 or later +* Python 3.6 or later -If you don't already have a bitcoin node or lightning node, you can [follow the instructions](docs/DOCKER.md) follow the instructions here to launch them in Docker. +If you don't already have a bitcoin node or lightning node, you can follow the instructions [here](docs/DOCKER.md) to launch them in Docker. #### Steps -- Create a **config.ini** file and fill in the relevant sections to connect to your bitcoin and lnd nodes: +- Update the **config.ini** file and fill in the relevant sections to connect to your bitcoin and lnd nodes: ``` - [squeaknode] + [core] network=testnet [lnd] host=localhost - rpc_port=10009 + external_host=lnd_server tls_cert_path=~/.lnd/tls.cert macaroon_path=~/.lnd/data/chain/bitcoin/testnet/admin.macaroon [bitcoin] rpc_host=localhost - rpc_port=18334 + rpc_port=18332 rpc_user=devuser rpc_pass=devpass @@ -40,6 +40,7 @@ If you don't already have a bitcoin node or lightning node, you can [follow the ``` or ``` + $ pip install -r requirements.txt $ python setup.py install ``` @@ -51,13 +52,20 @@ If you don't already have a bitcoin node or lightning node, you can [follow the ## Test -### Run unit tests: +### Unit tests: + +#### Requirements +* tox ``` $ make test ``` -### Run integration tests: +### Integration tests: + +#### Requirements +* docker-compose +* jq ``` $ make itest diff --git a/config.ini b/config.ini index 87972041..72023fae 100644 --- a/config.ini +++ b/config.ini @@ -1,5 +1,5 @@ [core] -network=simnet +network=testnet [lnd] host=localhost diff --git a/docs/DOCKER.md b/docs/DOCKER.md index 2a446f12..a56e0c3b 100644 --- a/docs/DOCKER.md +++ b/docs/DOCKER.md @@ -18,3 +18,7 @@ If you don't already have your own bitcoin node and lightning node, you can use ``` $ docker-compose -f docker-compose.yml -f docker-compose.mainnet.yml up ``` +- You may need to change the permissions of the `~/.lnd` directory on your host after docker containers start. + ``` + $ sudo chmod -R 755 ~/.lnd/ + ```