Skip to content

Commit

Permalink
Updated README.md (#6804)
Browse files Browse the repository at this point in the history
* Updated README.md

Added the general features of web3.js in the npm package

* Put the features on top

* Update packages/web3/README.md

Co-authored-by: Junaid <86780488+jdevcs@users.noreply.github.com>

---------

Co-authored-by: Santiago Trujillo Zuluaga <santiago@chainsafe.io>
Co-authored-by: Junaid <86780488+jdevcs@users.noreply.github.com>
  • Loading branch information
3 people committed Feb 12, 2024
1 parent a0d4d2e commit 9023511
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions packages/web3/README.md
Expand Up @@ -9,9 +9,24 @@
[![NPM Package][npm-image]][npm-url]
[![Downloads][downloads-image]][npm-url]

This is the main package of [web3.js](repo).

`web3` contains the ideal setup for a Web3.js package.
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

- **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

Expand Down

1 comment on commit 9023511

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Benchmark

Benchmark suite Current: 9023511 Previous: 6c075db Ratio
processingTx 9539 ops/sec (±4.12%) 9301 ops/sec (±4.81%) 0.98
processingContractDeploy 40465 ops/sec (±7.13%) 39129 ops/sec (±7.62%) 0.97
processingContractMethodSend 19222 ops/sec (±7.14%) 19443 ops/sec (±5.19%) 1.01
processingContractMethodCall 40285 ops/sec (±6.13%) 38971 ops/sec (±6.34%) 0.97
abiEncode 46244 ops/sec (±6.64%) 44252 ops/sec (±6.92%) 0.96
abiDecode 31675 ops/sec (±8.42%) 30419 ops/sec (±8.89%) 0.96
sign 1643 ops/sec (±3.85%) 1656 ops/sec (±4.08%) 1.01
verify 379 ops/sec (±0.99%) 373 ops/sec (±0.78%) 0.98

This comment was automatically generated by workflow using github-action-benchmark.

Please sign in to comment.