mirror of
https://github.com/yzernik/squeaknode.git
synced 2026-08-18 13:09:08 +02:00
c7b847a497
* Remove shell prompt from readme code snippets * Remove shell prompt from code snippets in all docs
89 lines
1.9 KiB
Markdown
89 lines
1.9 KiB
Markdown
# squeaknode
|
|
|
|
[](https://github.com/yzernik/squeaknode/actions/workflows/main.yml)
|
|
[](https://codecov.io/gh/yzernik/squeaknode) [](https://gitter.im/squeaknode/squeaknode?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
Node for [Squeak protocol](https://github.com/yzernik/squeak/blob/master/docs/PROTOCOL.md)
|
|
|
|
## Installation
|
|
|
|
### Requirements
|
|
* a Bitcoin node
|
|
* an LND node
|
|
* Python 3.6 or later
|
|
|
|
#### Optional
|
|
* a Tor SOCKS5 proxy (you can open Tor Browser and run it in the background)
|
|
|
|
### Step 1. Create the configuration
|
|
> Update the **config.ini** file and fill in the relevant sections to connect to your Bitcoin node and LND node:
|
|
|
|
```
|
|
[node]
|
|
network=mainnet
|
|
|
|
[lnd]
|
|
host=localhost
|
|
tls_cert_path=~/.lnd/tls.cert
|
|
macaroon_path=~/.lnd/data/chain/bitcoin/mainnet/admin.macaroon
|
|
|
|
[bitcoin]
|
|
rpc_host=localhost
|
|
rpc_port=8332
|
|
rpc_user=devuser
|
|
rpc_pass=devpass
|
|
zeromq_hashblock_port=28334
|
|
|
|
[tor]
|
|
proxy_ip=localhost
|
|
proxy_port=9150
|
|
|
|
[webadmin]
|
|
enabled=true
|
|
username=devuser
|
|
password=devpass
|
|
```
|
|
|
|
Add any other [configs](docs/CONFIGURATION.md) that you need.
|
|
|
|
### Step 2. Install squeaknode:
|
|
|
|
```
|
|
virtualenv venv
|
|
source venv/bin/activate
|
|
pip install -r requirements.txt
|
|
pip install .
|
|
```
|
|
|
|
### Step 3. Start squeaknode:
|
|
|
|
```
|
|
squeaknode --config config.ini
|
|
```
|
|
|
|
Go to http://localhost:12994/ and use the username/password in **config.ini** to log in.
|
|
|
|
## Test
|
|
|
|
### Unit tests:
|
|
|
|
#### Requirements
|
|
* tox
|
|
|
|
```
|
|
make test
|
|
```
|
|
|
|
### Integration tests:
|
|
|
|
#### Requirements
|
|
* docker-compose
|
|
* jq
|
|
|
|
```
|
|
make itest
|
|
```
|
|
|
|
## License
|
|
|
|
Distributed under the MIT License. See [LICENSE file](LICENSE).
|