web3-eth

What is web3-eth?

The web3-eth package is a sub-package of the web3.js library that provides functionalities to interact with the Ethereum blockchain. It allows developers to interact with Ethereum nodes, manage accounts, send transactions, and interact with smart contracts.

What are web3-eth's main functionalities?

Connecting to an Ethereum Node

This feature allows you to connect to an Ethereum node using an HTTP provider. In this example, we are connecting to the Ethereum mainnet using Infura.

const Web3 = require('web3');
const web3 = new Web3('https://mainnet.infura.io/v3/YOUR_INFURA_PROJECT_ID');

Getting the Balance of an Account

This feature allows you to get the balance of a specific Ethereum account. The balance is returned in Wei, the smallest unit of Ether.

web3.eth.getBalance('0x742d35Cc6634C0532925a3b844Bc454e4438f44e').then(console.log);

Sending a Transaction

This feature allows you to send a transaction from one Ethereum account to another. You need to specify the sender's address, recipient's address, amount of Ether to send, and gas limit.

const tx = {
  from: '0xYourAddress',
  to: '0xRecipientAddress',
  value: web3.utils.toWei('0.1', 'ether'),
  gas: 2000000
};
web3.eth.sendTransaction(tx).then(console.log);

Interacting with Smart Contracts

This feature allows you to interact with smart contracts deployed on the Ethereum blockchain. You need the contract's ABI and address to create a contract instance and call its methods.

const contractABI = [/* ABI array */];
const contractAddress = '0xContractAddress';
const contract = new web3.eth.Contract(contractABI, contractAddress);
contract.methods.myMethod().call().then(console.log);

Other packages similar to web3-eth

ethers

The ethers.js library is a complete and compact library for interacting with the Ethereum blockchain and its ecosystem. It provides similar functionalities to web3-eth, such as connecting to Ethereum nodes, managing accounts, sending transactions, and interacting with smart contracts. Ethers.js is known for its smaller size and better documentation.

ethjs

Ethjs is a highly modular and lightweight library for interacting with the Ethereum blockchain. It provides similar functionalities to web3-eth, including sending transactions, managing accounts, and interacting with smart contracts. Ethjs is designed to be simple and easy to use, with a focus on modularity.

truffle-contract

Truffle-contract is a library for managing and interacting with Ethereum smart contracts. It provides a higher-level abstraction for working with contracts compared to web3-eth. Truffle-contract is part of the Truffle Suite, which includes tools for developing, testing, and deploying smart contracts.

README

web3.js - Eth

This is a sub-package of web3.js.

web3-eth contains modules to interact with the Ethereum blockchain and smart contracts.

Installation

You can install the package either using NPM or using Yarn

Using NPM

npm install web3-eth

Using Yarn

yarn add web3-eth

Getting Started

• :writing_hand: If you have questions submit an issue or join us on Discord

Prerequisites

• :gear: NodeJS (LTS/Fermium)
• :toolbox: Yarn/Lerna

Package.json Scripts

Script	Description
clean	Uses rimraf to remove dist/
build	Uses tsc to build package and dependent packages
lint	Uses eslint to lint package
lint:fix	Uses eslint to check and fix any warnings
format	Uses prettier to format the code
test	Uses jest to run unit tests
test:integration	Uses jest to run tests under /test/integration
test:unit	Uses jest to run tests under /test/unit

Changelog

[4.11.0]

Fixed

web3-eth-abi

• fix encodedata in EIP-712 (#7095)

web3-utils

• _sendPendingRequests will catch unhandled errors from _sendToSocket (#6968)

web3-eth

• Fixed geth issue when running a new instance, transactions will index when there are no blocks created (#7098)

Changed

web3-eth-accounts

• baseTransaction method updated (#7095)

web3-providers-ws

• Update dependancies (#7109)

web3-plugin-example

• Dependencies updated

web3-rpc-providers

• Change request return type Promise<ResultType> to Promise<JsonRpcResponseWithResult<ResultType>> (#7102)

Added

web3-eth-contract

• populateTransaction was added to contract methods (#7124)
• Contract has setTransactionMiddleware and getTransactionMiddleware for automatically passing to sentTransaction for deploy and send functions (#7138)

web3-rpc-providers

• When error is returned with code 429, throw rate limit error (#7102)

web3

• web3.eth.Contract will get transaction middleware and use it, if web3.eth has transaction middleware. (#7138)