polluxweb v1.1.1-stable

What is PoxWeb?

PoxWeb 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 Pollux's unique feature set along with offering new tools for integrating DApps in the browser, Node.js and IoT devices.

Project scope

Any new Pollux feature will be incorporated into PoxWeb. Changes to the API to improve quality-of-life are in-scope for the project. We will not necessarilly maintain feature parity with Web3.js going forward as this is a separate project, not a synchronized fork.

HomePage

PoxWeb.network

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.

PoxWeb is also compatible with frontend frameworks such as:

• Angular
• React
• Vue.

You can also ship PoxWeb in a Chrome extension.

Installation

Node.js

npm install polluxweb

or

yarn add polluxweb

Browser

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

cp node_modules/PoxWeb/dist/PoxWeb.js ./js/PoxWeb.js

so that you can call it in your HTML page as

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

This project is also published on NPM and you can access CDN mirrors of this release (please use sub-resource integrity for any <script> includes).

Testnet

yuvi is the official Pollux testnet. To use it use the following endpoint:

https://yuvi.poxscan.io

Get some yuvi pox at https://faucet.poxscan.io/and play with it. Anything you do should be explorable on https://testnet.poxscan.io

Your local private network for heavy testing

You can set up your own private network, running Pollux Quickstart. To do it you must install Docker and, when ready, run a command like

docker run -it --rm \
  -p 9090:9090 \
  -e "defaultBalance=100000" \
  -e "showQueryString=true" \
  -e "showBody=true" \
  -e "formatJson=true" \
  --name Pollux \
  Polluxtools/quickstart

More details about Pollux Quickstart on GitHub

Creating an Instance

First off, in your javascript file, define PoxWeb:

const PoxWeb = require('Polluxweb')

When you instantiate Polluxweb you can define

• fullNode
• solidityNode
• eventServer
• privateKey

you can also set a

• fullHost

which works as a jolly. If you do so, though, the more precise specification has priority. Supposing you are using a server which provides everything, like PolluxGrid, you can instantiate PoxWeb as:

const PoxWeb = new PoxWeb({
    fullHost: 'https://fullnode.poxscan.io/',
    headers: { "Pollux-PRO-API-KEY": 'your api key' },
    privateKey: 'your private key'
})

For retro-compatibility, though, you can continue to use the old approach, where any parameter is passed separately:

const PoxWeb = new PoxWeb(fullNode, solidityNode, eventServer, privateKey)
PoxWeb.setHeader({ "Pollux-PRO-API-KEY": 'your api key' });

If you are, for example, using a server as full and solidity node, and another server for the events, you can set it as:

const PoxWeb = new PoxWeb({
    fullHost: 'https://fullnode.poxscan.io/',
    eventServer: 'https://api.someotherevent.io',
    privateKey: 'your private key'
  }
)

If you are using different servers for anything, you can do

const PoxWeb = new PoxWeb({
    fullNode: 'https://some-node.tld',
    solidityNode: 'https://some-other-node.tld',
    eventServer: 'https://some-event-server.tld',
    privateKey: 'your private key'
  }
)

A full example

The better way to understand how to work with PoxWeb is go to the demo directory in this repository.

If you'd like to connect with Polluxlink app and chrome extention and develop a dapp on Pollux, you could run the demo in path demo/Pollux-dapp-react-demo.

If you'd like to develop only with PoxWeb dependency, you could run the demo in path demo/PoxWeb-demo.

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 PoxWeb dist files — npm run build
• run a local private network using Pollux Quickstart
• run the tests — npm test:node
• push your changes and open a pull request