mirror of
https://github.com/yzernik/squeaknode.git
synced 2026-08-19 13:18:26 +02:00
No description
68e69e55c8
* Got basic web server running for peer * Got squeak route and lookup route working * Got secret key route working * Got offer endpoint working * Remove old comment * Move peer server code to server subdir * Create client subdir for peer client * Return empty list for lookup when pubkeys is empty * Add peer client and network controller class * Remove old network code * Remove old block subscription worker * Remove network handler class * Remove more old classes * Add back twitter forwarder worker * Remove download methods from controller * Add websocket endpoint * Add websocket subscribe method * Add websocket client library * Fetch squeaks from peer (slowly) on UI timeline load * Fetch squeaks from peer (slowly) on UI pubkey squeaks load * Got download squeaks working with HTTP requests * Fixed external address method in controller * Remove download pubkey squeak button and action * Remove unused connection displays from peer ana peers page * Fix 404 not found for offer endpoint * Better handling of null cases in peer client downloader * Simplify peer downloader * Create subclass for range download * Got single squeak download working * Fix itest for get external address |
||
|---|---|---|
| .github/workflows | ||
| docker | ||
| docs | ||
| frontend | ||
| itests | ||
| proto | ||
| squeaknode | ||
| tests | ||
| .dockerignore | ||
| .flake8 | ||
| .gitignore | ||
| .pre-commit-config.yaml | ||
| CHANGELOG.md | ||
| config-mainnet.ini | ||
| config.ini | ||
| createdb.sql | ||
| Dockerfile | ||
| LICENSE | ||
| Makefile | ||
| MANIFEST.in | ||
| PGP.txt | ||
| README.md | ||
| requirements-dev.txt | ||
| requirements-itest.txt | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| start-squeaknode.sh | ||
| torrc | ||
| tox.ini | ||
squeaknode
A peer-to-peer status feed with posts unlocked by Lightning.
Squeaknode allows you to create, view, buy, and sell squeaks.
A squeak is an immutable structure that:
- contains 280 utf-8 characters of text
- contains the hash of another squeak as a reply, if the squeak is a reply
- contains the height and block hash of the latest bitcoin block
- contains the public key of the author, and is signed by the author
- contains the public key of the recipient, if the text is end-to-end encrypted
- is encrypted until a lightning payment obtains the secret decryption key
- has a unique hash that is derived from its contents
The protocol is defined here.
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 that you need.
Step 2. Install squeaknode:
pip install squeaknode
Or install from source
python3 -m venv venv
source venv/bin/activate
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
Release + Commit Verification
All releases and all maintainer commits as of January 5, 2022 are signed by key D761F27D9B20BA52 (yzernik@gmail.com). The key can be found in this repo and on the Squeaknode website.
Telegram
License
Distributed under the MIT License. See LICENSE file.