History

Jaco Greeff a328eef8d9 UI 2 Api providers (#5714 ) * Add providers * Convert rpc calls to use provider * Update SecureApi for provider		2017-05-31 12:08:04 +02:00
..
test	Fix whitespace (#4299 )	2017-01-25 18:51:41 +01:00
package.json	Updating paths to repos. (#5330 )	2017-03-29 15:17:27 +02:00
README.md	UI 2 Api providers (#5714 )	2017-05-31 12:08:04 +02:00

README.md

@parity/parity.js

Parity.js is a thin, fast, Promise-based wrapper around the Ethereum APIs.

https://github.com/paritytech/parity/tree/master/js/src/api

installation

Install the package with npm install --save @parity/parity.js

usage

initialisation

// import the actual Api class
import { Api } from '@parity/parity.js';

// do the setup
const provider = new Api.Provider.Http('http://localhost:8545');
const api = new Api(provider);

making calls

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);
  });

contracts

attach contract

const abi = [{ name: 'callMe', inputs: [{ type: 'bool', ...}, { type: 'string', ...}]}, ...abi...];
const address = '0x123456...9abc';
const contract = new 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

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.