kizunanocoin
v2.5.0
Published
A toolkit for KIZUNANO COIN, allowing you to derive keys, generate seeds, hashes, signatures, proofs of work and blocks.
Downloads
7
Maintainers
Readme
kizunanocoin
A battle-tested toolkit for KIZUNANO COIN.
If you are looking for legacy blocks, you will want the ^1.0.0
versions.
The documentation is available locally in docs/
or online at https://kizunanocoin.github.io/kizunanocoin-js/packages/kizunanocoin/docs/.
Features
- Generate seeds
- Derive secret keys, public keys and addresses
- Hash blocks
- Sign and verify blocks
- Compute and test proofs of work
- Check the format of seeds, secret keys, public keys, addresses, amounts, etc.
- Convert Nano units
- CLI doing all of the above
Usage
To install the library:
npm install kizunanocoin
# or yarn add kizunanocoin
import * as kizunanocoin from 'kizunanocoin'
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 thedist/
directory, without optimization so that it is fast while developing. Note that you'll need to have Docker installedyarn test
: test the codeyarn lint
: lint the code against JavaScript Standard Styleyarn generate-docs
: generate thedocs/
website from the JSDoc annotations
Donations
If you like the project, feel free to donate some nano:
kizn_31oh1g739gh6gk4uisb75h7makxsy1xqyi3jckmkh8n6pegbphnswxoeyhrf