From dc0a092e62dcba22ff2835b15a7f139b057682b7 Mon Sep 17 00:00:00 2001 From: JP Lomas Date: Wed, 2 Jul 2025 10:36:23 +0100 Subject: [PATCH 1/3] Documentation updates --- README.md | 52 +++++++------- RELEASE.md | 2 +- .../support_additional_rpc_methods/index.md | 2 +- .../web3_tree_shaking_support_guide/index.md | 2 +- docs/docs/guides/basics/zond.md | 16 ++--- ...ng_and_interacting_with_smart_contracts.md | 8 +-- .../web3_plugin_guide/plugin_authors.md | 4 +- .../guides/web3_plugin_guide/plugin_users.md | 2 +- .../guides/web3_providers_guide/examples.md | 18 ++--- .../docs/guides/web3_providers_guide/index.md | 6 +- docs/docusaurus.config.js | 4 +- package.json | 8 +-- packages/abi/LICENSE.md | 34 ++++++++- packages/abi/README.md | 9 +-- packages/abi/package.json | 2 +- packages/web3-core/README.md | 34 ++++----- packages/web3-core/package.json | 4 +- packages/web3-errors/README.md | 30 ++++---- packages/web3-errors/package.json | 4 +- .../src/errors/transaction_errors.ts | 2 +- packages/web3-net/README.md | 31 ++++---- packages/web3-net/package.json | 4 +- packages/web3-providers-http/README.md | 33 ++++----- packages/web3-providers-http/package.json | 4 +- packages/web3-providers-ipc/README.md | 31 ++++---- packages/web3-providers-ipc/package.json | 4 +- packages/web3-providers-ws/README.md | 33 ++++----- packages/web3-providers-ws/package.json | 4 +- packages/web3-rpc-methods/README.md | 33 ++++----- packages/web3-rpc-methods/package.json | 4 +- packages/web3-types/README.md | 33 ++++----- packages/web3-types/package.json | 4 +- packages/web3-utils/README.md | 35 +++++----- packages/web3-utils/package.json | 4 +- packages/web3-validator/README.md | 33 ++++----- packages/web3-validator/package.json | 4 +- packages/web3-zond-abi/README.md | 34 ++++----- packages/web3-zond-abi/package.json | 4 +- packages/web3-zond-accounts/README.md | 34 ++++----- packages/web3-zond-accounts/package.json | 4 +- packages/web3-zond-contract/README.md | 35 +++++----- packages/web3-zond-contract/package.json | 4 +- packages/web3-zond-contract/src/index.ts | 2 +- packages/web3-zond-ens/README.md | 34 ++++----- packages/web3-zond-ens/package.json | 4 +- packages/web3-zond-iban/README.md | 34 ++++----- packages/web3-zond-iban/package.json | 4 +- packages/web3-zond/README.md | 33 ++++----- packages/web3-zond/package.json | 4 +- packages/web3-zond/src/rpc_method_wrappers.ts | 2 +- packages/web3-zond/src/web3_zond.ts | 2 +- .../test/integration/defaults.test.ts | 4 +- packages/web3/README.md | 70 +++++++++---------- packages/web3/package.json | 4 +- packages/web3/test/cjs_black_box/package.json | 2 +- .../cjs_black_box/test/batchRequest.test.ts | 2 +- .../web3-zond-accounts/hashMessage.test.ts | 2 +- .../test/web3-zond-contract/erc20.test.ts | 2 +- .../test/web3-zond/getBlock.test.ts | 2 +- .../test/web3-zond/getTransaction.test.ts | 2 +- packages/web3/test/cjs_black_box/yarn.lock | 48 ++++++------- packages/web3/test/esm_black_box/package.json | 2 +- packages/web3/test/esm_black_box/yarn.lock | 46 ++++++------ tools/eslint-config-base-web3/package.json | 8 +-- tools/web3-packagetemplate/README.md | 34 ++++----- tools/web3-packagetemplate/package.json | 4 +- tools/web3-plugin-example/README.md | 31 ++++---- tools/web3-plugin-example/package.json | 4 +- 68 files changed, 502 insertions(+), 536 deletions(-) diff --git a/README.md b/README.md index f3711ae5..59d7d2f4 100644 --- a/README.md +++ b/README.md @@ -11,30 +11,30 @@ ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -Web3.js is a TypeScript implementation of the [Zond JSON RPC API](https://eth.wiki/json-rpc/API) and related tooling maintained by [ChainSafe Systems](https://chainsafe.io). +Web3.js is a TypeScript implementation of the [Zond JSON RPC API](https://eth.wiki/json-rpc/API) and related tooling maintained by [The QRL Contributors](https://chainsafe.io). ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3) or using [Yarn](https://yarnpkg.com/package/web3) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3) -> If you wanna checkout latest bugfix or feature, use `npm install web3@dev` +> If you wanna checkout latest bugfix or feature, use `npm install @theqrl/web3@dev` ### Using NPM ```bash -npm install web3 +npm install @theqrl/web3 ``` ### Using Yarn ```bash -yarn add web3 +yarn add @theqrl/web3 ``` ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new/choose) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new/choose) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ## Prerequisites @@ -43,30 +43,32 @@ yarn add web3 ## Useful links -- [Web3 tree shaking support guide](https://docs.web3js.org/guides/advanced/web3_tree_shaking_support_guide/) +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](https://docs.web3js.org/guides/advanced/tree_shaking) - [React App Example](https://github.com/ChainSafe/web3js-example-react-app) ## Architecture Overview | Package | Version | License | Docs | Description | | ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| [web3](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3%2Fpackage.json)](https://www.npmjs.com/package/web3) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3) | :rotating_light: Entire Web3.js offering (includes all packages) | -| [web3-core](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-core) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-core%2Fpackage.json)](https://www.npmjs.com/package/web3-core) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-core) | Core functions for web3.js packages | -| [web3-errors](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-errors) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-errors%2Fpackage.json)](https://www.npmjs.com/package/web3-core) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-errors) | Errors Objects | -| [web3-zond](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth%2Fpackage.json)](https://www.npmjs.com/package/web3-eth) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-eth) | Modules to interact with the Zond blockchain and smart contracts | -| [web3-zond-abi](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-abi) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-abi%2Fpackage.json)](https://www.npmjs.com/package/web3-eth-abi) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-eth-abi) | Functions for encoding and decoding ZVM in/output | -| [web3-zond-accounts](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-accounts) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-accounts%2Fpackage.json)](https://www.npmjs.com/package/web3-eth-accounts) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-eth-accounts) | Functions for managing Zond accounts and signing | -| [web3-zond-contract](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-contract) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-contract%2Fpackage.json)](https://www.npmjs.com/package/web3-eth-contract) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-eth-contract) | The contract package contained in [web3-zond](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth) | -| [web3-zond-ens](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-ens) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-ens%2Fpackage.json)](https://www.npmjs.com/package/web3-eth-ens) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-eth-ens) | Functions for interacting with the Ethereum Name Service | -| [web3-zond-iban](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-iban) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-iban%2Fpackage.json)](https://www.npmjs.com/package/web3-eth-iban) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-eth-iban) | Functionality for converting Zond addressed to IBAN addressed and vice versa | -| [web3-net](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-net) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-net%2Fpackage.json)](https://www.npmjs.com/package/web3-net) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-net) | Functions to interact with an Zond node's network properties | -| [web3-providers-http](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-providers-http) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-providers-http%2Fpackage.json)](https://www.npmjs.com/package/web3-providers-http) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-providers-http) | Web3.js provider for the HTTP protocol | -| [web3-providers-ipc](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-providers-ipc) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-providers-ipc%2Fpackage.json)](https://www.npmjs.com/package/web3-providers-ipc) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-providers-ipc) | Web3.js provider for IPC | -| [web3-providers-ws](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-providers-ws) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-providers-ws%2Fpackage.json)](https://www.npmjs.com/package/web3-providers-ws) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-providers-ws) | Web3.js provider for the Websocket protocol | -| [web3-rpc-methods](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-rpc-methods) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-rpc-methods%2Fpackage.json)](https://www.npmjs.com/package/web3-types) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/) | RPC Methods | -| [web3-types](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-types) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-types%2Fpackage.json)](https://www.npmjs.com/package/web3-types) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-types) | Shared useable types | -| [web3-utils](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-utils) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-utils%2Fpackage.json)](https://www.npmjs.com/package/web3-utils) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-utils) | Useful utility functions for Dapp developers | -| [web3-validator](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-validator) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-validator%2Fpackage.json)](https://www.npmjs.com/package/web3-validator) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-validator) | Utilities for validating objects | +| [web3](https://github.com/theqrl/web3.js/tree/main/packages/web3) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3) | :rotating_light: Entire Web3.js offering (includes all packages) | +| [web3-core](https://github.com/theqrl/web3.js/tree/main/packages/web3-core) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-core%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-core) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-core) | Core functions for web3.js packages | +| [web3-errors](https://github.com/theqrl/web3.js/tree/main/packages/web3-errors) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-errors%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-core) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-errors) | Errors Objects | +| [web3-zond](https://github.com/theqrl/web3.js/tree/main/packages/web3-eth) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-eth%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-eth) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-eth) | Modules to interact with the Zond blockchain and smart contracts | +| [web3-zond-abi](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-abi) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-abi%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-abi) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-abi) | Functions for encoding and decoding ZVM in/output | +| [web3-zond-accounts](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-accounts) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-accounts%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-accounts) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-accounts) | Functions for managing Zond accounts and signing | +| [web3-zond-contract](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-contract) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-contract%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-contract) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-contract) | The contract package contained in [web3-zond](https://github.com/theqrl/web3.js/tree/main/packages/web3-eth) | +| [web3-zond-ens](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-ens) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-ens%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-ens) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-ens) | Functions for interacting with the Ethereum Name Service | +| [web3-zond-iban](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-iban) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-iban%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-iban) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-iban) | Functionality for converting Zond addressed to IBAN addressed and vice versa | +| [web3-net](https://github.com/theqrl/web3.js/tree/main/packages/web3-net) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-net%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-net) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-net) | Functions to interact with an Zond node's network properties | +| [web3-providers-http](https://github.com/theqrl/web3.js/tree/main/packages/web3-providers-http) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-providers-http%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-providers-http) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-providers-http) | Web3.js provider for the HTTP protocol | +| [web3-providers-ipc](https://github.com/theqrl/web3.js/tree/main/packages/web3-providers-ipc) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-providers-ipc%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-providers-ipc) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-providers-ipc) | Web3.js provider for IPC | +| [web3-providers-ws](https://github.com/theqrl/web3.js/tree/main/packages/web3-providers-ws) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-providers-ws%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-providers-ws) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-providers-ws) | Web3.js provider for the Websocket protocol | +| [web3-rpc-methods](https://github.com/theqrl/web3.js/tree/main/packages/web3-rpc-methods) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-rpc-methods%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-types) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/) | RPC Methods | +| [web3-types](https://github.com/theqrl/web3.js/tree/main/packages/web3-types) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-types%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-types) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-types) | Shared useable types | +| [web3-utils](https://github.com/theqrl/web3.js/tree/main/packages/web3-utils) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-utils%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-utils) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-utils) | Useful utility functions for Dapp developers | +| [web3-validator](https://github.com/theqrl/web3.js/tree/main/packages/web3-validator) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-validator%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-validator) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-validator) | Utilities for validating objects | ## Package.json Scripts diff --git a/RELEASE.md b/RELEASE.md index feb3295b..1a83f5f7 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -44,7 +44,7 @@ Further details about versioning can be found in the [semver 2.0.0 specification 8. `git tag bumped-version`: Tag the commit with bumped version having prefix `v` , e.g. `git tag v4.0.1-alpha.0` 9. `git push origin release/bumped-version`: Push release branch to `origin` 10. `git push origin --tags`: Push release tag created in `Step 8` to `origin` -11. Create a draft release on Github similar to [this](https://github.com/ChainSafe/web3.js/releases/tag/web3-providers-base%401.0.0-alpha.1) +11. Create a draft release on Github similar to [this](https://github.com/theqrl/web3.js/releases/tag/web3-providers-base%401.0.0-alpha.1) - Check `This is a pre-release` - In the release description, copy all entries in `CHANGELOG.md` for the version being released 12. Click `Save draft` diff --git a/docs/docs/guides/advanced/support_additional_rpc_methods/index.md b/docs/docs/guides/advanced/support_additional_rpc_methods/index.md index b685b292..92928698 100644 --- a/docs/docs/guides/advanced/support_additional_rpc_methods/index.md +++ b/docs/docs/guides/advanced/support_additional_rpc_methods/index.md @@ -112,6 +112,6 @@ web3.customRpcMethods.customRpcMethod(); For more details follow : -- [Example Plugin Code](https://github.com/web3/web3.js/tree/4.x/tools/web3-plugin-example) +- [Example Plugin Code](https://github.com/web3/web3.js/tree/main/tools/web3-plugin-example) - [Web3 Plugin developers Guide](/guides/web3_plugin_guide/plugin_authors) - [Web3 Plugin Users Guide](/guides/web3_plugin_guide/plugin_users) diff --git a/docs/docs/guides/advanced/web3_tree_shaking_support_guide/index.md b/docs/docs/guides/advanced/web3_tree_shaking_support_guide/index.md index 5db3c7e9..9f1266d1 100644 --- a/docs/docs/guides/advanced/web3_tree_shaking_support_guide/index.md +++ b/docs/docs/guides/advanced/web3_tree_shaking_support_guide/index.md @@ -40,4 +40,4 @@ If you only need a few functions from `web3-utils`: import { numberToHex, hexToNumber } from 'web3-utils'; ``` -You can find an example app with tree shaking [here](https://github.com/ChainSafe/web3js-example-react-app). +You can find an example app with tree shaking [here](https://github.com/theqrl/web3js-example-react-app). diff --git a/docs/docs/guides/basics/zond.md b/docs/docs/guides/basics/zond.md index 1879898b..abaac557 100644 --- a/docs/docs/guides/basics/zond.md +++ b/docs/docs/guides/basics/zond.md @@ -31,8 +31,8 @@ Before we start writing and deploying our contract, we need to set up our enviro First, create a new project directory for your project and navigate into it: ``` -mkdir web3-eth-tutorial -cd web3-eth-tutorial +mkdir web3-zond-tutorial +cd web3-zond-tutorial ``` Next, initialize a new Node.js project using npm: @@ -57,7 +57,7 @@ In this step, we will set up the web3.js library and connect to the Ganache netw First, install the `web3` package using npm: ``` -npm install @theqrl/web3@4.0.1-rc.1 +npm install @theqrl/web3 ``` Note that we are installing the latest version of 4.x, at the time of this tutorial writing. You can check the latest version at https://www.npmjs.com/package/@theqrl/web3?activeTab=versions @@ -65,7 +65,7 @@ Note that we are installing the latest version of 4.x, at the time of this tutor Next, create a new file called `index.ts` in your project directory and add the following code to it: ```javascript -const { Web3 } = require('web3'); // web3.js has native ESM builds and (`import Web3 from 'web3'`) +const { Web3 } = require('@theqrl/web3'); // web3.js has native ESM builds and (`import Web3 from 'web3'`) // Set up a connection to the Ganache network const web3 = new Web3(new Web3.providers.HttpProvider('http://localhost:7545')); @@ -99,7 +99,7 @@ In the first example, we are going to send a simple value transaction. Create a file named `transaction.ts` and fill it with the following code: ```typescript -const { Web3 } = require('web3'); // web3.js has native ESM builds and (`import Web3 from 'web3'`) +const { Web3 } = require('@theqrl/web3'); // web3.js has native ESM builds and (`import Web3 from 'web3'`) const fs = require('fs'); const path = require('path'); @@ -202,7 +202,7 @@ transactionHash { In the next example, we are going to use `estimateGas` function to see the expected gas for contract deployment. (For more on contracts, please see the corresponding tutotial). Create a file named `estimate.ts` and fill it with the following code: ```typescript -import Web3, { ZOND_DATA_FORMAT, DEFAULT_RETURN_FORMAT } from 'web3'; +import Web3, { ZOND_DATA_FORMAT, DEFAULT_RETURN_FORMAT } from '@theqrl/web3'; async function estimate() { // abi of our contract @@ -284,7 +284,7 @@ If everything is working correctly, you should see something like the following: In the next example we are going to sign a transaction and use `sendSignedTransaction` to send the signed transaction. Create a file named `sendSigned.ts` and fill it with the following code: ```typescript -import Web3 from 'web3'; +import Web3 from '@theqrl/web3'; const web3 = new Web3('http://localhost:7545'); //make sure to copy the private key from ganache @@ -347,7 +347,7 @@ Transaction receipt: { ## Conclusion -In this tutorial, we learned how to use different methods provied by the `web3-eth` package. +In this tutorial, we learned how to use different methods provided by the `@theqrl/web3` package. With this knowledge, you can start experimenting with the Zond blockchain. Keep in mind that this is just the beginning, and there is a lot more to learn about Zond and web3.js. So keep exploring and building, and have fun! diff --git a/docs/docs/guides/smart_contracts/deploying_and_interacting_with_smart_contracts.md b/docs/docs/guides/smart_contracts/deploying_and_interacting_with_smart_contracts.md index 0ebdcd30..2f348332 100644 --- a/docs/docs/guides/smart_contracts/deploying_and_interacting_with_smart_contracts.md +++ b/docs/docs/guides/smart_contracts/deploying_and_interacting_with_smart_contracts.md @@ -182,7 +182,7 @@ Note that we are installing the latest version of 4.x, at the time of this tutor Next, create a new file called `index.js` in your project directory and add the following code to it: ```javascript -const { Web3 } = require('web3'); // web3.js has native ESM builds and (`import Web3 from 'web3'`) +const { Web3 } = require('@theqrl/web3'); // web3.js has native ESM builds and (`import Web3 from 'web3'`) // Set up a connection to the Ganache network const web3 = new Web3(new Web3.providers.HttpProvider('http://localhost:7545')); @@ -217,7 +217,7 @@ Create a file named `deploy.js` and fill it with the following code: ```javascript // For simplicity we use `web3` package here. However, if you are concerned with the size, // you may import individual packages like 'web3-zond', 'web3-zond-contract' and 'web3-providers-http'. -const { Web3 } = require('web3'); // web3.js has native ESM builds and (`import Web3 from 'web3'`) +const { Web3 } = require('@theqrl/web3'); // web3.js has native ESM builds and (`import Web3 from 'web3'`) const fs = require('fs'); const path = require('path'); @@ -293,7 +293,7 @@ In this step, we will use web3.js to interact with the smart contract on the Gan Create a file named `interact.js` and fill it with the following code: ```javascript -const { Web3 } = require('web3'); // web3.js has native ESM builds and (`import Web3 from 'web3'`) +const { Web3 } = require('@theqrl/web3'); // web3.js has native ESM builds and (`import Web3 from 'web3'`) const fs = require('fs'); const path = require('path'); @@ -420,7 +420,7 @@ With this knowledge, you can start experimenting with writing smart contract in ## Additional Resources -- [Official web3.js Documentation](https://docs.web3js.org/) +- [Official web3.js Documentation](https://docs.theqrl.org/) - [Hyperion Documentation](https://solidity.readthedocs.io/) - [Ganache](https://www.trufflesuite.com/ganache) - [Truffle](https://trufflesuite.com/) diff --git a/docs/docs/guides/web3_plugin_guide/plugin_authors.md b/docs/docs/guides/web3_plugin_guide/plugin_authors.md index 794effc9..c95e3b72 100644 --- a/docs/docs/guides/web3_plugin_guide/plugin_authors.md +++ b/docs/docs/guides/web3_plugin_guide/plugin_authors.md @@ -8,7 +8,7 @@ sidebar_label: 'For Plugin Developers' This guide intends to provide the necessary context for developing plugins for web3.js. Feel free to explore some of [the already built plugins](https://github.com/chainSafe?q=web3.js-plugin) and/or -use this [template](https://github.com/ChainSafe/web3.js-plugin-template) to start with development of your Web3.js plugin. +use this [template](https://github.com/theqrl/web3.js-plugin-template) to start with development of your Web3.js plugin. :::caution To provide type safety and IntelliSense for your plugin users, please refer to the [Setting Up Module Augmentation](#setting-up-module-augmentation) section for how to augment the `Web3Context` module to enable typing features for your plugin. @@ -308,4 +308,4 @@ But, the user who does not call `.registerPlugin`, before accessing your plugin, ## Complete Example -You may find it helpful to reference a complete example for developing and using a web3 plugin. The [Web3.js Chainlink Plugin](https://github.com/ChainSafe/web3.js-plugin-chainlink/) repository provides an excellent example which you can check out. +You may find it helpful to reference a complete example for developing and using a web3 plugin. The [Web3.js Chainlink Plugin](https://github.com/theqrl/web3.js-plugin-chainlink/) repository provides an excellent example which you can check out. diff --git a/docs/docs/guides/web3_plugin_guide/plugin_users.md b/docs/docs/guides/web3_plugin_guide/plugin_users.md index af77d3cd..56f335fa 100644 --- a/docs/docs/guides/web3_plugin_guide/plugin_users.md +++ b/docs/docs/guides/web3_plugin_guide/plugin_users.md @@ -11,7 +11,7 @@ To help you get started, take a look at a list of useful plugins at diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 8e6bb7ef..8b0b9794 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -95,7 +95,7 @@ const config = { routeBasePath: '/', // Serve the docs at the site's root // Please change this to your repo. // Remove this to remove the "edit this page" links. - editUrl: 'https://github.com/theQRL/web3.js/tree/main/docs', + editUrl: 'https://github.com/theqrl/web3.js/tree/main/docs', }, theme: { customCss: require.resolve('./src/css/custom.css'), @@ -131,7 +131,7 @@ const config = { position: 'left', }, { - href: 'https://github.com/theQRL/web3.js/tree/main/', + href: 'https://github.com/theqrl/web3.js/tree/main/', label: 'GitHub', position: 'right', }, diff --git a/package.json b/package.json index ab809dbf..83ecedb3 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "web3.js", "private": true, "description": "Zond API wrappers and utilities", - "author": "ChainSafe Systems", + "author": "The QRL Contributors", "license": "LGPL-3.0", "keywords": [ "zond", @@ -11,13 +11,13 @@ "web3.js", "blockchain" ], - "homepage": "https://github.com/ChainSafe/web3.js#readme", + "homepage": "https://github.com/theqrl/web3.js#readme", "repository": { "type": "git", - "url": "git+https://github.com/ChainSafe/web3.js.git" + "url": "git+https://github.com/theqrl/web3.js.git" }, "bugs": { - "url": "https://github.com/ChainSafe/web3.js/issues" + "url": "https://github.com/theqrl/web3.js/issues" }, "engines": { "node": ">=14", diff --git a/packages/abi/LICENSE.md b/packages/abi/LICENSE.md index 989e34a7..10c588e4 100644 --- a/packages/abi/LICENSE.md +++ b/packages/abi/LICENSE.md @@ -1,6 +1,38 @@ +# MIT License + +## Ethers + +Derivative work based on the ethers project, which is licensed: + +MIT License + +Copyright (c) 2016-2025 Richard Moore + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +## Zond + +Zond project derivations and modifications are also MIT licensed: + MIT License -Copyright (c) 2019 Richard Moore +Copyright (c) 2023-2025 The QRL Contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/packages/abi/README.md b/packages/abi/README.md index 7ce37d72..3df4287c 100644 --- a/packages/abi/README.md +++ b/packages/abi/README.md @@ -1,19 +1,16 @@ Zond ABI Coder ================== -This sub-module is part of the [ethers project](https://github.com/ethers-io/ethers.js). +This sub-module is a fork of the [ethers project](https://github.com/ethers-io/ethers.js). It is responsible for encoding and decoding the Application Binary Interface (ABI) -used by most smart contracts to interoperate between other smart contracts and clients. +used by most Zond smart contracts to interoperate between other smart contracts and clients. -For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/abi/). +More information, can be inferred from the [ethers project documentation](https://docs.ethers.io/v5/api/utils/abi/). Importing --------- -Most users will prefer to use the [umbrella package](https://www.npmjs.com/package/ethers), -but for those with more specific needs, individual components can be imported. - ```javascript const { diff --git a/packages/abi/package.json b/packages/abi/package.json index bbb2531b..8ca02499 100644 --- a/packages/abi/package.json +++ b/packages/abi/package.json @@ -22,7 +22,7 @@ "repository": { "directory": "packages/abi", "type": "git", - "url": "git://github.com/ethers-io/ethers.js.git" + "url": "git://github.com/theQRL/web3.js.git" }, "scripts": { "clean": "rimraf dist && rimraf lib", diff --git a/packages/web3-core/README.md b/packages/web3-core/README.md index a5a21107..c29dfd32 100644 --- a/packages/web3-core/README.md +++ b/packages/web3-core/README.md @@ -1,38 +1,34 @@ -

- web3.js -

- -# web3.js - Web3 Core +# @theqrl/web3.js - Web3 Core ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -[![NPM Package][npm-image]][npm-url] -[![Downloads][downloads-image]][npm-url] +[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-core)][[npm-url](https://www.npmjs.com/package/@theqrl/web3-core)] +[![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-core)][[npm-url](https://www.npmjs.com/package/@theqrl/web3-core)] -This is a sub-package of [web3.js][repo]. +This is a sub-package of [@theqrl/web3.js](https://github.com/theqrl/web3.js). -`web3-core` package contains core functions for [web3.js][repo] packages. +`web3-core` package contains core functions for [@theqrl/web3.js](https://github.com/theqrl/web3.js) packages. ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3-core) or using [Yarn](https://yarnpkg.com/package/web3-core) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3-core) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3-core) ### Using NPM ```bash -npm install web3-core +npm install @theqrl/web3-core ``` ### Using Yarn ```bash -yarn add web3-core +yarn add @theqrl/web3-core ``` ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ## Prerequisites @@ -52,8 +48,8 @@ yarn add web3-core | test:integration | Uses `jest` to run tests under `/test/integration` | | test:unit | Uses `jest` to run tests under `/test/unit` | -[docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-core -[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-core%2Fpackage.json -[npm-url]: https://npmjs.org/package/web3-core -[downloads-image]: https://img.shields.io/npm/dm/web3-core?label=npm%20downloads +[docs]: https://docs.theqrl.org/ +[repo]: https://github.com/theqrl/web3.js/tree/main/packages/web3-core +[npm-image]: https://img.shields.io/github/package-json/v/theqrl/web3.js/main?filename=packages%2Fweb3-core%2Fpackage.json +[npm-url]: https://npmjs.org/package/@theqrl/web3-core +[downloads-image]: https://img.shields.io/npm/dm/@theqrl/web3-core?label=npm%20downloads diff --git a/packages/web3-core/package.json b/packages/web3-core/package.json index bd275718..c0b1ce8e 100644 --- a/packages/web3-core/package.json +++ b/packages/web3-core/package.json @@ -14,8 +14,8 @@ "require": "./lib/commonjs/index.js" } }, - "repository": "https://github.com/ChainSafe/web3.js", - "author": "ChainSafe Systems", + "repository": "https://github.com/theqrl/web3.js", + "author": "The QRL Contributors", "license": "LGPL-3.0", "engines": { "node": ">=14", diff --git a/packages/web3-errors/README.md b/packages/web3-errors/README.md index 9a68b9a7..1c2191bd 100644 --- a/packages/web3-errors/README.md +++ b/packages/web3-errors/README.md @@ -1,38 +1,34 @@ -

- web3.js -

- -# web3.js - Web3-Errors +# @theqrl/web3.js - Web3-Errors ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -[![NPM Package][npm-image]][npm-url] -[![Downloads][downloads-image]][npm-url] +[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-errors)](https://www.npmjs.com/package/@theqrl/web3-errors) +[![Downloads](https://img.shields.io/npm/dy/@theqrl/web3-errors)](https://www.npmjs.com/package/@theqrl/web3-errors) -This is a sub-package of [web3.js][repo]. +This is a sub-package of [@theqrl/web3.js](https://github.com/theqrl/web3.js). -`web3-errors` This package has web3 error classes. +`@theqrl/web3-errors` This package has @theqrl/web3 error classes. ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3-errors) or using [Yarn](https://yarnpkg.com/package/web3-errors) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3-errors) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3-errors) ### Using NPM ```bash -npm install web3-errors +npm install @theqrl/web3-errors ``` ### Using Yarn ```bash -yarn add web3-errors +yarn add @theqrl/web3-errors ``` ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ## Prerequisites @@ -52,8 +48,8 @@ yarn add web3-errors | test:integration | Uses `jest` to run tests under `/test/integration` | | test:unit | Uses `jest` to run tests under `/test/unit` | -[docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-errors -[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-errors%2Fpackage.json +[docs]: https://docs.theqrl.org/ +[repo]: https://github.com/web3/web3.js/tree/main/packages/web3-errors +[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-errors%2Fpackage.json [npm-url]: https://npmjs.org/package/web3-errors [downloads-image]: https://img.shields.io/npm/dm/web3-errors?label=npm%20downloads diff --git a/packages/web3-errors/package.json b/packages/web3-errors/package.json index 4110a8e4..344a515c 100644 --- a/packages/web3-errors/package.json +++ b/packages/web3-errors/package.json @@ -14,8 +14,8 @@ "require": "./lib/commonjs/index.js" } }, - "repository": "https://github.com/ChainSafe/web3.js", - "author": "ChainSafe Systems", + "repository": "https://github.com/theqrl/web3.js", + "author": "The QRL Contributors", "license": "LGPL-3.0", "engines": { "node": ">=14", diff --git a/packages/web3-errors/src/errors/transaction_errors.ts b/packages/web3-errors/src/errors/transaction_errors.ts index 63c0e00e..a5825b0f 100644 --- a/packages/web3-errors/src/errors/transaction_errors.ts +++ b/packages/web3-errors/src/errors/transaction_errors.ts @@ -263,7 +263,7 @@ export class ChainIdMismatchError extends InvalidValueError { public constructor(value: { txChainId: unknown; customChainId: unknown }) { super( JSON.stringify(value), - // https://github.com/ChainSafe/web3.js/blob/8783f4d64e424456bdc53b34ef1142d0a7cee4d7/packages/web3-eth-accounts/src/index.js#L176 + // https://github.com/theqrl/web3.js/blob/8783f4d64e424456bdc53b34ef1142d0a7cee4d7/packages/web3-zond-accounts/src/index.js#L176 'Chain Id doesnt match in tx.chainId tx.common.customChain.chainId', ); } diff --git a/packages/web3-net/README.md b/packages/web3-net/README.md index 9ea19647..babbd741 100644 --- a/packages/web3-net/README.md +++ b/packages/web3-net/README.md @@ -1,38 +1,35 @@ -

- web3.js -

# web3.js - Net ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -[![NPM Package][npm-image]][npm-url] -[![Downloads][downloads-image]][npm-url] +[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-net)](https://www.npmjs.com/package/@theqrl/web3-net) +[![Downloads](https://img.shields.io/npm/v/@theqrl/web3-net)](https://www.npmjs.com/package/@theqrl/web3-net) -This is a sub-package of [web3.js][repo]. +This is a sub-package of [@theqrl/web3.js](https://github.com/theqrl/web3.js). -`web3-net` package allows to interact with a Zond node’s network properties. +`@theqrl/web3-net` package allows to interact with a Zond node’s network properties. ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3-net) or using [Yarn](https://yarnpkg.com/package/web3-net) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3-net) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3-net) ### Using NPM ```bash -npm install web3-net +npm install @theqrl/web3-net ``` ### Using Yarn ```bash -yarn add web3-net +yarn add @theqrl/web3-net ``` ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ## Prerequisites @@ -52,8 +49,8 @@ yarn add web3-net | test:integration | Uses `jest` to run tests under `/test/integration` | | test:unit | Uses `jest` to run tests under `/test/unit` | -[docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-net -[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-net%2Fpackage.json -[npm-url]: https://npmjs.org/package/web3-net -[downloads-image]: https://img.shields.io/npm/dm/web3-net?label=npm%20downloads +[docs]: https://docs.theqrl.org/ +[repo]: https://github.com/theqrl/web3.js/tree/main/packages/web3-net +[npm-image]: https://img.shields.io/github/package-json/v/theqrl/web3.js/main?filename=packages%2Fweb3-net%2Fpackage.json +[npm-url]: https://npmjs.org/package/@theqrl/web3-net +[downloads-image]: https://img.shields.io/npm/dm/@theqrl/web3-net?label=npm%20downloads diff --git a/packages/web3-net/package.json b/packages/web3-net/package.json index a3b7c3b9..ff7e5cab 100644 --- a/packages/web3-net/package.json +++ b/packages/web3-net/package.json @@ -14,8 +14,8 @@ "require": "./lib/commonjs/index.js" } }, - "repository": "https://github.com/ChainSafe/web3.js", - "author": "ChainSafe Systems", + "repository": "https://github.com/theqrl/web3.js", + "author": "The QRL Contributors", "license": "LGPL-3.0", "engines": { "node": ">=14", diff --git a/packages/web3-providers-http/README.md b/packages/web3-providers-http/README.md index 12c52dd4..389b1747 100644 --- a/packages/web3-providers-http/README.md +++ b/packages/web3-providers-http/README.md @@ -1,38 +1,35 @@ -

- web3.js -

-# web3.js - Http Provider +# @theqrl/web3.js - Http Provider ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -[![NPM Package][npm-image]][npm-url] -[![Downloads][downloads-image]][npm-url] +[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-providers-http)](https://www.npmjs.com/package/@theqrl/web3-providers-http) +[![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-providers-http)](https://www.npmjs.com/package/@theqrl/web3-providers-http) -This is a sub-package of [web3.js][repo]. +This is a sub-package of [@theqrl/web3.js](https://github.com/theqrl/web3.js). -`web3-providers-http` contains the Web3.js provider for the HTTP protocol. +`@theqrl/web3-providers-http` contains the Web3.js provider for the HTTP protocol. ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3-providers-http) or using [Yarn](https://yarnpkg.com/package/web3-providers-http) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3-providers-http) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3-providers-http) ### Using NPM ```bash -npm install web3-providers-http +npm install @theqrl/web3-providers-http ``` ### Using Yarn ```bash -yarn add web3-providers-http +yarn add @theqrl/web3-providers-http ``` ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new/choose) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new/choose) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ## Prerequisites @@ -52,8 +49,8 @@ yarn add web3-providers-http | test:integration | Uses `jest` to run tests under `/test/integration` | | test:unit | Uses `jest` to run tests under `/test/unit` | -[docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-providers-http -[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-providers-http%2Fpackage.json -[npm-url]: https://npmjs.org/package/web3-providers-http -[downloads-image]: https://img.shields.io/npm/dm/web3-providers-http?label=npm%20downloads +[docs]: https://docs.theqrl.org/ +[repo]: https://github.com/theqrl/web3.js/tree/main/packages/web3-providers-http +[npm-image]: https://img.shields.io/github/package-json/v/theqrl/web3.js/main?filename=packages%2Fweb3-providers-http%2Fpackage.json +[npm-url]: https://npmjs.org/package/@theqrl/web3-providers-http +[downloads-image]: https://img.shields.io/npm/dm/@theqrl/web3-providers-http?label=npm%20downloads diff --git a/packages/web3-providers-http/package.json b/packages/web3-providers-http/package.json index 194bdc47..cafa43a0 100644 --- a/packages/web3-providers-http/package.json +++ b/packages/web3-providers-http/package.json @@ -14,8 +14,8 @@ "require": "./lib/commonjs/index.js" } }, - "repository": "https://github.com/ChainSafe/web3.js", - "author": "ChainSafe Systems", + "repository": "https://github.com/theqrl/web3.js", + "author": "The QRL Contributors", "license": "LGPL-3.0", "engines": { "node": ">=14", diff --git a/packages/web3-providers-ipc/README.md b/packages/web3-providers-ipc/README.md index 39913cd9..1b3689c4 100644 --- a/packages/web3-providers-ipc/README.md +++ b/packages/web3-providers-ipc/README.md @@ -1,38 +1,35 @@ -

- web3.js -

-# web3.js - IPC Provider +# @theqrl/web3.js - IPC Provider ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -[![NPM Package][npm-image]][npm-url] -[![Downloads][downloads-image]][npm-url] +[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-providers-ipc)](https://www.npmjs.com/package/@theqrl/web3-providers-ipc) +[![Downloads](https://img.shields.io/npm/dy/@theqrl/web3-providers-ipc)](https://www.npmjs.com/package/@theqrl/web3-providers-ipc) -This is a sub-package of [web3.js][repo]. +This is a sub-package of [@theqrl/web3.js](https://github.com/theqrl/web3.js). `web3-providers-ipc` contains the Web3.js provider for Inter Process Communication (IPC). ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3-providers-ipc) or using [Yarn](https://yarnpkg.com/package/web3-providers-ipc) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3-providers-ipc) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3-providers-ipc) ### Using NPM ```bash -npm install web3-providers-ipc +npm install @theqrl/web3-providers-ipc ``` ### Using Yarn ```bash -yarn add web3-providers-ipc +yarn add @theqrl/web3-providers-ipc ``` ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ## Prerequisites @@ -52,8 +49,8 @@ yarn add web3-providers-ipc | test:integration | Uses `jest` to run tests under `/test/integration` | | test:unit | Uses `jest` to run tests under `/test/unit` | -[docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-probiders-ipc -[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-providers-ipc%2Fpackage.json -[npm-url]: https://npmjs.org/package/web3-providers-ipc -[downloads-image]: https://img.shields.io/npm/dm/web3-providers-ipc?label=npm%20downloads +[docs]: https://docs.theqrl.org/ +[repo]: https://github.com/theqrl/web3.js/tree/main/packages/web3-providers-ipc +[npm-image]: https://img.shields.io/github/package-json/v/theqrl/web3.js/main?filename=packages%2Fweb3-providers-ipc%2Fpackage.json +[npm-url]: https://npmjs.org/package/@theqrl/web3-providers-ipc +[downloads-image]: https://img.shields.io/npm/dm/@theqrl/web3-providers-ipc?label=npm%20downloads diff --git a/packages/web3-providers-ipc/package.json b/packages/web3-providers-ipc/package.json index 1b0f63e8..5840ebb1 100644 --- a/packages/web3-providers-ipc/package.json +++ b/packages/web3-providers-ipc/package.json @@ -14,8 +14,8 @@ "require": "./lib/commonjs/index.js" } }, - "repository": "https://github.com/ChainSafe/web3.js", - "author": "ChainSafe Systems", + "repository": "https://github.com/theqrl/web3.js", + "author": "The QRL Contributors", "license": "LGPL-3.0", "engines": { "node": ">=14", diff --git a/packages/web3-providers-ws/README.md b/packages/web3-providers-ws/README.md index 942839b6..6e102a5f 100644 --- a/packages/web3-providers-ws/README.md +++ b/packages/web3-providers-ws/README.md @@ -1,38 +1,35 @@ -

- web3.js -

-# web3.js - Websocket Provider +# @theqrl/web3.js - Websocket Provider ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -[![NPM Package][npm-image]][npm-url] -[![Downloads][downloads-image]][npm-url] +[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-providers-ws)](https://www.npmjs.com/package/@theqrl/web3-providers-ws) +[![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-providers-ws)](https://www.npmjs.com/package/@theqrl/web3-providers-ws) -This is a sub-package of [web3.js][repo]. +This is a sub-package of [@theqrl/web3.js](https://github.com/theqrl/web3.js). -`web3-providers-ws` contains the Web3.js provider for the Websocket protocol. +`@theqrl/web3-providers-ws` contains the Web3.js provider for the Websocket protocol. ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3-providers-ws) or using [Yarn](https://yarnpkg.com/package/web3-providers-ws) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3-providers-ws) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3-providers-ws) ### Using NPM ```bash -npm install web3-providers-ws +npm install @theqrl/web3-providers-ws ``` ### Using Yarn ```bash -yarn add web3-providers-ws +yarn add @theqrl/web3-providers-ws ``` ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ## Prerequisites @@ -52,8 +49,8 @@ yarn add web3-providers-ws | test:integration | Uses `jest` to run tests under `/test/integration` | | test:unit | Uses `jest` to run tests under `/test/unit` | -[docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-providers-ws -[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-providers-ws%2Fpackage.json -[npm-url]: https://npmjs.org/package/web3-providers-ws -[downloads-image]: https://img.shields.io/npm/dm/web3-providers-ws?label=npm%20downloads +[docs]: https://docs.theqrl.org/ +[repo]: https://github.com/theqrl/web3.js/tree/main/packages/web3-providers-ws +[npm-image]: https://img.shields.io/github/package-json/v/theqrl/web3.js/main?filename=packages%2Fweb3-providers-ws%2Fpackage.json +[npm-url]: https://npmjs.org/package/@theqrl/web3-providers-ws +[downloads-image]: https://img.shields.io/npm/dm/@theqrl/web3-providers-ws?label=npm%20downloads diff --git a/packages/web3-providers-ws/package.json b/packages/web3-providers-ws/package.json index 2222e43a..d5de6b5a 100644 --- a/packages/web3-providers-ws/package.json +++ b/packages/web3-providers-ws/package.json @@ -14,8 +14,8 @@ "require": "./lib/commonjs/index.js" } }, - "repository": "https://github.com/ChainSafe/web3.js", - "author": "ChainSafe Systems", + "repository": "https://github.com/theqrl/web3.js", + "author": "The QRL Contributors", "license": "LGPL-3.0", "engines": { "node": ">=14", diff --git a/packages/web3-rpc-methods/README.md b/packages/web3-rpc-methods/README.md index 2b46d105..85434cd5 100644 --- a/packages/web3-rpc-methods/README.md +++ b/packages/web3-rpc-methods/README.md @@ -1,38 +1,35 @@ -

- web3.js -

-# Web3 RPC Methods +# @theqrl/Web3 RPC Methods ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -[![NPM Package][npm-image]][npm-url] -[![Downloads][downloads-image]][npm-url] +[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-providers-methods)](https://www.npmjs.com/package/@theqrl/web3-providers-methods) +[![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-providers-methods)](https://www.npmjs.com/package/@theqrl/web3-providers-methods) -This is a sub-package of [web3.js][repo]. +This is a sub-package of [@theqrl/web3.js](https://github.com/theqrl/web3.js). -`web3-rpc-methods` contains RPC methods for various ETH related protocols. +`@theqrl/web3-rpc-methods` contains RPC methods for various ETH related protocols. ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3-rpc-methods) or using [Yarn](https://yarnpkg.com/package/web3-rpc-methods) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3-rpc-methods) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3-rpc-methods) ### Using NPM ```bash -npm install web3-rpc-methods +npm install @theqrl/web3-rpc-methods ``` ### Using Yarn ```bash -yarn add web3-rpc-methods +yarn add @theqrl/web3-rpc-methods ``` ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ## Prerequisites @@ -52,8 +49,8 @@ yarn add web3-rpc-methods | test:integration | Uses `jest` to run tests under `/test/integration` | | test:unit | Uses `jest` to run tests under `/test/unit` | -[docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-rpc-methods -[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-rpc-methods%2Fpackage.json -[npm-url]: https://npmjs.org/package/web3-rpc-methods -[downloads-image]: https://img.shields.io/npm/dm/web3-rpc-methods?label=npm%20downloads +[docs]: https://docs.theqrl.org/ +[repo]: https://github.com/theqrl/web3.js/tree/main/packages/web3-rpc-methods +[npm-image]: https://img.shields.io/github/package-json/v/theqrl/web3.js/main?filename=packages%2Fweb3-rpc-methods%2Fpackage.json +[npm-url]: https://npmjs.org/package/@theqrl/web3-rpc-methods +[downloads-image]: https://img.shields.io/npm/dm/@theqrl/web3-rpc-methods?label=npm%20downloads diff --git a/packages/web3-rpc-methods/package.json b/packages/web3-rpc-methods/package.json index 04b322c6..1fa33059 100644 --- a/packages/web3-rpc-methods/package.json +++ b/packages/web3-rpc-methods/package.json @@ -14,8 +14,8 @@ "require": "./lib/commonjs/index.js" } }, - "repository": "https://github.com/ChainSafe/web3.js", - "author": "ChainSafe Systems", + "repository": "https://github.com/theqrl/web3.js", + "author": "The QRL Contributors", "license": "LGPL-3.0", "engines": { "node": ">=14", diff --git a/packages/web3-types/README.md b/packages/web3-types/README.md index 7c15e2dc..6fbece36 100644 --- a/packages/web3-types/README.md +++ b/packages/web3-types/README.md @@ -1,38 +1,35 @@ -

- web3.js -

-# web3-types +# @theqrl/web3-types ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -[![NPM Package][npm-image]][npm-url] -[![Downloads][downloads-image]][npm-url] +[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-types)](https://www.npmjs.com/package/@theqrl/web3-types) +[![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-types)](https://www.npmjs.com/package/@theqrl/web3-types) -This is a sub-package of [web3.js][repo]. +This is a sub-package of [@theqrl/web3.js](https://github.com/theqrl/web3.js). -`web3-types` contains the common data structures and interfaces used in [web3.js][repo]. +`@theqrl/web3-types` contains the common data structures and interfaces used in [@theqrl/web3.js](https://github.com/theqrl/web3.js). ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3-types) or using [Yarn](https://yarnpkg.com/package/web3-types) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3-types) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3-types) ### Using NPM ```bash -npm install web3-types +npm install @theqrl/web3-types ``` ### Using Yarn ```bash -yarn add web3-types +yarn add @theqrl/web3-types ``` ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ## Prerequisites @@ -52,8 +49,8 @@ yarn add web3-types | test:integration | Uses `jest` to run tests under `/test/integration` | | test:unit | Uses `jest` to run tests under `/test/unit` | -[docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-types -[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-types%2Fpackage.json -[npm-url]: https://npmjs.org/package/web3-types -[downloads-image]: https://img.shields.io/npm/dm/web3-types?label=npm%20downloads +[docs]: https://docs.theqrl.org/ +[repo]: https://github.com/theqrl/web3.js/tree/main/packages/web3-types +[npm-image]: https://img.shields.io/github/package-json/v/theqrl/web3.js/main?filename=packages%2Fweb3-types%2Fpackage.json +[npm-url]: https://npmjs.org/package/@theqrl/web3-types +[downloads-image]: https://img.shields.io/npm/dm/@theqrl/web3-types?label=npm%20downloads diff --git a/packages/web3-types/package.json b/packages/web3-types/package.json index d5805859..f32f4e9f 100644 --- a/packages/web3-types/package.json +++ b/packages/web3-types/package.json @@ -14,8 +14,8 @@ "require": "./lib/commonjs/index.js" } }, - "repository": "https://github.com/ChainSafe/web3.js", - "author": "ChainSafe Systems", + "repository": "https://github.com/theqrl/web3.js", + "author": "The QRL Contributors", "license": "LGPL-3.0", "engines": { "node": ">=14", diff --git a/packages/web3-utils/README.md b/packages/web3-utils/README.md index 8d9f8293..6510f56c 100644 --- a/packages/web3-utils/README.md +++ b/packages/web3-utils/README.md @@ -1,38 +1,35 @@ -

- web3.js -

-# web3-utils +# @theqrl/web3-utils ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -[![NPM Package][npm-image]][npm-url] -[![Downloads][downloads-image]][npm-url] +[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-utils)](https://www.npmjs.com/package/@theqrl/web3-utils) +[![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-utils)](https://www.npmjs.com/package/@theqrl/web3-utils) -This is a sub-package of [web3.js][repo]. +This is a sub-package of [@theqrl/web3.js](https://github.com/theqrl/web3.js). -`web3-utils` This contains useful utility functions for Dapp developers. +`@theqrl/web3-utils` This contains useful utility functions for Dapp developers. ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3-utils) or using [Yarn](https://yarnpkg.com/package/web3-utils) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3-utils) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3-utils) ### Using NPM ```bash -npm install web3-utils +npm install @theqrl/web3-utils ``` ### Using Yarn ```bash -yarn add web3-utils +yarn add @theqrl/web3-utils ``` ## Usage ```js -const Web3Utils = require('web3-utils'); +const Web3Utils = require('@theqrl/web3-utils'); console.log(Web3Utils); { sha3: function(){}, @@ -44,8 +41,8 @@ console.log(Web3Utils); ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ## Prerequisites @@ -65,8 +62,8 @@ console.log(Web3Utils); | test:integration | Uses `jest` to run tests under `/test/integration` | | test:unit | Uses `jest` to run tests under `/test/unit` | -[docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-utils -[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-utils%2Fpackage.json -[npm-url]: https://npmjs.org/package/web3-utils -[downloads-image]: https://img.shields.io/npm/dm/web3-utils?label=npm%20downloads +[docs]: https://docs.theqrl.org/ +[repo]: https://github.com/theqrl/web3.js/tree/main/packages/web3-utils +[npm-image]: https://img.shields.io/github/package-json/v/theqrl/web3.js/main?filename=packages%2Fweb3-utils%2Fpackage.json +[npm-url]: https://npmjs.org/package/@theqrl/web3-utils +[downloads-image]: https://img.shields.io/npm/dm/@theqrl/web3-utils?label=npm%20downloads diff --git a/packages/web3-utils/package.json b/packages/web3-utils/package.json index 2d196fb3..0638d953 100644 --- a/packages/web3-utils/package.json +++ b/packages/web3-utils/package.json @@ -15,8 +15,8 @@ "require": "./lib/commonjs/index.js" } }, - "repository": "https://github.com/ChainSafe/web3.js", - "author": "ChainSafe Systems", + "repository": "https://github.com/theqrl/web3.js", + "author": "The QRL Contributors", "license": "LGPL-3.0", "engines": { "node": ">=14", diff --git a/packages/web3-validator/README.md b/packages/web3-validator/README.md index f8e75959..695f7beb 100644 --- a/packages/web3-validator/README.md +++ b/packages/web3-validator/README.md @@ -1,38 +1,35 @@ -

- web3.js -

-# web3-validator +# @theqrl/web3-validator ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -[![NPM Package][npm-image]][npm-url] -[![Downloads][downloads-image]][npm-url] +[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-validator)](https://www.npmjs.com/package/@theqrl/web3-validator) +[![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-validator)](https://www.npmjs.com/package/@theqrl/web3-validator) -This is a sub-package of [web3.js][repo]. +This is a sub-package of [@theqrl/web3.js](https://github.com/theqrl/web3.js). -`web3-validator` contains functions for validating objects. +`@theqrl/web3-validator` contains functions for validating objects. ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3-validator) or using [Yarn](https://yarnpkg.com/package/web3-validator) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3-validator) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3-validator) ### Using NPM ```bash -npm install web3-validator +npm install @theqrl/web3-validator ``` ### Using Yarn ```bash -yarn add web3-validator +yarn add @theqrl/web3-validator ``` ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ### Usage @@ -91,8 +88,8 @@ The implementation of the validator is extension of [JSON-Schema-Draft07](https: | test:integration | Uses `jest` to run tests under `/test/integration` | | test:unit | Uses `jest` to run tests under `/test/unit` | -[docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-validator -[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-validator%2Fpackage.json -[npm-url]: https://npmjs.org/package/web3-validator -[downloads-image]: https://img.shields.io/npm/dm/web3-validator?label=npm%20downloads +[docs]: https://docs.theqrl.org/ +[repo]: https://github.com/theqrl/web3.js/tree/main/packages/web3-validator +[npm-image]: https://img.shields.io/github/package-json/v/theqrl/web3.js/main?filename=packages%2Fweb3-validator%2Fpackage.json +[npm-url]: https://npmjs.org/package/@theqrl/web3-validator +[downloads-image]: https://img.shields.io/npm/dm/@theqrl/web3-validator?label=npm%20downloads diff --git a/packages/web3-validator/package.json b/packages/web3-validator/package.json index c18421e0..1db8f407 100644 --- a/packages/web3-validator/package.json +++ b/packages/web3-validator/package.json @@ -15,8 +15,8 @@ } }, "browser": "./dist/web3-validator.min.js", - "repository": "https://github.com/ChainSafe/web3.js", - "author": "ChainSafe Systems", + "repository": "https://github.com/theqrl/web3.js", + "author": "The QRL Contributors", "license": "LGPL-3.0", "engines": { "node": ">=14", diff --git a/packages/web3-zond-abi/README.md b/packages/web3-zond-abi/README.md index 5a5f4c65..98ca6393 100644 --- a/packages/web3-zond-abi/README.md +++ b/packages/web3-zond-abi/README.md @@ -1,38 +1,34 @@ -

- web3.js -

- -# web3.js - Web3-Zond-Abi +# @theqrl/web3.js - Web3-Zond-Abi ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -[![NPM Package][npm-image]][npm-url] -[![Downloads][downloads-image]][npm-url] +[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-zond-abi)](https://www.npmjs.com/package/@theqrl/web3-zond-abi) +[![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-zond-abi)](https://www.npmjs.com/package/@theqrl/web3-zond-abi) -This is a sub-package of [web3.js][repo]. +This is a sub-package of [@theqrl/web3.js](https://github.com/theqrl/web3.js). -`web3-zond-abi` contains functions for the encode and decode ZVM in/output. +`@theqrl/web3-zond-abi` contains functions for the encode and decode ZVM in/output. ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3-eth-abi) or using [Yarn](https://yarnpkg.com/package/web3-eth-abi) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3-zond-abi) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3-zond-abi) ### Using NPM ```bash -npm install web3-zond-abi +npm install @theqrl/web3-zond-abi ``` ### Using Yarn ```bash -yarn add web3-zond-abi +yarn add @theqrl/web3-zond-abi ``` ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ## Prerequisites @@ -52,8 +48,8 @@ yarn add web3-zond-abi | test:integration | Uses `jest` to run tests under `/test/integration` | | test:unit | Uses `jest` to run tests under `/test/unit` | -[docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-eth-abi -[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-abi%2Fpackage.json -[npm-url]: https://npmjs.org/package/web3-eth-abi -[downloads-image]: https://img.shields.io/npm/dm/web3-eth-abi?label=npm%20downloads +[docs]: https://docs.theqrl.org/ +[repo]: https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-abi +[npm-image]: https://img.shields.io/github/package-json/v/theqrl/web3.js/main?filename=packages%2Fweb3-zond-abi%2Fpackage.json +[npm-url]: https://npmjs.org/package/@theqrl/web3-zond-abi +[downloads-image]: https://img.shields.io/npm/dm/@theqrl/web3-zond-abi?label=npm%20downloads diff --git a/packages/web3-zond-abi/package.json b/packages/web3-zond-abi/package.json index a39e00c9..362fea1c 100644 --- a/packages/web3-zond-abi/package.json +++ b/packages/web3-zond-abi/package.json @@ -14,8 +14,8 @@ "require": "./lib/commonjs/index.js" } }, - "repository": "https://github.com/theQRL/web3.js/tree/main/packages/web3-zond-abi", - "author": "ChainSafe Systems", + "repository": "https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-abi", + "author": "The QRL Contributors", "license": "LGPL-3.0", "engines": { "node": ">=14", diff --git a/packages/web3-zond-accounts/README.md b/packages/web3-zond-accounts/README.md index cc23184c..89c5c5d9 100644 --- a/packages/web3-zond-accounts/README.md +++ b/packages/web3-zond-accounts/README.md @@ -1,38 +1,34 @@ -

- web3.js -

- -# web3.js - Web3 Zond Accounts +# @theqrl/web3.js - Web3 Zond Accounts ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -[![NPM Package][npm-image]][npm-url] -[![Downloads][downloads-image]][npm-url] +[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-zond-accounts)](https://www.npmjs.com/package/@theqrl/web3-zond-accounts) +[![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-zond-accounts)](https://www.npmjs.com/package/@theqrl/web3-zond-accounts) -This is a sub-package of [web3.js][repo]. +This is a sub-package of [@theqrl/web3.js](https://github.com/theqrl/web3.js). -`web3-zond-accounts` contains functionality for managing Zond accounts and signing. +`@theqrl/web3-zond-accounts` contains functionality for managing Zond accounts and signing. ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3-eth-accounts) or using [Yarn](https://yarnpkg.com/package/web3-eth-accounts) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3-zond-accounts) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3-zond-accounts) ### Using NPM ```bash -npm install web3-zond-accounts +npm install @theqrl/web3-zond-accounts ``` ### Using Yarn ```bash -yarn add web3-zond-accounts +yarn add @theqrl/web3-zond-accounts ``` ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ## Prerequisites @@ -52,8 +48,8 @@ yarn add web3-zond-accounts | test:integration | Uses `jest` to run tests under `/test/integration` | | test:unit | Uses `jest` to run tests under `/test/unit` | -[docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-eth-accounts -[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-accounts%2Fpackage.json -[npm-url]: https://npmjs.org/package/web3-eth-accounts -[downloads-image]: https://img.shields.io/npm/dm/web3-eth-accounts?label=npm%20downloads +[docs]: https://docs.theqrl.org/ +[repo]: https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-accounts +[npm-image]: https://img.shields.io/github/package-json/v/theqrl/web3.js/main?filename=packages%2Fweb3-zond-accounts%2Fpackage.json +[npm-url]: https://npmjs.org/package/@theqrl/web3-zond-accounts +[downloads-image]: https://img.shields.io/npm/dm/@theqrl/web3-zond-accounts?label=npm%20downloads diff --git a/packages/web3-zond-accounts/package.json b/packages/web3-zond-accounts/package.json index bc8f6860..d92387e4 100644 --- a/packages/web3-zond-accounts/package.json +++ b/packages/web3-zond-accounts/package.json @@ -14,8 +14,8 @@ "require": "./lib/commonjs/index.js" } }, - "repository": "https://github.com/ChainSafe/web3.js", - "author": "ChainSafe Systems", + "repository": "https://github.com/theqrl/web3.js", + "author": "The QRL Contributors", "license": "LGPL-3.0", "engines": { "node": ">=14", diff --git a/packages/web3-zond-contract/README.md b/packages/web3-zond-contract/README.md index e0b4dfde..fc5e4f65 100644 --- a/packages/web3-zond-contract/README.md +++ b/packages/web3-zond-contract/README.md @@ -1,38 +1,35 @@ -

- web3.js -

-# web3.js - Zond Contract Package +# @theqrl/web3.js - Zond Contract Package ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -[![NPM Package][npm-image]][npm-url] -[![Downloads][downloads-image]][npm-url] +[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-zond-contract)](https://www.npmjs.com/package/@theqrl/web3-zond-contract) +[![Downloads](https://img.shields.io/npm/v/@theqrl/web3-zond-contract)](https://www.npmjs.com/package/@theqrl/web3-zond-contract) -This is a sub-package of [web3.js][repo]. +This is a sub-package of [@theqrl/web3.js](https://github.com/theqrl/web3.js). -`web3-zond-contract` contains the contract package used in `web3-zond`. +`@theqrl/web3-zond-contract` contains the contract package used in `@theqrl/web3-zond`. ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3-eth-contract) or using [Yarn](https://yarnpkg.com/package/web3-eth-contract) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3-zond-contract) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3-zond-contract) ### Using NPM ```bash -npm install web3-zond-contract +npm install @theqrl/web3-zond-contract ``` ### Using Yarn ```bash -yarn add web3-zond-contract +yarn add @theqrl/web3-zond-contract ``` ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ## Prerequisites @@ -60,7 +57,7 @@ const contract = new Contract(abi); We have tested the Typescript interface support for the ABIs compiled with hyperion version `v0.4.x` and above. If you face any issue regarding the contract typing, please create an issue to report to us. -The Typescript support for fixed length array types are supported up 30 elements. See more details [here](https://github.com/ChainSafe/web3.js/blob/nh%2F4562-contract-typing/packages/web3-eth-abi/src/number_map_type.ts#L1). This limitation is only to provide more performant developer experience in IDEs. In future we may come up with a workaround to avoid this limitation. If you have any idea feel free to share. +The Typescript support for fixed length array types are supported up 30 elements. This limitation is only to provide more performant developer experience in IDEs. In future we may come up with a workaround to avoid this limitation. If you have any idea feel free to share. ## Package.json Scripts @@ -75,8 +72,8 @@ The Typescript support for fixed length array types are supported up 30 elements | test:integration | Uses `jest` to run tests under `/test/integration` | | test:unit | Uses `jest` to run tests under `/test/unit` | -[docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-eth-contract -[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-contract%2Fpackage.json -[npm-url]: https://npmjs.org/package/web3-eth-contract -[downloads-image]: https://img.shields.io/npm/dm/web3-eth-contract?label=npm%20downloads +[docs]: https://docs.theqrl.org/ +[repo]: https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-contract +[npm-image]: https://img.shields.io/github/package-json/v/theqrl/web3.js/main?filename=packages%2Fweb3-zond-contract%2Fpackage.json +[npm-url]: https://npmjs.org/package/@theqrl/web3-zond-contract +[downloads-image]: https://img.shields.io/npm/dm/@theqrl/web3-zond-contract?label=npm%20downloads diff --git a/packages/web3-zond-contract/package.json b/packages/web3-zond-contract/package.json index dd07b777..94179226 100644 --- a/packages/web3-zond-contract/package.json +++ b/packages/web3-zond-contract/package.json @@ -14,8 +14,8 @@ "require": "./lib/commonjs/index.js" } }, - "repository": "https://github.com/theQRL/web3.js/tree/main/packages/web3-zond-contract", - "author": "ChainSafe Systems", + "repository": "https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-contract", + "author": "The QRL Contributors", "license": "LGPL-3.0", "engines": { "node": ">=14", diff --git a/packages/web3-zond-contract/src/index.ts b/packages/web3-zond-contract/src/index.ts index e545f268..238bf182 100644 --- a/packages/web3-zond-contract/src/index.ts +++ b/packages/web3-zond-contract/src/index.ts @@ -24,7 +24,7 @@ along with web3.js. If not, see . * To use it standalone: * * ```ts - * const Contract = require('web3-zond-contract'); + * const Contract = require('@theqrl/web3-zond-contract'); * * // set provider for all later instances to use * Contract.setProvider('ws://localhost:8546'); diff --git a/packages/web3-zond-ens/README.md b/packages/web3-zond-ens/README.md index 51f68dad..984426e0 100644 --- a/packages/web3-zond-ens/README.md +++ b/packages/web3-zond-ens/README.md @@ -1,38 +1,34 @@ -

- web3.js -

- -# web3.js - ENS +# @theqrl/web3.js - ENS ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -[![NPM Package][npm-image]][npm-url] -[![Downloads][downloads-image]][npm-url] +[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-zond-ens)](https://www.npmjs.com/package/@theqrl/web3-zond-ens) +[![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-zond-ens)](https://www.npmjs.com/package/@theqrl/web3-zond-ens) -This is a sub-package of [web3.js][repo]. +This is a sub-package of [@theqrl/web3.js](https://github.com/theqrl/web3.js). -`web3-zond-ens` This package has ENS functions for interacting with Ethereum Name Service. +`@theqrl/web3-zond-ens` This package has ENS functions for interacting with the Zond derivative of the Ethereum Name Service. ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3-eth-ens) or using [Yarn](https://yarnpkg.com/package/web3-eth-ens) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3-zond-ens) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3-zond-ens) ### Using NPM ```bash -npm install web3-zond-ens +npm install @theqrl/web3-zond-ens ``` ### Using Yarn ```bash -yarn add web3-zond-ens +yarn add @theqrl/web3-zond-ens ``` ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ## Prerequisites @@ -52,8 +48,8 @@ yarn add web3-zond-ens | test:integration | Uses `jest` to run tests under `/test/integration` | | test:unit | Uses `jest` to run tests under `/test/unit` | -[docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-eth-ens -[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-ens%2Fpackage.json -[npm-url]: https://npmjs.org/package/web3-eth-ens -[downloads-image]: https://img.shields.io/npm/dm/web3-eth-ens?label=npm%20downloads +[docs]: https://docs.theqrl.org/ +[repo]: https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-ens +[npm-image]: https://img.shields.io/github/package-json/v/theqrl/web3.js/main?filename=packages%2Fweb3-zond-ens%2Fpackage.json +[npm-url]: https://npmjs.org/package/@theqrl/web3-zond-ens +[downloads-image]: https://img.shields.io/npm/dm/@theqrl/web3-zond-ens?label=npm%20downloads diff --git a/packages/web3-zond-ens/package.json b/packages/web3-zond-ens/package.json index 5301f510..2b2c46c2 100644 --- a/packages/web3-zond-ens/package.json +++ b/packages/web3-zond-ens/package.json @@ -14,8 +14,8 @@ "require": "./lib/commonjs/index.js" } }, - "repository": "https://github.com/ChainSafe/web3.js", - "author": "ChainSafe Systems", + "repository": "https://github.com/theqrl/web3.js", + "author": "The QRL Contributors", "license": "LGPL-3.0", "engines": { "node": ">=14", diff --git a/packages/web3-zond-iban/README.md b/packages/web3-zond-iban/README.md index 7b6a3341..6cf5a74d 100644 --- a/packages/web3-zond-iban/README.md +++ b/packages/web3-zond-iban/README.md @@ -1,38 +1,34 @@ -

- web3.js -

- -# web3.js - IBAN +# @theqrl/web3.js - IBAN ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -[![NPM Package][npm-image]][npm-url] -[![Downloads][downloads-image]][npm-url] +[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-zond-iban)](https://www.npmjs.com/package/@theqrl/web3-zond-iban) +[![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-zond-iban)](https://www.npmjs.com/package/@theqrl/web3-zond-iban) -This is a sub-package of [web3.js][repo]. +This is a sub-package of [@theqrl/web3.js](https://github.com/theqrl/web3.js). -`web3-zond-iban` This package converts Zond addresses to IBAN addresses a vice versa. +`@theqrl/web3-zond-iban` This package converts Zond addresses to IBAN addresses a vice versa. ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3-eth-iban) or using [Yarn](https://yarnpkg.com/package/web3-eth-iban) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3-zond-iban) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3-zond-iban) ### Using NPM ```bash -npm install web3-zond-iban +npm install @theqrl/web3-zond-iban ``` ### Using Yarn ```bash -yarn add web3-zond-iban +yarn add @theqrl/web3-zond-iban ``` ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ## Prerequisites @@ -52,8 +48,8 @@ yarn add web3-zond-iban | test:integration | Uses `jest` to run tests under `/test/integration` | | test:unit | Uses `jest` to run tests under `/test/unit` | -[docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-eth-iban -[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-iban%2Fpackage.json -[npm-url]: https://npmjs.org/package/web3-eth-iban -[downloads-image]: https://img.shields.io/npm/dm/web3-eth-iban?label=npm%20downloads +[docs]: https://docs.theqrl.org/ +[repo]: https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-iban +[npm-image]: https://img.shields.io/github/package-json/v/theqrl/web3.js/main?filename=packages%2Fweb3-zond-iban%2Fpackage.json +[npm-url]: https://npmjs.org/package/@theqrl/web3-zond-iban +[downloads-image]: https://img.shields.io/npm/dm/@theqrl/web3-zond-iban?label=npm%20downloads diff --git a/packages/web3-zond-iban/package.json b/packages/web3-zond-iban/package.json index 4854da02..a0094fe8 100644 --- a/packages/web3-zond-iban/package.json +++ b/packages/web3-zond-iban/package.json @@ -14,8 +14,8 @@ "require": "./lib/commonjs/index.js" } }, - "repository": "https://github.com/ChainSafe/web3.js", - "author": "ChainSafe Systems", + "repository": "https://github.com/theqrl/web3.js", + "author": "The QRL Contributors", "license": "LGPL-3.0", "engines": { "node": ">=14", diff --git a/packages/web3-zond/README.md b/packages/web3-zond/README.md index 069eb82c..c9eed463 100644 --- a/packages/web3-zond/README.md +++ b/packages/web3-zond/README.md @@ -1,38 +1,35 @@ -

- web3.js -

-# web3.js - Zond +# @theqrl/web3.js - Zond ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -[![NPM Package][npm-image]][npm-url] -[![Downloads][downloads-image]][npm-url] +[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-zond)](https://www.npmjs.com/package/@theqrl/web3-zond) +[![Downloads](https://img.shields.io/npm/v/@theqrl/web3-zond)](https://www.npmjs.com/package/@theqrl/web3-zond) -This is a sub-package of [web3.js][repo]. +This is a sub-package of [@theqrl/web3.js](https://github.com/theqrl/web3.js). -`web3-zond` contains modules to interact with the Zond blockchain and smart contracts. +`@theqrl/web3-zond` contains modules to interact with the Zond blockchain and smart contracts. ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3-eth) or using [Yarn](https://yarnpkg.com/package/web3-eth) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3-zond) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3-zond) ### Using NPM ```bash -npm install web3-zond +npm install @theqrl/web3-zond ``` ### Using Yarn ```bash -yarn add web3-zond +yarn add @theqrl/web3-zond ``` ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ## Prerequisites @@ -52,8 +49,8 @@ yarn add web3-zond | test:integration | Uses `jest` to run tests under `/test/integration` | | test:unit | Uses `jest` to run tests under `/test/unit` | -[docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-eth -[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth%2Fpackage.json -[npm-url]: https://npmjs.org/package/web3-eth -[downloads-image]: https://img.shields.io/npm/dm/web3-eth?label=npm%20downloads +[docs]: https://docs.theqrl.org/ +[repo]: https://github.com/theqrl/web3.js/tree/main/packages/web3-zond +[npm-image]: https://img.shields.io/github/package-json/v/theqrl/web3.js/main?filename=packages%2Fweb3-zond%2Fpackage.json +[npm-url]: https://npmjs.org/package/@theqrl/web3-zond +[downloads-image]: https://img.shields.io/npm/dm/@theqrl/web3-zond?label=npm%20downloads diff --git a/packages/web3-zond/package.json b/packages/web3-zond/package.json index 42bae7be..5ec25d09 100644 --- a/packages/web3-zond/package.json +++ b/packages/web3-zond/package.json @@ -14,8 +14,8 @@ "require": "./lib/commonjs/index.js" } }, - "repository": "https://github.com/ChainSafe/web3.js", - "author": "ChainSafe Systems", + "repository": "https://github.com/theqrl/web3.js", + "author": "The QRL Contributors", "license": "LGPL-3.0", "engines": { "node": ">=14", diff --git a/packages/web3-zond/src/rpc_method_wrappers.ts b/packages/web3-zond/src/rpc_method_wrappers.ts index 319eda8e..ef2e4737 100644 --- a/packages/web3-zond/src/rpc_method_wrappers.ts +++ b/packages/web3-zond/src/rpc_method_wrappers.ts @@ -849,7 +849,7 @@ export async function signTransaction( } // TODO Decide what to do with transaction.to -// https://github.com/ChainSafe/web3.js/pull/4525#issuecomment-982330076 +// https://github.com/theqrl/web3.js/pull/4525#issuecomment-982330076 /** * View additional documentations here: {@link Web3Zond.call} * @param web3Context ({@link Web3Context}) Web3 configuration object that contains things such as the provider, request manager, wallet, etc. diff --git a/packages/web3-zond/src/web3_zond.ts b/packages/web3-zond/src/web3_zond.ts index 97766da2..d162234d 100644 --- a/packages/web3-zond/src/web3_zond.ts +++ b/packages/web3-zond/src/web3_zond.ts @@ -1052,7 +1052,7 @@ export class Web3Zond extends Web3Context { // check utils expect(getTransactionFromOrToAttr('from', zond2)).toBe(tempAcc3.address); - // TODO: after handleRevert implementation https://github.com/ChainSafe/web3.js/issues/5069 add following tests in future release + // TODO: after handleRevert implementation https://github.com/theqrl/web3.js/issues/5069 add following tests in future release // set handleRevert true and test following functions with invalid input tx data and see revert reason present in error details: contractMsgFrom.setConfig({ defaultAccount: tempAcc.address, @@ -157,7 +157,7 @@ describe('defaults', () => { }); it('handleRevert', () => { /* - //TO DO: after handleRevert implementation https://github.com/ChainSafe/web3.js/issues/5069 add following tests in future release + //TO DO: after handleRevert implementation https://github.com/theqrl/web3.js/issues/5069 add following tests in future release /* set handleRevert true and test following functions with invalid input tx data and see revert reason present in error details: web3.zond.call() diff --git a/packages/web3/README.md b/packages/web3/README.md index 334ed99e..93101f46 100644 --- a/packages/web3/README.md +++ b/packages/web3/README.md @@ -1,38 +1,34 @@ -

- web3.js -

- -# web3.js +# @theqrl/web3 ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -[![NPM Package][npm-image]][npm-url] -[![Downloads][downloads-image]][npm-url] +[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3)](https://www.npmjs.com/package/@theqrl/web3) +[![Downloads](https://img.shields.io/npm/dy/@theqrl/web3)](https://www.npmjs.com/package/@theqrl/web3) -This is the main package of [web3.js](repo). +This is the main package of [@theqrl/web3.js](https://github.com/theqrl/web3.js). -`web3` contains the ideal setup for a Web3.js package. +`@theqrl/web3` contains the ideal setup for a Zond Web3.js package. ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3) or using [Yarn](https://yarnpkg.com/package/web3) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3) ### Using NPM ```bash -npm install web3 +npm install @theqrl/web3 ``` ### Using Yarn ```bash -yarn add web3 +yarn add @theqrl/web3 ``` ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ## Prerequisites @@ -58,26 +54,26 @@ We encourage users to use only required individual packages listed in following | Package | Version | License | Docs | Description | | ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| [web3](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3%2Fpackage.json)](https://www.npmjs.com/package/web3) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3) | :rotating_light: Entire Web3.js offering (includes all packages) | -| [web3-core](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-core) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-core%2Fpackage.json)](https://www.npmjs.com/package/web3-core) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-core) | Core functions for web3.js packages | -| [web3-errors](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-errors) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-errors%2Fpackage.json)](https://www.npmjs.com/package/web3-core) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-errors) | Errors Objects | -| [web3-zond](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth%2Fpackage.json)](https://www.npmjs.com/package/web3-eth) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-eth) | Modules to interact with the Zond blockchain and smart contracts | -| [web3-zond-abi](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-abi) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-abi%2Fpackage.json)](https://www.npmjs.com/package/web3-eth-abi) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-eth-abi) | Functions for encoding and decoding ZVM in/output | -| [web3-zond-accounts](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-accounts) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-accounts%2Fpackage.json)](https://www.npmjs.com/package/web3-eth-accounts) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-eth-accounts) | Functions for managing Zond accounts and signing | -| [web3-zond-contract](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-contract) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-contract%2Fpackage.json)](https://www.npmjs.com/package/web3-eth-contract) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-eth-contract) | The contract package contained in [web3-zond](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth) | -| [web3-zond-ens](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-ens) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-ens%2Fpackage.json)](https://www.npmjs.com/package/web3-eth-ens) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-eth-ens) | Functions for interacting with the Ethereum Name Service | -| [web3-zond-iban](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-iban) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-iban%2Fpackage.json)](https://www.npmjs.com/package/web3-eth-iban) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-eth-iban) | Functionality for converting Zond addressed to IBAN addressed and vice versa | -| [web3-net](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-net) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-net%2Fpackage.json)](https://www.npmjs.com/package/web3-net) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-net) | Functions to interact with an Zond node's network properties | -| [web3-providers-http](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-providers-http) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-providers-http%2Fpackage.json)](https://www.npmjs.com/package/web3-providers-http) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-providers-http) | Web3.js provider for the HTTP protocol | -| [web3-providers-ipc](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-providers-ipc) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-providers-ipc%2Fpackage.json)](https://www.npmjs.com/package/web3-providers-ipc) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-providers-ipc) | Web3.js provider for IPC | -| [web3-providers-ws](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-providers-ws) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-providers-ws%2Fpackage.json)](https://www.npmjs.com/package/web3-providers-ws) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-providers-ws) | Web3.js provider for the Websocket protocol | -| [web3-rpc-methods](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-rpc-methods) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-rpc-methods%2Fpackage.json)](https://www.npmjs.com/package/web3-types) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/) | RPC Methods | -| [web3-types](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-types) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-types%2Fpackage.json)](https://www.npmjs.com/package/web3-types) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-types) | Shared useable types | -| [web3-utils](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-utils) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-utils%2Fpackage.json)](https://www.npmjs.com/package/web3-utils) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-utils) | Useful utility functions for Dapp developers | -| [web3-validator](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-validator) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-validator%2Fpackage.json)](https://www.npmjs.com/package/web3-validator) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.web3js.org/api/web3-validator) | Utilities for validating objects | - -[docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3 -[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3%2Fpackage.json -[npm-url]: https://npmjs.org/package/web3 -[downloads-image]: https://img.shields.io/npm/dm/web3?label=npm%20downloads +| [web3](https://github.com/theqrl/web3.js/tree/main/packages/web3) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3) | :rotating_light: Entire Web3.js offering (includes all packages) | +| [web3-core](https://github.com/theqrl/web3.js/tree/main/packages/web3-core) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-core%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-core) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-core) | Core functions for web3.js packages | +| [web3-errors](https://github.com/theqrl/web3.js/tree/main/packages/web3-errors) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-errors%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-core) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-errors) | Errors Objects | +| [web3-zond](https://github.com/theqrl/web3.js/tree/main/packages/web3-eth) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-eth%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-eth) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-eth) | Modules to interact with the Zond blockchain and smart contracts | +| [web3-zond-abi](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-abi) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-abi%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-abi) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-abi) | Functions for encoding and decoding ZVM in/output | +| [web3-zond-accounts](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-accounts) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-accounts%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-accounts) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-accounts) | Functions for managing Zond accounts and signing | +| [web3-zond-contract](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-contract) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-contract%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-contract) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-contract) | The contract package contained in [web3-zond](https://github.com/theqrl/web3.js/tree/main/packages/web3-eth) | +| [web3-zond-ens](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-ens) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-ens%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-ens) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-ens) | Functions for interacting with the Ethereum Name Service | +| [web3-zond-iban](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-iban) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-iban%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-iban) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-iban) | Functionality for converting Zond addressed to IBAN addressed and vice versa | +| [web3-net](https://github.com/theqrl/web3.js/tree/main/packages/web3-net) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-net%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-net) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-net) | Functions to interact with an Zond node's network properties | +| [web3-providers-http](https://github.com/theqrl/web3.js/tree/main/packages/web3-providers-http) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-providers-http%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-providers-http) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-providers-http) | Web3.js provider for the HTTP protocol | +| [web3-providers-ipc](https://github.com/theqrl/web3.js/tree/main/packages/web3-providers-ipc) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-providers-ipc%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-providers-ipc) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-providers-ipc) | Web3.js provider for IPC | +| [web3-providers-ws](https://github.com/theqrl/web3.js/tree/main/packages/web3-providers-ws) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-providers-ws%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-providers-ws) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-providers-ws) | Web3.js provider for the Websocket protocol | +| [web3-rpc-methods](https://github.com/theqrl/web3.js/tree/main/packages/web3-rpc-methods) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-rpc-methods%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-types) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/) | RPC Methods | +| [web3-types](https://github.com/theqrl/web3.js/tree/main/packages/web3-types) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-types%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-types) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-types) | Shared useable types | +| [web3-utils](https://github.com/theqrl/web3.js/tree/main/packages/web3-utils) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-utils%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-utils) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-utils) | Useful utility functions for Dapp developers | +| [web3-validator](https://github.com/theqrl/web3.js/tree/main/packages/web3-validator) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-validator%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-validator) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-validator) | Utilities for validating objects | + +[docs]: https://docs.theqrl.org/ +[repo]: https://github.com/theqrl/web3.js/tree/main/packages/web3 +[npm-image]: https://img.shields.io/github/package-json/v/theqrl/web3.js/main?filename=packages%2Fweb3%2Fpackage.json +[npm-url]: https://npmjs.org/package/@theqrl/web3 +[downloads-image]: https://img.shields.io/npm/dm/@theqrl/web3?label=npm%20downloads diff --git a/packages/web3/package.json b/packages/web3/package.json index cdd98baa..6fea073d 100644 --- a/packages/web3/package.json +++ b/packages/web3/package.json @@ -14,12 +14,12 @@ "require": "./lib/commonjs/index.js" } }, - "repository": "https://github.com/ChainSafe/web3.js", + "repository": "https://github.com/theqrl/web3.js", "engines": { "node": ">=14.0.0", "npm": ">=6.12.0" }, - "author": "ChainSafe Systems", + "author": "The QRL Contributors", "browser": "./dist/web3.min.js", "license": "LGPL-3.0", "keywords": [ diff --git a/packages/web3/test/cjs_black_box/package.json b/packages/web3/test/cjs_black_box/package.json index b22f62a6..898a2819 100644 --- a/packages/web3/test/cjs_black_box/package.json +++ b/packages/web3/test/cjs_black_box/package.json @@ -2,7 +2,7 @@ "name": "web3_black_box_cjs_tests", "version": "1.0.0", "main": "index.js", - "author": "ChainSafe Systems", + "author": "The QRL Contributors", "license": "LGPL-3.0", "type": "commonjs", "scripts": { diff --git a/packages/web3/test/cjs_black_box/test/batchRequest.test.ts b/packages/web3/test/cjs_black_box/test/batchRequest.test.ts index d4869783..e50a17a0 100644 --- a/packages/web3/test/cjs_black_box/test/batchRequest.test.ts +++ b/packages/web3/test/cjs_black_box/test/batchRequest.test.ts @@ -22,7 +22,7 @@ import { isWs, } from '../../shared_fixtures/system_tests_utils'; // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires -const Web3 = require('web3').default; +const Web3 = require('@theqrl/web3').default; describe('CJS - Black Box Unit Tests - web3.BatchRequest', () => { let web3: typeof Web3; diff --git a/packages/web3/test/cjs_black_box/test/web3-zond-accounts/hashMessage.test.ts b/packages/web3/test/cjs_black_box/test/web3-zond-accounts/hashMessage.test.ts index 630a64ca..3f5111c7 100644 --- a/packages/web3/test/cjs_black_box/test/web3-zond-accounts/hashMessage.test.ts +++ b/packages/web3/test/cjs_black_box/test/web3-zond-accounts/hashMessage.test.ts @@ -24,7 +24,7 @@ import { } from '../../../shared_fixtures/system_tests_utils'; /* eslint-disable @typescript-eslint/no-unsafe-call */ // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires -const Web3 = require('web3').default; +const Web3 = require('@theqrl/web3').default; jest.setTimeout(15000); diff --git a/packages/web3/test/cjs_black_box/test/web3-zond-contract/erc20.test.ts b/packages/web3/test/cjs_black_box/test/web3-zond-contract/erc20.test.ts index 26f7223f..bd902ac9 100644 --- a/packages/web3/test/cjs_black_box/test/web3-zond-contract/erc20.test.ts +++ b/packages/web3/test/cjs_black_box/test/web3-zond-contract/erc20.test.ts @@ -31,7 +31,7 @@ import { } from '../../../shared_fixtures/contracts/ERC20Token'; /* eslint-disable @typescript-eslint/no-unsafe-call */ // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires -const Web3 = require('web3').default; +const Web3 = require('@theqrl/web3').default; describeIf(getSystemTestBackend() === 'gzond')( diff --git a/packages/web3/test/cjs_black_box/test/web3-zond/getBlock.test.ts b/packages/web3/test/cjs_black_box/test/web3-zond/getBlock.test.ts index 345298db..99dcd53e 100644 --- a/packages/web3/test/cjs_black_box/test/web3-zond/getBlock.test.ts +++ b/packages/web3/test/cjs_black_box/test/web3-zond/getBlock.test.ts @@ -24,7 +24,7 @@ import { } from '../../../shared_fixtures/system_tests_utils'; /* eslint-disable @typescript-eslint/no-unsafe-call */ // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires -const Web3 = require('web3').default; +const Web3 = require('@theqrl/web3').default; describe('CJS - Black Box Unit Tests - web3.zond.getBlock', () => { let web3: typeof Web3; diff --git a/packages/web3/test/cjs_black_box/test/web3-zond/getTransaction.test.ts b/packages/web3/test/cjs_black_box/test/web3-zond/getTransaction.test.ts index 5f711848..c76005a8 100644 --- a/packages/web3/test/cjs_black_box/test/web3-zond/getTransaction.test.ts +++ b/packages/web3/test/cjs_black_box/test/web3-zond/getTransaction.test.ts @@ -22,7 +22,7 @@ import { } from '../../../shared_fixtures/system_tests_utils'; /* eslint-disable @typescript-eslint/no-unsafe-call */ // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires -const Web3 = require('web3').default; +const Web3 = require('@theqrl/web3').default; describe('CJS - Black Box Unit Tests - web3.zond.getTransaction', () => { let web3: typeof Web3; diff --git a/packages/web3/test/cjs_black_box/yarn.lock b/packages/web3/test/cjs_black_box/yarn.lock index 58987d9d..45fc3f87 100644 --- a/packages/web3/test/cjs_black_box/yarn.lock +++ b/packages/web3/test/cjs_black_box/yarn.lock @@ -2735,7 +2735,7 @@ web3-core@^5.0.0: integrity sha512-vVtZMUbZasYd/4bqHOP3t/l3dHOFzYCPnsxZM+ptc2p96GvryC6/OwwZZ6eh14bkih7VvSmUX/heuajCK4HQ1g== dependencies: web3-errors "^5.0.0" - web3-eth-iban "^5.0.0" + web3-zond-iban "^5.0.0" web3-providers-http "^5.0.0" web3-providers-ipc "^5.0.0" web3-providers-ws "^5.0.0" @@ -2750,9 +2750,9 @@ web3-errors@^5.0.0: dependencies: web3-types "^5.0.0" -web3-eth-abi@^5.0.0: +web3-zond-abi@^5.0.0: version "5.0.0" - resolved "http://localhost:4873/web3-eth-abi/-/web3-eth-abi-5.0.0.tgz#f88c78121a3f65107b44b34638e9a534e8cbdff6" + resolved "http://localhost:4873/web3-zond-abi/-/web3-zond-abi-5.0.0.tgz#f88c78121a3f65107b44b34638e9a534e8cbdff6" integrity sha512-TYsp6uXzXKSxJOEmWVkwyaFeFYrLCiu++Y4kAYXKFXOY+pSWGQ1owml/24KE+nLO9INvXir4ATxGVC3SuhZeYA== dependencies: "@ethersproject/abi" "^5.7.0" @@ -2761,9 +2761,9 @@ web3-eth-abi@^5.0.0: web3-types "^5.0.0" web3-utils "^5.0.0" -web3-eth-accounts@^5.0.0: +web3-zond-accounts@^5.0.0: version "5.0.0" - resolved "http://localhost:4873/web3-eth-accounts/-/web3-eth-accounts-5.0.0.tgz#75d223096e899db803bed2c684b8d542ea9b3cda" + resolved "http://localhost:4873/web3-zond-accounts/-/web3-zond-accounts-5.0.0.tgz#75d223096e899db803bed2c684b8d542ea9b3cda" integrity sha512-btDSO3A4EgAe3ibGQRjJOHPkA6ngMWWcgpvmQCQFBolCQQhGSiV72ywtjrDakJQtDPbdjKDGnFKQCzTC+dudWw== dependencies: "@ethereumjs/tx" "^3.5.2" @@ -2773,37 +2773,37 @@ web3-eth-accounts@^5.0.0: web3-utils "^5.0.0" web3-validator "^5.0.0" -web3-eth-contract@5.0.0, web3-eth-contract@^5.0.0: +web3-zond-contract@5.0.0, web3-zond-contract@^5.0.0: version "5.0.0" - resolved "http://localhost:4873/web3-eth-contract/-/web3-eth-contract-5.0.0.tgz#f54ccbc1194227f0e319358c924cd15732f01504" + resolved "http://localhost:4873/web3-zond-contract/-/web3-zond-contract-5.0.0.tgz#f54ccbc1194227f0e319358c924cd15732f01504" integrity sha512-dmzzYo56rzIAWHYIyU7drf5pRNTqHzfV/gyZIhZr/r5/9B4fwnmaROeDmiYvvGHtRa7bYbQ4/BFbyBvc+Mv6Ag== dependencies: web3-core "^5.0.0" web3-errors "^5.0.0" web3-eth "^5.0.0" - web3-eth-abi "^5.0.0" + web3-zond-abi "^5.0.0" web3-types "^5.0.0" web3-utils "^5.0.0" web3-validator "^5.0.0" -web3-eth-ens@^5.0.0: +web3-zond-ens@^5.0.0: version "5.0.0" - resolved "http://localhost:4873/web3-eth-ens/-/web3-eth-ens-5.0.0.tgz#938bf7982ab7208cb281745e9be9854a94d5f1ba" + resolved "http://localhost:4873/web3-zond-ens/-/web3-zond-ens-5.0.0.tgz#938bf7982ab7208cb281745e9be9854a94d5f1ba" integrity sha512-bz/brHWOvW8nSkt/8RPTi6aEuyNZHkl9W8siIpPHMPfNPpV49IGHhLz8WA9UuEhVbs+VJj5/7qMWkRVujS+omA== dependencies: "@adraffy/ens-normalize" "^1.8.8" web3-core "^5.0.0" web3-errors "^5.0.0" web3-eth "^5.0.0" - web3-eth-contract "^5.0.0" + web3-zond-contract "^5.0.0" web3-net "^5.0.0" web3-types "^5.0.0" web3-utils "^5.0.0" web3-validator "^5.0.0" -web3-eth-iban@^5.0.0: +web3-zond-iban@^5.0.0: version "5.0.0" - resolved "http://localhost:4873/web3-eth-iban/-/web3-eth-iban-5.0.0.tgz#381a800d82d0a9cff5d812d672b304391ddbb836" + resolved "http://localhost:4873/web3-zond-iban/-/web3-zond-iban-5.0.0.tgz#381a800d82d0a9cff5d812d672b304391ddbb836" integrity sha512-jB2uQynx4/30ODjGKPr/v3ftHYnqfAq/JGOZaBSdj5uZnCOnwZO5zHQE7LeBDsvyR0D5zkSVtKfGJHyChrod9Q== dependencies: web3-errors "^5.0.0" @@ -2811,9 +2811,9 @@ web3-eth-iban@^5.0.0: web3-utils "^5.0.0" web3-validator "^5.0.0" -web3-eth-personal@^5.0.0: +web3-zond-personal@^5.0.0: version "5.0.0" - resolved "http://localhost:4873/web3-eth-personal/-/web3-eth-personal-5.0.0.tgz#2bef135325ce087db83b2965d6bf81b32a3b1cac" + resolved "http://localhost:4873/web3-zond-personal/-/web3-zond-personal-5.0.0.tgz#2bef135325ce087db83b2965d6bf81b32a3b1cac" integrity sha512-RjTPVrXQ1xHNtLDBiMwBctBQRyddEt2pdvS/Ew7NJLJUHYLD4guzc1u/iszx5skrGA7TV5PCQGwFVFkUg08Bug== dependencies: web3-core "^5.0.0" @@ -2825,7 +2825,7 @@ web3-eth-personal@^5.0.0: web3-eth@5.0.0, web3-eth@^5.0.0: version "5.0.0" - resolved "http://localhost:4873/web3-eth/-/web3-eth-5.0.0.tgz#e3c0767117191415b912288689bdc40790e1e1e7" + resolved "http://localhost:4873/web3-eth/-/web3-zond-5.0.0.tgz#e3c0767117191415b912288689bdc40790e1e1e7" integrity sha512-K0i1CT/aFJFEVPfo8GHSVMvFz+XkFxVeOSjNlXyjD5lmOhZc95axxjlqFRwDXphy//GilggTlVuYC4NWpueQaw== dependencies: "@ethereumjs/common" "^2.6.5" @@ -2833,8 +2833,8 @@ web3-eth@5.0.0, web3-eth@^5.0.0: setimmediate "^1.0.5" web3-core "^5.0.0" web3-errors "^5.0.0" - web3-eth-abi "^5.0.0" - web3-eth-accounts "^5.0.0" + web3-zond-abi "^5.0.0" + web3-zond-accounts "^5.0.0" web3-net "^5.0.0" web3-providers-ws "^5.0.0" web3-rpc-methods "^5.0.0" @@ -2924,12 +2924,12 @@ web3@5.0.0: web3-core "^5.0.0" web3-errors "^5.0.0" web3-eth "^5.0.0" - web3-eth-abi "^5.0.0" - web3-eth-accounts "^5.0.0" - web3-eth-contract "^5.0.0" - web3-eth-ens "^5.0.0" - web3-eth-iban "^5.0.0" - web3-eth-personal "^5.0.0" + web3-zond-abi "^5.0.0" + web3-zond-accounts "^5.0.0" + web3-zond-contract "^5.0.0" + web3-zond-ens "^5.0.0" + web3-zond-iban "^5.0.0" + web3-zond-personal "^5.0.0" web3-net "^5.0.0" web3-providers-http "^5.0.0" web3-providers-ipc "^5.0.0" diff --git a/packages/web3/test/esm_black_box/package.json b/packages/web3/test/esm_black_box/package.json index 0b232f96..c24e84ca 100644 --- a/packages/web3/test/esm_black_box/package.json +++ b/packages/web3/test/esm_black_box/package.json @@ -2,7 +2,7 @@ "name": "web3_black_box_esm_tests", "version": "1.0.0", "main": "index.js", - "author": "ChainSafe Systems", + "author": "The QRL Contributors", "license": "LGPL-3.0", "type": "module", "scripts": { diff --git a/packages/web3/test/esm_black_box/yarn.lock b/packages/web3/test/esm_black_box/yarn.lock index e726d718..e575cafe 100644 --- a/packages/web3/test/esm_black_box/yarn.lock +++ b/packages/web3/test/esm_black_box/yarn.lock @@ -2737,7 +2737,7 @@ web3-core@^5.0.0: integrity sha512-BjWC0apqv48vK+tgjBtNXxef6Ujgkwmupum5Ld+uAgP9lssEPlUtvGkho1myPKY45dWzC3rAbxfT2H7FwscA6Q== dependencies: web3-errors "^5.0.0" - web3-eth-iban "^5.0.0" + web3-zond-iban "^5.0.0" web3-providers-http "^5.0.0" web3-providers-ipc "^5.0.0" web3-providers-ws "^5.0.0" @@ -2752,9 +2752,9 @@ web3-errors@^5.0.0: dependencies: web3-types "^5.0.0" -web3-eth-abi@^5.0.0: +web3-zond-abi@^5.0.0: version "5.0.0" - resolved "http://localhost:4873/web3-eth-abi/-/web3-eth-abi-5.0.0.tgz#29b1e45e7f64e432ddad903328a2cc41c193456b" + resolved "http://localhost:4873/web3-zond-abi/-/web3-zond-abi-5.0.0.tgz#29b1e45e7f64e432ddad903328a2cc41c193456b" integrity sha512-y6GjMi95Fq4Djt1nm3GBCrxrY+2/yDpUon4UwA2tDikFSnMr2xQx8vmymF1IIQjkDWQnhS8KdbJYUXgb4cKd6A== dependencies: "@ethersproject/abi" "^5.6.4" @@ -2762,9 +2762,9 @@ web3-eth-abi@^5.0.0: web3-types "^5.0.0" web3-utils "^5.0.0" -web3-eth-accounts@^5.0.0: +web3-zond-accounts@^5.0.0: version "5.0.0" - resolved "http://localhost:4873/web3-eth-accounts/-/web3-eth-accounts-5.0.0.tgz#c8f4b2fdf1bbf2324a687c1c1e9ed98e5c578985" + resolved "http://localhost:4873/web3-zond-accounts/-/web3-zond-accounts-5.0.0.tgz#c8f4b2fdf1bbf2324a687c1c1e9ed98e5c578985" integrity sha512-DGzzO5hRfMm/DK+xU5GEJ53dihS1PShT6U8X+oFQkENhHZDx5/+zD6znyVpbcZ/ypRgf12q1YVRm2PAh45NRCw== dependencies: "@ethereumjs/tx" "^3.5.2" @@ -2774,45 +2774,45 @@ web3-eth-accounts@^5.0.0: web3-utils "^5.0.0" web3-validator "^5.0.0" -web3-eth-contract@5.0.0, web3-eth-contract@^5.0.0: +web3-zond-contract@5.0.0, web3-zond-contract@^5.0.0: version "5.0.0" - resolved "http://localhost:4873/web3-eth-contract/-/web3-eth-contract-5.0.0.tgz#dde4856bc8b3e00c35499cbbc260ba8d6bf10e4d" + resolved "http://localhost:4873/web3-zond-contract/-/web3-zond-contract-5.0.0.tgz#dde4856bc8b3e00c35499cbbc260ba8d6bf10e4d" integrity sha512-FYtL4W3sFyXmMVtIRX7qaN7c07gMXyha5i3tti2MnroojteqFm0cY2q8qvAPatDrCincx4Xi+OhXw+BBmhDYFw== dependencies: web3-core "^5.0.0" web3-errors "^5.0.0" web3-eth "^5.0.0" - web3-eth-abi "^5.0.0" + web3-zond-abi "^5.0.0" web3-types "^5.0.0" web3-utils "^5.0.0" web3-validator "^5.0.0" -web3-eth-ens@^5.0.0: +web3-zond-ens@^5.0.0: version "5.0.0" - resolved "http://localhost:4873/web3-eth-ens/-/web3-eth-ens-5.0.0.tgz#825fb84cab99785f6f621ecffca3f8088b3828cf" + resolved "http://localhost:4873/web3-zond-ens/-/web3-zond-ens-5.0.0.tgz#825fb84cab99785f6f621ecffca3f8088b3828cf" integrity sha512-+DWenDS2Yt7N4jidWPmxbvKFFyhHOIyvqQJSWOFtajZ04Lk8Nxc4G1zELJuau49B16rC3yBL/9MwtIr8WMIxQQ== dependencies: idna-uts46-hx "^3.5.0" web3-core "^5.0.0" web3-errors "^5.0.0" web3-eth "^5.0.0" - web3-eth-contract "^5.0.0" + web3-zond-contract "^5.0.0" web3-net "^5.0.0" web3-types "^5.0.0" web3-utils "^5.0.0" -web3-eth-iban@^5.0.0: +web3-zond-iban@^5.0.0: version "5.0.0" - resolved "http://localhost:4873/web3-eth-iban/-/web3-eth-iban-5.0.0.tgz#63f40186331c9fc6b38f3686d1605714956c2b4e" + resolved "http://localhost:4873/web3-zond-iban/-/web3-zond-iban-5.0.0.tgz#63f40186331c9fc6b38f3686d1605714956c2b4e" integrity sha512-pp7MpmKgQmf/LAuM0S7Ufv0xCzsSqPnCmLGaUApLi8gHMsPZY07uxeiH/oEZyzYkdaR+nbkPF/Y/Ztj0N3PNHQ== dependencies: web3-errors "^5.0.0" web3-types "^5.0.0" web3-utils "^5.0.0" -web3-eth-personal@^5.0.0: +web3-zond-personal@^5.0.0: version "5.0.0" - resolved "http://localhost:4873/web3-eth-personal/-/web3-eth-personal-5.0.0.tgz#623c687163a784d1edacb395614e986623d358cd" + resolved "http://localhost:4873/web3-zond-personal/-/web3-zond-personal-5.0.0.tgz#623c687163a784d1edacb395614e986623d358cd" integrity sha512-rt6fbYTpTo89KejPcf81rnzGHU9CSDH6M2W+S06e6vZEFVzyoSa/kyTgMKrzKI2Q7widLM4JSz/aMNEMgY2vWw== dependencies: web3-core "^5.0.0" @@ -2823,14 +2823,14 @@ web3-eth-personal@^5.0.0: web3-eth@5.0.0, web3-eth@^5.0.0: version "5.0.0" - resolved "http://localhost:4873/web3-eth/-/web3-eth-5.0.0.tgz#5b2b19677ee3c61aa26215cbe6b7dec6dbb16ddc" + resolved "http://localhost:4873/web3-eth/-/web3-zond-5.0.0.tgz#5b2b19677ee3c61aa26215cbe6b7dec6dbb16ddc" integrity sha512-pp8yuLKiO1Vpjp1yY7x+OUd2Pf4fAg1hC4Cv2muP4Pmy/MhqJBRJcxsS6fmPWbj9y9IV/lbdbFF6DBSunUYppw== dependencies: "@ethereumjs/common" "^2.6.5" "@ethereumjs/tx" "^3.5.2" web3-core "^5.0.0" web3-errors "^5.0.0" - web3-eth-accounts "^5.0.0" + web3-zond-accounts "^5.0.0" web3-net "^5.0.0" web3-providers-ws "^5.0.0" web3-types "^5.0.0" @@ -2908,12 +2908,12 @@ web3@5.0.0: web3-core "^5.0.0" web3-errors "^5.0.0" web3-eth "^5.0.0" - web3-eth-abi "^5.0.0" - web3-eth-accounts "^5.0.0" - web3-eth-contract "^5.0.0" - web3-eth-ens "^5.0.0" - web3-eth-iban "^5.0.0" - web3-eth-personal "^5.0.0" + web3-zond-abi "^5.0.0" + web3-zond-accounts "^5.0.0" + web3-zond-contract "^5.0.0" + web3-zond-ens "^5.0.0" + web3-zond-iban "^5.0.0" + web3-zond-personal "^5.0.0" web3-net "^5.0.0" web3-types "^5.0.0" web3-utils "^5.0.0" diff --git a/tools/eslint-config-base-web3/package.json b/tools/eslint-config-base-web3/package.json index 08c48af8..b5ede7b7 100644 --- a/tools/eslint-config-base-web3/package.json +++ b/tools/eslint-config-base-web3/package.json @@ -5,7 +5,7 @@ "access": "public" }, "description": "Base eslint config for Web3 project.", - "author": "ChainSafe Systems", + "author": "The QRL Contributors", "private": true, "license": "LGPL-3.0", "keywords": [ @@ -16,13 +16,13 @@ "web3.js", "blockchain" ], - "homepage": "https://github.com/ChainSafe/web3.js#readme", + "homepage": "https://github.com/theqrl/web3.js#readme", "repository": { "type": "git", - "url": "git+https://github.com/ChainSafe/web3.js.git" + "url": "git+https://github.com/theqrl/web3.js.git" }, "bugs": { - "url": "https://github.com/ChainSafe/web3.js/issues" + "url": "https://github.com/theqrl/web3.js/issues" }, "engines": { "node": ">=12", diff --git a/tools/web3-packagetemplate/README.md b/tools/web3-packagetemplate/README.md index 4fe1e003..17be6a71 100644 --- a/tools/web3-packagetemplate/README.md +++ b/tools/web3-packagetemplate/README.md @@ -1,38 +1,34 @@ -

- web3.js -

- -# web3.js - Package Template +# @theqrl/web3.js - Package Template ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -[![NPM Package][npm-image]][npm-url] -[![Downloads][downloads-image]][npm-url] +[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-packagetemplate)](https://www.npmjs.com/package/@theqrl/web3-packagetemplate) +[![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-packagetemplate)](https://www.npmjs.com/package/@theqrl/web3-packagetemplate) -This is a sub-package of [web3.js][repo]. +This is a sub-package of [@theqrl/web3.js](https://github.com/theqrl/web3.js). -`web3-packagetemplate` contains the ideal setup for a Web3.js package. +`@theqrl/web3-packagetemplate` contains the ideal setup for a Web3.js package. ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3-packagetemplate) or using [Yarn](https://yarnpkg.com/package/web3-packagetemplate) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3-packagetemplate) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3-packagetemplate) ### Using NPM ```bash -npm install web3-packagetemplate +npm install @theqrl/web3-packagetemplate ``` ### Using Yarn ```bash -yarn add web3-packagetemplate +yarn add @theqrl/web3-packagetemplate ``` ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ## Prerequisites @@ -52,8 +48,8 @@ yarn add web3-packagetemplate | test:integration | Uses `jest` to run tests under `/test/integration` | | test:unit | Uses `jest` to run tests under `/test/unit` | -[docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/tools/web3-packagetemplate -[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=tools%2Fweb3-packagetemplate%2Fpackage.json -[npm-url]: https://npmjs.org/package/web3-packagetemplate -[downloads-image]: https://img.shields.io/npm/dm/web3-packagetemplate?label=npm%20downloads +[docs]: https://docs.theqrl.org/ +[repo]: https://github.com/theqrl/web3.js/tree/main/tools/web3-packagetemplate +[npm-image]: https://img.shields.io/github/package-json/v/theqrl/web3.js/main?filename=tools%2Fweb3-packagetemplate%2Fpackage.json +[npm-url]: https://npmjs.org/package/@theqrl/web3-packagetemplate +[downloads-image]: https://img.shields.io/npm/dm/@theqrl/web3-packagetemplate?label=npm%20downloads diff --git a/tools/web3-packagetemplate/package.json b/tools/web3-packagetemplate/package.json index cc9e7e71..aab1dd9f 100644 --- a/tools/web3-packagetemplate/package.json +++ b/tools/web3-packagetemplate/package.json @@ -6,8 +6,8 @@ }, "description": "Package template for Web3", "main": "lib/index.js", - "repository": "https://github.com/ChainSafe/web3.js", - "author": "ChainSafe Systems", + "repository": "https://github.com/theqrl/web3.js", + "author": "The QRL Contributors", "license": "LGPL-3.0", "engines": { "node": ">=14", diff --git a/tools/web3-plugin-example/README.md b/tools/web3-plugin-example/README.md index f06e2d7d..0f8b0d9e 100644 --- a/tools/web3-plugin-example/README.md +++ b/tools/web3-plugin-example/README.md @@ -1,36 +1,33 @@ -

- web3.js -

-# Web3 Plugin Example +# @theqrl/Web3 Plugin Example ![ES Version](https://img.shields.io/badge/ES-2020-yellow) ![Node Version](https://img.shields.io/badge/node-14.x-green) -[![NPM Package][npm-image]][npm-url] -[![Downloads][downloads-image]][npm-url] +[![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-plugin-example)](https://www.npmjs.com/package/@theqrl/web3-plugin-example) +[![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-plugin-example)](https://www.npmjs.com/package/@theqrl/web3-plugin-example) -This is an example of a plugin implementation for [web3.js][repo]. +This is an example of a plugin implementation for [@theqrl/web3.js](https://github.com/theqrl/web3.js). ## Installation -You can install the package either using [NPM](https://www.npmjs.com/package/web3-plugin-example) or using [Yarn](https://yarnpkg.com/package/web3-plugin-example) +You can install the package either using [NPM](https://www.npmjs.com/package/@theqrl/web3-plugin-example) or using [Yarn](https://yarnpkg.com/package/@theqrl/web3-plugin-example) ### Using NPM ```bash -npm install web3-plugin-example +npm install @theqrl/web3-plugin-example ``` ### Using Yarn ```bash -yarn add web3-plugin-example +yarn add @theqrl/web3-plugin-example ``` ## Getting Started -- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP) - ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord) +- :writing_hand: If you have questions [submit an issue](https://github.com/theqrl/web3.js/issues/new) or join us on [Discord](https://theqrl.org/discord) + ![Discord](https://img.shields.io/discord/357604137204056065.svg?label=Discord&logo=discord) ## Prerequisites @@ -50,8 +47,8 @@ yarn add web3-plugin-example | test:integration | Uses `jest` to run tests under `/test/integration` | | test:unit | Uses `jest` to run tests under `/test/unit` | -[docs]: https://docs.web3js.org/ -[repo]: https://github.com/web3/web3.js/tree/4.x/tools/web3-plugin-example -[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=tools%2Fweb3-plugin-example%2Fpackage.json -[npm-url]: https://npmjs.org/package/web3-plugin-example -[downloads-image]: https://img.shields.io/npm/dm/web3-plugin-example?label=npm%20downloads +[docs]: https://docs.theqrl.org/ +[repo]: https://github.com/theqrl/web3.js/tree/main/tools/web3-plugin-example +[npm-image]: https://img.shields.io/github/package-json/v/theqrl/web3.js/main?filename=tools%2Fweb3-plugin-example%2Fpackage.json +[npm-url]: https://npmjs.org/package/@theqrl/web3-plugin-example +[downloads-image]: https://img.shields.io/npm/dm/@theqrl/web3-plugin-example?label=npm%20downloads diff --git a/tools/web3-plugin-example/package.json b/tools/web3-plugin-example/package.json index 6e1d05ad..7ed8577f 100644 --- a/tools/web3-plugin-example/package.json +++ b/tools/web3-plugin-example/package.json @@ -5,12 +5,12 @@ "access": "public" }, "description": "Example implementations of Web3.js' plugin system", - "repository": "https://github.com/ChainSafe/web3.js", + "repository": "https://github.com/theqrl/web3.js", "engines": { "node": ">=14", "npm": ">=6.12.0" }, - "author": "ChainSafe Systems", + "author": "The QRL Contributors", "license": "LGPL-3.0", "keywords": [ "Zond", From b8d0d92f924a9eb949e5e2eb39878017055ff0ee Mon Sep 17 00:00:00 2001 From: JP Lomas Date: Wed, 2 Jul 2025 10:38:21 +0100 Subject: [PATCH 2/3] Node version badge to v18.x --- README.md | 2 +- packages/web3-core/README.md | 2 +- packages/web3-errors/README.md | 2 +- packages/web3-net/README.md | 2 +- packages/web3-providers-http/README.md | 2 +- packages/web3-providers-ipc/README.md | 2 +- packages/web3-providers-ws/README.md | 2 +- packages/web3-rpc-methods/README.md | 2 +- packages/web3-types/README.md | 2 +- packages/web3-utils/README.md | 2 +- packages/web3-validator/README.md | 2 +- packages/web3-zond-abi/README.md | 2 +- packages/web3-zond-accounts/README.md | 2 +- packages/web3-zond-contract/README.md | 2 +- packages/web3-zond-ens/README.md | 2 +- packages/web3-zond-iban/README.md | 2 +- packages/web3-zond/README.md | 2 +- packages/web3/README.md | 2 +- tools/web3-packagetemplate/README.md | 2 +- tools/web3-plugin-example/README.md | 2 +- 20 files changed, 20 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 59d7d2f4..6a56e25e 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ ![Contributors](https://img.shields.io/github/contributors/web3/web3.js?label=contributors%20on%20all%20branches) ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) Web3.js is a TypeScript implementation of the [Zond JSON RPC API](https://eth.wiki/json-rpc/API) and related tooling maintained by [The QRL Contributors](https://chainsafe.io). diff --git a/packages/web3-core/README.md b/packages/web3-core/README.md index c29dfd32..ab831247 100644 --- a/packages/web3-core/README.md +++ b/packages/web3-core/README.md @@ -1,7 +1,7 @@ # @theqrl/web3.js - Web3 Core ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) [![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-core)][[npm-url](https://www.npmjs.com/package/@theqrl/web3-core)] [![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-core)][[npm-url](https://www.npmjs.com/package/@theqrl/web3-core)] diff --git a/packages/web3-errors/README.md b/packages/web3-errors/README.md index 1c2191bd..0286b1c4 100644 --- a/packages/web3-errors/README.md +++ b/packages/web3-errors/README.md @@ -1,7 +1,7 @@ # @theqrl/web3.js - Web3-Errors ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) [![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-errors)](https://www.npmjs.com/package/@theqrl/web3-errors) [![Downloads](https://img.shields.io/npm/dy/@theqrl/web3-errors)](https://www.npmjs.com/package/@theqrl/web3-errors) diff --git a/packages/web3-net/README.md b/packages/web3-net/README.md index babbd741..6ccdd0da 100644 --- a/packages/web3-net/README.md +++ b/packages/web3-net/README.md @@ -2,7 +2,7 @@ # web3.js - Net ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) [![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-net)](https://www.npmjs.com/package/@theqrl/web3-net) [![Downloads](https://img.shields.io/npm/v/@theqrl/web3-net)](https://www.npmjs.com/package/@theqrl/web3-net) diff --git a/packages/web3-providers-http/README.md b/packages/web3-providers-http/README.md index 389b1747..53e7f16d 100644 --- a/packages/web3-providers-http/README.md +++ b/packages/web3-providers-http/README.md @@ -2,7 +2,7 @@ # @theqrl/web3.js - Http Provider ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) [![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-providers-http)](https://www.npmjs.com/package/@theqrl/web3-providers-http) [![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-providers-http)](https://www.npmjs.com/package/@theqrl/web3-providers-http) diff --git a/packages/web3-providers-ipc/README.md b/packages/web3-providers-ipc/README.md index 1b3689c4..cb9efa55 100644 --- a/packages/web3-providers-ipc/README.md +++ b/packages/web3-providers-ipc/README.md @@ -2,7 +2,7 @@ # @theqrl/web3.js - IPC Provider ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) [![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-providers-ipc)](https://www.npmjs.com/package/@theqrl/web3-providers-ipc) [![Downloads](https://img.shields.io/npm/dy/@theqrl/web3-providers-ipc)](https://www.npmjs.com/package/@theqrl/web3-providers-ipc) diff --git a/packages/web3-providers-ws/README.md b/packages/web3-providers-ws/README.md index 6e102a5f..393d7192 100644 --- a/packages/web3-providers-ws/README.md +++ b/packages/web3-providers-ws/README.md @@ -2,7 +2,7 @@ # @theqrl/web3.js - Websocket Provider ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) [![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-providers-ws)](https://www.npmjs.com/package/@theqrl/web3-providers-ws) [![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-providers-ws)](https://www.npmjs.com/package/@theqrl/web3-providers-ws) diff --git a/packages/web3-rpc-methods/README.md b/packages/web3-rpc-methods/README.md index 85434cd5..9154767a 100644 --- a/packages/web3-rpc-methods/README.md +++ b/packages/web3-rpc-methods/README.md @@ -2,7 +2,7 @@ # @theqrl/Web3 RPC Methods ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) [![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-providers-methods)](https://www.npmjs.com/package/@theqrl/web3-providers-methods) [![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-providers-methods)](https://www.npmjs.com/package/@theqrl/web3-providers-methods) diff --git a/packages/web3-types/README.md b/packages/web3-types/README.md index 6fbece36..fdf4c459 100644 --- a/packages/web3-types/README.md +++ b/packages/web3-types/README.md @@ -2,7 +2,7 @@ # @theqrl/web3-types ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) [![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-types)](https://www.npmjs.com/package/@theqrl/web3-types) [![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-types)](https://www.npmjs.com/package/@theqrl/web3-types) diff --git a/packages/web3-utils/README.md b/packages/web3-utils/README.md index 6510f56c..5ed814c3 100644 --- a/packages/web3-utils/README.md +++ b/packages/web3-utils/README.md @@ -2,7 +2,7 @@ # @theqrl/web3-utils ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) [![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-utils)](https://www.npmjs.com/package/@theqrl/web3-utils) [![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-utils)](https://www.npmjs.com/package/@theqrl/web3-utils) diff --git a/packages/web3-validator/README.md b/packages/web3-validator/README.md index 695f7beb..cf8d22b3 100644 --- a/packages/web3-validator/README.md +++ b/packages/web3-validator/README.md @@ -2,7 +2,7 @@ # @theqrl/web3-validator ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) [![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-validator)](https://www.npmjs.com/package/@theqrl/web3-validator) [![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-validator)](https://www.npmjs.com/package/@theqrl/web3-validator) diff --git a/packages/web3-zond-abi/README.md b/packages/web3-zond-abi/README.md index 98ca6393..8192e4fb 100644 --- a/packages/web3-zond-abi/README.md +++ b/packages/web3-zond-abi/README.md @@ -1,7 +1,7 @@ # @theqrl/web3.js - Web3-Zond-Abi ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) [![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-zond-abi)](https://www.npmjs.com/package/@theqrl/web3-zond-abi) [![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-zond-abi)](https://www.npmjs.com/package/@theqrl/web3-zond-abi) diff --git a/packages/web3-zond-accounts/README.md b/packages/web3-zond-accounts/README.md index 89c5c5d9..63c5762a 100644 --- a/packages/web3-zond-accounts/README.md +++ b/packages/web3-zond-accounts/README.md @@ -1,7 +1,7 @@ # @theqrl/web3.js - Web3 Zond Accounts ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) [![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-zond-accounts)](https://www.npmjs.com/package/@theqrl/web3-zond-accounts) [![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-zond-accounts)](https://www.npmjs.com/package/@theqrl/web3-zond-accounts) diff --git a/packages/web3-zond-contract/README.md b/packages/web3-zond-contract/README.md index fc5e4f65..3d0bd993 100644 --- a/packages/web3-zond-contract/README.md +++ b/packages/web3-zond-contract/README.md @@ -2,7 +2,7 @@ # @theqrl/web3.js - Zond Contract Package ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) [![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-zond-contract)](https://www.npmjs.com/package/@theqrl/web3-zond-contract) [![Downloads](https://img.shields.io/npm/v/@theqrl/web3-zond-contract)](https://www.npmjs.com/package/@theqrl/web3-zond-contract) diff --git a/packages/web3-zond-ens/README.md b/packages/web3-zond-ens/README.md index 984426e0..32888007 100644 --- a/packages/web3-zond-ens/README.md +++ b/packages/web3-zond-ens/README.md @@ -1,7 +1,7 @@ # @theqrl/web3.js - ENS ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) [![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-zond-ens)](https://www.npmjs.com/package/@theqrl/web3-zond-ens) [![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-zond-ens)](https://www.npmjs.com/package/@theqrl/web3-zond-ens) diff --git a/packages/web3-zond-iban/README.md b/packages/web3-zond-iban/README.md index 6cf5a74d..accd570d 100644 --- a/packages/web3-zond-iban/README.md +++ b/packages/web3-zond-iban/README.md @@ -1,7 +1,7 @@ # @theqrl/web3.js - IBAN ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) [![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-zond-iban)](https://www.npmjs.com/package/@theqrl/web3-zond-iban) [![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-zond-iban)](https://www.npmjs.com/package/@theqrl/web3-zond-iban) diff --git a/packages/web3-zond/README.md b/packages/web3-zond/README.md index c9eed463..dc516612 100644 --- a/packages/web3-zond/README.md +++ b/packages/web3-zond/README.md @@ -2,7 +2,7 @@ # @theqrl/web3.js - Zond ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) [![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-zond)](https://www.npmjs.com/package/@theqrl/web3-zond) [![Downloads](https://img.shields.io/npm/v/@theqrl/web3-zond)](https://www.npmjs.com/package/@theqrl/web3-zond) diff --git a/packages/web3/README.md b/packages/web3/README.md index 93101f46..0632f295 100644 --- a/packages/web3/README.md +++ b/packages/web3/README.md @@ -1,7 +1,7 @@ # @theqrl/web3 ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) [![NPM Package](https://img.shields.io/npm/v/@theqrl/web3)](https://www.npmjs.com/package/@theqrl/web3) [![Downloads](https://img.shields.io/npm/dy/@theqrl/web3)](https://www.npmjs.com/package/@theqrl/web3) diff --git a/tools/web3-packagetemplate/README.md b/tools/web3-packagetemplate/README.md index 17be6a71..f8cbd3e0 100644 --- a/tools/web3-packagetemplate/README.md +++ b/tools/web3-packagetemplate/README.md @@ -1,7 +1,7 @@ # @theqrl/web3.js - Package Template ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) [![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-packagetemplate)](https://www.npmjs.com/package/@theqrl/web3-packagetemplate) [![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-packagetemplate)](https://www.npmjs.com/package/@theqrl/web3-packagetemplate) diff --git a/tools/web3-plugin-example/README.md b/tools/web3-plugin-example/README.md index 0f8b0d9e..dc604cf3 100644 --- a/tools/web3-plugin-example/README.md +++ b/tools/web3-plugin-example/README.md @@ -2,7 +2,7 @@ # @theqrl/Web3 Plugin Example ![ES Version](https://img.shields.io/badge/ES-2020-yellow) -![Node Version](https://img.shields.io/badge/node-14.x-green) +![Node Version](https://img.shields.io/badge/node-18.x-green) [![NPM Package](https://img.shields.io/npm/v/@theqrl/web3-plugin-example)](https://www.npmjs.com/package/@theqrl/web3-plugin-example) [![Downloads](https://img.shields.io/npm/dm/@theqrl/web3-plugin-example)](https://www.npmjs.com/package/@theqrl/web3-plugin-example) From a10aac06a809e45fbeae9040262ff4eb3e6f9a95 Mon Sep 17 00:00:00 2001 From: JP Lomas Date: Wed, 2 Jul 2025 12:03:07 +0100 Subject: [PATCH 3/3] Fix some broken links --- CONTRIBUTIONS.md | 8 ++- README.md | 4 +- RELEASE.md | 8 +-- .../support_additional_rpc_methods/index.md | 16 +++--- .../web3_tree_shaking_support_guide/index.md | 6 +-- .../basics/sign_and_send_tx/local_wallet.md | 4 +- .../sign_and_send_tx/wallet_of_zond_node.md | 4 +- docs/docs/guides/basics/zond.md | 4 +- ...ng_and_interacting_with_smart_contracts.md | 6 +-- .../infer_contract_types_guide/index.md | 4 +- .../web3_plugin_guide/plugin_authors.md | 49 ++++++++++--------- .../guides/web3_plugin_guide/plugin_users.md | 8 +-- .../web3_providers_guide/events_listening.md | 2 +- .../docs/guides/web3_providers_guide/index.md | 17 +++---- packages/web3/README.md | 4 +- packages/web3/test/e2e/web3_extend.test.ts | 2 +- 16 files changed, 73 insertions(+), 73 deletions(-) diff --git a/CONTRIBUTIONS.md b/CONTRIBUTIONS.md index 95b072de..a3bf15a8 100644 --- a/CONTRIBUTIONS.md +++ b/CONTRIBUTIONS.md @@ -1,8 +1,10 @@ ## Guidelines for Pull Requests and Releases +_These guidelines are a work in progress and will be changed/updated as the project evolves._ + This document provides some ground rules for contributors (including the maintainer(s) of the project) about how to make, review and publish changes. The most basic requirement is -that **Web3 not break**. +that **this should not break**. ### Pull Requests for substantive changes (e.g. everything except comments and docs) @@ -45,7 +47,3 @@ Read more in [Release Guidelines](./RELEASE.md). ### Emergencies Emergency releases are allowed to shorten waiting periods depending on the severity of the issue. - -There is precedent set for this in the 1.2.6 release (see [#3351](https://github.com/ethereum/web3.js/pull/3351)), where the consensus view was to make the smallest change necessary to address the emergency while waiving the `rc` process (meaning many existing additions to master were excluded). - -This topic is under further org-wide discussion at [ethereum/js-organization#6](https://github.com/ethereum/js-organization/issues/6). diff --git a/README.md b/README.md index 6a56e25e..474ec1ab 100644 --- a/README.md +++ b/README.md @@ -55,10 +55,10 @@ These links are for the Web3.js but should be useful pointers in the correct dir | [web3](https://github.com/theqrl/web3.js/tree/main/packages/web3) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3) | :rotating_light: Entire Web3.js offering (includes all packages) | | [web3-core](https://github.com/theqrl/web3.js/tree/main/packages/web3-core) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-core%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-core) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-core) | Core functions for web3.js packages | | [web3-errors](https://github.com/theqrl/web3.js/tree/main/packages/web3-errors) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-errors%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-core) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-errors) | Errors Objects | -| [web3-zond](https://github.com/theqrl/web3.js/tree/main/packages/web3-eth) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-eth%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-eth) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-eth) | Modules to interact with the Zond blockchain and smart contracts | +| [web3-zond](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-eth%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-eth) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-eth) | Modules to interact with the Zond blockchain and smart contracts | | [web3-zond-abi](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-abi) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-abi%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-abi) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-abi) | Functions for encoding and decoding ZVM in/output | | [web3-zond-accounts](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-accounts) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-accounts%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-accounts) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-accounts) | Functions for managing Zond accounts and signing | -| [web3-zond-contract](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-contract) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-contract%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-contract) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-contract) | The contract package contained in [web3-zond](https://github.com/theqrl/web3.js/tree/main/packages/web3-eth) | +| [web3-zond-contract](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-contract) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-contract%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-contract) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-contract) | The contract package contained in [web3-zond](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond) | | [web3-zond-ens](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-ens) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-ens%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-ens) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-ens) | Functions for interacting with the Ethereum Name Service | | [web3-zond-iban](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-iban) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-iban%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-iban) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-iban) | Functionality for converting Zond addressed to IBAN addressed and vice versa | | [web3-net](https://github.com/theqrl/web3.js/tree/main/packages/web3-net) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-net%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-net) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-net) | Functions to interact with an Zond node's network properties | diff --git a/RELEASE.md b/RELEASE.md index 1a83f5f7..990c88cc 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,8 +1,10 @@ -# web3.js Release Guidelines +# @theqrl/web3.js Release Guidelines + +_This document has not yet been fully ported from the original web3.js repository. It is a work in progress and will be updated in the future._ ## Version Number Definition -The web3.js project follows the [semver 2.0.0 specification](https://semver.org/). +The @theqrl/web3.js project follows the [semver 2.0.0 specification](https://semver.org/). ### Major @@ -44,7 +46,7 @@ Further details about versioning can be found in the [semver 2.0.0 specification 8. `git tag bumped-version`: Tag the commit with bumped version having prefix `v` , e.g. `git tag v4.0.1-alpha.0` 9. `git push origin release/bumped-version`: Push release branch to `origin` 10. `git push origin --tags`: Push release tag created in `Step 8` to `origin` -11. Create a draft release on Github similar to [this](https://github.com/theqrl/web3.js/releases/tag/web3-providers-base%401.0.0-alpha.1) +11. Create a draft release on Github similar to [this Chainsafe example](https://github.com/chainsafe/web3.js/releases/tag/web3-providers-base%401.0.0-alpha.1) - Check `This is a pre-release` - In the release description, copy all entries in `CHANGELOG.md` for the version being released 12. Click `Save draft` diff --git a/docs/docs/guides/advanced/support_additional_rpc_methods/index.md b/docs/docs/guides/advanced/support_additional_rpc_methods/index.md index 92928698..ad0b44ca 100644 --- a/docs/docs/guides/advanced/support_additional_rpc_methods/index.md +++ b/docs/docs/guides/advanced/support_additional_rpc_methods/index.md @@ -24,7 +24,7 @@ This will give your plugin access to [requestManager](/api/web3-core/class/Web3C :::caution ```ts -import { Web3PluginBase } from 'web3'; +import { Web3PluginBase } from '@theqrl/web3'; export default class CustomRpcMethodsPlugin extends Web3PluginBase { // step 1 @@ -35,7 +35,7 @@ export default class CustomRpcMethodsPlugin extends Web3PluginBase { 2. After that add public `pluginNamespace` property. This will be used to access your plugin, as mentioned in step number 5 code example. ```ts -import { Web3PluginBase } from 'web3'; +import { Web3PluginBase } from '@theqrl/web3'; export default class CustomRpcMethodsPlugin extends Web3PluginBase { public pluginNamespace = 'customRpcMethods'; // step 2 @@ -45,7 +45,7 @@ export default class CustomRpcMethodsPlugin extends Web3PluginBase { 3. Once plugin class is created using above mentioned steps, its very easy to add new RPC methods like: ```ts -import { Web3PluginBase } from 'web3'; +import { Web3PluginBase } from '@theqrl/web3'; export default class CustomRpcMethodsPlugin extends Web3PluginBase { public pluginNamespace = 'customRpcMethods'; @@ -64,7 +64,7 @@ export default class CustomRpcMethodsPlugin extends Web3PluginBase { 4. Final step is setting up module [augmentation](https://www.typescriptlang.org/docs/handbook/declaration-merging.html#module-augmentation), this will allow you to access plugin on web3 object. ```ts -import { Web3PluginBase } from 'web3'; +import { Web3PluginBase } from '@theqrl/web3'; export default class CustomRpcMethodsPlugin extends Web3PluginBase { public pluginNamespace = 'customRpcMethods'; @@ -79,7 +79,7 @@ export default class CustomRpcMethodsPlugin extends Web3PluginBase { } // Module Augmentation -declare module 'web3' { +declare module '@theqrl/web3' { // step 4 interface Web3Context { @@ -99,8 +99,8 @@ After the plugin is ready, it is recommended to publish it on the NPM registry. Once plugin is registered its custom methods will be available to use. ```ts -import { Web3 } from 'web3'; -import CustomRpcMethodsPlugin from 'web3-plugin-example'; +import { Web3 } from '@theqrl/web3'; +import CustomRpcMethodsPlugin from '@theqrl/web3-plugin-example'; const web3 = new Web3('http://127.0.0.1:8545'); web3.registerPlugin(new CustomRpcMethodsPlugin()); // step 5 @@ -112,6 +112,6 @@ web3.customRpcMethods.customRpcMethod(); For more details follow : -- [Example Plugin Code](https://github.com/web3/web3.js/tree/main/tools/web3-plugin-example) +- [Example Plugin Code](https://github.com/theqrl/web3.js/tree/main/tools/web3-plugin-example) - [Web3 Plugin developers Guide](/guides/web3_plugin_guide/plugin_authors) - [Web3 Plugin Users Guide](/guides/web3_plugin_guide/plugin_users) diff --git a/docs/docs/guides/advanced/web3_tree_shaking_support_guide/index.md b/docs/docs/guides/advanced/web3_tree_shaking_support_guide/index.md index 9f1266d1..906365ea 100644 --- a/docs/docs/guides/advanced/web3_tree_shaking_support_guide/index.md +++ b/docs/docs/guides/advanced/web3_tree_shaking_support_guide/index.md @@ -34,10 +34,10 @@ For further information about `sideEffects` see [webpack docs](https://webpack.j import Web3Zond from '@theqrl/web3-zond'; ``` -If you only need a few functions from `web3-utils`: +If you only need a few functions from `@theqrl/web3-utils`: ```ts -import { numberToHex, hexToNumber } from 'web3-utils'; +import { numberToHex, hexToNumber } from '@theqrl/web3-utils'; ``` -You can find an example app with tree shaking [here](https://github.com/theqrl/web3js-example-react-app). +You can find an example app with tree shaking [here](https://github.com/ChainSafe/web3js-example-react-app). diff --git a/docs/docs/guides/basics/sign_and_send_tx/local_wallet.md b/docs/docs/guides/basics/sign_and_send_tx/local_wallet.md index a3d78cec..2e546fc4 100644 --- a/docs/docs/guides/basics/sign_and_send_tx/local_wallet.md +++ b/docs/docs/guides/basics/sign_and_send_tx/local_wallet.md @@ -11,7 +11,7 @@ The simplest way to sign and send transactions is using a local wallet: ```ts // First step: initialize `web3` instance -import Web3 from 'web3'; +import Web3 from '@theqrl/web3'; const web3 = new Web3(/* PROVIDER*/); // Second step: add an account to wallet @@ -45,7 +45,7 @@ List of references: ```ts // First step: initialize `web3` instance -import Web3 from 'web3'; +import Web3 from '@theqrl/web3'; const web3 = new Web3(/* PROVIDER*/); // Second step: add an account to wallet diff --git a/docs/docs/guides/basics/sign_and_send_tx/wallet_of_zond_node.md b/docs/docs/guides/basics/sign_and_send_tx/wallet_of_zond_node.md index e3f95993..4ea60ea5 100644 --- a/docs/docs/guides/basics/sign_and_send_tx/wallet_of_zond_node.md +++ b/docs/docs/guides/basics/sign_and_send_tx/wallet_of_zond_node.md @@ -11,7 +11,7 @@ If Zond node has unlocked account in its wallet you can send transaction without ```ts // First step: initialize web3 instance -import Web3 from 'web3'; +import Web3 from '@theqrl/web3'; const web3 = new Web3(/* PROVIDER*/); // Second step: sign and send the transaction @@ -37,7 +37,7 @@ List of references: ```ts // First step: initialize web3 instance -import Web3 from 'web3'; +import Web3 from '@theqrl/web3'; const web3 = new Web3(/* PROVIDER*/); // Second step: sign and send the transaction diff --git a/docs/docs/guides/basics/zond.md b/docs/docs/guides/basics/zond.md index abaac557..de06a331 100644 --- a/docs/docs/guides/basics/zond.md +++ b/docs/docs/guides/basics/zond.md @@ -65,7 +65,7 @@ Note that we are installing the latest version of 4.x, at the time of this tutor Next, create a new file called `index.ts` in your project directory and add the following code to it: ```javascript -const { Web3 } = require('@theqrl/web3'); // web3.js has native ESM builds and (`import Web3 from 'web3'`) +const { Web3 } = require('@theqrl/web3'); // web3.js has native ESM builds and (`import Web3 from '@theqrl/web3'`) // Set up a connection to the Ganache network const web3 = new Web3(new Web3.providers.HttpProvider('http://localhost:7545')); @@ -99,7 +99,7 @@ In the first example, we are going to send a simple value transaction. Create a file named `transaction.ts` and fill it with the following code: ```typescript -const { Web3 } = require('@theqrl/web3'); // web3.js has native ESM builds and (`import Web3 from 'web3'`) +const { Web3 } = require('@theqrl/web3'); // web3.js has native ESM builds and (`import Web3 from '@theqrl/web3'`) const fs = require('fs'); const path = require('path'); diff --git a/docs/docs/guides/smart_contracts/deploying_and_interacting_with_smart_contracts.md b/docs/docs/guides/smart_contracts/deploying_and_interacting_with_smart_contracts.md index 2f348332..ad11866a 100644 --- a/docs/docs/guides/smart_contracts/deploying_and_interacting_with_smart_contracts.md +++ b/docs/docs/guides/smart_contracts/deploying_and_interacting_with_smart_contracts.md @@ -182,7 +182,7 @@ Note that we are installing the latest version of 4.x, at the time of this tutor Next, create a new file called `index.js` in your project directory and add the following code to it: ```javascript -const { Web3 } = require('@theqrl/web3'); // web3.js has native ESM builds and (`import Web3 from 'web3'`) +const { Web3 } = require('@theqrl/web3'); // web3.js has native ESM builds and (`import Web3 from '@theqrl/web3'`) // Set up a connection to the Ganache network const web3 = new Web3(new Web3.providers.HttpProvider('http://localhost:7545')); @@ -217,7 +217,7 @@ Create a file named `deploy.js` and fill it with the following code: ```javascript // For simplicity we use `web3` package here. However, if you are concerned with the size, // you may import individual packages like 'web3-zond', 'web3-zond-contract' and 'web3-providers-http'. -const { Web3 } = require('@theqrl/web3'); // web3.js has native ESM builds and (`import Web3 from 'web3'`) +const { Web3 } = require('@theqrl/web3'); // web3.js has native ESM builds and (`import Web3 from '@theqrl/web3'`) const fs = require('fs'); const path = require('path'); @@ -293,7 +293,7 @@ In this step, we will use web3.js to interact with the smart contract on the Gan Create a file named `interact.js` and fill it with the following code: ```javascript -const { Web3 } = require('@theqrl/web3'); // web3.js has native ESM builds and (`import Web3 from 'web3'`) +const { Web3 } = require('@theqrl/web3'); // web3.js has native ESM builds and (`import Web3 from '@theqrl/web3'`) const fs = require('fs'); const path = require('path'); diff --git a/docs/docs/guides/smart_contracts/infer_contract_types_guide/index.md b/docs/docs/guides/smart_contracts/infer_contract_types_guide/index.md index d01993ec..e89978be 100644 --- a/docs/docs/guides/smart_contracts/infer_contract_types_guide/index.md +++ b/docs/docs/guides/smart_contracts/infer_contract_types_guide/index.md @@ -11,7 +11,7 @@ Before we dive into the problem, let's take a quick look at the problem. Web3.js Web3.js uses ABI type to dynamically load available methods and events but Typescript currently [doesn't support loading JSON as const](https://github.com/microsoft/TypeScript/issues/32063). If you go to the [Playground Link](https://www.typescriptlang.org/play?#code/MYewdgzgLgBAhgIwJYwLwwNoCga5gbxz1wCIkwAHAVyghIC5MjjdCWWywoBTAJzDgAbACoBPCtwYwS0XuQDmJADTN20gQFtJjEpu4B9ZavYko47dNkKSxvAF8VagreKce-IWIlSZUOWEVHJ3U4LR8IUQ0EEEFDIKdTc3C-axcYO1sAXXi8XzgeAFkaRCRBJDMfMHAKOFFEQUkc0jNvHVBIPypgKBBeG2IHVTYOOCqwSJAqOkYAMyEIbibpcmpaKWwnYYTyABNuAA9uHalOxbTScncBESSdOB2d3m4IOiXXPR8QAHcwPiNg6QtCwke6PZ50NKDTbnZZgPaHY6MU5vXKXPjXLzA0FPF7-YK6ULAiASOF-FHNW7SbHg-pqKFqLZqTjwo5SOaCBbk2FXTyUkhUS4AJgArAA2PEJD46ABuQiojRhiVa0gFXBF4shWSWBLCOgAghQKLwQLLBBLckCfNxpdwuLTcPTWLYQWMJlM2fMziYVjRpkxoQDmQdWUjePKuW50bzlSCHjjXoqpdIZsaNOaTJa7nGaZCUYzvaSEScw178WiPDcY9TcRGk6YQOmOJmqdncbm0vmOLtg4iYOzOYryxi+aqoOrG+9CT5TfKJxaR0KxfaWBl2NlnXXhLxRhAZmTnc2SNbbVBl47nAXVn6NgzB1wo5Wsa2E4G699fn0I4fqxCnOfiJ2rhDtGT5gjWiZTjoxK2nsn6Kt+z7LgMWobpBVKCII3yjMAComJMUBXusHZ3jyj4+KO461mhJBzhSMYUUumprtq0D5NwRRQCUZQVDKSDcF8jZKsCMxUGA3RIOAZ45J2nCEYwN7sIBqL3hWmI+D+tEhLqlgkrBmlCepiHtgGZYqcO9GLuKVHaSCGiTHaX4LmqjF-ihJh1nAhrGjagn4XJ-q3oGwFkTo0QxPpdb6YeYVmkxLDriYrGFMUyDcaIlTVLU9S4U2fIiWJUASWAUlDM6PprPJxFBWZIGGWBL74h5wCgKJp6OVWRmucxqE2QgQjYdwADyMy+TQ-kKSwSkXDVIUqpZEXUVFTlji5dJuRwSXsSlpTlOlvH8YJh75eJkmqOeMnldeCUcHWezAEgGjzKNBG+kRJnbDNak6KOAAcC02UtFlcH9cXENdribRxXG7dOfECdqR2iSdxVndJZWUK9lXvUywVfS29X-USun7oGCEE8ZgWmaReP8vN1lElQCB+HA3RHAAanKOUJIeDEal18Xard3DAE8cALHqGFYWJXO5H5mMBYpJEPjTMWEz4gPAqroN4ODuSQ9taUZZQWUIA0h15UjhWnQMaOXvLE0AUrql8hp9PhMTcGky7nV0nmTvmcCvNq1mew7Bzgizu1gfzdruC66QdbkCL3Bi9wEuYV8A3PeNVVU8rfKq27Ogaz4Wv82DLGcclnGpTDOhjDUdSmzLdHCZbRUlY7dsVZg8dacCHzanLPcO3gU3cvnMZWAEwfSCXUEpDPscwH3eTV9DPHSNKcPmzGx1WyjNuld3V2C9RERROFQ9jfbucfdTfLT4EEEA1HyT+Ioy+r-rNc7ZvJDbwOgjC2BUO6o2Pl2DGI9V51h6JxQQABlKghpBDpWvi9Eed8cafWWpRF+wJ55zWcnzNa3VEpVy2r-Q2+14YHhAcjTuY90Y52xgWB+HUCZF0BA2N+Id4xIXsH7aq7Do7ENnrZeybV4K4NWuwVcAserAmZpAPcnsODD2vFgthk9NYgCvvg9WvDpBl1IQo8hbEoa13-g3E2ZtgF73btbQRECgJQM0awyBIi6r8K4SQFMIA0xGNjOTP8Qi87Ow4T4gxOgeiEOCfwimithE6PInTaJVI7KtTiUHL+Z8bLKN3HwAAYqmbOt8PGuK8aFPRZpfFxJMXI9aEMKGWL-ntdQmUm52LoQ40BTiHREEyPACAMB2jQAANxAA) and choose ".d.ts" you can check type difference with and without `as const`. ```typescript -import { Contract, Web3 } from 'web3'; +import { Contract, Web3 } from '@theqrl/web3'; import ERC20 from './node_modules/@openzeppelin/contracts/build/contracts/ERC20.json'; (async function () { @@ -100,7 +100,7 @@ and run the script with `node -r ts-node/register +