bitcoinjs-lib
Advanced tools
The bitcoinjs-lib npm package is a library for Bitcoin-related operations in JavaScript. It provides tools for creating, signing, and verifying Bitcoin transactions, as well as generating and managing Bitcoin addresses and keys.
Generate a Bitcoin Address
This feature allows you to generate a new Bitcoin address. The code creates a random key pair and derives a Bitcoin address from the public key.
const bitcoin = require('bitcoinjs-lib');
const keyPair = bitcoin.ECPair.makeRandom();
const { address } = bitcoin.payments.p2pkh({ pubkey: keyPair.publicKey });
console.log(address);Create a Bitcoin Transaction
This feature allows you to create a Bitcoin transaction. The code builds a transaction by adding inputs and outputs, and then signs it with the private key.
const bitcoin = require('bitcoinjs-lib');
const keyPair = bitcoin.ECPair.fromWIF('your-private-key');
const txb = new bitcoin.TransactionBuilder();
txb.addInput('previous-txid', 0); // Add input (previous transaction)
txb.addOutput('recipient-address', 100000); // Add output (recipient address and amount in satoshis)
txb.sign(0, keyPair); // Sign the transaction
const tx = txb.build().toHex();
console.log(tx);Verify a Bitcoin Transaction
This feature allows you to verify a Bitcoin transaction. The code parses a transaction from its hexadecimal representation and checks if all inputs have valid scripts.
const bitcoin = require('bitcoinjs-lib');
const tx = bitcoin.Transaction.fromHex('transaction-hex');
const txb = bitcoin.TransactionBuilder.fromTransaction(tx);
const isValid = txb.inputs.every(input => input.script && input.script.length > 0);
console.log(isValid);Bitcore-lib is another JavaScript library for Bitcoin-related operations. It offers similar functionalities to bitcoinjs-lib, such as creating and signing transactions, generating addresses, and managing keys. Bitcore-lib is part of the Bitcore project, which includes additional tools and services for Bitcoin development.
Bcoin is a full Bitcoin node implementation in JavaScript. It provides a comprehensive set of tools for Bitcoin development, including wallet management, transaction creation, and blockchain interaction. Bcoin is more feature-rich compared to bitcoinjs-lib, as it can run as a full node and participate in the Bitcoin network.
Bitcoin-core is a JavaScript library for interacting with Bitcoin Core, the reference implementation of the Bitcoin protocol. It allows developers to communicate with a Bitcoin Core node using RPC calls, enabling functionalities such as transaction creation, address management, and blockchain querying. Unlike bitcoinjs-lib, which is a standalone library, bitcoin-core relies on a running Bitcoin Core node.
The pure JavaScript Bitcoin library for node.js and browsers.
A continued implementation of the original 0.1.3 version used by over a million wallet users; the backbone for almost all Bitcoin web wallets in production today.
If you are thinking of using the master branch of this library in production, stop. Master is not stable; it is our development branch, and only tagged releases may be classified as stable.
If you are looking for the original, it is tagged as 0.1.3. Unless you need it for dependency reasons, it is strongly recommended that you use (or upgrade to) the newest version, which adds major functionality, cleans up the interface, fixes many bugs, and adds over 1,300 more tests.
npm install bitcoinjs-lib
var bitcoin = require('bitcoinjs-lib')
If you're familiar with how to use browserify, ignore this and proceed normally. These steps are advisory only and allow you to use the API to its full extent.
Browserify is assumed to be installed for these steps.
From your repository, create a foobar.js file
var foobar = {
base58: require('bs58'),
bitcoin: require('bitcoinjs-lib'),
ecurve: require('ecurve'),
BigInteger: require('bigi'),
Buffer: require('buffer')
}
module.exports = foobar
Each of these included packages are seperate to bitcoinjs-lib, and must be installed separately.
They are however used in the bitcoinjs-lib public API.
Using browserify, compile foobar.js for use in the browser:
$ browserify foobar.js -s foobar > foobar.js
You will then be able to load foobar.js into your browser, with each of the dependencies above accessible from the global foobar object.
NOTE: See our package.json for the currently supported version of browserify used by this repository.
NOTE: When uglifying the javascript, you must exclude the following variable names from being mangled: Array, BigInteger, Boolean, Buffer, ECPair, Function, Number, Point and Script.
This is because of the function-name-duck-typing used in typeforce.
The below examples are implemented as integration tests, they should be very easy to understand. Otherwise, pull requests are appreciated.
Stefan Thomas is the inventor and creator of this project. His pioneering work made Bitcoin web wallets possible.
Since then, many people have contributed. Click here to see the comprehensive list.
Daniel Cousens, Wei Lu, JP Richardson and Kyle Drake lead the major refactor of the library from 0.1.3 to 1.0.0.
Join the ongoing IRC development channel at #bitcoinjs-dev on Freenode.
We are always accepting of Pull requests, but we do adhere to specific standards in regards to coding style, test driven development and commit messages.
Please make your best effort to adhere to these when contributing to save on trivial corrections.
$ npm test
$ npm run-script coverage
This library is free and open-source software released under the MIT license.
BitcoinJS (c) 2011-2015 Bitcoinjs-lib contributors Released under MIT license
2.0.0
In this release we have strived to simplify the API, using native types wherever possible to encourage cross-compatibility with other open source community modules.
The ecdsa module has been removed in lieu of using a new ECDSA module (for performance and safety reasons) during the 2.x.y major release.
Several other cumbersome modules have been removed, with their new independent modules recommended for usage instead for greater modularity in your projects.
Backward incompatible changes:
added
address, for address based utility functions, most compatible, just without Address instantiation, see #401, #444script, for script based utility functions, mostly compatible, just without Script instantiation, see #438, #444ECPair, a merged replacement for ECKey/ECPubKey, invalid types will throw via typeforcechanged
address.toOutputScript, ECPair.prototype.fromWIF and HDNode.prototype.fromBase58 no longer automatically detect the network, networks.bitcoin is always assumed unless given.
assert was used for type checking, now replaced by typeforce
BIP66 compliant strict DER signature validation was added to ECSignature.fromDER, changing the exact exception messages slightly, see #448.
new HDNode(d/Q, chainCode, network) -> new HDNode(keyPair, chainCode), now uses ECPair
HDNode.prototype.toBase58(false) -> HDNode.prototype.neutered().toBase58() for exporting an extended public key
HDNode.prototype.toBase58(true) -> HDNode.prototype.toBase58() for exporting an extended private key
Transaction.prototype.hashForSignature(prevOutScript, inIndex, hashType) -> Transaction.prototype.hashForSignature(inIndex, prevOutScript, hashType)
Transaction.prototype.addInput(hash, ...): hash could be a string, Transaction or Buffer -> hash can now only be a Buffer.
Transaction.prototype.addOutput(scriptPubKey, ...): scriptPubKey could be a string, Address or a Buffer -> scriptPubKey can now only be a Buffer.
TransactionBuilder API unchanged.
removed
export Address, strings are now used, benchwith no performance loss for most use cases
export base58check, use bs58check instead
export ecdsa, use ecurve instead
export ECKey, use new export ECPair instead
export ECPubKey, use new export ECPair instead
export Wallet, see README.md#complementing-libraries instead
export Script, use new utility export script instead (#438 for more information)
crypto.HmacSHA256 , use node crypto instead
crypto.HmacSHA512 , use node crypto instead
Transaction.prototype.sign, use TransactionBuilder.prototype.sign
Transaction.prototype.signInput, use TransactionBuilder.prototype.sign
Transaction.prototype.validateInput, use Transaction.prototype.hashForSignature and ECPair.verify
HDNode.fromBuffer, use HDNode.fromBase58 instead
HDNode.fromHex, use HDNode.fromBase58 instead
HDNode.toBuffer, use HDNode.prototype.toBase58 instead
HDNode.toHex, use HDNode.prototype.toBase58 instead
networks.*.magic, see the comment here
networks.[viacoin|viacointestnet|gamerscoin|jumbucks|zetacoin], import these yourself (see #383/a0e6ee7)
networks.*.estimateFee, out-dated
renamed
Message -> messagescripts -> scriptscripts.dataOutput -> script.nullDataOutput (per convention)FAQs
Client-side Bitcoin JavaScript library
The npm package bitcoinjs-lib receives a total of 169,750 weekly downloads. As such, bitcoinjs-lib popularity was classified as popular.
We found that bitcoinjs-lib demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.