This repository is not maintained anymore. It has been moved to https://github.com/paritytech/js-libs/tree/master/packages/api.
Parity.js is a thin, fast, Promise-based wrapper around the Ethereum APIs.
Install the package with npm install --save @parity/api
// import the actual Api class
import Api from '@parity/api';
// do the setup
const provider = new Api.Provider.Http('http://localhost:8545');
const api = new Api(provider);perform a call
api.eth
.coinbase()
.then((coinbase) => {
console.log(`The coinbase is ${coinbase}`);
});multiple promises
Promise
.all([
api.eth.coinbase(),
api.net.listening()
])
.then(([coinbase, listening]) => {
// do stuff here
});chaining promises
api.eth
.newFilter({...})
.then((filterId) => api.eth.getFilterChanges(filterId))
.then((changes) => {
console.log(changes);
});attach contract
const abi = [{ name: 'callMe', inputs: [{ type: 'bool', ...}, { type: 'string', ...}]}, ...abi...];
const address = '0x123456...9abc';
const contract = api.newContract(abi, address);find & call a function
contract.instance
.callMe
.call({ gas: 21000 }, [true, 'someString']) // or estimateGas or postTransaction
.then((result) => {
console.log(`the result was ${result}`);
});APIs implement the calls as exposed in the Ethcore JSON Ethereum RPC definitions. Mapping follows the naming conventions of the originals, i.e. eth_call becomes eth.call, personal_accounts becomes personal.accounts, etc.
For operation within a public node, the following peerDependencies needs to be added (this functionality will be moved shortly) -