|
1 | 1 | --- |
| 2 | +slug: / |
2 | 3 | sidebar_position: 1 |
3 | 4 | sidebar_label: Introduction |
4 | 5 | --- |
5 | 6 |
|
6 | 7 | # Introduction |
7 | 8 |
|
8 | | -Welcome to Web3.js Documentation!👋 |
| 9 | +Web3.js is a robust and flexible collection of **TypeScript and JavaScript** libraries that allows developers to interact with local or remote [Ethereum](https://ethereum.org/en/) nodes (or **any EVM-compatible blockchain**) over **HTTP, IPC or WebSocket** connections. It is a powerful and efficient toolkit for crafting applications within the Ethereum ecosystem and beyond. |
9 | 10 |
|
10 | | -Web3.js is a robust and flexible collection of libraries for **TypeScript and JavaScript** developers. It allows you to interact with a local or remote Ethereum node (or **any EVM-compatible blockchain**) using **HTTP, IPC or WebSocket.** It serves as an essential tool for connecting and crafting applications within the Ethereum ecosystem. |
11 | | - |
12 | | -The following documentation will guide you through different use cases of Web3.js, upgrading from older versions, as well as providing an API reference documentation with examples. |
| 11 | +This documentation is the entrypoint to Web3.js for developers. It covers [basic](/guides/getting_started/quickstart) and [advanced](/guides/smart_contracts/) usage with examples, and includes comprehensive [API documentation](/api) as well as guides for common tasks, like [upgrading](/guides/web3_upgrade_guide/x/) from older versions. |
13 | 12 |
|
14 | 13 | ## Features of Web3.js v4 |
15 | 14 |
|
16 | | -- Web3.js [Plugins Feature](/guides/web3_plugin_guide/) for extending functionality ( [List of Existing Plugins](https://web3js.org/plugins) ) |
17 | | -- ECMAScript (ESM) and CommonJS (CJS) builds |
18 | | -- [Tree shakable with ESM](/guides/advanced/tree_shaking) |
19 | | -- [Contracts dynamic types](/guides/smart_contracts/infer_contract_types/) & full API in TypeScript |
20 | | -- Using native BigInt instead of large BigNumber libraries |
21 | | -- More efficient ABI Encoder & Decoder |
22 | | -- Custom Output formatters |
23 | | -- In compliance with Eth EL API |
| 15 | +- Flexible |
| 16 | + - ECMAScript (ESM) and CommonJS (CJS) builds |
| 17 | + - [Plugins](/guides/web3_plugin_guide/) for extending functionality |
| 18 | +- Efficient |
| 19 | + - Modular, [package](/#packages)-based design reduces unneeded dependencies |
| 20 | + - [Tree shakable with ESM](/guides/advanced/tree_shaking) |
| 21 | + - Use of native [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) (instead of large [BigNumber](https://mikemcl.github.io/bignumber.js/) libraries) |
| 22 | + - Efficient ABI [encoding](/api/web3-eth-abi/function/encodeFunctionCall) & [decoding](/api/web3-eth-abi/function/decodeParameter) |
| 23 | +- Developer-Friendly |
| 24 | + - [Dynamic contract types](/guides/smart_contracts/infer_contract_types/) & full API in TypeScript |
| 25 | + - Custom output [formatters](https://docs.web3js.org/api/web3-utils/function/format) |
| 26 | + - In compliance with the [Ethereum JSON-RPC Specification](https://ethereum.github.io/execution-apis/api-documentation/) |
24 | 27 |
|
25 | 28 | ## Packages |
26 | 29 |
|
27 | | -Web3.js is modular, consisting of several packages, each serving specific functionalities. If you have specific tasks in mind, you don't need to install the entire Web3 library. Instead, selectively install the package that suits your requirements for a more efficient development experience. Here is an overview of the available packages: |
| 30 | +Web3.js is a modular collection of packages, each of which serves a specific needs. This means developers don't need to install the entire Web3 library for most use cases. Instead, necessary packages are selectively installed for a more efficient development experience. Here is an overview of a selection of available packages: |
| 31 | + |
| 32 | +- [**Web3Eth:**](/libdocs/Web3Eth) The `web3-eth` package is the entrypoint to Web3.js - it's the control center for managing interactions with Ethereum and other EVM-compatible networks. |
28 | 33 |
|
29 | | -- [**ABI:**](/libdocs/ABI) The `web3-eth-abi` package simplifies decoding logs and parameters, encoding function calls and signatures, and inferring types for efficient Ethereum **contract interactions.** |
| 34 | +- [**Net:**](/libdocs/Net) The `web3-net` package provides discovery and interactions for an **Ethereum node's network properties.** |
30 | 35 |
|
31 | | -- [**Accounts:**](/libdocs/Accounts) The `web3-eth-accounts` package has tools for creating Ethereum accounts/wallets and making sure transactions and data are **securely signed.** |
| 36 | +- [**Accounts:**](/libdocs/Accounts) The `web3-eth-accounts` package has tools for creating Ethereum accounts and the **secure signing** of transactions and data. |
32 | 37 |
|
33 | | -- [**Contract:**](/libdocs/Contract) With the `web3-eth-Contract`, you can interact with Smart contracts. This functionality allows **communication with contracts through JavaScript or TypeScript objects**, simplifying your development and interaction processes. |
| 38 | +- [**Personal:**](/libdocs/Personal) Use `web3-eth-personal` for **direct communication about your accounts with the Ethereum node**, which streamlines account management during development. |
34 | 39 |
|
35 | | -- [**ENS:**](/libdocs/ENS) The `web3-eth-ens` package helps you communicate with the **Ethereum Name Service (ENS)** on the blockchain. |
| 40 | + **NOTE:** *For enhanced security in production and when interacting with public nodes, consider using `web3-eth-accounts` for local signing operations, which keeps your private keys and sensitive information secure on your local machine* |
36 | 41 |
|
37 | | -- [**Iban:**](/libdocs/Iban) The `web3-eth-iban` package allows you to switch between **Ethereum addresses and special banking-like addresses** (IBAN or BBAN). It makes the conversion back and forth easier. |
| 42 | +- [**Utils:**](/libdocs/Utils) The `web3-utils` package provides helpers to perform a range of essential Ethereum development tasks, including **converting data formats, checking addresses, encoding and decoding data, hashing, handling numbers, and much more.**. |
38 | 43 |
|
39 | | -- [**Net:**](/libdocs/Net) The `web3-net` class allows you to talk about and deal with an **Ethereum node's network details.** |
| 44 | +- [**Contract:**](/libdocs/Contract) The `web3-eth-contract` package makes it easy to **interact with smart contracts through JavaScript or TypeScript,** which streamlines the development process and makes it less error-prone. |
40 | 45 |
|
41 | | -- [**Personal:**](/libdocs/Personal) Use `web3-eth-personal` for **direct communication with the Ethereum node about your accounts**, streamlining account management in your development workflow. |
42 | | - **NOTE:** *For enhanced security when interacting with public nodes, consider using `web3-eth-accounts` for local signing operations, keeping your private keys and sensitive information secure on your local machine* |
| 46 | +- [**ABI:**](/libdocs/ABI) The `web3-eth-abi` package simplifies decoding logs and parameters, encoding function calls and signatures, and inferring types for efficient Ethereum **smart contract interactions.** |
43 | 47 |
|
44 | | -- [**Utils:**](/libdocs/Utils) With the `web3-utils` package you can perform a range of essential tasks in Ethereum development, including **converting data formats, checking addresses, encoding and decoding, hashing, handling numbers, and much more**, providing versatile utility functions for your applications. |
| 48 | +- [**ENS:**](/libdocs/ENS) The `web3-eth-ens` package makes it easy for developers to communicate with the **Ethereum Name Service (ENS).** |
45 | 49 |
|
46 | | -- [**Web3Eth:**](/libdocs/Web3Eth) The `web3-eth` is your main tool for interacting with the Ethereum blockchain. It's like the control center for managing your interactions with Ethereum. |
| 50 | +- [**Iban:**](/libdocs/Iban) The `web3-eth-iban` package allows you to switch between **Ethereum addresses and special banking-like addresses** (IBAN or BBAN) and simplifies conversion between the types. |
47 | 51 |
|
48 | | -### Additional supporting packages |
| 52 | +### Additional supporting packages |
49 | 53 |
|
50 | | -- **Web3 Types:** This package has common typescript types. |
| 54 | +- [**Web3 Core:**](/api/web3-core) subscriptions, request management, and configuration used by other Web3 packages |
51 | 55 |
|
52 | | -- **Web3 Validator:** This package offers functionality for validation using provided Schema. |
| 56 | +- [**Web3 Types:**](/api/web3-types) data structures, objects, interfaces and types used by Web3 |
53 | 57 |
|
54 | | -- **Web3 Core:** Web3 Core has configuration, Subscriptions and Requests management functionality used by other Web3 packages. |
| 58 | +- [**Web3 Validator:**](/api/web3-validator) runtime type validation against predefined types or custom schemas |
55 | 59 |
|
56 | | -- **Web3 Errors:** Web3 Errors has error codes and common error classes that are used by other Web3 packages. |
| 60 | +- [**Web3 Errors:**](/api/web3-errors) error codes and common error classes that are used by other Web3 packages |
57 | 61 |
|
58 | | -- **Web3 RPC Methods:** This is for advanced uses for building more lightweight applications. It has functions for making RPC requests to Ethereum using a given provider. |
| 62 | +- [**Web3 RPC Methods:**](/api/web3/namespace/rpcMethods) functions for making RPC requests to Ethereum using a given provider |
59 | 63 |
|
60 | 64 | ## Advantages over other libraries |
61 | 65 |
|
62 | | -- **Extensive Documentation and Community**: Being one of the earliest Ethereum libraries, Web3.js benefits from extensive documentation and a large, active community. Web3.js is widely adopted and has been thoroughly tested in various production environments and is compatible with a broad range of other tools and services in the Ethereum ecosystem. |
| 66 | +- **Extensive Documentation and Community**: Web3.js is one of the most established Ethereum libraries, which means it benefits from extensive documentation and a large, active community. Web3.js is widely adopted and has been thoroughly tested in various production environments, and is compatible with a broad range of other tools and services in the Ethereum ecosystem. |
63 | 67 |
|
64 | | -- **Modular Design**: Web3.js is designed to be modular, meaning it allows developers to use specific packages according to their needs. This may lead to smaller bundle sizes and faster load times for web applications. |
| 68 | +- **Modular Design**: Web3.js is designed to be modular, which allows developers to use specific packages according to their needs. This leads to smaller bundle sizes and faster load times for web applications. |
65 | 69 |
|
66 | 70 | - **Active Development and Support**: Web3.js sees regular updates and active development. This support is crucial for developers needing assurance that the library they're using will keep pace with the evolving Ethereum landscape. |
0 commit comments