@hashex/web3-multicall
TypeScript icon, indicating that this package has built-in type declarations

0.0.6 • Public • Published

web3-multicall

npm version

A library to do multiple calls via a single eth_call using web3.

Installation

  • via yarn
yarn add @hashex/web3-multicall
  • via npm
npm i @hashex/web3-multicall

Usage

Contract Reference

Default Supported Networks

Constructing

  • With chainId

    import Multicall from '@hashex/web3-multicall';
    
    import erc20Abi from './abi/erc20.json';
    
    async function main() {
      const web3 = new Web3(provider /* Your Web3 provider here */);
    
      const multicall = new Multicall({
        chainId: 1,
        provider: 'Your Web3 provider here',
      });
    
      ...
    }
    
    main()
  • With custom Multicall address

    import Multicall from '@hashex/web3-multicall';
    
    import erc20Abi from './abi/erc20.json';
    
    async function main() {
      const web3 = new Web3(provider /* Your Web3 provider here */);
    
      const multicall = new Multicall({
        multicallAddress: 'The address of the deployed multicall contract',
        provider: 'Your Web3 provider here',
      });
    
      ...
    }
    
    main();

Aggregating

const dpxContract = new web3.eth.Contract(dpxAddress, erc20Abi);

const balances = await multicall.aggregate([
  dpxContract.methods.balanceOf('Address 1'),
  dpxContract.methods.balanceOf('Address 2'),
  multicall.getEthBalance('Address 3'),
]);

console.log('DPX balance of Address 1', balances[0]);
console.log('DPX balance of Address 2', balances[1]);
console.log('ETH balance of Address 3', balances[2]);

Helper Functions

  • getEthBalance Gets the ETH balance of an address

    const ethBalance = await multicall.getEthBalance('address').call();
  • getBlockHash Gets the block hash

    Only works for 256 most recent, excluding current according to Solidity docs

    const blockHash = await multicall.getBlockHash(blockNumber).call();
  • getLastBlockHash Gets the last blocks hash

    const lastBlockHash = await multicall.getLastBlockHash().call();
  • getCurrentBlockTimestamp Gets the current block timestamp

    const currentBlockTimestamp = await multicall.getCurrentBlockTimestamp().call();
  • getCurrentBlockDifficulty Gets the current block difficulty

    const currentBlockDifficulty = await multicall.getCurrentBlockDifficulty().call();
  • getCurrentBlockGasLimit Gets the current block gas limit

    const currentBlockGasLimit = await multicall.getCurrentBlockGasLimit().call();
  • getCurrentBlockCoinbase Gets the current block coinbase

    const currentBlockCoinbase = await multicall.getCurrentBlockCoinbase().call();

License

This project is licensed under the MIT License - Copyright (c) 2022 HashEx

Readme

Keywords

none

Package Sidebar

Install

npm i @hashex/web3-multicall

Weekly Downloads

4

Version

0.0.6

License

MIT

Unpacked Size

97.1 kB

Total Files

24

Last publish

Collaborators

  • kalexeev
  • abelozertsev