@psf/bip21

    2.0.1 • Public • Published

    bip21

    build status Version

    A BIP21 compatible URL encoding library.

    Example

    var bip21 = require('bip21')
    
    var decoded = bip21.decode('bitcoin:1BgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH?amount=20.3&label=Foobar')
    
    console.log(decoded)
    // { address: '1BgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH',
    //   options: {
    //     amount: 20.3,
    //     label: 'Foobar' }
    // }
    //
    // WARNING: Remember to error check the `.address`!
    
    console.log(bip21.encode('1BgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH'))
    // => bitcoin:1BgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH
    
    console.log(bip21.encode('1BgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH', {
    	amount: 20.3,
    	label: 'Foobar'
    }))
    // => bitcoin:1BgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH?amount=20.3&label=Foobar

    License ISC

    Keywords

    Install

    npm i @psf/bip21

    DownloadsWeekly Downloads

    387

    Version

    2.0.1

    License

    ISC

    Unpacked Size

    9.37 kB

    Total Files

    8

    Last publish

    Collaborators

    • psf-account
    • chris.troutner