What is HxbWeb?

HxbWeb aims to deliver a unified, seamless development experience influenced by Ethereum's Web3 implementation. We have taken the core ideas and expanded upon it to unlock the functionality of HXB's unique feature set along with offering new tools for integrating DApps in the browser, Node.js and IoT devices.

Compatibility

• Version built for Node.js v6 and above
• Version built for browsers with more than 0.25% market share

You can access either version specifically from the dist folder.

HxbWeb is also compatible with frontend frameworks such as:

• Angular
• React
• Vue.

You can also ship HxbWeb in a Chrome extension.

Installation

Node.js

npm install hxbweb

or

yarn add hxbweb

Browser

First, don't use the release section of this repo, it has not updated in a long time.

Then easiest way to use HxbWeb in a browser is to install it as above and copy the dist file to your working folder. For example:

cp node_modules/hxbweb/dist/HxbWeb.js ./js/hxbweb.js

so that you can call it in your HTML page as

<script src="./js/hxbweb.js"><script>

Creating an Instance

First off, in your javascript file, define HxbWeb:

const HxbWeb = require('hxbweb')

The easiest way to instantiate hxbWeb is to run

const hxbWeb = new HxbWeb({
    fullHost: 'http://<ip:port>',
    privateKey: '...'
})

but you can continue to use the old way:

const hxbWeb = new HxbWeb(fullNode, solidityNode, eventServer, privateKey)

const hxbWeb = new HxbWeb({
    fullNode: 'http://<ip:port>',
    solidityNode: 'http://<ip:port>',
    eventServer: 'http://<ip:port>',
    privateKey: '...'
  }
)

similar to the old approach

Contributions

In order to contribute you can

• fork this repo and clone it locally
• install the dependencies — npm i
• do your changes to the code
• build the HxbWeb dist files — npm run build
• run a local private network using Hxb Quickstart
• run the tests — npm test:node
• push your changes and open a pull request

Recent History

2.3.1

• Adds support for not-tld domain, like http://localhost
• Improve the new format, allow passing the privateKey as a property in the option object

2.3.0

• Introduces new format to instantiate hxbWeb, passing an options object instead that fullNode, solidityNode and eventServer as separate params
• Fixes bug in _watch which causes an ethernal update of the since parameter

Licence

HxbWeb is distributed under a MIT licence.