rue-web3 v0.20.8
Migration 0.13.0 -> 0.14.0
web3.js version 0.14.0 supports multiple instances of web3 object. To migrate to this version, please follow the guide:
-var web3 = require('web3');
+var Web3 = require('web3');
+var web3 = new Web3();
Rue JavaScript API
This is the Rue compatible JavaScript API based on Ethereum's Javascript API. This API implements the Generic JSON RPC spec from Ethereum. It's available on npm as a node module, for bower and component as an embeddable js and as a meteor.js package.
This API is for Rue Alpha, while front-end components refer to "Rue", "RGwei", "Rwei" all backend commands still utilize the "eth" namespace from web3 to allow for greater flexibility in developers looking to adapt their Ethereum dApps over to Rue. You will need to use commands like web3.eth.getBalance() for the time being.
The Rue team plans to transition these backend API commands in the future once the Rue ecosystem is more robust and stable, which will allow third-party developers to justify time upkeeping a separate fork of their dApps for the Rue Network. The Rue team will announce these changes at least 6 months prior to the launch of the rue. namespace, and once launched will have a one-year 'sunset phase' supporting both namespaces before removing the eth. command namespace.
You need to run a local Rue (GRUE) node to use this library.
Installation
Node.js
npm install web3
Yarn
yarn add web3
Meteor.js
meteor add rue:web3
As Browser module
Bower
bower install web3
Component
component install rue/web3.js
- Include
web3.min.js
in your html file. (not required for the meteor package)
Usage
Use the web3
object directly from global namespace:
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://host.url', 0, BasicAuthUsername, BasicAuthPassword));
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 example
directory.
Contribute!
Requirements
- Node.js
- npm
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