@theqrl/web3

This is the main package of @theqrl/web3.js.

@theqrl/web3 contains the ideal setup for a Zond Web3.js package.

Installation

You can install the package either using NPM or using Yarn

Using NPM

npm install @theqrl/web3

Using Yarn

yarn add @theqrl/web3

Getting Started

• :writing_hand: If you have questions submit an issue or join us on Discord

Prerequisites

• :gear: NodeJS (LTS/Fermium)
• :toolbox: Yarn/Lerna

Package.json Scripts

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

Web3.js Packages

We encourage users to use only required individual packages listed in following table, for making lightweight application instead of importing main web3 package, and if you don't need functions from most of the packages that are implicitly included with main web3 package.

| Package | Version | License | Docs | Description | | ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | | web3 | | | | :rotating_light: 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 |