1.0.1 • Published 12 months ago

ethers-provider-multicall v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
12 months ago

Ethers Provider Multicall

This purpose of this repository is to create a 100% compatible ethers JsonRpcProvider that can bundle multiple RPC requests into a single request to a Multicall contract. This can significantly reduce the amount of RPC queries that need to be made and reduce the chance of hitting rate limits.

This provider also supports multiple RPC url's and will track request failures for the various RPC url's. It will then delegate the RPC call to the url with the least amount of request failures. This can be useful for example if you are using Infura and want to use a backup RPC url if Infura is down.

Features

  • Batch requests
  • Multiple RPC connection management
  • Retry handling for requests
  • Detects RPC errors to modify the batch size
  • Compatible with typechain

Usage

To construct the provider it requires a BlockchainNetwork object, this object contains the chainId and an array of RPC connections. It will default to the first connection in the array, but if that connection fails it will try the next connection in the array.

const network: BlockchainNetwork = {
    name: "mainnet",
    chainId: 1,
    connections: [
        {
            url: "https://mainnet.infura.io/v3/...",
        },
        {
            url: "https://cloudflare-eth.com",
        },
    ],
};

const provider = new JsonRpcProviderMulticall(network);

And is compatible with typechain and ethers generally, for instance you can use it to connect to an ERC20 contract:

const provider = new JsonRpcProviderMulticall(network);

const usdc = ERC20__factory.connect(
    "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
    provider
);

Installation