web3-core

What is web3-core?

The web3-core package is a core module of the Web3.js library, which is used to interact with the Ethereum blockchain. It provides essential functionalities such as managing accounts, sending transactions, and interacting with smart contracts.

What are web3-core's main functionalities?

Managing Accounts

This feature allows you to create and manage Ethereum accounts. The code sample demonstrates how to create a new Ethereum account using the web3-core package.

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

// Create a new account
const account = web3.eth.accounts.create();
console.log(account);

Sending Transactions

This feature allows you to send transactions on the Ethereum network. The code sample demonstrates how to sign and send a transaction using the web3-core package.

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

const transaction = {
  to: '0xRecipientAddress',
  value: web3.utils.toWei('0.1', 'ether'),
  gas: 2000000
};

web3.eth.accounts.signTransaction(transaction, 'YOUR_PRIVATE_KEY').then(signedTx => {
  web3.eth.sendSignedTransaction(signedTx.rawTransaction).on('receipt', console.log);
});

Interacting with Smart Contracts

This feature allows you to interact with smart contracts deployed on the Ethereum network. The code sample demonstrates how to call a method on a smart contract using the web3-core package.

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

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

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-core, such as managing accounts, sending transactions, and interacting with smart contracts. Ethers.js is known for its simplicity and ease of use.

truffle-contract

Truffle Contract is a library that provides a better abstraction for interacting with Ethereum smart contracts. It is part of the Truffle Suite and offers a higher-level API compared to web3-core, making it easier to work with smart contracts. It integrates seamlessly with the Truffle framework for development and testing.

README

web3.js - Web3 Core

This is a sub-package of web3.js.

web3-core package contains core functions for web3.js packages.

Installation

You can install the package either using NPM or using Yarn

Using NPM

npm install web3-core

Using Yarn

yarn add web3-core

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