@0x-klaytn/web3-wrapper

@0x-klaytn/web3-wrapper

Web3-wrapper is a JSON-RPC client for Klaytn nodes. It is a type-safe alternative to Web3.js written in TypeScript and patched to be compatible with Klaytn.

Read the Documentation.

Installation

yarn add @0x-klaytn/web3-wrapper

If your project is in TypeScript, add the following to your tsconfig.json:

"compilerOptions": {
    "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}

Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our contribution guidelines before getting started.

Install dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

yarn config set workspaces-experimental true

Then install dependencies

yarn install

Build

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

PKG=@0x-klaytn/web3-wrapper yarn build

Or continuously rebuild on change:

PKG=@0x-klaytn/web3-wrapper yarn watch

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test