@ethercast/eth-jsonrpc-client

eth-jsonrpc-client

Lightweight HTTP and WebSocket JSON RPC client for Ethereum, compatible with both geth and parity, made for polling blocks from Ethercast. Great for when Web3 is too heavy.

Installation

npm install --save @ethercast/eth-jsonrpc-client

Usage

There are three main classes exported from this module. EthHTTPClient, EthWebSocketClient, and ValidatedEthClient.

To construct a client, call getClient(nodeUrl: string) which will construct the appropriate client based on the URL (HTTP or WebSocket)

Once you have a client, use one of the supported methods on the interface or call an unsupported method using .cmd, e.g.:

import { EthClient } from '@ethercast/eth-jsonrpc-client';
import BigNumber from 'bignumber.js';

async function getBlockNumber(): BigNumber {
    const client: EthClient = getClient('http://infura.node.io/my-api-key');
    const blockNumber = await client.eth_blockNumber();
    console.log(`blockNumber is ${blockNumber}`);
}

API Docs

https://ethercast.github.io/eth-jsonrpc-client/

Changelog

1.1.1 (2018-09-14)

<a name="1.0.6"></a>