Giter VIP home page Giter VIP logo

neb.js's Introduction

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.
CDN Support

neb.js has been released to NPM, and developers can use the following code through CDN addition.

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/nebulas.js"></script>

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.
  • Deploy/call smart contract, breakpoint debugging support.

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

Contribution

We are very glad that you are considering to help Nebulas Team or go-nebulas project, including but not limited to source code, documents or others.

If you'd like to contribute, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base. If you wish to submit more complex changes though, please check up with the core devs first on our slack channel to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.

Please refer to our contribution guideline for more information.

Thanks.

License

The go-nebulas project is licensed under the GNU Lesser General Public License Version 3.0 (“LGPL v3”).

For the more information about licensing, please refer to Licensing page.

neb.js's People

Contributors

qywang2012 avatar bogdandidenko avatar bibibong avatar ottokafka avatar chengorangeju avatar yupnano avatar fbzhong avatar nebulashub avatar yuxizhe avatar silentttttt avatar xbhuang1994 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.