Class MultiCall

Basic representation of a standard Multicall compatible contract. If additional functionality is required, this contract can be extended via inheritance

Hierarchy

BaseContract
- MultiCall

Index

Constructors

Accessors

address contract

Methods

aggregate call connect getBlockHash getCurrentBlockCoinbase getCurrentBlockDifficulty getCurrentBlockGasLimit getCurrentBlockTimestamp getEthBalance getLastBlockHash retryCall supportsInterface

Constructors

constructor

new MultiCall(_contract): MultiCall
Constructs a new instance of the object
Parameters
- _contract: IContract
Returns MultiCall

Inherited from BaseContract.constructor

Accessors

address

get address(): string
Returns the contract address

Returns string

Inherited from BaseContract.address

contract

get contract(): Contract
Returns the underlying contract interface

Returns Contract

Inherited from BaseContract.contract

Methods

aggregate

aggregate(calls): Promise<{
blockNumber: BigNumber;
returnData: string[];
}>
Executes the aggregated calls and returns the results
Parameters
- calls: string[] | BytesLike[]
Returns Promise<{
blockNumber: BigNumber;
returnData: string[];
}>

call

call(name, ...params): ContractCall
Returns an interface allowing for us with the multicall method of a provider
Parameters
- name: string
- Rest ...params: any[]
Returns ContractCall

Inherited from BaseContract.call

connect

connect(signerOrProvider): MultiCall
Connects the existing instance of the contract to a new signer or provider
Parameters
- signerOrProvider: Provider | Signer | MulticallProvider
Returns MultiCall

Inherited from BaseContract.connect

getBlockHash

getBlockHash(blockNumber): Promise<string>
Retrieves the hash of the specified block height
Parameters
- blockNumber: BigNumberish
Returns Promise<string>

getCurrentBlockCoinbase

getCurrentBlockCoinbase(): Promise<string>
Retrieves the current block's coinbase address

Returns Promise<string>

getCurrentBlockDifficulty

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

Returns Promise<BigNumber>

getCurrentBlockGasLimit

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

Returns Promise<BigNumber>

getCurrentBlockTimestamp

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

Returns Promise<BigNumber>

getEthBalance

getEthBalance(address): Promise<BigNumber>
Retrieves the balance of the specified account
Parameters
- address: string
Returns Promise<BigNumber>

getLastBlockHash

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

Returns Promise<string>

`Protected` retryCall

retryCall<T>(func, ...params): Promise<T>
Protected
Automatically keeps trying the call unless we get a revert exception
Type Parameters
- T
Parameters
- func: ((...args) => Promise<T>)
  - - (...args): Promise<T>
    - Parameters
      
      Rest ...args: any[]
      
      Returns Promise<T>
- Rest ...params: any[]
Returns Promise<T>

Inherited from BaseContract.retryCall

supportsInterface

supportsInterface(interfaceId): Promise<boolean>
Returns whether the specified interface is supported by the contract
Parameters
- interfaceId: string
Returns Promise<boolean>

Inherited from BaseContract.supportsInterface