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
520 commits 12 branches 232 tags 179 MiB
Find a file
Jonathan Zernik f263dd60dd
Create main.yml (#554) 
* Create main.yml

Add the yaml file for the github action

* Update main.yml

Try build and push docker image

* Update main.yml

Fix image tag

* Update main.yml

Specify platforms in docker build action

* Upgrade pip in dockerfile

* Pin version of grpcio in requirements.txt

* Install pip requirements with only-binary

* Change grpcio version

* Remove only-binary option for pip install

* Update main.yml

cache docker layers

* Update main.yml

Push version tags to dockerhub

* Update main.yml

export and import cache to local

* Update main.yml

Fix image name
2021-01-03 21:00:49 -08:00
.github/workflows Create main.yml (#554) 2021-01-03 21:00:49 -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 Add sync package (#543) 2021-01-02 05:46:49 -08:00
proto Use squeaklib with ptlc (#502) 2020-12-25 20:17:54 -08:00
squeaknode Remove old log lines from squeak_d (#544) 2021-01-02 17:04:46 -08:00
tests Use mypy precommit hook (#537) 2021-01-01 21:39:33 -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 Add sync package (#543) 2021-01-02 05:46:49 -08:00
Dockerfile Create main.yml (#554) 2021-01-03 21:00:49 -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 Improve readme sections (#521) 2020-12-27 23:55:28 -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 Create main.yml (#554) 2021-01-03 21:00:49 -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 Make config.ini file optional (#531) 2020-12-31 15:30:58 -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
price_msat=1000000
sync_interval_s=10

[lnd]
host=localhost
port=9735
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