Libnexajs

This library is a fork of Bitcore Lib Cash library with changes to make it work for Nexa project. The library still in development, don't use it in production!

Libnexa Javascript library

Principles

Nexa is another powerful peer-to-peer platform for the next generation of financial technology. The decentralized nature of the Nexa network allows for highly resilient nexa infrastructure, and the developer community needs reliable, open-source tools to implement nexa apps and services.

Get Started

npm i libnexa-js

Adding libnexa-js to your app's package.json:

"dependencies": {
    "libnexa-js": "^1.0.0",
    ...
}

Documentation

The complete docs are hosted here: libnexa-js documentation.

Examples

• Generate a random address
• Generate a HD masterkey using Bip39
• Generate a address from a SHA256 hash
• Import an address via WIF (Wallet Import Format)
• Create a Transaction
• Sign a Bitcoin message
• Verify a Bitcoin message
• Create an OP RETURN transaction
• Create a 2-of-3 multisig P2SH address
• Spend from a 2-of-2 multisig P2SH address

Building the Browser Bundle

To build libnexa full bundle for the browser:

gulp browser

This will generate files named libnexa.js and libnexa.min.js.

Development

git clone https://gitlab.com/nexa/libnexa-js.git
cd libnexa-js
npm install

Tests

Install Mocha for tests

install as development dependency for your project

npm install --save-dev mocha

Run all the tests

npm test

Run a specific test

./node_modules/mocha/bin/mocha.js test/example.js

You can also run just the Node.js tests with gulp test:node, just the browser tests with gulp test:browser or create a test coverage report (you can open coverage/lcov-report/index.html to visualize it) with gulp coverage.

Security

We're using libnexa in production in the Otoplo wallet, as are many others, but please use common sense when doing anything related to finances! We take no responsibility for your implementation decisions.

If you find a security issue, please email [email protected]

Contributing

Feel free to open an MR and we will review it.

License

Code released under the MIT license.

Copyright 2024, Maintained by Bitcoin Unlimited Developers.