|Project Name||Stars||Downloads||Repos Using This||Packages Using This||Most Recent Commit||Total Releases||Latest Release||Open Issues||License||Language|
|Bitcoinjs Lib||5,127||1,819||1,073||2 days ago||85||June 09, 2023||60||mit||TypeScript|
|Andengine||3,062||5 years ago||118||apache-2.0||Java|
|Free Android 2D OpenGL Game Engine|
|Web2web||2,265||5 years ago||2||HTML|
|P2P web powered by torrents and blockchain.|
|Eclair||1,177||3 days ago||44||apache-2.0||Scala|
|A scala implementation of the Lightning Network.|
|Scallion||1,079||3 years ago||40||other||C#|
|GPU-based Onion Hash generator|
|Bitcoin Php||986||62||43||3 months ago||78||December 10, 2019||72||unlicense||PHP|
|Bitcoin implementation in PHP|
|Vanitygen||962||4 years ago||89||agpl-3.0||C|
|Plutus||842||9 months ago||4||Python|
|An automated bitcoin wallet collider that brute forces random wallet addresses|
|Explorer for Bitcoin and Liquid|
|Brainflayer||793||4 months ago||13||C|
|A proof-of-concept cracker for cryptocurrency brainwallets and other low entropy key alogrithms.|
Released under the terms of the MIT LICENSE.
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.
Don't trust. Verify.
We recommend every user of this library and the bitcoinjs ecosystem audit and verify any underlying code for its validity and suitability, including reviewing any and all of your project's dependencies.
Mistakes and bugs happen, but with your help in resolving and reporting issues, together we can produce open source software that is:
Buffer's throughout, and
Most of the time, this is not appropriate. Creating issues and pull requests in the open will help others with similar issues, so please try to use public issues and pull requests for communication.
That said, sometimes developers might be open to taking things off the record (ie. You want to share code that you don't want public to get help with it). In that case, please negotiate on the public issues as to where you will contact.
We have created public rooms on IRC (
libera.chat) and Matrix (
#bitcoinjs-dev:matrix.org). These two channels have been joined together in a Matrix "Space" which has the Matrix room AND an IRC bridge room that can converse with the IRC room. The "Space" is
Matrix and IRC both have functions for direct messaging, but IRC is not end to end encrypted, so Matrix is recommended for most communication. The official Matrix client maintained by the Matrix core team is called "Element" and can be downloaded here: https://element.io/download (Account creation is free on the matrix.org server, which is the default setting for Element.)
We used to have a Slack. It is dead. If you find it, no one will answer you most likely.
No we will not make a Discord.
npm install bitcoinjs-lib # optionally, install a key derivation library as well npm install ecpair bip32 # ecpair is the ECPair class for single keys # bip32 is for generating HD keys
Previous versions of the library included classes for key management (ECPair, HDNode(->"bip32")) but now these have been separated into different libraries. This lowers the bundle size significantly if you don't need to perform any crypto functions (converting private to public keys and deriving HD keys).
Typically we support the Node Maintenance LTS version. TypeScript target will be set to the ECMAScript version in which all features are fully supported by current Active Node LTS. However, depending on adoption among other environments (browsers etc.) we may keep the target back a year or two. If in doubt, see the main_ci.yml for what versions are used by our continuous integration tests.
WARNING: We presently don't provide any tooling to verify that the release on
npm matches GitHub. As such, you should verify anything downloaded by
npm against your own verified copy.
Crypto is hard.
When working with private keys, the random number generator is fundamentally one of the most important parts of any software you write.
For random number generation, we default to the
randombytes module, which uses
window.crypto.getRandomValues in the browser, or Node js'
crypto.randomBytes, depending on your build system.
Although this default is ~OK, there is no simple way to detect if the underlying RNG provided is good enough, or if it is catastrophically bad.
You should always verify this yourself to your own standards.
This library uses tiny-secp256k1, which uses RFC6979 to help prevent
k re-use and exploitation.
Unfortunately, this isn't a silver bullet.
Buffer (UInt8Array), for example, can trivially result in catastrophic fund loss without any warning.
It can do this through undermining your random number generation, accidentally producing a duplicate
k value, sending Bitcoin to a malformed output script, or any of a million different ways.
Running tests in your target environment is important and a recommended step to verify continuously.
Finally, adhere to best practice. We are not an authoritative source of best practice, but, at the very least:
Math.random- in any way - don't.
The recommended method of using
bitcoinjs-lib in your browser is through browserify.
If you'd like to use a different (more modern) build tool than
$ npm install bitcoinjs-lib browserify $ npx browserify --standalone bitcoin - -o bitcoinjs-lib.js <<<"module.exports = require('bitcoinjs-lib');"
Which you can then import as an ESM module:
<script type="module">import "/scripts/bitcoinjs-lib.js"</script>
Type declarations for Typescript are included in this library. Normal installation should include all the needed type information.
The below examples are implemented as integration tests, they should be very easy to understand. Otherwise, pull requests are appreciated. Some examples interact (via HTTPS) with a 3rd Party Blockchain Provider (3PBP).
If you have a use case that you feel could be listed here, please ask for it!
npm test npm run-script coverage