/neb.js

Primary LanguageCSSGNU Lesser General Public License v3.0LGPL-3.0

Nebulas JavaScript API

NPM

This is the Nebulas compatible JavaScript API. Users can use it in browser and node.js. This javascript library also support API for our Repl console. Users can sign/send transactions and deploy/call smart contract with it. neb.js

Install && Package

Use the npm installation dependencies

npm install

Use gulp to package the neb.js:

gulp

Now we can check the newly created files in /dist

Here you should see a bunch of js files.

  • neb.js:Used in browser side. Including outside dependency.
  • neb-light.js:Used in Repl console. Not including outside dependency.
  • nebulas.js: Fully functional in the browser. Users can create an address, sign a transaction, and deploy/call a smart contract.

Documentation

Public API documentation link

For build API documentation run gulp documentation task.

Generated documentation you can check in /documentation folder.

Usage

neb.js is a useful library for nebulas developers. It provides rich underlying support in web and node.js's dapp. It implements the following functions.

  • The RPC interface for the nebulas node is encapsulated;
  • Create and manage the private key and address of the nebulas;
  • Generate the transaction object and sign the transaction.

The use of neb.js can be used as examples:

Extra

Rollup is a module bundler for JavaScript which compiles small pieces of code into something larger and more complex, such as a library or application.

Next step go to the neb.js folder in your Nebulas dir and Build neb-node.js by using rollup:

rollup -c