Skip to content

PchainJS/PchainWeb3

Repository files navigation

Pchain JavaScript API

This is the Pchain compatible JavaScript API which implements the Generic JSON RPC spec. It's available on npm as a node module, for Bower and component as embeddable scripts.

NPM version Build Status dependency status dev dependency status Coverage Status Stories in Ready

You need to run a local Pchain node to use this library.

Documentation

Table of Contents

Installation

Node.js

npm install pweb3

Yarn

yarn add pweb3

### As a Browser module


Bower

```bash
bower install pweb3
  • Include pweb3.min.js in your html file. (not required for the meteor package)

Usage

Use the web3 object directly from the global namespace:

var Web3 = require("pweb3");
var web3 = new Web3();
console.log(web3); // {eth: .., shh: ...} // It's here!

Set a provider (HttpProvider):

if (typeof web3 !== 'undefined') {
  web3 = new Web3(web3.currentProvider);
} else {
  // Set the provider you want from Web3.providers
  web3 = new Web3(new Web3.providers.HttpProvider("http://localhost:8545"));
}

Set a provider (HttpProvider using HTTP Basic Authentication):

web3.setProvider(new web3.providers.HttpProvider('http://' + BasicAuthUsername + ':' + BasicAuthPassword + '@localhost:8545'));

There you go, now you can use it:

var coinbase = web3.eth.coinbase;
var balance = web3.eth.getBalance(coinbase);

You can find more examples in the example directory.

## Contribute!

### Requirements

* Node.js
* npm

```bash
# On Linux:
sudo apt-get update
sudo apt-get install nodejs
sudo apt-get install npm
sudo apt-get install nodejs-legacy

Building (gulp)

npm run-script build

Testing (mocha)

npm test

License

LGPL-3.0+ © 2018 Contributors

Releases

No releases published

Packages

No packages published