QuarkChain JavaScript API

QuarkChain’s client library is built around web3.js which is the Javascript-based client library for Quarkchain JSON RPC.

#Description The current client library quarkchain-web3.js ( https://github.com/QuarkChain/quarkchain-web3.js ) is built around web3.js without modifying the source code of web3.js. This is a quick hack to get a working client library with basic features. But in the long run we would like to have a client library that built upon the native QuarkChain JSON RPCs as described in https://developers.quarkchain.io/#json-rpc . This task is to build this client library in JavaScript with at least the same features provided in quarkchain-web3.js. The new library should use native QuarkChain RPCs rather than the eth* ones. The lastest RPC interfaces can be found in https://github.com/QuarkChain/pyquarkchain/blob/master/quarkchain/cluster/jsonrpc.py . Note that in most cases the interfaces of the client library should be the same as web3.js ( https://github.com/ethereum/wiki/wiki/JavaScript-API ). Since the eth APIs only accept ETH address (20 bytes) while the QKC address is (24 bytes), quarkchain-web3.js APIs do not have a block identifier parameter ( https://github.com/ethereum/wiki/wiki/JavaScript-API#web3ethdefaultblock ) as it passes the shard id to the eth_ APIs through the block identifier parameter. However, the new client library should be able to take block identifier as a parameter since the native RPCs accept QKC address. Your submission will be judged on feature completeness and code quality. Implementing additional features that are not in quarkchain-web3.js but available in web3.js will get bonus points.

Implemented methods

• qkc3.qkc.getBalance()
• qkc3.qkc.getTransactionCount()
• qkc3.qkc.getCode()
• qkc3.qkc.getTransactionReceipt
• qkc3.qkc.getAccountData()
• qkc3.qkc.sendTransaction() Server issues #178
• qkc3.qkc.call() Server issues #178

Run demo on Docker

You can build a docker image with all the dependencies installed using this Dockerfile

docker build -t quarkchain-qkc .
docker run quarkchain-qkc

Result:

init
HASH: 0x68fB978BF0e4c69bA338D4Fa5A4e5EAA88438AA819e189EC
TRUE: true
----------------------------------------------------------------
balance:
{ branch: '0x2c', shard: '0xc', balance: '0x0' }
----------------------------------------------------------------
getTransactionCount:
0x0
----------------------------------------------------------------
getCode:
0x
----------------------------------------------------------------
getTransactionReceipt:
null
----------------------------------------------------------------

Run demo

node ./example/node-app.js

Documentation

Contribute!

Requirements

• Node.js
• npm

# 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+ © 2015 Contributors