GlcoinCore/squeaknode
1
0
Fork 0
mirror of https://github.com/yzernik/squeaknode.git synced 2026-08-13 12:33:25 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
530 commits 12 branches 232 tags 179 MiB
Find a file
Jonathan Zernik 62c13ddaba
Create peer with default port (#569) 
* Added unit test for create peer

* Got test working for create peer with default port

* Use namedtuple for squeak peer class

* Rename test name in test create peer

* Use type hints for insert squeak peer
2021-01-06 23:47:03 -08:00
.github/workflows Update main.yml (#555) 2021-01-03 23:09:10 -08:00
docker Package for umbrel (#528) 2020-12-30 16:46:48 -08:00
docs Improve readme sections (#521) 2020-12-27 23:55:28 -08:00
frontend Simplify frontend readme (#539) 2021-01-01 22:21:27 -08:00
itests Use typed config (#566) 2021-01-05 23:39:04 -08:00
proto Add get network rpc method (#563) 2021-01-05 14:37:20 -08:00
squeaknode Create peer with default port (#569) 2021-01-06 23:47:03 -08:00
tests Create peer with default port (#569) 2021-01-06 23:47:03 -08:00
.dockerignore Add get squeaks for address rpc method (#108) 2020-07-21 16:12:26 -07:00
.flake8 Add precommit hooks (#526) 2020-12-28 23:52:32 -08:00
.gitignore Use data classes instead of namedtuples (#508) 2020-12-26 01:00:58 -08:00
.pre-commit-config.yaml Add typed dependencies for mypy precommit (#542) 2021-01-01 23:04:28 -08:00
config.ini Use typed config (#566) 2021-01-05 23:39:04 -08:00
Dockerfile Use noninteractive build in dockerfile (#559) 2021-01-04 00:09:30 -08:00
LICENSE Update LICENSE (#71) 2020-07-15 16:00:13 -07:00
Makefile Add precommit hooks (#526) 2020-12-28 23:52:32 -08:00
MANIFEST.in Remove createdb script from manifest (#532) 2020-12-31 16:35:31 -08:00
README.md Update readme simplify config (#564) 2021-01-05 14:53:42 -08:00
requirements-dev.txt Add precommit hooks (#526) 2020-12-28 23:52:32 -08:00
requirements-itest.txt Add precommit hooks (#526) 2020-12-28 23:52:32 -08:00
requirements.txt Use typed config (#566) 2021-01-05 23:39:04 -08:00
setup.cfg Rename to squeaknode (#342) 2020-10-29 14:35:17 -04:00
setup.py Create main.yml (#554) 2021-01-03 21:00:49 -08:00
start-squeaknode.sh Use typed config (#566) 2021-01-05 23:39:04 -08:00
tox.ini Add precommit hooks (#526) 2020-12-28 23:52:32 -08:00

README.md

squeaknode

Node for Squeak protocol

Run a node:

Requirements

  • a bitcoin node
  • an LND node
  • Python 3.7 or later

If you don't already have a bitcoin node or lightning node, you can follow the instructions follow the instructions here to launch them in Docker.

Steps

  • Create a config.ini file and fill in the relevant sections to connect to your bitcoin and lnd nodes:

    [squeaknode]
network=testnet

[lnd]
host=localhost
rpc_port=10009
tls_cert_path=~/.lnd/tls.cert
macaroon_path=~/.lnd/data/chain/bitcoin/testnet/admin.macaroon

[bitcoin]
rpc_host=localhost
rpc_port=18334
rpc_user=devuser
rpc_pass=devpass

[webadmin]
enabled=true
username=devuser
password=devpass

  • Install squeaknode:

    $ pip install squeaknode

    or

    $ python setup.py install

  • Start the squeak server:

    $ runsqueaknode --config config.ini run-server

  • Go to http://localhost:12994/ and use the username/password in config.ini to log in.

Test

Run unit tests:

$ make test

Run integration tests:

$ make itest