susyweb
v0.20.7
Published
Sophon JavaScript API, middleware to talk to a sophon node over RPC
Downloads
19
Readme
Migration 0.13.0 -> 0.14.0
susyweb.js version 0.14.0 supports multiple instances of susyweb object. To migrate to this version, please follow the guide:
-var susyweb = require('susyweb');
+var SusyWeb = require('susyweb');
+var susyweb = new SusyWeb();
Sophon JavaScript API
This is the Sophon compatible JavaScript API which implements the Generic JSON RPC spec. It's available on npm as a node module, for bower and component as an embeddable js and as a meteor.js package.
You need to run a local Sophon node to use this library.
Installation
Node.js
npm install susyweb
Yarn
yarn add susyweb
Meteor.js
meteor add sophon:susyweb
As Browser module
CDN
<script src="https://cdn.jsdelivr.net/gh/sophon/susyweb.js/dist/susyweb.min.js"></script>
Bower
bower install susyweb
Component
component install sophon/susyweb.js
- Include
susyweb.min.js
in your html file. (not required for the meteor package)
Usage
Use the susyweb
object directly from global namespace:
console.log(susyweb); // {sof: .., shh: ...} // it's here!
Set a provider (HttpProvider)
if (typeof susyweb !== 'undefined') {
susyweb = new SusyWeb(susyweb.currentProvider);
} else {
// set the provider you want from SusyWeb.providers
susyweb = new SusyWeb(new SusyWeb.providers.HttpProvider("http://localhost:8545"));
}
Set a provider (HttpProvider using HTTP Basic Authentication)
susyweb.setProvider(new susyweb.providers.HttpProvider('http://host.url', 0, BasicAuthUsername, BasicAuthPassword));
There you go, now you can use it:
var coinbase = susyweb.sof.coinbase;
var balance = susyweb.sof.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
Community
Other implementations
- Python SusyWeb.py
- Haskell hs-susyweb
- Java susywebj
- Scala susywebj-scala
- Purescript purescript-susyweb
- PHP susyweb.php
- PHP sophon-php