JSPM

bip173

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2
  • Score
    100M100P100Q42801F
  • License ISC

nodejs version for bip173

Package Exports

  • bip173

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (bip173) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

bip173

A BIP173 compatible encoding/decoding library.

Example

let bip173 = require('bip173')

bip173.decode('abcdef1qpzry9x8gf2tvdw0s3jn54khce6mua7lmqqqxw')
// => {
// 	 prefix: 'abcdef',
// 	 words: [0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31]
// }

let words = bip173.toWords(Buffer.from('foobar', 'utf8'))
bip173.encode('foo', words)
// => 'foo1vehk7cnpwgry9h96'

Advanced

BIP173 enforces a limitation of 90 characters, if extend the LIMIT parameter beyond this, be aware that the effectiveness of checksum decreases as the length increases.

It is highly recommended NOT exceed 1023 characters, as the module could only guarantee detecting 1 error.

Credits

  • Peter Wuille for the reference JavaScript implementation, and for authoring the Bech32 BIP173.

License MIT