https://github.com/bitcoinjs/bip21

A BIP21 compatible URL encoding utility library
https://github.com/bitcoinjs/bip21

bip21 bitcoin javascript

Last synced: 10 days ago
JSON representation

A BIP21 compatible URL encoding utility library

• Host: GitHub
• URL: https://github.com/bitcoinjs/bip21
• Owner: bitcoinjs
• License: mit
• Created: 2014-10-29T14:52:25.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-07-07T03:35:45.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T08:34:39.617Z (3 months ago)
• Topics: bip21, bitcoin, javascript
• Language: JavaScript
• Size: 37.1 KB
• Stars: 54
• Watchers: 12
• Forks: 53
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Lists

• awesome-cryptocoinjs - bitcoin
• awesome-wallet - BIP21

README

        
# bip21

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

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

A [BIP21](https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki) compatible URL encoding library.

## Example

``` javascript

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 [MIT](LICENSE)