tum3 v0.1.3

MOAC JavaScript API version 0.1.15.

This is the MOAC compatible JavaScript API which implements the Generic JSON RPC spec as described in the Tum3.md. It's available on npm as a node module, for bower and component as an embeddable js and as a meteor.js package.

• v0.1.15 Added local MOAC sign and verify signature methods.
• v0.1.14 Fixed document errors.
• v0.1.13 Added scs_getBlockList method.
• v0.1.12 Fixed Readme and missing scs_getMicroChainInfo method.
• v0.1.11 Added scs method getMicroChainInfo to work with subchain explorer.
• v0.1.10 Added vnode and scs methods to work with MicroChains.
• v0.1.9 Added new method to get ip for local node.
• v0.1.8 Moved git repository to https://github.com/MOACChain/tum3 and fixed some bugs.
• v0.1.7 Fixed uneven signature R & S.
• v0.1.6 A complete package with all tests.
• v0.1.4 First compatible version with MOAC chain.

Some of the methods require running a local MOAC node to use this library. To use vnode methods, need to enable the vnode APIs in MOAC node by: --rpc --rpcport "8545" --rpcapi "tum3,mc,net,vnode"

To use scs methods, need to enable the SCS RPC ports by: --rpc

More information is in Tum3.md or MOAC wiki.

Installation

Node.js

npm install tum3

As Browser module

Bower

bower install tum3

Meteor.js

meteor add moaclib:tum3

• Include tum3.min.js in your html file. (not required for the meteor package)

Usage

Use the tum3 object directly from global namespace:

var Tum3 = require('tum3');
var tum3 = new Tum3();
console.log(tum3); // {mc: .., net: ...} // it's here!

Set a provider (HttpProvider) with VNODE:

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

Set a provider (HttpProvider using HTTP Basic Authentication)

tum3.setProvider(new tum3.providers.HttpProvider('http://host.url', 0, BasicAuthUsername, BasicAuthPassword));

There you go, now you can use it:

var coinbase = tum3.mc.coinbase;
var balance = tum3.mc.getBalance(coinbase);

To work with SCS servers, need to enable the rpc port on SCS monitors and set the scsProvider for tum3.

if (typeof tum3 !== 'undefined') {
  tum3 = new Tum3(tum3.currentProvider);
} else {
  // set the provider you want from Tum3.providers
  tum3 = new Tum3(new Tum3.providers.HttpProvider("http://localhost:8545"));
  tum3.setScsProvider(new tum3.providers.HttpProvider('http://localhost:8548'));
}

After set the SCS monitor, now you can use it:

mclist=tum3.scs.getMicroChainList();
console.log("SCS MicroChain List:", mclist);

console.log("MicroChain state:", tum3.scs.getDappState(mclist[0]));
console.log("MicroChain blockNumber:", tum3.scs.getBlockNumber(mclist[0]));

More examples are under the 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)

Require install gulp (https://gulpjs.com/) in the system:

npm run-script build

Testing (mocha)

Test all cases. May need to install package mocha first.

mocha

Test a singe function.

mocha test/tum3.mc.coinbase.js 

Some examples

send_mc

Example codes to send moac through signed transaction.

var rawTx = {
      from: src.addr,
      nonce: tum3.intToHex(txcount),
      gasPrice: tum3.intToHex(2000000000),

gasLimit: tum3.intToHex(2000), to: '0xf1f5b7a35dff6400af7ab3ea54e4e637059ef909', value: tum3.intToHex(tum3.toSha(value, 'mc')), data: '0x00', chainId: chainid }

var cmd1 = tum3.signTransaction(rawTx, src["key"]);
    
tum3.mc.sendRawTransaction(cmd1, function(err, hash) {
    if (!err){
        console.log("Succeed!: ", hash);
        return hash;
    }else{
        console.log("Tum3 error:", err.message);
        return err.message;
    }

});

contract_deploy

Deploy a contract through tum3 RPC calls. This example requires install solc solc

build a web server to access the MOAC network using this API library.

sign and verify the signatures

Example codes to sign a message using MOAC network and verify the signature.

// Connect with the MOAC network tum3.setProvider(new tum3.providers.HttpProvider('http://gateway.moac.io/mainnet'));

if (!tum3.isConnected()){ console.log("Tum3 RPC is not connected!"); return; }

// Hash the message let sha3Msg = tum3.sha3("HELLO MOAC!");

// Unlock the account 'tacct.addr' before signing let signedData = tum3.mc.sign(tacct.addr, sha3Msg);

// or you can call the local function to get the same result, but require a private key let signedData = tum3.signMcMessage(sha3Msg,tacct.key);

// Verify the signature with the message and the address console.log("Verify:", tum3.verifyMcSignature(sha3Msg, signedData, tacct.addr))；

Accounts use the following library for generating private key.

browserify-cryptojs v0.3.1