Crates
This is the complete list of crates supported right now:
| Crate | Description | Version |
|---|
| lampod-cli | Lampo Daemon command line interface to run the daemon | unrelated |
| lampo-cli | Simple Lampo command line interface to interact with the daemon | unrelated |
How to Install
To install all the requirements and the Lampo binary, you need to
have rust installed, and then run the following command:
make install
After you have lampod-cli and lampo-cli available, the first time you run
lampod-cli with signet network, it will create a new wallet:
➜ ~ lampod-cli --network signet
✓ Wallet Generated, please store these words in a safe way
wallet-keys maple have fitness decide food joy flame coast stereo front grab stumble
[!NOTE]
Store your wallet words securely. You can use them later to restore the wallet with --restore-wallet.
If you do not store your words anywhere, your funds will be lost the next time Lampo starts!
The second time you run the same command, it will start the Lampo daemon (lampod), which will show continuous logs of the node's activity:
➜ ~ lampod-cli --network signet
[2025-08-27T10:15:23Z INFO lampod] WARN lampod_cl1 Loading from existing wallet. [lampod-cli/src/main.rs:159]
... (continuous log output) ...
Please note that you need to have a lampo.conf in the path ~/.lampo/signet. Run the
following command to use the example config file:
cp lampo.example.conf ~/.lampo/signet/lampo.conf
A newly generated wallet jumps its checkpoint to the chain tip (fast-sync, on
by default) so it does not scan from genesis. A mnemonic restore never takes
that automatic jump, even when its local database is new, because the seed may
own historical funds. Use reindex=<height> in lampo.conf for a known
birthday.
Then you can query the node with the following command:
➜ ~ lampo-cli --network signet getinfo
{
"node_id": "035b889551a44e502cd0cd6657acf067336034986cd6639b222cd4be563a7fc205",
"peers": 0,
"channels": 0
}
To run integration tests:
make bins compiles the test binaries once. make unit reruns the
ones that do not need a chain. make integration needs bitcoind on
PATH and runs the regtest suite against Bitcoin Core.
LAMPO_CHAIN=all also runs it against rbitcoin-node (or LAMPO_RBITCOIN).
make unit
make integration
LAMPO_CHAIN=all make integration
Peer backup
Lampo stores a peer's encrypted backup blob and sends our own channel-monitor
backup, as specified by BOLT 1 peer_storage.
Feature bits 42/43 (option_provide_storage) advertise that this node will
store a peer's opaque blob. Sending our monitor backup is separate: LDK only
queues that blob when built with --cfg peer_storage.
That flag lives in .cargo/config.toml. RUSTFLAGS and
CARGO_ENCODED_RUSTFLAGS replace the file instead of appending to it, so a
build that sets either must include --cfg peer_storage too. Without the cfg,
lampod's build.rs refuses to compile. cargo test doctests run under
rustdoc, which does not read this file; that is expected and is not a missing
backup.
This is not disaster recovery. LDK stores at most 1 KiB per peer, and our
monitor snapshot is larger than that, so a Lampo or LDK peer will not keep it.
See SECURITY.md.
Simulation
Pre-production soak harness lives in simulations/ (regtest only). See
simulations/README.md, AGENTS.md, and CLAUDE.md
for Phase 1 recovery/stress and Phase 2 N-node chaos soak gates.
Contributing guidelines
Please read our Contributing guide.
Community
Determined to maintain clarity, we’ve chosen specific channels for communication:
- Developers, join us on Zulip.
- Community members, our Twitter community awaits your insights.
- For technical questions and feature requests, dive into our GitHub discussions.
