Security News
Namecheap Takes Down Polyfill.io Service Following Supply Chain Attack
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
bitcoinjs-lib
Advanced tools
Package description
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.
Changelog
2.1.1
changed
buffer-reverse
, dependency only kept for bufferutils.reverse
, to be deprecated (#478)fixed
isMultisigOutput
no longer allows data chunks for m
/n
(#482)isMultisigOutput
's n
value must now match the number of public keys (as per bitcoin/bitcoin) (#484)Readme
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
FAQs
Client-side Bitcoin JavaScript library
The npm package bitcoinjs-lib receives a total of 91,614 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 3 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
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.
Security News
A JavaScript library maintainer is under fire after merging a controversial PR to support legacy versions of Node.js.