Practical overview
When it fits
Use Bitcoin S when developing JVM applications that need modular Bitcoin or Lightning capabilities, or when you want to start the repository's documented Docker wallet environment.
Who it is for
- Scala developers building Bitcoin or Lightning applications on the JVM.
- Teams adding wallet, key-management, chain or node-RPC components to an application.
- Developers exploring Bitcoin-S modules for DLC or node-related projects.
Documented uses
- Add Bitcoin-S libraries to a Scala project using the documented dependency declarations.
- Build wallet functionality from wallet and key-manager modules.
- Connect an application to Eclair or LND through the listed RPC modules.
- Start the documented Docker environment and access its local wallet frontend.
Requirements & limits
- The project is written in Scala and its documented library dependencies use Scala's libraryDependencies syntax.
- The repository lists separate modules for Bitcoin Core, Eclair and LND RPC integration.
- The Docker setup starts backend syncing and exposes a wallet frontend at localhost:3002.
- The project is MIT-licensed.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Add Bitcoin-S modules to a Scala project
Declare selected Bitcoin-S libraries as dependencies in a Scala project.
Before you start
- A Scala project using the documented libraryDependencies syntax.
Steps
Choose the required Bitcoin-S modules, such as bitcoin-s-wallet and bitcoin-s-key-manager for wallet-related components.
Add the selected org.bitcoin-s dependencies using the README's libraryDependencies examples and version.
Expected outcome
The selected Bitcoin-S modules are declared as project dependencies.
Guide limitations
- The dependency declarations do not define a complete application design or integration procedure.
Start the documented wallet environment with Docker
Start the repository's Docker environment and open its local wallet frontend.
Before you start
- Docker and Docker Compose.
Steps
From the bitcoin-s repository, run APP_PASSWORD=topsecret docker compose up.
Allow the environment to start syncing the backend.
Visit localhost:3002 for the wallet web frontend.
Expected outcome
The Docker environment starts the backend sync and exposes the wallet frontend locally.
Guide limitations
- The repository does not describe further wallet configuration in this run instruction.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 10 October 2026
- Original website title
- bitcoin-s/bitcoin-s · Official homepage title · retained in its source language

