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

z32check

v0.0.2

Published

z-base-32 checksum encoding

Downloads

4

Readme

z32check

z-base-32 encoding library with 4-byte checksum.

This library is meant for generating and decoding Stacks addresses on the Blockstack blockchain.

How it works

Each z32check string encodes a 1-byte version and a 4-byte checksum. When decoded as a hex string, the wire format looks like this:

0      1                             n+1             n+5
|------|-----------------------------|---------------|
version     n-byte hex payload          4-byte hash

If version is the version byte (a 1-byte number) and payload is the raw bytes (e.g. as a string), then the checksum is calculated as follows:

checksum = sha256(sha256(version + payload)).substring(0,4)

In other words, the checksum is the first four bytes of the double-sha256 of the bytestring concatenation of the version and payload. This is similar to base58check encoding, for example.

z32 Addresses

Specific to Blockstack, the Stacks blockchain uses z32-encoded public key hashes as addresses. Specifically, a z32 address is a z32-encoded ripemd160 hash, where the first character is capitalized (note that the z-base-32 alphabet does not have capital letters).

Examples

> z32 = require('z32check')
{ z32encode: [Function: z32encode],
  z32decode: [Function: z32decode],
  z32checkEncode: [Function: z32checkEncode],
  z32checkDecode: [Function: z32checkDecode],
  z32address: [Function: z32address],
  z32addressDecode: [Function: z32addressDecode],
  versions: 
   { mainnet: { p2pkh: 22, p2sh: 11 },
     testnet: { p2pkh: 17, p2sh: 2 } } }

z32encode, z32decode

> z32check.z32encode(Buffer.from('hello world').toString('hex'))
'decisga53yq7zzr5dr'
> z32check.z32decode('decisga53yq7zzr5dr')
'68656c6c6f20776f726c64'
> Buffer.from('68656c6c6f20776f726c64', 'hex').toString()
'hello world'

z32checkEncode, z32checkDecode

> version = 12
12
> z32check.z32checkEncode(version, Buffer.from('hello world').toString('hex'))
'cpb1sa5dxrb5s6huccoawk3ce'
> z32check.z32checkDecode('cpb1sa5dxrb5s6huccoawk3ce')
[ 12, '68656c6c6f20776f726c64' ] 
> Buffer.from('68656c6c6f20776f726c64', 'hex').toString()
'hello world'

z32address, z32addressDecode

NOTE: these methods only work on ripemd160 hashes

> hash160 = 'a46ff88886c2ef9762d970b4d2c63678835bd39d'
'a46ff88886c2ef9762d970b4d2c63678835bd39d'
> version = z32check.versions.mainnet.p2pkh
22
> z32check.z32address(version, hash160)
'Sn1g96reo5bq9f5n5famjwsgg3hegs6uuia5jq18'
> z32check.z32addressDecode('Sn1g96reo5bq9f5n5famjwsgg3hegs6uuia5jq18')
[ 22, 'a46ff88886c2ef9762d970b4d2c63678835bd39d' ]