aljaz/python-teos
1
0
Fork 0
mirror of https://github.com/aljazceru/python-teos.git synced 2026-02-04 06:04:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update missing readmes and circleci

Browse Source 
- Some apps intances were not removed
- requeriment paths were wrong in circleci and some apps path needed to be removed
This commit is contained in:
Sergi Delgado Segura
2020-03-18 12:17:31 +01:00
parent 90ec15923e
commit 6d6fa9f728
5 changed files with 33 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -1,3 +1,7 @@
## State of the code
Currently working on updating the software to match [BOLT13 rev1](https://github.com/sr-gi/bolt13).
# The Eye of Satoshi (TEOS)
The Eye of Satoshi is a Lightning watchtower compliant with [BOLT13](https://github.com/sr-gi/bolt13), written in Python 3.
@@ -10,7 +14,6 @@ TEOS consists in three main modules:
Additionally, tests for every module can be found at `tests`.
### 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.
@@ -19,7 +22,9 @@ You can use `generate_keys.py` to generate those keys.
### 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`.
Since `teos_cli` works independently of `teos`, you will need a separate configuration file for this (follow [cli/INSTALL.md](cli/INSTALL.md)) and a different set of keys. You can use `generate_keys.py` to generate those keys.
Since `teos_cli` works independently of `teos`, you will need a separate configuration file for this (follow [cli/INSTALL.md](cli/INSTALL.md)).
`teos_cli` will also need an independent set of keys (that can be generated using `generate_keys.py`) as well as the public key of the tower instance (`teos_pk.der`). The same data directory can be used for both if you are running things locally.
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.