TypeScript Ethereum JSON RPC client
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
src
.gitignore
.npmignore
.prettierignore
.travis.yml
CHANGELOG.md
LICENSE
README.md
package-lock.json
package.json
tsconfig.json
tsconfig.module.json
tslint.json

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/