ethereum-multicall
Advanced tools
Multicall allows multiple smart contract constant function calls to be grouped into a single call and the results aggregated into a single result
ethereum-multicall is a lightweight library for interacting with the multicall smart contract.
Multicall allows multiple smart contract constant function calls to be grouped into a single call and the results aggregated into a single result. This reduces the number of separate JSON RPC requests that need to be sent over the network if using a remote node like Infura, and provides the guarantee that all values returned are from the same block. The latest block number is also returned along with the aggregated results.
ethereum-multicall is fully written in typescript so has full compile time support. The motivation of this package was to expose a super simple and easy to understand interface for you to take the full benefits of the multicalls. Also to not being opinionated on how you use it, you can use it with web3, ethers or even pass in a custom nodeUrl and we do it for you. This package takes care of the decoding for you but at the same time if you dont want it to you can turn that part off.
$ npm install ethereum-multicall
$ yarn add ethereum-multicall
var ethereumMulticall = require('ethereum-multicall');
const ethereumMulticall = require('ethereum-multicall');
import {
Multicall,
ContractCallResults,
ContractCallContext,
} from 'ethereum-multicall';
import {
Multicall,
ContractCallResults,
ContractCallContext,
} from 'ethereum-multicall';
import { ethers } from 'ethers';
let provider = ethers.getDefaultProvider();
// you can use any ethers provider context here this example is
// just shows passing in a default provider, ethers hold providers in
// other context like wallet, signer etc all can be passed in as well.
const multicall = new Multicall({ ethersProvider: wallet.provider, tryAggregate: true });
const contractCallContext: ContractCallContext<{extraContext: string, foo4: boolean}>[] = [
{
reference: 'testContract',
contractAddress: '0x6795b15f3b16Cf8fB3E56499bbC07F6261e9b0C3',
abi: [ { name: 'foo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256' }] } ],
calls: [{ reference: 'fooCall', methodName: 'foo', methodParameters: [42] }],
context: {
extraContext: 'extraContext',
foo4: true
}
},
{
reference: 'testContract2',
contractAddress: '0x66BF8e2E890eA0392e158e77C6381b34E0771318',
abi: [ { name: 'fooTwo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256', name: "path", "type": "address[]" }] } ],
calls: [{ reference: 'fooTwoCall', methodName: 'fooTwo', methodParameters: [42] }]
}
];
const results: ContractCallResults = await multicall.call(contractCallContext);
console.log(results);
// results:
{
results: {
testContract: {
originalContractCallContext: {
reference: 'testContract',
contractAddress: '0x6795b15f3b16Cf8fB3E56499bbC07F6261e9b0C3',
abi: [ { name: 'foo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256' }] } ],
calls: [{ reference: 'fooCall', methodName: 'foo', methodParameters: [42] }]
},
callsReturnContext: [{
returnValues: [{ amounts: BigNumber }],
decoded: true,
reference: 'fooCall',
methodName: 'foo',
methodParameters: [42],
success: true
}]
},
testContract2: {
originalContractCallContext: {
reference: 'testContract2',
contractAddress: '0x66BF8e2E890eA0392e158e77C6381b34E0771318',
abi: [ { name: 'fooTwo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256[]' ] } ],
calls: [{ reference: 'fooTwoCall', methodName: 'fooTwo', methodParameters: [42] }]
},
callsReturnContext: [{
returnValues: [{ amounts: [BigNumber, BigNumber, BigNumber] }],
decoded: true,
reference: 'fooCall',
methodName: 'foo',
methodParameters: [42],
success: true
}]
}
},
blockNumber: 10994677
}
import {
Multicall,
ContractCallResults,
ContractCallContext,
} from 'ethereum-multicall';
import Web3 from 'web3';
const web3 = new Web3('https://some.local-or-remote.node:8546');
const multicall = new Multicall({ web3Instance: web3, tryAggregate: true });
const contractCallContext: ContractCallContext[] = [
{
reference: 'testContract',
contractAddress: '0x6795b15f3b16Cf8fB3E56499bbC07F6261e9b0C3',
abi: [ { name: 'foo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256' }] } ],
calls: [{ reference: 'fooCall', methodName: 'foo', methodParameters: [42] }]
},
{
reference: 'testContract2',
contractAddress: '0x66BF8e2E890eA0392e158e77C6381b34E0771318',
abi: [ { name: 'fooTwo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256', name: "path", "type": "address[]" }] } ],
calls: [{ reference: 'fooTwoCall', methodName: 'fooTwo', methodParameters: [42] }]
}
];
const results: ContractCallResults = await multicall.call(contractCallContext);
console.log(results);
// results:
{
results: {
testContract: {
originalContractCallContext: {
reference: 'testContract',
contractAddress: '0x6795b15f3b16Cf8fB3E56499bbC07F6261e9b0C3',
abi: [ { name: 'foo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256' }] } ],
calls: [{ reference: 'fooCall', methodName: 'foo', methodParameters: [42] }]
},
callsReturnContext: [{
returnValues: [{ amounts: BigNumber }],
decoded: true,
reference: 'fooCall',
methodName: 'foo',
methodParameters: [42],
success: true
}]
},
testContract2: {
originalContractCallContext: {
reference: 'testContract2',
contractAddress: '0x66BF8e2E890eA0392e158e77C6381b34E0771318',
abi: [ { name: 'fooTwo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256[]' ] } ],
calls: [{ reference: 'fooTwoCall', methodName: 'fooTwo', methodParameters: [42] }]
},
callsReturnContext: [{
returnValues: [{ amounts: [BigNumber, BigNumber, BigNumber] }],
decoded: true,
reference: 'fooCall',
methodName: 'foo',
methodParameters: [42],
success: true
}]
}
},
blockNumber: 10994677
}
If you want store any context or state so you don't need to look back over arrays once you got the result back. it can be stored in context within ContractCallContext.
import {
Multicall,
ContractCallResults,
ContractCallContext,
} from 'ethereum-multicall';
import { ethers } from 'ethers';
let provider = ethers.getDefaultProvider();
// you can use any ethers provider context here this example is
// just shows passing in a default provider, ethers hold providers in
// other context like wallet, signer etc all can be passed in as well.
const multicall = new Multicall({ ethersProvider: wallet.provider, tryAggregate: true });
// this is showing you having the same context for all `ContractCallContext` but you can also make this have
// different context for each `ContractCallContext`, as `ContractCallContext<TContext>` takes generic `TContext`.
const contractCallContext: ContractCallContext<{extraContext: string, foo4: boolean}>[] = [
{
reference: 'testContract',
contractAddress: '0x6795b15f3b16Cf8fB3E56499bbC07F6261e9b0C3',
abi: [ { name: 'foo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256' }] } ],
calls: [{ reference: 'fooCall', methodName: 'foo', methodParameters: [42] }],
// pass it in here!
context: {
extraContext: 'extraContext',
foo4: true
}
},
{
reference: 'testContract2',
contractAddress: '0x66BF8e2E890eA0392e158e77C6381b34E0771318',
abi: [ { name: 'fooTwo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256', name: "path", "type": "address[]" }] } ],
calls: [{ reference: 'fooTwoCall', methodName: 'fooTwo', methodParameters: [42] }],
// pass it in here!
context: {
extraContext: 'extraContext2',
foo4: false
}
}
];
const results: ContractCallResults = await multicall.call(contractCallContext);
console.log(results);
// results:
{
results: {
testContract: {
originalContractCallContext: {
reference: 'testContract',
contractAddress: '0x6795b15f3b16Cf8fB3E56499bbC07F6261e9b0C3',
abi: [ { name: 'foo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256' }] } ],
calls: [{ reference: 'fooCall', methodName: 'foo', methodParameters: [42] }],
context: {
extraContext: 'extraContext',
foo4: true
}
},
callsReturnContext: [{
returnValues: [{ amounts: BigNumber }],
decoded: true,
reference: 'fooCall',
methodName: 'foo',
methodParameters: [42],
success: true
}]
},
testContract2: {
originalContractCallContext: {
reference: 'testContract2',
contractAddress: '0x66BF8e2E890eA0392e158e77C6381b34E0771318',
abi: [ { name: 'fooTwo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256[]' ] } ],
calls: [{ reference: 'fooTwoCall', methodName: 'fooTwo', methodParameters: [42] }],
context: {
extraContext: 'extraContext2',
foo4: false
}
},
callsReturnContext: [{
returnValues: [{ amounts: [BigNumber, BigNumber, BigNumber] }],
decoded: true,
reference: 'fooCall',
methodName: 'foo',
methodParameters: [42],
success: true
}]
}
},
blockNumber: 10994677
}
By default if you dont turn tryAggregate to true if 1 eth_call fails in your multicall the whole result will throw. If you turn tryAggregate to true it means if 1 of your eth_call methods fail it still return you the rest of the results. It will still be in the same order as you expect but you have a success boolean to check if it passed or failed.
import {
Multicall,
ContractCallResults,
ContractCallContext,
} from 'ethereum-multicall';
const multicall = new Multicall({ nodeUrl: 'https://some.local-or-remote.node:8546', tryAggregate: true });
const contractCallContext: ContractCallContext[] = [
{
reference: 'testContract',
contractAddress: '0x6795b15f3b16Cf8fB3E56499bbC07F6261e9b0C3',
abi: [ { name: 'foo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256' }] }, { name: 'foo_fail', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256' }] } ],
calls: [{ reference: 'fooCall', methodName: 'foo', methodParameters: [42] }, { reference: 'fooCall_fail', methodName: 'foo_fail', methodParameters: [42] }]
},
{
reference: 'testContract2',
contractAddress: '0x66BF8e2E890eA0392e158e77C6381b34E0771318',
abi: [ { name: 'fooTwo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256', name: "path", "type": "address[]" }] } ],
calls: [{ reference: 'fooTwoCall', methodName: 'fooTwo', methodParameters: [42] }]
}
];
const results: ContractCallResults = await multicall.call(contractCallContext);
console.log(results);
// results:
{
results: {
testContract: {
originalContractCallContext: {
reference: 'testContract',
contractAddress: '0x6795b15f3b16Cf8fB3E56499bbC07F6261e9b0C3',
abi: [ { name: 'foo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256' }] }, { name: 'foo_fail', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256' }] } ],
calls: [{ reference: 'fooCall', methodName: 'foo', methodParameters: [42] }, { reference: 'fooCall_fail', methodName: 'foo_fail', methodParameters: [42] }]
},
callsReturnContext: [{
returnValues: [{ amounts: BigNumber }],
decoded: true,
reference: 'fooCall',
methodName: 'foo',
methodParameters: [42],
success: true
},
{
returnValues: [],
decoded: false,
reference: 'fooCall_fail',
methodName: 'foo_fail',
methodParameters: [42],
success: false
}]
},
testContract2: {
originalContractCallContext: {
reference: 'testContract2',
contractAddress: '0x66BF8e2E890eA0392e158e77C6381b34E0771318',
abi: [ { name: 'fooTwo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256[]' ] } ],
calls: [{ reference: 'fooTwoCall', methodName: 'fooTwo', methodParameters: [42] }]
},
callsReturnContext: [{
returnValues: [{ amounts: [BigNumber, BigNumber, BigNumber] }],
decoded: true,
reference: 'fooCall',
methodName: 'foo',
methodParameters: [42],
success: true
}]
}
},
blockNumber: 10994677
}
import {
Multicall,
ContractCallResults,
ContractCallContext,
} from 'ethereum-multicall';
const multicall = new Multicall({ nodeUrl: 'https://some.local-or-remote.node:8546', tryAggregate: true });
const contractCallContext: ContractCallContext[] = [
{
reference: 'testContract',
contractAddress: '0x6795b15f3b16Cf8fB3E56499bbC07F6261e9b0C3',
abi: [ { name: 'foo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256' }] } ],
calls: [{ reference: 'fooCall', methodName: 'foo', methodParameters: [42] }]
},
{
reference: 'testContract2',
contractAddress: '0x66BF8e2E890eA0392e158e77C6381b34E0771318',
abi: [ { name: 'fooTwo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256', name: "path", "type": "address[]" }] } ],
calls: [{ reference: 'fooTwoCall', methodName: 'fooTwo', methodParameters: [42] }]
}
];
const results: ContractCallResults = await multicall.call(contractCallContext);
console.log(results);
// results:
{
results: {
testContract: {
originalContractCallContext: {
reference: 'testContract',
contractAddress: '0x6795b15f3b16Cf8fB3E56499bbC07F6261e9b0C3',
abi: [ { name: 'foo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256' }] } ],
calls: [{ reference: 'fooCall', methodName: 'foo', methodParameters: [42] }]
},
callsReturnContext: [{
returnValues: [{ amounts: BigNumber }],
decoded: true,
reference: 'fooCall',
methodName: 'foo',
methodParameters: [42],
success: true
}]
},
testContract2: {
originalContractCallContext: {
reference: 'testContract2',
contractAddress: '0x66BF8e2E890eA0392e158e77C6381b34E0771318',
abi: [ { name: 'fooTwo', type: 'function', inputs: [ { name: 'example', type: 'uint256' } ], outputs: [ { name: 'amounts', type: 'uint256[]' ] } ],
calls: [{ reference: 'fooTwoCall', methodName: 'fooTwo', methodParameters: [42] }]
},
callsReturnContext: [{
returnValues: [{ amounts: [BigNumber, BigNumber, BigNumber] }],
decoded: true,
reference: 'fooCall',
methodName: 'foo',
methodParameters: [42],
success: true
}]
}
},
blockNumber: 10994677
}
by default it looks at your network from the provider you passed in and makes the contract address to that:
If you wanted this to point at a different multicall contract address just pass that in the options when creating the multicall instance, example:
const multicall = new Multicall({
multicallCustomContractAddress: '0x5BA1e12693Dc8F9c48aAD8770482f4739bEeD696',
// your rest of your config depending on the provider your using.
});
Please raise any issues in the below link.
https://github.com/joshstevens19/ethereum-multicall/issues
This package is brought to you by Josh Stevens. My aim is to be able to keep creating these awesome packages to help the Ethereum space grow with easier-to-use tools to allow the learning curve to get involved with blockchain development easier and also making Ethereum ecosystem better. So if you want to help out with that vision and allow me to invest more time into creating cool packages please sponsor me, every little helps. By sponsoring me, you're supporting me to be able to maintain existing packages, extend existing packages (as Ethereum matures), and allowing me to build more packages for Ethereum due to being able to invest more time into it. Thanks, everyone!
FAQs
Multicall allows multiple smart contract constant function calls to be grouped into a single call and the results aggregated into a single result
The npm package ethereum-multicall receives a total of 20,671 weekly downloads. As such, ethereum-multicall popularity was classified as popular.
We found that ethereum-multicall demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."