No description
Find a file
Jonathan Zernik b29cc9e925
Add build instructions for protoc in readme (#348)
* Add build instructions for protoc in readme

* Fix protoc download urls
2020-10-30 12:42:32 -04:00
docker Allow frontend testing without login (#345) 2020-10-29 18:22:01 -04:00
frontend Add build instructions for protoc in readme (#348) 2020-10-30 12:42:32 -04:00
itests Rename to squeaknode (#342) 2020-10-29 14:35:17 -04:00
proto Rename to squeaknode (#342) 2020-10-29 14:35:17 -04:00
squeaknode Allow frontend testing without login (#345) 2020-10-29 18:22:01 -04:00
tests Rename to squeaknode (#342) 2020-10-29 14:35:17 -04:00
.dockerignore Add get squeaks for address rpc method (#108) 2020-07-21 16:12:26 -07:00
.gitignore Ignore generated python pb2 files (#328) 2020-10-28 14:26:25 -04:00
createdb.sql Rename to squeaknode (#342) 2020-10-29 14:35:17 -04:00
install-rpc.sh Lnd get info from frontend (#100) 2020-07-20 22:52:04 -07:00
LICENSE Update LICENSE (#71) 2020-07-15 16:00:13 -07:00
Makefile Add black to make codeformat in makefile (#85) 2020-07-18 19:40:28 -07:00
MANIFEST.in Rename to squeaknode (#342) 2020-10-29 14:35:17 -04:00
README.md Add step to build docker-compose in readme (#343) 2020-10-29 16:19:08 -04:00
requirements-itest.txt Use pytest for itest (#161) 2020-07-28 19:49:44 -07:00
requirements.txt Allow frontend testing without login (#345) 2020-10-29 18:22:01 -04:00
setup.cfg Rename to squeaknode (#342) 2020-10-29 14:35:17 -04:00
setup.py Rename to squeaknode (#342) 2020-10-29 14:35:17 -04:00
tox.ini Rename to squeaknode (#342) 2020-10-29 14:35:17 -04:00
wait-for-it.sh Make docker compose run (#45) 2020-06-11 20:09:02 -07:00

squeaknode

Node for Squeak protocol

Run

Run with docker:

  • Edit docker/config.ini to change any configs
  • Start the squeak server:
    $ cd docker
    $ docker-compose build
    $ docker-compose up
    

Run without docker:

  • Create a config.ini file and fill in the relevant values:

    [squeaknode]
    network=testnet
    price=<YOUR_SELLING_PRICE_IN_SATOSHIS>
    max_squeaks_per_address_per_hour=<YOUR_RATE_LIMIT>
    
    [lnd]
    host=<YOUR_LND_HOST>
    external_host=<YOUR_LND_HOST>
    port=9735
    rpc_port=10009
    tls_cert_path=/root/.lnd/tls.cert
    macaroon_path=/root/.lnd/data/chain/bitcoin/testnet/admin.macaroon
    
    [bitcoin]
    rpc_host=btcd
    rpc_port=18334
    rpc_user=devuser
    rpc_pass=devpass
    
    [server]
    rpc_host=0.0.0.0
    rpc_port=8774
    
    [admin]
    rpc_host=0.0.0.0
    rpc_port=8994
    
  • Install squeaknode:

    $ pip install squeaknode
    

    or

    $ python setup.py install
    
  • Start the squeak server:

    $ runsqueaknode --config config.ini run-server
    

Test

Run unit tests:

$ make test

Run integration tests:

$ make itest