Documentation
OCEAN Lightning
Payout tooling that receives your OCEAN mining rewards over the Lightning Network — self-custodial, to a node you run. Generate a seed, derive your mining address, create a payable BOLT12 offer, and BIP-322 sign the OCEAN message, end to end.
New here? Start with Getting started to install the tooling and run your first payout, then dive into the CLI reference.
What it is
oceanln is a Cargo workspace with three crates over one shared core. The core holds the actual flow — resolve offer → load seed → derive → BIP-322 sign → provision — and every frontend is a thin adapter over it.
| Crate | What it is |
|---|---|
oceanln-common | Shared core: BIP-322 signing, address derivation, seed sources, Lexe wallet/sidecar client. |
oceanln-cli | The oceanln command-line tool — for humans, scripts, and AI. |
oceanln-httpd | A local loopback HTTP server exposing the same flow to a web or desktop frontend. |
Two more frontends sit alongside the workspace: oceanln-web (the Svelte wizard) and src-tauri (the Tauri desktop shell). Both share one orchestration core in oceanln-httpd::service, so the HTTP handlers and the desktop IPC commands stay thin.