Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sovereign-app/chamberlain
Cashu Mint with Integrated Lightning Node
https://github.com/sovereign-app/chamberlain
bitcoin cashu lightning-network
Last synced: about 3 hours ago
JSON representation
Cashu Mint with Integrated Lightning Node
- Host: GitHub
- URL: https://github.com/sovereign-app/chamberlain
- Owner: sovereign-app
- License: other
- Created: 2024-06-21T13:23:40.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-09-06T13:37:24.000Z (2 months ago)
- Last Synced: 2024-09-06T15:47:34.988Z (2 months ago)
- Topics: bitcoin, cashu, lightning-network
- Language: Rust
- Homepage: https://sovereign.app
- Size: 101 KB
- Stars: 20
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cashu - Chamberlain
- awesome-cashu - Chamberlain
README
# Chamberlain
> Cashu Mint with Integrated Lightning Node
**Alpha Notice**: The software is currently in alpha-testing. Use at your own
risk.
This project aims to substantially increase the number of
[Uncle Jims](https://thebitcoinmanual.com/behind-btc/nodes/uncle-jim-node/)
running mints who can manage day-to-day Bitcoin transactions for friends and
family.
## Running the Mint
Chamberlain ships with two binaries: `chamberlaind`, the long-running daemon,
and `chamberlain`, the management cli tool.
```
chamberlaind --mint-url=http://mint.url:3338
```
All configurable options are available from the help menu:
```
$ chamberlaind --help
Chamberlain daemon
Usage: chamberlaind [OPTIONS]
Options:
--data-dir
Data directory
--network
Network
--bitcoind-rpc-url
Bitcoind RPC URL
--bitcoind-rpc-user
Bitcoind RPC user
--bitcoind-rpc-password
Bitcoind RPC password
--lightning-port
Lightning Network p2p port
--lightning-announce-addr
Lightning Network announce address
--lightning-auto-announce
Auto announce lightning node [possible values: true, false]
--rpc-host
Host IP to bind the RPC server
--rpc-port
Port to bind the RPC server
--http-host
Host IP to bind the HTTP server
--http-port
Port to bind the HTTP server
--mint-url
Mint URL
--mint-name
Mint name and LN alias
--mint-description
Mint description
--mint-color
Mint LN alias color
--mint-contact-email
Mint contact email
--mint-contact-npub
Mint contact nostr public key
--mint-contact-twitter
Mint contact twitter
--mint-motd
Mint message of the day
--password
RPC auth token password
--log-level
Log level [possible values: trace, trace-all, debug, debug-all, info, warn, error, off]
-h, --help
Print help
-V, --version
Print version
```
## Building from Source
It is recommended to use [cargo](https://github.com/rust-lang/cargo) from the
[rustup](https://rustup.rs/) toolchain installer.
```
cargo build --release
```
## Local Testing
Running regtest node is supported using [Polar](https://lightningpolar.com/):
```
cargo run --bin chamberlaind -- --network=regtest --bitcoind-rpc-url=http://127.0.0.1:18443 --bitcoind-rpc-user=polaruser --bitcoind-rpc-password=polarpass --mint-url=http://:3338 --http-host 0.0.0.0 --lightning-port=9634 --log-level=debug
```