Merge pull request #239 from talaia-labs/fixes-0.1.1

Fixes for release v0.1.1

Author: sr-gi

CONTRIBUTING.md

@@ -104,3 +104,10 @@ We use [pytest](https://docs.pytest.org/en/latest/) to build and run tests. Test
 
 We require that all commits to be merge into master are signed. You can enable commit signing on GitHub by following [Signing commits](https://help.github.com/en/github/authenticating-to-github/signing-commits).
 
+## Installing the development client
+
+You can install the development client for easier testing by setting the development flag (DEV=1) when installing `teos`.
+
+```
+DEV=1 python setup.py install
+```

DEPENDENCIES.md

@@ -6,7 +6,7 @@
 
 `teos` has the following system-wide dependencies:
 
-- `python3` version 3.6+
+- `python3` version 3.7+
 - `pip3`
 - `openssl` version 1.1+
 - `bitcoind`
@@ -58,7 +58,7 @@ 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).
 
-Bitcoin needs to be running with the following options enables:
+Bitcoin needs to be running with the following options enabled:
 
 - `zmq` for rawblockhash notifications
 - `txindex` to be able to look for non-wallet transactions
@@ -90,7 +90,7 @@ maxtxfee=1
 
 ### 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` can 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.
 
 #### Ubuntu
 
@@ -112,17 +112,10 @@ and for `pip3`:
 
 `pip3` will be installed alongside `python3` in this case.
 
-## Python Dependencies
+## Python Dependencies	
 
-`teos` has the following dependencies (which can be satisfied by using `pip install -r requirements.txt`):
-
-- `wheel`
-- `zmq`
-- `flask`
-- `cryptography`
-- `coincurve`
-- `pyzbase32`
-- `requests`
-- `plyvel`
-- `readerwriterlock`
+ `teos` has several python dependencies that are automatically alongside the it. Should you need to install them manually, you can do so by running:
 
+```
+ pip install -r requirements.txt`
+```

INSTALL.md

@@ -2,32 +2,26 @@
 
 `teos` has some dependencies that can be satisfied by following [DEPENDENCIES.md](DEPENDENCIES.md). If your system already satisfies the dependencies, you can skip that part.
 
-There are two ways of running `teos`: running it as a module or adding the library to the `PYTHONPATH` env variable.
+There are two ways of installing `teos`, from source or getting it from PyPi (the Python Package Index).
 
-## Running `teos` as a Module
-The **easiest** way to run `teos` is as a module. To do so you need to use `python -m`. From the teos parent directory run:
+No matter the way you chose, once installed the executables for `teosd` and `teos-cli` will be available in the shell.
 
-    python -m teos.teosd -h
-    
-Notice that if you run `teos` as a module, you'll need to replace all the calls from `python teosd.py` to `python -m teos.teosd` 
+## Installing from source
 
-## Modifying `PYTHONPATH`
-**Alternatively**, you can add `teos` to your `PYTHONPATH` by running:
+`teos` can be installed from source by running:
 
-	export PYTHONPATH=$PYTHONPATH:<absolute_path_to_teos_parent>
-	
-For example, for user alice running a UNIX system and having `python-teos` in her home folder, she would run:
-	
-	export PYTHONPATH=$PYTHONPATH:/home/alice/python-teos/
-	
-You should also include the command in your `.bashrc` to avoid having to run it every time you open a new terminal. You can do it by running:
+```
+python setup.py install
+```
 
-	echo 'export PYTHONPATH=$PYTHONPATH:<absolute_path_to_teos_parent>' >> ~/.bashrc
-	
-Once the `PYTHONPATH` is set, you should be able to run `teos` straightaway. Try it by running:
+## Installing via PyPi
+
+`teos` can be installed from PyPi bu running:
+
+```
+pip install teos
+```
 
-	cd <absolute_path_to_cli_parent>/teos
-	python teosd.py -h
 
 ## Modify Configuration Parameters
 If you'd like to modify some of the configuration defaults (such as the bitcoind rpcuser and password) you can do so in the config file located at:

README.md

@@ -6,16 +6,19 @@ Currently working on updating the software to match [BOLT13 rev1](https://github
 
 The Eye of Satoshi is a Lightning watchtower compliant with [BOLT13](https://github.com/sr-gi/bolt13), written in Python 3.
 
-`teos` consists in four main modules:
+`python-teos` consists in four main modules:
 
-- `teos`: including the tower's main functionality (server-side)
-- `cli`: including a reference command line interface (client-side)
-- `common`: including shared functionality between `teos` and `cli`.
+- `teos`: including the tower's main functionality (server-side).
+- `cli`: including a reference command line interface.
+- `common`: including shared functionality between server and client side (useful to build a client).
 - `watchtower-plugin`: including a watchtower client plugin for c-lightning.
 
-Additionally, tests for every module can be found at `tests`.
+Additionally `contrib` contains tools that are external to the tower (currently `teos_client`, an example Python client for the tower). 
+
+Tests for every module can be found at `tests`.
 
 ## Dependencies
+
 Refer to [DEPENDENCIES.md](DEPENDENCIES.md)
 
 ## Installation
@@ -27,14 +30,12 @@ Refer to [INSTALL.md](INSTALL.md)
 Make sure bitcoind is running before running TEOS (it will fail at startup if it cannot connect to bitcoind). You can find
 [here](DEPENDENCIES.md#installing-bitcoind) a sample config file.
 
-Before you can run TEOS, you need to follow a few more configuration steps.
-
 ### Starting the TEOS daemon 👁
 
-You can run `teos` by running `teosd.py` under `teos`:
+Once installed, you can start the tower by running:
 
 ```
-python -m teos.teosd
+teosd
 ```
 
 ### Configuration file and command line parameters
@@ -49,14 +50,14 @@ To change the configuration defaults you can:
 
 and / or 
 
-- Add some global options when running the daemon (run `teosd.py -h` for more info).
+- Add some global options when running the daemon (run `teosd -h` for more info).
 
 ### Passing command line options to `teosd`
 
 Some configuration options can also be passed as options when running `teosd`. We can, for instance, pick the network as follows:
 
 ```
-python -m teos.teosd --btcnetwork=regtest
+teosd --btcnetwork=regtest
 ```
 
 ### Running TEOS in another network
@@ -84,7 +85,7 @@ btc_network = regtest
 ```
 
 ## Running `teos` in a docker container
-A `teos` image can be built from the Dockerfile located in `/docker`. You can create the image by running:
+A `teos` image can be built from the Dockerfile located in `docker`. You can create the image by running:
 
 	cd python-teos
 	docker build -f docker/Dockerfile -t teos .
@@ -98,6 +99,8 @@ Notice that ENV variables are optional, if unset the corresponding default setti
 ```
 - API_BIND=<teos_api_hostname>
 - API_PORT=<teos_api_port>
+- RPC_BIND=<teos_rpc_hostname>
+- RPC_PORT=<teos_rpc_port>
 - BTC_NETWORK=<btc_network>
 - BTC_RPC_CONNECT=<btc_node_hostname>
 - BTC_RPC_PORT=<btc_node_port>
@@ -161,17 +164,23 @@ Otherwise it will bind to `localost` and we won't be able to send requests to th
 
 ## Interacting with a TEOS Instance
 
-You can interact with a `teos` instance (either run by yourself or someone else) by using `teos_cli` under `cli`.
+You can interact with a `teos` instance (either run by yourself or someone else) by using `teos-cli` under `teos/cli`. This is an admin tool that has privileged access to the watchtower, and it should therefore only be used within a trusted environment (for example, the same machine).
+
+While `teos-cli` works independently of `teos`, it shares the same configuration file by default, of which it only uses a subset of its settings. The folder can be changed using the `--datadir` command line argument, if desired.
+
+For help on the available arguments and commands, you can run:
+
+```
+teos-cli -h
+```
 
-Since `teos_cli` works independently of `teos`, it uses a different configuration. The defaults can be found at [cli/\_\_init\_\_.py](cli/__init__.py). The same approach as with `teosd` is followed:
+## Interacting with TEOS as a client
 
-- A config file (`~/.teos_cli/teos_cli.conf`) can be set to change the defaults.
-- Some options ca also be changed via command line. 
-- The configuration file template can be found at [cli/template.conf](cli/template.conf))
+The [contrib/client](contrib/client) folder contains an example Python client that can interact with the watchtower in order to register, add appointments and later retrieve them.
 
-`teos_cli` needs an independent set of keys that are also automatically generated in the same way as `teos`.
+See [here](contrib/client) for more information on how to use the client.
 
-Notice that `teos_cli` is a simple way to interact with `teos`, but ideally that should be part of your wallet functionality (therefore why they are independent entities). `teos_cli` can be used as an example for how to send data to a [BOLT13](https://github.com/sr-gi/bolt13) compliant watchtower.
+Note that while the client is a simple way to interact with `teos`, ideally its functionality should be part of your wallet or lightning node. `teos_client` can be used as an example for how to send data to a [BOLT13](https://github.com/sr-gi/bolt13) compliant watchtower.
 
 ## Contributing 
 Refer to [CONTRIBUTING.md](CONTRIBUTING.md)

common/__init__.py

@@ -0,0 +1,2 @@
+version_info = (0, 1, 1)
+__version__ = ".".join([str(v) for v in version_info])

common/constants.py

@@ -1,5 +1,3 @@
-import logging.handlers
-
 # Locator
 LOCATOR_LEN_HEX = 32
 LOCATOR_LEN_BYTES = LOCATOR_LEN_HEX // 2
@@ -20,6 +18,3 @@
 
 # Temporary constants, may be changed
 ENCRYPTED_BLOB_MAX_SIZE_HEX = 2 * 2048
-
-# The port used for the tcp logging service is 9020
-TCP_LOGGING_PORT = logging.handlers.DEFAULT_TCP_LOGGING_PORT

common/errors.py

@@ -6,7 +6,7 @@
 APPOINTMENT_FIELD_TOO_SMALL = -5
 APPOINTMENT_FIELD_TOO_BIG = -6
 APPOINTMENT_WRONG_FIELD = -7
-APPOINTMENT_INVALID_SIGNATURE_OR_INSUFFICIENT_SLOTS = -8
+APPOINTMENT_INVALID_SIGNATURE_OR_SUBSCRIPTION_ERROR = -8
 APPOINTMENT_ALREADY_TRIGGERED = -9
 
 # Registration errors [-33, -64]

common/requirements.txt

@@ -1,4 +1,4 @@
-cryptography==2.8
+cryptography>=2.8
 coincurve
 pyzbase32
 plyvel

contrib/client/DEPENDENCIES.md

@@ -1,12 +1,12 @@
 # Dependencies
 
-`teos_client` has both system-wide and Python dependencies. This document walks you through how to satisfy them.
+`teos-client` has both system-wide and Python dependencies. This document walks you through how to satisfy them.
 
 ## System-wide dependencies
 
-`teos_client` has the following system-wide dependencies:
+`teos-client` has the following system-wide dependencies:
 
-- `python3` version 3.6+
+- `python3` version 3.7+
 - `pip3`
 - `openssl` version 1.1+
 
@@ -28,7 +28,7 @@ It is also likely that, if `python3` is installed in our system, the `python` al
 
 	python3 --version
 
-If `python3` is installed but the `python` alias is not set to it, we should either set it, or use `python3` to run `teos_client`.
+If `python3` is installed but the `python` alias is not set to it, we should either set it, or use `python3` to run `teos-client`.
 
 Regarding `pip`, we can check what version is installed in our system (if any) by running:
 
@@ -51,7 +51,7 @@ And, if it happens to be installed, change the alias to `pip3`, or use `pip3` in
 
 ### 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` can 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.
 
 #### Ubuntu
 
@@ -73,10 +73,10 @@ and for `pip3`:
 
 `pip3` will be installed alongside `python3` in this case.
 
-## Python dependencies
+## Python Dependencies	
 
-`teos_client` has the following dependencies (which can be satisfied by using `pip install -r requirements.txt`):
+ `teos-client` has several python dependencies that are automatically alongside the it. Should you need to install them manually, you can do so by running:
 
-- `cryptography`
-- `requests`
-- `structlog`
+```
+ pip install -r requirements.txt`
+```

contrib/client/INSTALL.md

@@ -1,38 +1,13 @@
 # Install 
 
-`teos_client` has some dependencies that can be satisfied by following [DEPENDENCIES.md](DEPENDENCIES.md). If your system already satisfies the dependencies, you can skip that part.
+`teos-client` gets installed alongside `teos` as long as you set the development flag when installing `teos`:
 
-There are two ways of running `teos_client`:  running it as a module or adding the library to the PYTHONPATH env variable.
+```
+DEV=1 python setup.py install
+```
 
-## Running `teos_client` as a module
-The **easiest** way to run `teos_client` is as a module. To do so you need to use `python -m`. From the root directory of `python-teos`, run:
+You can also get a standalone client from pip:
 
-    python -m contrib.client.teos_client -h
-    
-Notice that if you run `teos_client` as a module, you'll need to replace all the calls from `python teos_client.py <argument>` to `python -m contrib.client.teos_client <argument>` 
-
-## Modifying `PYTHONPATH`
-**Alternatively**, you can add `teos_client` to your `PYTHONPATH` by running:
-
-	export PYTHONPATH=$PYTHONPATH:<absolute_path_to_python-teos_root>
-	
-For example, for user alice running a UNIX system and having `python-teos` in her home folder, she would run:
-	
-	export PYTHONPATH=$PYTHONPATH:/home/alice/python-teos/
-	
-You should also include the command in your `.bashrc` to avoid having to run it every time you open a new terminal. You can do it by running:
-
-	echo 'export PYTHONPATH=$PYTHONPATH:<absolute_path_to_python-teos_root>' >> ~/.bashrc
-	
-Once the `PYTHONPATH` is set, you should be able to run `teos_client` straightaway. Try it by running:
-
-	cd <absolute_path_to_python-teos_root>/contrib/client
-	python teos_client.py -h
-	
-
-## Modify configuration parameters
-If you'd like to modify some of the configuration defaults (such as the user directory, where the logs and appointment receipts will be stored) you can do so in the config file located at:
-
-	 <data_dir>/.teos_client/teos_client.conf
-	 
-`<data_dir>` defaults to your home directory (`~`).
+```
+pip install teos-client
+```