# bip21-b4bcoin

> A BIP21 compatible URL encoding utility library for B4Bcoin

Latest version **1.0.0** (published 2019-01-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install bip21-b4bcoin
pnpm add bip21-b4bcoin
yarn add bip21-b4bcoin
bun add bip21-b4bcoin
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-01-22 |
| First published | 2019-01-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 10.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ivo Nijenhuis |
| Maintainers | b4bcoin |
| Keywords | bip21, b4bcoin, bip21-b4bcoin |

## Links

- npm: https://www.npmjs.com/package/bip21-b4bcoin
- Repository: https://github.com/B4Bcoin/bip21-b4bcoin
- Issues: https://github.com/B4Bcoin/bip21-b4bcoin/issues
- npm.io page: https://npm.io/package/bip21-b4bcoin

## Dependencies (1)

- [qs](https://npm.io/package/qs.md) ^6.3.0

## Recent versions

- 1.0.0 (latest) — 2019-01-22

## README

# bip21-b4bcoin

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

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



## Example

``` javascript
var bip21 = require('bip21-b4bcoin')

var decoded = bip21.decode('b4bcoin:BBgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH?amount=20.3&label=Foobar')

console.log(decoded)
// { address: 'BBgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH',
//   options: {
//     amount: 20.3,
//     label: 'Foobar' }
// }
//
// WARNING: Remember to error check the `.address`!

console.log(bip21.encode('BBgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH'))
// => b4bcoin:BBgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH

console.log(bip21.encode('BBgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH', {
	amount: 20.3,
	label: 'Foobar'
}))
// => b4bcoin:BBgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH?amount=20.3&label=Foobar
```


## License [MIT](LICENSE)

---
_Source: https://npm.io/package/bip21-b4bcoin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
