No description or website provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test
.eslintrc.yml
.gitignore
.travis.yml
LICENSE
README.md
foo.js
index.js
package-lock.json
package.json

README.md

Validate QRL Address

Build Status Coverage Status npm version

Synopsis

An npm package to validate (and extract data from) QRL addresses.

Code Example

var validate = require('@theqrl/validate-qrl-address');
var isValid = validate.hexString('Q01070050d31c7f123995f097bc98209e9231d663dc26e06085df55dc2f6afe3c2cd62e8271a6bd').result
console.log(isValid.result);
console.log(isValid.sig.type);
console.log(isValid.sig.number);
console.log(isValid.hash.function);

=>

true
XMSS
16384
SHAKE-128

Motivation

Provides a utility function to nodejs based applications. Part of a suite of development tools to simplify working within the QRL ecosystem.

Installation

npm install @theqrl/validate-qrl-address

API Reference

TODO (but the object returned is pretty self explanatory)

Inspecting this Pen may be of use.

Tests

Run with:

npm test

See test/test.js for examples.

  #validateHexString
    ✓ should return true: argument is a valid address
    ✓ should return xmss as name of signature scheme
    ✓ should return XMSS tree height of 14
    ✓ should return number of XMSS signatures as 16384 (2^14)
    ✓ should return shake-128 as name of the hashing method
    ✓ should return false: argument is NOT a valid address
    ✓ should return false: argument does NOT have an initial Q
    ✓ should return true: argument is a valid address length
    ✓ should return false: argument is NOT a valid address length
    ✓ should return true: argument does have a valid hashing mechanism
    ✓ should return false: argument does NOT a valid hashing mechanism
    ✓ should return false: argument does NOT a valid checksum

Contributors

JP Lomas

License

MIT