npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

bstring-errors

v0.0.3

Published

bstring based address error detector.

Downloads

2

Readme

bstring-errors

This is a tool to detect errors in bech32 and cashaddr addresses (up to 2 errors). This will only return error positions and wont attempt to fix the address, because it might lead to incorrect fixes in some cases.

Installation

You can install using npm.

For usage as a library npm i bstring-errors or
For binaries npm i -g bstring-errors

bin usage

This repo comes with two binaries: bech32-errors and bcashaddr-errors.

bech32-errors usage

bech32-errors:
  Usage:
    bech32-errors addresses...
    bech32-errors address0 address1...

  Options:
    -h  Show this message

bcashaddr-errors usage

cashaddr-errors:
  Usage:
    cashaddr-errors addresses...
    cashaddr-errors address0 address1...

  Options:
    -h  Show this message
    --prefix    Default prefix[bitcoincash]

lib usage

const {bech32, cashaddr} = require('bstring-errors');

// Bech32 
// correct
const bech1 = 'bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4';
// with error
const bech2 = 'bc1qw500d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4';
// can't detect
const bech3 = 'bc13333336qejxtdg4y5r3zarvary0c5xw7kv8f3t4';

// returns empty array
console.log(bech32.locateErrors(bech1));

// [ 7 ]
console.log(bech32.locateErrors(bech2));

// Throws "Invalid Address, Could not locate errors."
console.log(bech32.locateErrors(bech3));

// CashAddr

const prefix = 'bitcoincash';
// correct
const cashaddr1 = 'bitcoincash:qpzry9x8gf2tvdw0s3jn54khce6mua7lcw20ayyn';
// with error
const cashaddr2 = 'bitcoincash:qpzry988gf2tvdw0s3jn54khce6mua7lcw20ayyn';
// no recovery
const cashaddr3 = 'bitcoincash:999999x8gf2tvdw0s3jn54khce6mua7lcw20ayyn';

// returns empty array
console.log(cashaddr.locateErrors(cashaddr1, prefix));

// [ 18 ]
console.log(cashaddr.locateErrors(cashaddr2, prefix));

// Throws "Invalid Address, Could not locate errors."
console.log(cashaddr.locateErrors(cashaddr3, prefix));

bin example

$ bech32-errors bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4
bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4

$ bech32-errors bc1qw500d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4 
bc1qw500d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4
       ^