Class Contract

Represents an extension to ethers.Contract that allows us to easily dump out the contract calls so that they can be used within a multicall execution pattern

Hierarchy

Contract
- Contract

Implements

ContractType

Index

Constructors

Properties

_callChain multicallProvider?

Accessors

connected isSignerConnected

Methods

call callMethod exec retryCall

Constructors

constructor

new Contract(addressOrName, contractInterface, signerOrProvider?): Contract
Creates a new instance of the object
Parameters
- addressOrName: string
- contractInterface: ContractInterface
- Optional signerOrProvider: Provider | Signer | MulticallProvider
Returns Contract

Overrides ethers.Contract.constructor

Properties

`Protected` _callChain

_callChain: ContractCall[] = []

`Optional` `Readonly` multicallProvider

multicallProvider?: MulticallProvider

Accessors

connected

get connected(): Provider | Signer
Returns the connected provider/signer

Returns Provider | Signer

isSignerConnected

get isSignerConnected(): boolean
Returns if the contract is connected to a signer

Returns boolean

Methods

call

call(name, ...params): Contract
Creates a chainable list of contract calls
Parameters
- name: string
- Rest ...params: any[]
Returns Contract

Implementation of ContractType.call

callMethod

callMethod(name, ...params): ContractCall
Construct a contract call that can be utilized as a multicall
Parameters
- name: string
- Rest ...params: any[]
Returns ContractCall

Implementation of ContractType.callMethod

exec

exec<Type>(provider?): Promise<Type>
Executes the chainable list of contract calls
Type Parameters
- Type extends any[] = any[]
Parameters
- Optional provider: Provider | Signer | MulticallProvider
Returns Promise<Type>

Implementation of ContractType.exec

retryCall

retryCall<T>(func, ...params): Promise<T>
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>