Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bitcoinjs/bip38

BIP38 is a standard process to encrypt Bitcoin and crypto currency private keys that is less susceptible to brute force attacks thus protecting the user.
https://github.com/bitcoinjs/bip38

bip38 bitcoin bitcoinjs encryption javascript scrypt

Last synced: 6 days ago
JSON representation

BIP38 is a standard process to encrypt Bitcoin and crypto currency private keys that is less susceptible to brute force attacks thus protecting the user.

Host: GitHub
URL: https://github.com/bitcoinjs/bip38
Owner: bitcoinjs
License: mit
Created: 2014-02-28T08:55:01.000Z (almost 11 years ago)
Default Branch: master
Last Pushed: 2023-12-23T06:02:38.000Z (about 1 year ago)
Last Synced: 2025-01-02T02:05:33.336Z (10 days ago)
Topics: bip38, bitcoin, bitcoinjs, encryption, javascript, scrypt
Language: JavaScript
Homepage: http://cryptocoinjs.com/modules/currency/bip38/
Size: 915 KB
Stars: 214
Watchers: 22
Forks: 101
Open Issues: 9
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

awesome-cryptocoinjs - bitcoin
best-of-crypto - GitHub - 24% open · ⏱️ 20.10.2023): (Cryptocurrencies)

README

        # bip38

[![build status](https://secure.travis-ci.org/bitcoinjs/bip38.svg)](http://travis-ci.org/bitcoinjs/bip38)

[![Coverage Status](https://img.shields.io/coveralls/cryptocoinjs/bip38.svg)](https://coveralls.io/r/cryptocoinjs/bip38)

[![Version](http://img.shields.io/npm/v/bip38.svg)](https://www.npmjs.org/package/bip38)

[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)

A JavaScript component that adheres to the [BIP38](https://github.com/bitcoin/bips/blob/master/bip-0038.mediawiki) standard to secure your crypto currency private keys. Fully compliant with Node.js and the browser (via Browserify).

## Why?

BIP38 is a standard process to encrypt Bitcoin and crypto currency private keys that is impervious to brute force attacks thus protecting the user.

## Package Info

- homepage: [http://cryptocoinjs.com/modules/currency/bip38/](http://cryptocoinjs.com/modules/currency/bip38/)

- github: [https://github.com/cryptocoinjs/bip38](https://github.com/cryptocoinjs/bip38)

- tests: [https://github.com/cryptocoinjs/bip38/tree/master/test](https://github.com/cryptocoinjs/bip38/tree/master/test)

- issues: [https://github.com/cryptocoinjs/bip38/issues](https://github.com/cryptocoinjs/bip38/issues)

- license: **MIT**

- versioning: [http://semver-ftw.org](http://semver-ftw.org)

## Usage

### Installation

    npm install --save bip38

### Async methods

Async methods are available, but using them will be slower, but free up the event loop in intervals you choose.

For benchmark results, please see the section in the README of the [scryptsy](https://github.com/cryptocoinjs/scryptsy/tree/395c3b09b21e06ea4a6cc2933e046c0984a414c5#benchmarks) library. Increasing the interval will decrease the performance hit, but increase the span between event loop free ups (UI drawing etc.) promiseInterval is the last optional parameter after scryptParams. There is no recommendation currently, as the performance trade off is app specific.

### API

### encrypt(buffer, compressed, passphrase[, progressCallback, scryptParams])

``` javascript

var bip38 = require('bip38')

var wif = require('wif')

var myWifString = '5KN7MzqK5wt2TP1fQCYyHBtDrXdJuXbUzm4A9rKAteGu3Qi5CVR'

var decoded = wif.decode(myWifString)

var encryptedKey = bip38.encrypt(decoded.privateKey, decoded.compressed, 'TestingOneTwoThree')

console.log(encryptedKey)

// => '6PRVWUbkzzsbcVac2qwfssoUJAN1Xhrg6bNk8J7Nzm5H7kxEbn2Nh2ZoGg'

```

### decrypt(encryptedKey, passphrase[, progressCallback, scryptParams])

``` javascript

var bip38 = require('bip38')

var wif = require('wif')

var encryptedKey = '6PRVWUbkzzsbcVac2qwfssoUJAN1Xhrg6bNk8J7Nzm5H7kxEbn2Nh2ZoGg'

var decryptedKey = bip38.decrypt(encryptedKey, 'TestingOneTwoThree', function (status) {

  console.log(status.percent) // will print the percent every time current increases by 1000

})

console.log(wif.encode(0x80, decryptedKey.privateKey, decryptedKey.compressed))

// => '5KN7MzqK5wt2TP1fQCYyHBtDrXdJuXbUzm4A9rKAteGu3Qi5CVR'

```

# References

- https://github.com/bitcoin/bips/blob/master/bip-0038.mediawiki

- https://github.com/pointbiz/bitaddress.org/issues/56 (Safari 6.05 issue)

- https://github.com/casascius/Bitcoin-Address-Utility/tree/master/Model

- https://github.com/nomorecoin/python-bip38-testing/blob/master/bip38.py

- https://github.com/pointbiz/bitaddress.org/blob/master/src/ninja.key.js