GlcoinCore/clboss
1
0
Fork 0
mirror of https://github.com/ZmnSCPxj/clboss.git synced 2026-08-13 12:33:20 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

README: document signet Boltz I2P proxy setup
Some checks failed
Code Base Sanity Check / tests (push) Has been cancelled
Details
Code Base Sanity Check / coverage (push) Has been cancelled
Details
Code Base Sanity Check / build-clang (push) Has been cancelled
Details

Browse source 
Add a "Testing on signet with swaps" section to the top-level README describing how
to reach the signet Boltz backend, which has no public clearnet endpoint. Covers
running i2pd's SOCKS5 proxy and a socat forward from 127.0.0.1:8080 to the
service's I2P address (with a systemd unit for persistence), and the
dev-boltz-api BOLTZ_PROXY/BOLTZ_API_BASE environment variables for smoke-testing
the backend directly over I2P.
This commit is contained in:
Ken Sedgwick 2026-06-22 16:04:33 -07:00
parent 8dbde86789
commit b698844ded
No known key found for this signature in database
GPG key ID: DBD2AF0849D711A9
1 changed files with 47 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

47
README.md
View file

@ -228,6 +228,53 @@ Installing `lcov`:
* Debian/Ubuntu: `sudo apt-get install lcov`
* Or via Nix (without installing system-wide): `nix shell nixpkgs#lcov --command make coverage-report`
### Testing on signet w/ swaps
CLBOSS can run its `boltz.exchange` swaps against a signet Boltz backend,
which is useful for exercising the swap machinery without spending real
funds. This needs a CLBOSS built with signet support, which ships a
`Network_Signet` Boltz instance.
The signet Boltz service has no public clearnet endpoint, so CLBOSS
reaches it at a local address (`http://127.0.0.1:8080`) that you front
with a forward to the service. The service is reachable over I2P
(preferred) or Tor — its `.onion` is also configured, but has been
unreliable in practice.
To forward the local port over I2P:
1. Install and run [i2pd](https://i2pd.readthedocs.io/). Its SOCKS5 proxy
listens on `127.0.0.1:4447` by default; no extra configuration is
required.
2. Forward `127.0.0.1:8080` to the signet Boltz I2P address through that
SOCKS5 proxy with `socat`. A systemd unit keeps it running:
```
[Unit]
Description=socat proxy: 127.0.0.1:8080 -> Boltz signet I2P (via i2pd SOCKS5)
After=i2pd.service network-online.target
Wants=i2pd.service
[Service]
Type=simple
ExecStart=/usr/bin/socat --experimental -d TCP4-LISTEN:8080,bind=127.0.0.1,fork,reuseaddr SOCKS5-CONNECT:127.0.0.1:4447:boltz7c3f7bb5pe7k25uv2wdd57oayoazacorwdvzksz6q7hicxq.b32.i2p:80
Restart=always
RestartSec=10
[Install]
WantedBy=multi-user.target
```
For a one-off test, run just the `socat …` command from `ExecStart`
directly. With i2pd and this forward running, a signet CLBOSS uses the
Boltz signet backend automatically.
To smoke-test the backend without CLBOSS, the `dev-boltz-api` helper
honors two environment variables: set `BOLTZ_PROXY=socks5h://127.0.0.1:4447`
and `BOLTZ_API_BASE=http://boltz7c3f7bb5pe7k25uv2wdd57oayoazacorwdvzksz6q7hicxq.b32.i2p`
to reach the service directly over I2P.
### Contributed Utilities
There are a number of contributed utilities in the `contrib` directory. See