Need help with bitcoinj?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

4.1K Stars 2.3K Forks Apache License 2.0 3.7K Commits 357 Opened issues


A library for working with Bitcoin

Services available


Need anything else?

Contributors list

Github Build Status GitLab Build Status Coverage Status

Visit our IRC channel

Welcome to bitcoinj

The bitcoinj library is a Java implementation of the Bitcoin protocol, which allows it to maintain a wallet and send/receive transactions without needing a local copy of Bitcoin Core. It comes with full documentation and some example apps showing how to use it.


  • Java 8+ (needs Java 8 API or Android 6.0 API, compiles to Java 8 bytecode) and Gradle 4.4+ for the
  • Java 8+ and Gradle 4.4+ for
  • Java 11+ and Gradle 4.10+ for the JavaFX-based
  • Gradle - for building the project
  • Google Protocol Buffers - for use with serialization and hardware communications

Getting started

To get started, it is best to have the latest JDK and Gradle installed. The HEAD of the

branch contains the latest development code and various production releases are provided on feature branches.

Building from the command line

Official builds are currently using with JDK 8, even though the

module is compatible with JDK 7 and later.

To perform a full build (including JavaDocs and unit/integration tests) use JDK 8+

gradle clean build
If you are running JDK 11 or later and Gradle 4.10 or later, the build will automatically include the JavaFX-based
module. The outputs are under the

To perform a full build without unit/integration tests use:

gradle clean assemble

Building from an IDE

Alternatively, just import the project using your IDE. IntelliJ has Gradle integration built-in and has a free Community Edition. Simply use

File | New | Project from Existing Sources
and locate the
in the root of the cloned project source tree.

Building and Using the Wallet Tool

The bitcoinj

subproject includes a command-line Wallet Tool (
) that can be used to create and manage bitcoinj-based wallets (both the HD keychain and SPV blockchain state.) Using
on Bitcoin's test net is a great way to learn about Bitcoin and bitcoinj.

To build an executable shell script that runs the command-line Wallet Tool, use:

gradle bitcoinj-tools:installDist

You can now run the

without parameters to get help on its operation:

To create a test net wallet file in

, you would use:
mkdir ~/bitcoinj
./tools/build/install/wallet-tool/bin/wallet-tool --net=TEST --wallet=$HOME/bitcoinj/bitcoinj-test.wallet create

To sync the newly created wallet in

with the test net, you would use:
./tools/build/install/wallet-tool/bin/wallet-tool --net=TEST --wallet=$HOME/bitcoinj/bitcoinj-test.wallet sync

To dump the state of the wallet in

with the test net, you would use:
./tools/build/install/wallet-tool/bin/wallet-tool --net=TEST --wallet=$HOME/bitcoinj/bitcoinj-test.wallet dump

Note: These instructions are for macOS/Linux, for Windows use the

batch file with the equivalent Windows command-line commands and options.

Example applications

These are found in the


Where next?

Now you are ready to follow the tutorial.

Testing a SNAPSHOT build

Building apps with official releases of bitcoinj is covered in the tutorial.

If you want to develop or test your app with a Jitpack-powered build of the latest

branch of bitcoinj follow the dynamically-generated instructions for that branch by following the correct link.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.