Class MulticallProvider

Represents a multicall capable provider interface

Hierarchy

MulticallProvider

Index

Constructors

Properties

chainId provider

Methods

aggregate getBlockHash getCurrentBlockCoinbase getCurrentBlockDifficulty getCurrentBlockGasLimit getCurrentBlockTimestamp getEthBalance getLastBlockHash multicall create registerMulticallAddress

Constructors

`Protected` constructor

new MulticallProvider(provider, chainId, multicallAddress?): MulticallProvider
Protected
Protected constructor of the object
Parameters
- provider: Provider | Signer
- chainId: number
- Optional multicallAddress: string
Returns MulticallProvider

Properties

`Readonly` chainId

chainId: number

`Readonly` provider

provider: Provider | Signer

Methods

aggregate

aggregate<Type>(calls, batchSize?): Promise<Type>
Execute the requests contract calls using the multicall contract facility
Type Parameters
- Type extends any[] = any[]
Parameters
- calls: ContractCall[]
- batchSize: number = 50
Returns Promise<Type>

getBlockHash

getBlockHash(blockNumber): Promise<string>
Get the block hash for the specified block number
Parameters
- blockNumber: BigNumberish
Returns Promise<string>

getCurrentBlockCoinbase

getCurrentBlockCoinbase(): Promise<string>
Returns the current block coinbase address

Returns Promise<string>

getCurrentBlockDifficulty

getCurrentBlockDifficulty(): Promise<BigNumber>
Return the current block difficulty

Returns Promise<BigNumber>

getCurrentBlockGasLimit

getCurrentBlockGasLimit(): Promise<BigNumber>
Return the current block gas limit

Returns Promise<BigNumber>

getCurrentBlockTimestamp

getCurrentBlockTimestamp(): Promise<BigNumber>
Return the current block timestamp

Returns Promise<BigNumber>

getEthBalance

getEthBalance(account): Promise<BigNumber>
Return the balance for the specified account
Parameters
- account: string
Returns Promise<BigNumber>

getLastBlockHash

getLastBlockHash(): Promise<string>
Returns the last block hash

Returns Promise<string>

multicall

multicall<Type>(calls, batchSize?): Promise<Type>
Execute the requests contract calls using the multicall contract facility
Type Parameters
- Type extends any[] = any[]
Parameters
- calls: ContractCall[]
- batchSize: number = 50
Returns Promise<Type>

Deprecated

Alias
aggregate

`Static` create

create(provider, options?): Promise<MulticallProvider>
Creates a new instance of a multicall provider using an existing provider
Parameters
- provider: Provider | Signer
- options: Partial<MulticallProviderOptions> = {}
Returns Promise<MulticallProvider>

`Static` registerMulticallAddress

registerMulticallAddress(chainId, multicallAddress): void
Registers the multicall address for the specified chain ID
Parameters
- chainId: number
- multicallAddress: string
Returns void