bitcoinjs/bitcoinjs-lib

★ 5,987JavaScriptAudience · developerComplexity · 4/5LicenseSetup · moderate

Mindmap

mindmap
  root((bitcoinjs-lib))
    What it does
      Create transactions
      Generate addresses
      Sign data
      Parse raw data
    Environments
      Node.js
      Web browser
    Companion packages
      ecpair keys
      bip32 derivation
    Security rules
      No address reuse
      Safe RNG required
      Verify before broadcast

mindmap root((bitcoinjs-lib)) What it does Create transactions Generate addresses Sign data Parse raw data Environments Node.js Web browser Companion packages ecpair keys bip32 derivation Security rules No address reuse Safe RNG required Verify before broadcast

Click or tap to explore — scroll the page freely

Things people build with this

USE CASE 1

Build a Bitcoin wallet that generates addresses and signs transactions in the browser

USE CASE 2

Create a Node.js service that constructs and broadcasts raw Bitcoin transactions

USE CASE 3

Parse and decode existing Bitcoin transaction data for a block explorer or analytics tool

USE CASE 4

Integrate Bitcoin payment creation into a JavaScript app without relying on a third-party custodian

Tech stack

TypeScriptJavaScriptNode.js

Getting it running

Difficulty · moderate Time to first run · 30min

Key management requires installing separate ecpair and bip32 companion packages, cryptographic correctness depends on using a secure random number source, not Math.random.

Use freely for any purpose, including commercial use, as long as you keep the MIT license notice.

In plain English

This is a JavaScript library for working with Bitcoin, usable in both Node.js server environments and web browsers. It gives developers the building blocks they need to create Bitcoin transactions, generate addresses, sign data, and interact with the Bitcoin network at a code level. It is written in TypeScript but also ships compiled JavaScript files. The library handles the lower-level mechanics of Bitcoin: creating and signing transactions, parsing raw transaction data, and working with address formats. Key management, meaning generating and storing private keys, was split out into separate companion libraries called ecpair and bip32, which you install on top of this one if your application needs to create or derive keys. The maintainers are unusually direct about risk. The README warns that cryptography is hard, that the quality of your random number generator matters enormously when dealing with private keys, and that bugs in seemingly unrelated parts of the JavaScript ecosystem can lead to loss of funds without any warning. They list specific practices to follow: do not reuse Bitcoin addresses, do not share extended public keys carelessly, do not use Math.random for anything security-related, and always have users confirm a readable version of a transaction before it is broadcast. Installing is straightforward via npm. The library has over 95% test coverage and follows a consistent code style. Communication happens through GitHub issues and public chat rooms on IRC and Matrix. The maintainers explicitly say they will not create a Discord. This repository is intended for developers building Bitcoin applications, wallets, or tools, not for end users. If you are not writing code, this library is not something you interact with directly. Only tagged releases are considered stable, the main development branch is not safe for production use.

Copy-paste prompts

Prompt 1

Using bitcoinjs-lib, write a Node.js script that generates a new Bitcoin address and shows the private key in WIF format

Prompt 2

How do I construct and sign a Bitcoin transaction with bitcoinjs-lib that sends 0.001 BTC to a specific address?

Prompt 3

Show me how to use bitcoinjs-lib with the ecpair companion library to create a key pair and derive a P2PKH address

Prompt 4

Build a simple Bitcoin transaction parser using bitcoinjs-lib that takes a raw transaction hex and prints all inputs and outputs

Prompt 5

What precautions should I take when using bitcoinjs-lib in production to avoid accidental loss of user funds?

Open on GitHub → Explain another repo

← bitcoinjs on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.