Nebulas payment Javascript SDK
Switch branches/tags
Nothing to show
Clone or download
Latest commit c4c5531 Aug 13, 2018

README.md

nebPay

NPM

This is the Nebulas payment JavaScript API. Users can use it in browser on both PC and mobile. Users can do NAS payment through Chrome extension and iOS/Android wallet with it. nebPay

Install && Package

Use npm to install dependencies:

npm install

Notice:The official version of the package in NPMJS is nebpay.js, not nebpay and etc.

Use gulp to package the nebPay:

gulp

Now we can check the newly created files in /dist

Here you should see a bunch of js files.

  • nebPay.js: Used in browser side. Including outside dependency.
CDN Support

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

<script src="https://cdn.jsdelivr.net/npm/nebpay.js@0.2.1/dist/nebPay.min.js"></script>

Usage

nebPay.js is a useful library for Nebulas DApp developers. It provides rich underlying support in web's DApp. It implements the payment functions.

For the usage of nebPay please refer to this example:

Wallet support

iOS/Android wallet

Nebpay supports evoking mobile wallets, allowing users to pay via their phones. Mobile payment is safe and convenient. We recommend you to pay by mobile wallet.


Tips:NAS Nano also provides a test version of the wallet for the Testnet, which only supports the use of the wallet in the Testnet for developers to test.

  • iOS for Testnet(itms-services://?action=download-manifest&url=https://testnet.nebulas.io/static/wallet/ios/NASnano.plist)
  • Android for Testnet

Chrome extension wallet

An implementation of chrome extension contributed by community is:

The parameter options.callback is used for querying transaction result. And it's mainnet by default if you don't specify it.

  • to select mainnet: callback : NebPay.config.mainnetUrl (default value)
  • to select testnet: callback : NebPay.config.testnetUrl

Documentation

All NebPay SDK documents are in doc folder.

And also there is a blog tutorial:

The process of a transaction using NebPay

Wiki

Please check our Wiki to learn more about Nebulas.

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.