@onekeyfe/kaspa-core-lib

JavaScript Data Primitives Library for Kaspa
=============================================

PLEASE NOTE: This project is under heavy development and is not production ready

Based on the popular Bitcore library developed by BitPay for the Bitcoin, Kaspacore library provides primitives for interfacing with the Kaspa network.

Get Started
-----------

``sh git clone git@github.com:aspectron/kaspacore-lib`

Adding Kaspacore to your app's package.json:

`json "dependencies": { "aspectron/kaspacore-lib": "*" }`

Kaspa adaptation ----------------

Kaspacore library provides primitives such as Transaction and UTXO data structures customized for use with the next-generation high-performance Kaspa network.

Documentation -------------

The complete docs are hosted here: bitcore documentation. There's also a bitcore API reference available generated from the JSDocs of the project, where you'll find low-level details on each bitcore utility.

Building the Browser Bundle ---------------------------

To build a kaspacore-lib full bundle for the browser:

`sh gulp browser`

This will generate files named kaspacore-lib.js and kaspacore-lib.min.js`.

You can also use our pre-generated files, provided for each release along with a PGP signature by one of the project's maintainers. To get them, checkout the releases.

Contributing
------------

See CONTRIBUTING.md on the main bitcore repo for information about how to contribute.

License
-------

Code released under the MIT license.