‚̧Nurturing Pluto's Martians
    Wondering what‚Äôs next for npm?Check out our public roadmap! ¬Ľ

    bip38
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/bip38 package

    3.1.1¬†‚Äʬ†Public¬†‚Äʬ†Published

    bip38

    build status Coverage Status Version

    js-standard-style

    A JavaScript component that adheres to the BIP38 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

    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 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])

    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])

    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

    Install

    npm i bip38

    DownloadsWeekly Downloads

    8,332

    Version

    3.1.1

    License

    none

    Unpacked Size

    19.7 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar