ethjs-query

A simple module for querying the Ethereum RPC layer.

Install

npm install --save @metamask/ethjs-query

Usage

const BN = require('bn.js');
const HttpProvider = require('@metamask/ethjs-provider-http');
const Eth = require('@metamask/ethjs-query');
const eth = new Eth(new HttpProvider('http://localhost:8545'));

eth.getBalance('0x407d73d8a49eeb85d32cf465507dd71d507100c1', cb);

// result null <BN ...>

eth.sendTransaction({
  from: '0x407d73d8a49eeb85d32cf465507dd71d507100c1',
  to: '0x987d73d8a49eeb85d32cf462207dd71d50710033',
  value: new BN('6500000'),
  gas: 3000000,
  data: '0x',
}).then(cb).catch(cb);

// result null 0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470

About

A simple Ethereum RPC module for querying data from an Ethereum node such as a geth (go-etherem), parity (rust-ethereum) or TestRPC (local js-ethereum).

This module supports all Ethereum RPC methods and is designed completely to specification.

Amorphic Data Formatting

ethjs-query uses the ethjs-format module to format incoming and outgoing RPC data payloads. The primary formatting task is numbers. Number values can be inputed as: BigNumber, BN, string, hex or actual numbers. Because the blockchain does not support decimal or negative numbers, any kind of decimal or negative number will cause an error return. All received number values are returned as BN.js object instances.

Read more about the formatting layer here: ethjs-format

Async Only

All methods are async only, requiring either a callback or promise.

Error handling

Error handling is done through function callbacks or promised catches.

Debugging Options

ethjs-query comes equip with a full debug options for all data inputs and outputs.

const HttpProvider = require('@metamask/ethjs-provider-http');
const Eth = require('@metamask/ethjs-query');
const eth = new Eth(new HttpProvider('http://localhost:8545'), { debug: true, logger: console, jsonSpace: 0 });

eth.accounts(cb);

/* result
[ethjs-query 2016-11-27T19:37:54.917Z] attempting method accounts with params [null]
[ethjs-query 2016-11-27T19:37:54.917Z] [method 'accounts'] callback provided: true
[ethjs-query 2016-11-27T19:37:54.917Z] [method 'accounts'] attempting input formatting of 0 inputs
[ethjs-query 2016-11-27T19:37:54.917Z] [method 'accounts'] formatted inputs: []
[ethjs-query 2016-11-27T19:37:54.917Z] [method 'accounts'] attempting query with formatted inputs...
[ethjs-query 2016-11-27T19:37:54.919Z] [method 'accounts'] callback success, attempting formatting of raw outputs: ["0xb88643569c19d05dc67b960f91d9d696eebf808e","0xf...]
[ethjs-query 2016-11-27T19:37:54.919Z] [method 'accounts'] formatted outputs: ["0xb88643569c19d05dc67b960f91d9d696eebf808e","0xf...]
*/

Supported Methods

ethjs-query supports all Ethereum specified RPC methods.

const HttpProvider = require('@metamask/ethjs-provider-http');
const Eth = require('@metamask/ethjs-query');
const eth = new Eth(new HttpProvider('http://localhost:8545'));

eth.protocolVersion(cb);

// ....

• eth.protocolVersion

• eth.syncing

• eth.coinbase

• eth.mining

• eth.hashrate

• eth.gasPrice

• eth.accounts

• eth.blockNumber

• eth.getBalance

• eth.getStorageAt

• eth.getTransactionCount

• eth.getBlockTransactionCountByHash

• eth.getBlockTransactionCountByNumber

• eth.getUncleCountByBlockHash

• eth.getUncleCountByBlockNumber

• eth.getCode

• eth.sign

• eth.sendTransaction

• eth.sendRawTransaction

• eth.call

• eth.estimateGas

• eth.getBlockByHash

• eth.getBlockByNumber

• eth.getTransactionByHash

• eth.getTransactionByBlockHashAndIndex

• eth.getTransactionByBlockNumberAndIndex

• eth.getTransactionReceipt

• eth.getUncleByBlockHashAndIndex

• eth.getUncleByBlockNumberAndIndex

• eth.getCompilers

• eth.compileLLL

• eth.compileSolidity

• eth.compileSerpent

• eth.newFilter

• eth.newBlockFilter

• eth.newPendingTransactionFilter

• eth.uninstallFilter

• eth.getFilterChanges

• eth.getFilterLogs

• eth.getLogs

• eth.getWork

• eth.submitWork

• eth.submitHashrate

• eth.web3_clientVersion

• eth.web3_sha3

• eth.net_version

• eth.net_peerCount

• eth.net_listening

• eth.db_putString

• eth.db_getString

• eth.db_putHex

• eth.db_getHex

• eth.shh_post

• eth.shh_version

• eth.shh_newIdentity

• eth.shh_hasIdentity

• eth.shh_newGroup

• eth.shh_addToGroup

• eth.shh_newFilter

• eth.shh_uninstallFilter

• eth.shh_getFilterChanges

• eth.shh_getMessages

Contributing

Please help better the ecosystem by submitting issues and pull requests to ethjs-query. We need all the help we can get to build the absolute best linting standards and utilities. We follow the AirBNB linting standard and the unix philosophy.

Guides

You'll find more detailed information on using ethjs-query and tailoring it to your needs in our guides:

• User guide - Usage, configuration, FAQ and complementary tools.
• Developer guide - Contributing to ethjs-query and writing your own code and coverage.

Help out

There is always a lot of work to do, and will have many rules to maintain. So please help out in any way that you can:

• Create, enhance, and debug ethjs rules (see our guide to "Working on rules").
• Improve documentation.
• Chime in on any open issue or pull request.
• Open new issues about your ideas for making ethjs-query better, and pull requests to show us how your idea works.
• Add new tests to absolutely anything.
• Create or contribute to ecosystem tools, like modules for encoding or contracts.
• Spread the word.

Please consult our Code of Conduct docs before helping out.

We communicate via issues and pull requests.

Important documents

• Changelog
• Code of Conduct
• License

Licence

This project is licensed under the MIT license, Copyright (c) 2016 Nick Dodson. For more information see LICENSE.md.

The MIT License

Copyright (c) 2016 Nick Dodson. nickdodson.com

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.