Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(docs): intro #7056

Merged
merged 5 commits into from
May 23, 2024
Merged

fix(docs): intro #7056

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bdfe9d4
fix(docs): intro
danforbes May 22, 2024
872723f
Packages
danforbes May 22, 2024
003a8cb
Tweaks
danforbes May 22, 2024
9d32697
@luu-alex suggestion
danforbes May 23, 2024
c58821f
Update docs/docs/guides/getting_started/introduction.md
danforbes May 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/docs/guides/getting_started/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
slug: /
sidebar_position: 2
sidebar_label: Quickstart
---
Expand Down
26 changes: 14 additions & 12 deletions docs/docs/guides/getting_started/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@
---
slug: /
sidebar_position: 1
sidebar_label: Introduction
---

# Introduction

Welcome to Web3.js Documentation!👋
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**) using **HTTP, IPC or WebSocket.** It is a powerful and efficient toolkit for crafting applications within the Ethereum ecosystem and beyond.

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.

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.
This documentation is the entrypoint to Web3.js for developers. It covers [basic](/guides/getting_started/) 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.

## Features of Web3.js v4

- Web3.js [Plugins Feature](/guides/web3_plugin_guide/) for extending functionality ( [List of Existing Plugins](https://web3js.org/plugins) )
- ECMAScript (ESM) and CommonJS (CJS) builds
- [Tree shakable with ESM](/guides/advanced/tree_shaking)
- [Contracts dynamic types](/guides/smart_contracts/infer_contract_types/) & full API in TypeScript
- Using native BigInt instead of large BigNumber libraries
- More efficient ABI Encoder & Decoder
- Custom Output formatters
- In compliance with Eth EL API
- Flexible
- ECMAScript (ESM) and CommonJS (CJS) builds
- [Plugins](/guides/web3_plugin_guide/) for extending functionality
- Efficient
- [Tree shakable with ESM](/guides/advanced/tree_shaking)
- 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
- Efficient ABI [encoding](/api/web3-eth-abi/function/encodeFunctionCall) & [decoding](/api/web3-eth-abi/function/decodeLog)
danforbes marked this conversation as resolved.
Show resolved Hide resolved
- Developer-Friendly
- [Dynamic contract types](/guides/smart_contracts/infer_contract_types/) & full API in TypeScript
- Custom output [formatters](https://docs.web3js.org/api/web3-utils/function/format)
- In compliance with Eth EL API

## Packages

Expand Down
Loading