rgcweb v2.3.2
What is RgcWeb?
RgcWeb 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 RGC'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.
RgcWeb is also compatible with frontend frameworks such as:
- Angular
- React
- Vue.
You can also ship RgcWeb in a Chrome extension.
Installation
Node.js
npm install rgcweb
or
yarn add rgcweb
Browser
First, don't use the release section of this repo, it has not updated in a long time.
Then easiest way to use RgcWeb in a browser is to install it as above and copy the dist file to your working folder. For example:
cp node_modules/rgcweb/dist/RgcWeb.js ./js/rgcweb.js
so that you can call it in your HTML page as
<script src="./js/rgcweb.js"><script>
Creating an Instance
First off, in your javascript file, define RgcWeb:
const RgcWeb = require('rgcweb')
The easiest way to instantiate rgcWeb is to run
const rgcWeb = new RgcWeb({
fullHost: 'http://<ip:port>',
privateKey: '...'
})
but you can continue to use the old way:
const rgcWeb = new RgcWeb(fullNode, solidityNode, eventServer, privateKey)
const rgcWeb = new RgcWeb({
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 RgcWeb dist files —
npm run build
- run a local private network using Rgc 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 rgcWeb, passing an options object instead that
fullNode
,solidityNode
andeventServer
as separate params - Fixes bug in
_watch
which causes an ethernal update of thesince
parameter
Licence
RgcWeb is distributed under a MIT licence.