Skip to content
TypeScript Ethereum JSON RPC client
Branch: master
Clone or download
Latest commit ea1ccbf Sep 19, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github initial commit Sep 13, 2018
src linting Sep 14, 2018
.gitignore initial commit Sep 13, 2018
.npmignore initial commit Sep 13, 2018
.prettierignore initial commit Sep 13, 2018
.travis.yml remove latest Sep 13, 2018
CHANGELOG.md chore(release): 1.2.1 Sep 18, 2018
LICENSE initial commit Sep 13, 2018
README.md Update README.md Sep 18, 2018
package-lock.json chore(release): 1.2.1 Sep 18, 2018
package.json chore(release): 1.2.1 Sep 18, 2018
tsconfig.json
tsconfig.module.json initial commit Sep 13, 2018
tslint.json initial commit Sep 13, 2018

README.md

eth-jsonrpc-client

Build Status codecov NPM version

Lightweight HTTP and WebSocket JSON RPC client for Ethereum, compatible with both geth and parity, made for polling blocks for the Ethercast project. Great for when Web3 is too heavy, and the only functionality required is to query the JSON RPC.

Installation

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

Usage

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

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

import { getClient } from '@ethercast/eth-jsonrpc-client';

async function printBlockNumber(): Promise<void> {
  const validatedClient = getClient('http://infura.node.io/my-api-key', true);
  const blockNumber = await validatedClient.eth_blockNumber();
  console.log(`blockNumber is ${blockNumber}`);
}

API Docs

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

You can’t perform that action at this time.