nanocurrency-js

A toolkit for the Nano cryptocurrency, allowing you to derive keys, generate seeds, hashes, signatures, proofs of work and blocks.

Code showcase

The documentation is available in the DOCUMENTATION.md file.

Usage

npm install nanocurrency
# or yarn add nanocurrency

Performance

You might be wondering how fast is the work generation. There's a pow-benchmark example in the examples/ directory. On an Intel Core i7-8550U CPU, with 100 iterations, the average computation time is 18.5s per work.

Considering you can pre-compute and cache the work prior to an actual transaction, this should be satisfying for a smooth user experience.

Contribute

Contributions are very welcome. To develop, make use of the following commands (using Yarn):

yarn build:dev: build the C++ code to WebAssembly and bundle the files into the dist directory, without optimization so that it is fast while developing. Note that you'll need to have Docker installed
yarn test: test the code
yarn lint: lint the code against JavaScript Standard Style
yarn generate-docs: generate the DOCUMENTATION.md file from the JSDoc annotations

Helpful materials

Article about seed / secret key / public key / address generation: https://medium.com/@benkray/raiblocks-deterministic-keys-8cb869cc6046
BLAKE2 reference implementation, used for hashing: https://github.com/BLAKE2/BLAKE2
Ed25519 portable implementation from Orson PETERS, used for keypair/signing: https://github.com/orlp/ed25519. Note: The library has been modified to use BLAKE2b instead of SHA-512
tiny-bignum-c from kokke, used for amount representation: https://github.com/kokke/tiny-bignum-c

Donations

If you like the project, feel free to donate some nano:

xrb_3mrogerjhkdyj6mzf4e7aatf3xs3gp4stwc9yt9ymgasw7kr7g17t4jwwwy8