Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/talaia-labs/rust-teos

The Eye of Satoshi - Lightning Watchtower
https://github.com/talaia-labs/rust-teos

bitcoin lightning-network rust-lang watchtower

Last synced: 9 days ago
JSON representation

The Eye of Satoshi - Lightning Watchtower

Awesome Lists containing this project

README 

        
# The Eye of Satoshi (rust-teos)



The Eye of Satoshi is a Lightning watchtower compliant with [BOLT13](https://github.com/sr-gi/bolt13), written in Rust.



[![discord](https://img.shields.io/discord/991334710611550208?logo=discord&style=plastic)](https://discord.gg/EyVbrNMDUP)

[![build](https://img.shields.io/github/actions/workflow/status/talaia-labs/rust-teos/build.yaml?logo=github&style=plastic)](https://github.com/talaia-labs/rust-teos/actions/workflows/build.yaml)

[![release](https://img.shields.io/github/v/release/talaia-labs/rust-teos?style=plastic)](https://github.com/talaia-labs/rust-teos/releases/latest)



`rust-teos` consists of two main crates:



- `teos`: including the tower's main functionality (server-side) and a CLI. Compiling this crate will generate two binaries: `teosd` and `teos-cli`.

- `teos-common`: including shared functionality between server and client-side (useful to build a client).



## Dependencies



Refer to [DEPENDENCIES.md](DEPENDENCIES.md)



## Installation

Refer to [INSTALL.md](INSTALL.md)



## Running TEOS



Make sure `bitcoind` is running before running `teosd` (it will fail at startup if it cannot connect to `bitcoind`). [Here](DEPENDENCIES.md#installing-bitcoind) you can find a sample bitcoin.conf.



Please see [Docker instructions](docker/README.md) for instructions on how to set up `teosd` in Docker.



### Starting the tower daemon ♖



Once installed, you can start the tower by running:



```

teosd

```



### Configuration file and command line parameters



`teosd` comes with a default configuration that can be found at [teos/src/config.rs](teos/src/config.rs). 



The configuration includes, amongst others, where your data folder is placed, what network it connects to, etc.



To change the configuration defaults you can:



- Define a configuration file named `teos.toml` following the template (check [conf_template.toml](teos/src/conf_template.toml)) and place it in the `data_dir` (that defaults to `~/.teos/`).



and/or 



- 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 specified when running `teosd`. We can, for instance, change the tower data directory as follows:



```

teosd --datadir=

```



### Running `teosd` in another network



By default, `teosd` runs on `mainnet`. In order to run it on another network, you need to change the network parameter in the configuration file or pass the network parameter as a command-line option. Notice that if `teosd` does not find a `bitcoind` node running in the same network that it is set to run, it will refuse to run.



The configuration file option to change the network where `teosd` will run is `btc_network`:



```

btc_network = mainnet

```



For regtest, it should look like:



```

btc_network = regtest

```



### Running `teosd` with Tor



This requires a Tor daemon running on the same machine as `teosd` and a control port open on that daemon.



Download Tor from the [torproject site](https://www.torproject.org/download/).



To open Tor's control port, you add the following to the Tor config file ([source](https://2019.www.torproject.org/docs/faq.html.en#torrc)):



```

## The port on which Tor will listen for local connections from Tor

## controller applications, as documented in control-spec.txt.

ControlPort 9051



## If you enable the controlport, be sure to enable one of these

## authentication methods, to prevent attackers from accessing it.

CookieAuthentication 1

CookieAuthFileGroupReadable 1

```



Once the Tor daemon is running, and the control port is open, make sure to enable `--torsupport` when running `teosd`.



### Tower id and signing key



`teosd` needs a pair of keys that will serve as tower id and signing key. The former can be used by users to identify the tower, whereas the latter is used by the tower to sign responses. These keys are automatically generated on the first run and can be refreshed by running `teosd` with the `--overwritekey` flag. Notice that once a key is overwritten you won't be able to use the previous key again*.



\* Old keys are actually kept in the tower's database as a fail-safe in case you overwrite them by mistake. However, there is no automated way of switching back to an old key. Feel free to open an issue if you overwrote your key by mistake and need support to recover it.



## Interacting with a TEOS instance



You can interact with a `teosd` instance (either run by yourself or someone else) by using `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 `teosd`, 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

```



### Running teos-cli remotely



To run `teos-cli` remotely, you'll need to take one extra step. When `teosd` is started up, self-signed certificates are automatically generated for a user to make a secure connection to the remote TEOS watchtower. When the CLI is run locally, it knows where to find these files. But if run remotely, these files need to be copied over to the machine where the CLI is being run.



The files are generated to the data directory (by default stored at `~/.teos/`). To run remotely, users need to copy the `client.pem`, `client-key.pem`, and `ca.pem` files to the corresponding watchtower data directory on the machine where the CLI is being run. That is, by default, to `~/.teos/` on the remote machine.



## Interacting with TEOS as a client

### TEOS clients



Here is a list of the available clients for `teos`:



- [watchtower-client for CLN](watchtower-plugin/)



## Contributing 

Refer to [CONTRIBUTING.md](CONTRIBUTING.md)