Web3.js

Web3.js is a TypeScript implementation of the Zond JSON RPC API and related tooling maintained by The QRL Contributors.

Installation

You can install the package either using NPM or using Yarn

If you wanna checkout latest bugfix or feature, use npm install @theqrl/web3@dev

Using NPM

npm install @theqrl/web3

Using Yarn

yarn add @theqrl/web3

Getting Started

• ✍️ If you have questions submit an issue or join us on Discord

Prerequisites

• ⚙️ NodeJS (LTS/Fermium)
• 🧰 Yarn/Lerna

Useful links

These links are for the Web3.js but should be useful pointers in the correct direction for theQRL/Web3.js as well.

• Web3 tree shaking support guide
• React App Example

Architecture Overview

Package	Version	License	Docs	Description
web3				🚨 Entire Web3.js offering (includes all packages)
web3-core				Core functions for web3.js packages
web3-errors				Errors Objects
web3-zond				Modules to interact with the Zond blockchain and smart contracts
web3-zond-abi				Functions for encoding and decoding ZVM in/output
web3-zond-accounts				Functions for managing Zond accounts and signing
web3-zond-contract				The contract package contained in web3-zond
web3-zond-ens				Functions for interacting with the Ethereum Name Service
web3-zond-iban				Functionality for converting Zond addressed to IBAN addressed and vice versa
web3-net				Functions to interact with an Zond node's network properties
web3-providers-http				Web3.js provider for the HTTP protocol
web3-providers-ipc				Web3.js provider for IPC
web3-providers-ws				Web3.js provider for the Websocket protocol
web3-rpc-methods				RPC Methods
web3-types				Shared useable types
web3-utils				Useful utility functions for Dapp developers
web3-validator				Utilities for validating objects

Package.json Scripts

Script	Description
clean	Uses rimraf to remove dist/
build	Uses tsc to build all packages
lint	Uses eslint to lint all packages
lint:fix	Uses eslint to check and fix any warnings
format	Uses prettier to format the code
test	Uses jest to run unit tests in each package
test:integration	Uses jest to run tests under /test/integration in each package
test:unit	Uses jest to run tests under /test/unit in each package