Skip to content

Commit cdebe82

Browse files
darosiorcdecker
authored andcommitted
sauron: add a basic README
1 parent 3ae9b32 commit cdebe82

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

sauron/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## Sauron
2+
3+
A Bitcoin backend plugin relying on [Esplora](https://github.com/Blockstream/esplora).
4+
5+
6+
### About
7+
8+
It allows C-lightning to run without needing a *local* `bitcoind`, and can be either
9+
self-hosted (Esplora is Open Source, and self hosting it is basically a `docker` one-liner).
10+
11+
This is still a WIP, so is the API C-lightning side. So not to be used for real.
12+
13+
14+
### Run
15+
16+
You need to:
17+
- disable the default Bitcoin backend (`bcli`)
18+
- register sauron
19+
- provide the API endpoint you want to use
20+
21+
Here is a fully reptilian example running against [blockstream.info](https://blockstream.info/):
22+
23+
```
24+
lightningd --mainnet --disable-plugin bcli --plugin $PWD/sauron.py --sauron-api-endpoint https://blockstream.info/api/
25+
```

0 commit comments

Comments
 (0)