From 1392ec9fc4dcc3b8cd5ab3d07835ce0340687497 Mon Sep 17 00:00:00 2001 From: Deepak <83352186+Deepak2030@users.noreply.github.com> Date: Fri, 9 Feb 2024 17:08:36 +0530 Subject: [PATCH 1/3] Updated README.md Added the general features of web3.js in the npm package --- packages/web3/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/packages/web3/README.md b/packages/web3/README.md index bec916e563d..ef20f7c6602 100644 --- a/packages/web3/README.md +++ b/packages/web3/README.md @@ -39,6 +39,23 @@ yarn add web3 - :gear: [NodeJS](https://nodejs.org/) (LTS/Fermium) - :toolbox: [Yarn](https://yarnpkg.com/)/[Lerna](https://lerna.js.org/) +## General Features + +- **Web3.js Plugins](https://docs.web3js.org/guides/web3_plugin_guide/)**: Enhance or add any functionality by creating scalable web3 plugins for any project. +- **Abstractions over the [JSON-RPC API](https://ethereum.org/en/developers/docs/apis/json-rpc)**: Simplifying interaction for your Developer Experience. +- **Language aligned to the official [Ethereum terminology](https://ethereum.org/en/glossary** +- **Tree-shaking focus**: Include only what you need during bundling for optimized performance. +- **Dynamic contract types and full API in TypeScript**: Enforced with strict types for enhanced security and safety. +- **Complete utilities and functionalities for all your Ethereum needs** +- **More efficient ABI Encoder & Decoder** +- **Extensive [documentation](https://docs.web3js.org/) with guides and APIs** +- **Large collection of test cases** +- **First-class APIs for interacting with [Smart Contracts](https://ethereum.org/en/glossary#smart-contract** +- **ESM and CJS module builds**: Support for both ECMAScript module and CommonJS module builds for flexible integration with various project setups. +- **Contracts dynamic types](https://docs.web3js.org/guides/smart_contracts/infer_contract_types/) & full API in TypeScript** +- **Using native BigInt instead of large BigNumber libraries**: Use native BigInt for improved efficiency compared to using large external BigNumber libraries. +- **Custom Output formatters**: Format any returned value to be a string, number, BigInt, etc., providing flexibility in handling output data. + ## Migration Guide - [Migration Guide from Web3.js 1.x to 4.x](https://docs.web3js.org/docs/guides/web3_migration_guide) From 941bfb49e15580a126502992e93507783efca8b9 Mon Sep 17 00:00:00 2001 From: Santiago Trujillo Zuluaga Date: Fri, 9 Feb 2024 12:25:44 +0000 Subject: [PATCH 2/3] Put the features on top --- packages/web3/README.md | 36 +++++++++++++++++------------------- 1 file changed, 17 insertions(+), 19 deletions(-) diff --git a/packages/web3/README.md b/packages/web3/README.md index ef20f7c6602..d13bafb5169 100644 --- a/packages/web3/README.md +++ b/packages/web3/README.md @@ -9,9 +9,24 @@ [![NPM Package][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] -This is the main package of [web3.js](repo). +This is the main package of [web3.js](repo), it cointains a collection of comprehensive [TypeScript](https://www.typescriptlang.org/) libraries for Interaction with the [Ethereum JSON RPC API](https://ethereum.org/developers/docs/apis/json-rpc) and utility functions. -`web3` contains the ideal setup for a Web3.js package. +## Features + +- **Web3.js Plugins](https://docs.web3js.org/guides/web3_plugin_guide/)**: Enhance or add any functionality by creating scalable web3 plugins for any project. +- **Abstractions over the [JSON-RPC API](https://ethereum.org/en/developers/docs/apis/json-rpc)**: Simplifying interaction for your Developer Experience. +- **Language aligned to the official [Ethereum terminology](https://ethereum.org/en/glossary** +- **Tree-shaking focus**: Include only what you need during bundling for optimized performance. +- **Dynamic contract types and full API in TypeScript**: Enforced with strict types for enhanced security and safety. +- **Complete utilities and functionalities for all your Ethereum needs** +- **More efficient ABI Encoder & Decoder** +- **Extensive [documentation](https://docs.web3js.org/) with guides and APIs** +- **Large collection of test cases** +- **First-class APIs for interacting with [Smart Contracts](https://ethereum.org/en/glossary#smart-contract** +- **ESM and CJS module builds**: Support for both ECMAScript module and CommonJS module builds for flexible integration with various project setups. +- **Contracts dynamic types](https://docs.web3js.org/guides/smart_contracts/infer_contract_types/) & full API in TypeScript** +- **Using native BigInt instead of large BigNumber libraries**: Use native BigInt for improved efficiency compared to using large external BigNumber libraries. +- **Custom Output formatters**: Format any returned value to be a string, number, BigInt, etc., providing flexibility in handling output data. ## Installation @@ -39,23 +54,6 @@ yarn add web3 - :gear: [NodeJS](https://nodejs.org/) (LTS/Fermium) - :toolbox: [Yarn](https://yarnpkg.com/)/[Lerna](https://lerna.js.org/) -## General Features - -- **Web3.js Plugins](https://docs.web3js.org/guides/web3_plugin_guide/)**: Enhance or add any functionality by creating scalable web3 plugins for any project. -- **Abstractions over the [JSON-RPC API](https://ethereum.org/en/developers/docs/apis/json-rpc)**: Simplifying interaction for your Developer Experience. -- **Language aligned to the official [Ethereum terminology](https://ethereum.org/en/glossary** -- **Tree-shaking focus**: Include only what you need during bundling for optimized performance. -- **Dynamic contract types and full API in TypeScript**: Enforced with strict types for enhanced security and safety. -- **Complete utilities and functionalities for all your Ethereum needs** -- **More efficient ABI Encoder & Decoder** -- **Extensive [documentation](https://docs.web3js.org/) with guides and APIs** -- **Large collection of test cases** -- **First-class APIs for interacting with [Smart Contracts](https://ethereum.org/en/glossary#smart-contract** -- **ESM and CJS module builds**: Support for both ECMAScript module and CommonJS module builds for flexible integration with various project setups. -- **Contracts dynamic types](https://docs.web3js.org/guides/smart_contracts/infer_contract_types/) & full API in TypeScript** -- **Using native BigInt instead of large BigNumber libraries**: Use native BigInt for improved efficiency compared to using large external BigNumber libraries. -- **Custom Output formatters**: Format any returned value to be a string, number, BigInt, etc., providing flexibility in handling output data. - ## Migration Guide - [Migration Guide from Web3.js 1.x to 4.x](https://docs.web3js.org/docs/guides/web3_migration_guide) From c0b22c5b53513b897b3cc2af64ebc03a7b072237 Mon Sep 17 00:00:00 2001 From: Deepak <83352186+Deepak2030@users.noreply.github.com> Date: Fri, 9 Feb 2024 19:48:31 +0530 Subject: [PATCH 3/3] Update packages/web3/README.md Co-authored-by: Junaid <86780488+jdevcs@users.noreply.github.com> --- packages/web3/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/web3/README.md b/packages/web3/README.md index d13bafb5169..53a0d16c806 100644 --- a/packages/web3/README.md +++ b/packages/web3/README.md @@ -9,7 +9,7 @@ [![NPM Package][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] -This is the main package of [web3.js](repo), it cointains a collection of comprehensive [TypeScript](https://www.typescriptlang.org/) libraries for Interaction with the [Ethereum JSON RPC API](https://ethereum.org/developers/docs/apis/json-rpc) and utility functions. +This is the main package of [web3.js](repo), it contains a collection of comprehensive [TypeScript](https://www.typescriptlang.org/) libraries for Interaction with the [Ethereum JSON RPC API](https://ethereum.org/developers/docs/apis/json-rpc) and utility functions. ## Features