You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ We use `rustfmt` as our base code formatter. Before submitting a PR make sure yo
9
9
cargo fmt
10
10
```
11
11
12
-
In addition, we use [clippy](https://github.com/rust-lang/rust-clippy/) to detect catch common mistakes and improve the code:
12
+
In addition, we use [clippy](https://github.com/rust-lang/rust-clippy/) to catch common mistakes and improve the code:
13
13
14
14
```bash
15
15
cargo clippy
@@ -70,8 +70,8 @@ pub struct Responder {
70
70
```
71
71
72
72
## Test Coverage
73
-
Tests should be provided to cover both positive and negative conditions. Test should cover both the proper execution as well as all the covered error paths. PR with no proper test coverage will be rejected.
73
+
Tests should be provided to cover both positive and negative conditions. Tests should cover both the proper execution as well as all the covered error paths. PR with no proper test coverage will not be merged.
74
74
75
75
## Signing Commits
76
76
77
-
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).
77
+
We require that all commits to be merged 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).
Copy file name to clipboardExpand all lines: README.md
+26-28Lines changed: 26 additions & 28 deletions
Original file line number
Diff line number
Diff line change
@@ -4,10 +4,10 @@
4
4
5
5
The Eye of Satoshi is a Lightning watchtower compliant with [BOLT13](https://github.com/sr-gi/bolt13), written in Rust.
6
6
7
-
`rust-teos` consists in two main crates:
7
+
`rust-teos` consists of two main crates:
8
8
9
-
-`teos`: including the tower's main functionality (server-side) and a CLI.
10
-
-`teos-common`: including shared functionality between server and clientside (useful to build a client).
9
+
-`teos`: including the tower's main functionality (server-side) and a CLI. Compiling this crate will generate two binaries: `teosd` and `teos-cli`.
10
+
-`teos-common`: including shared functionality between server and client-side (useful to build a client).
11
11
12
12
## Dependencies
13
13
@@ -18,8 +18,7 @@ Refer to [INSTALL.md](INSTALL.md)
18
18
19
19
## Running TEOS
20
20
21
-
Make sure bitcoind is running before running `rust-teos` (it will fail at startup if it cannot connect to bitcoind). You can find
22
-
[here](DEPENDENCIES.md#installing-bitcoind) a sample config file.
21
+
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.
23
22
24
23
### Starting the tower daemon ♖
25
24
@@ -31,31 +30,31 @@ teosd
31
30
32
31
### Configuration file and command line parameters
33
32
34
-
`rust-teos` comes with a default configuration that can be found at [teos/src/config.rs](teos/src/config.rs).
33
+
`teosd` comes with a default configuration that can be found at [teos/src/config.rs](teos/src/config.rs).
35
34
36
35
The configuration includes, amongst others, where your data folder is placed, what network it connects to, etc.
37
36
38
37
To change the configuration defaults you can:
39
38
40
-
- Define a configuration file named `teos.toml` following the template (check [teos/src/conf_template.toml](teos/src/conf_template.toml)) and place it in the `data_dir` (that defaults to `~/.teos/`)
39
+
- 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/`).
41
40
42
-
and / or
41
+
and/or
43
42
44
43
- Add some global options when running the daemon (run `teosd -h` for more info).
45
44
46
-
### Passing commandline options to `teosd`
45
+
### Passing command-line options to `teosd`
47
46
48
-
Some configuration options can also be passed as options when running `teosd`. We can, for instance, change the tower data directory as follows:
47
+
Some configuration options can also be specified when running `teosd`. We can, for instance, change the tower data directory as follows:
49
48
50
49
```
51
50
teosd --datadir=<path_to_dir>
52
51
```
53
52
54
-
### Running TEOS in another network
53
+
### Running `teosd` in another network
55
54
56
-
By default, `rust-teos` 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 commandline option. Notice that if teos does not find a `bitcoind` node running in the same network that it is set to run, it will refuse to run.
55
+
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.
57
56
58
-
The configuration file option to change the network where `teos` will run is `btc_network`:
57
+
The configuration file option to change the network where `teosd` will run is `btc_network`:
59
58
60
59
```
61
60
btc_network = mainnet
@@ -67,15 +66,14 @@ For regtest, it should look like:
67
66
btc_network = regtest
68
67
```
69
68
70
-
### Running TEOS with tor
69
+
### Running `teosd` with tor
71
70
72
-
This requires a tor deamon running on the same machine as teos and a control port open on that deamon.
71
+
This requires a tor daemon running on the same machine as `teosd` and a control port open on that daemon.
73
72
74
-
Download tor from the torproject site here: [torproject](https://www.torproject.org/download/)
73
+
Download tor from the [torproject site](https://www.torproject.org/download/).
75
74
76
-
To open tor's control port, follow the instructions here on how to update the configuration file [tor conf](https://2019.www.torproject.org/docs/faq.html.en#torrc)
75
+
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)):
77
76
78
-
Add the following lines to the file:
79
77
```
80
78
## The port on which Tor will listen for local connections from Tor
81
79
## controller applications, as documented in control-spec.txt.
@@ -87,19 +85,19 @@ CookieAuthentication 1
87
85
CookieAuthFileGroupReadable 1
88
86
```
89
87
90
-
Once the tor deamon is running, and the control port is open, make sure to change `tor_support` flag to true in teos conf.
88
+
Once the tor daemon is running, and the control port is open, make sure to enable the `tor_support` flag `teosd`.
91
89
92
90
### Tower id and signing key
93
91
94
-
`teos` 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 `teos` with the `--overwritekey` flag. Notice that once a key is overwritten you won't be able to use the previous key again*.
92
+
`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*.
95
93
96
-
\* Old keys are actually kept in the tower's database as a failsafe in case you overwrite them by mistake. However, there is no automated way of switching back to and old key. Feel free to open an issue if you overwrote your key by mistake and need support to recover it.
94
+
\* 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.
97
95
98
-
## Interacting with a TEOS Instance
96
+
## Interacting with a TEOS instance
99
97
100
-
You can interact with a `teos` 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).
98
+
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).
101
99
102
-
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` commandline argument, if desired.
100
+
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.
103
101
104
102
For help on the available arguments and commands, you can run:
105
103
@@ -109,16 +107,16 @@ teos-cli -h
109
107
110
108
### Running teos-cli remotely
111
109
112
-
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 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.
110
+
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.
113
111
114
-
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.
112
+
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.
115
113
116
114
## Interacting with TEOS as a client
117
-
## TEOS clients
115
+
###TEOS clients
118
116
119
117
Here is a list of the available clients for `teos`:
Copy file name to clipboardExpand all lines: watchtower-plugin/README.md
+22-2Lines changed: 22 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -47,14 +47,14 @@ cd ~/.lightning
47
47
mkdir plugins && cd plugins
48
48
```
49
49
50
-
Now you need to place the watchtower-client to this folder. To do so we will create a symbolic link to it. First, check where the binary is placed (this is usually placed in your user's home).
50
+
Now you need to place the watchtower-client into this folder. To do so we will create a symbolic link to it. First, check where the binary is placed (this is usually placed in your user's home).
Notice that here,`<your_user_home>` will be the path to your users home directory, for instance `/home/sergi/`.
57
+
Notice that here `<your_user_home>` will be the path to your user's home directory, for instance `/home/sergi/`.
58
58
59
59
Now create a symbolic link to it (make sure to replace the path for your's!):
60
60
@@ -71,6 +71,26 @@ ls
71
71
72
72
You can now turn on your lightning node and the plugin will be automatically linked.
73
73
74
+
### Check that the client is properly linked
75
+
76
+
We can check the plugin was properly linked by running:
77
+
78
+
```
79
+
lightning-cli plugin list
80
+
```
81
+
82
+
That will return a list of all linked plugins, which should include the `watchtower-client`:
83
+
84
+
```
85
+
[
86
+
...
87
+
{
88
+
"name": "~/.lightning/plugins/watchtower-client",
89
+
"active": true
90
+
}
91
+
]
92
+
```
93
+
74
94
# Config file, data folder and first bootstrap
75
95
76
96
The plugin, by default, creates a data folder under the user's home folder (`~/.watchtower`), where all the plugin's data is stored. The data folder can be modified by setting the ENV variable `TOWERS_DATA_DIR`.
0 commit comments