bitcoinjs / bip21

A BIP21 compatible URL encoding utility library

bip21

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 MIT

bip21's Issues

Support :// linking syntax

Variables which are prefixed with a req- are considered required

Capitalized scheme throws

Not sure if it's a valid issue, but
bitcoin:1BgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH?amount=20.3&label=Foobar decodes fine while BITCOIN:1BgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH?amount=20.3&label=Foobar throws Invalid BIP21 URI

Typescript declaration file

The @types/bip21 type declaration is for the 1.x series and doesn't reflect the API changes in 2.x version. Would you be interested in officialy supporting a typescript declaration file?

I'd happily open a PR to add it so it can be distributed as part of the bip21 npm package.

Support parsing of other variables

They obviously can't be validated for any purpose, but they can still be given back to the user.
Right now the parse results are restricted to the variables address, amount, label and message.

Validate that no comma is used in the amount

From the BIP21:

If an amount is provided, it MUST be specified in decimal BTC. All amounts MUST contain no commas and use a period (.) as the separating character to separate whole numbers and decimal fractions. I.e. amount=50.00 or amount=50 is treated as 50 BTC, and amount=50,000.00 is invalid.

Source: https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki#transfer-amount

May I suggest that extra validation is added if amount contains a comma and throw error?