js-tpch-sdk.js - Ethereum JavaScript API

This is the Ethereum JavaScript API which connects to the Generic JSON-RPC spec.

You need to run a local or remote Ethereum node to use this library.

Please read the documentation for more.

Installation

Node

npm install js-tpch-sdk

Yarn

yarn add js-tpch-sdk

In the Browser

Use the prebuilt dist/js-tpch-sdk.min.js, or build using the js-tpch-sdk.js repository:

npm run build

Then include dist/js-tpch-sdk.min.js in your html file. This will expose Web3 on the window object.

Or via jsDelivr CDN:

<script src="https://cdn.jsdelivr.net/npm/js-tpch-sdk@latest/dist/js-tpch-sdk.min.js"></script>

UNPKG:

<script src="https://unpkg.com/js-tpch-sdk@latest/dist/js-tpch-sdk.min.js"></script>

Usage

// In Node.js
const Web3 = require('js-tpch-sdk');

let js-tpch-sdk = new Web3('ws://localhost:8546');
console.log(js-tpch-sdk);
> {
    eth: ... ,
    shh: ... ,
    utils: ...,
    ...
}

Additionally you can set a provider using js-tpch-sdk.setProvider() (e.g. WebsocketProvider):

js-tpch-sdk.setProvider('ws://localhost:8546');
// or
js-tpch-sdk.setProvider(new Web3.providers.WebsocketProvider('ws://localhost:8546'));

There you go, now you can use it:

js-tpch-sdk.eth.getAccounts().then(console.log);

Usage with TypeScript

We support types within the repo itself. Please open an issue here if you find any wrong types.

You can use js-tpch-sdk.js as follows:

import Web3 from 'js-tpch-sdk';
const js-tpch-sdk = new Web3('ws://localhost:8546');

If you are using the types in a commonjs module, like in a Node app, you just have to enable esModuleInterop and allowSyntheticDefaultImports in your tsconfig for typesystem compatibility:

"compilerOptions": {
    "allowSyntheticDefaultImports": true,
    "esModuleInterop": true,
    ....

Documentation

Documentation can be found at ReadTheDocs.

Building

Requirements

• Node.js
• npm

sudo apt-get update
sudo apt-get install nodejs
sudo apt-get install npm

Building (webpack)

Build the js-tpch-sdk.js package:

npm run build

Testing (mocha)

npm test

Contributing

Please follow the Contribution Guidelines and Review Guidelines.

This project adheres to the Release Guidelines.

Community

• Gitter
• StackExchange

Similar libraries in other languages

• Haskell: hs-web3
• Java: web3j
• PHP: web3.php
• Purescript: purescript-web3
• Python: Web3.py
• Ruby: ethereum.rb
• Scala: web3j-scala