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-multicallvar 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 });
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]
}]
},
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]
}]
}
},
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 });
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]
}]
},
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]
}]
}
},
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 });
// 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]
}]
},
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]
}]
}
},
blockNumber: 10994677
}import {
Multicall,
ContractCallResults,
ContractCallContext,
} from 'ethereum-multicall';
const multicall = new Multicall({ nodeUrl: 'https://some.local-or-remote.node:8546' });
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]
}]
},
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]
}]
}
},
blockNumber: 10994677
}by default it looks at your network from the provider you passed in and makes the contract address to that:
- mainnet > '0xeefba1e63905ef1d7acba5a8513c70307c1ce441'
- kovan > '0x2cc8688c5f75e365aaeeb4ea8d6a480405a48d2a'
- rinkeby > '0x42ad527de7d4e9d9d011ac45b31d8551f8fe9821'
- ropsten > '0x53c43764255c17bd724f74c4ef150724ac50a3ed'
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: '0x5Eb3fa2DFECdDe21C950813C665E9364fa609bD2',
// 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!