Contract | superxerox-sdk

Hierarchy

BaseContract
- Contract

Indexable

[key: string]: ContractFunction | any

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Contract(addressOrName: string, contractInterface: ContractInterface, signerOrProvider?: Signer | Provider): Contract

Inherited from BaseContract.constructor
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:102
Parameters
- addressOrName: string
- contractInterface: ContractInterface
- Optional signerOrProvider: Signer | Provider
Returns Contract

Properties

_deployedPromise

_deployedPromise: Promise<Contract>

_runningEvents

_runningEvents: {}

Type declaration

[eventTag: string]: RunningEvent

_wrappedEmits

_wrappedEmits: {}

Type declaration

[eventTag: string]: (...args: any[]) => void
- - (...args: any[]): void
  - Parameters
    - Rest ...args: any[]
    Returns void

Readonly address

address: string

Readonly callStatic

callStatic: {}

Type declaration

[name: string]: ContractFunction

Readonly deployTransaction

deployTransaction: TransactionResponse

Readonly estimateGas

estimateGas: {}

Type declaration

[name: string]: ContractFunction<BigNumber>

Readonly filters

filters: {}

Type declaration

[name: string]: (...args: any[]) => EventFilter
- - (...args: any[]): EventFilter
  - Parameters
    - Rest ...args: any[]
    Returns EventFilter

Readonly functions

functions: {}

Type declaration

[name: string]: ContractFunction

Readonly interface

interface: Interface

Readonly populateTransaction

populateTransaction: {}

Type declaration

[name: string]: ContractFunction<PopulatedTransaction>

Readonly provider

provider: Provider

Readonly resolvedAddress

resolvedAddress: Promise<string>

Readonly signer

signer: Signer

Methods

_checkRunningEvents

_checkRunningEvents(runningEvent: RunningEvent): void

Inherited from BaseContract._checkRunningEvents
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:117
Parameters
- runningEvent: RunningEvent
Returns void

_deployed

_deployed(blockTag?: BlockTag): Promise<Contract>

Inherited from BaseContract._deployed
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:110
Parameters
- Optional blockTag: BlockTag
Returns Promise<Contract>

_wrapEvent

_wrapEvent(runningEvent: RunningEvent, log: Log, listener: Listener): Event

Inherited from BaseContract._wrapEvent
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:118
Parameters
- runningEvent: RunningEvent
- log: Log
- listener: Listener
Returns Event

attach

attach(addressOrName: string): Contract

Inherited from BaseContract.attach
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:113
Parameters
- addressOrName: string
Returns Contract

connect

connect(signerOrProvider: string | Signer | Provider): Contract

Inherited from BaseContract.connect
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:112
Parameters
- signerOrProvider: string | Signer | Provider
Returns Contract

deployed

deployed(): Promise<Contract>

Inherited from BaseContract.deployed
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:109
Returns Promise<Contract>

emit

emit(eventName: string | EventFilter, ...args: any[]): boolean

Inherited from BaseContract.emit
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:123
Parameters
- eventName: string | EventFilter
- Rest ...args: any[]
Returns boolean

fallback

fallback(overrides?: TransactionRequest): Promise<TransactionResponse>

Inherited from BaseContract.fallback
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:111
Parameters
- Optional overrides: TransactionRequest
Returns Promise<TransactionResponse>

listenerCount

listenerCount(eventName?: string | EventFilter): number

Inherited from BaseContract.listenerCount
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:124
Parameters
- Optional eventName: string | EventFilter
Returns number

listeners

listeners(eventName?: string | EventFilter): Listener[]

Inherited from BaseContract.listeners
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:125
Parameters
- Optional eventName: string | EventFilter
Returns Listener[]

off

off(eventName: string | EventFilter, listener: Listener): Contract

Inherited from BaseContract.off
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:127
Parameters
- eventName: string | EventFilter
- listener: Listener
Returns Contract

on

on(event: string | EventFilter, listener: Listener): Contract

Inherited from BaseContract.on
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:121
Parameters
- event: string | EventFilter
- listener: Listener
Returns Contract

once

once(event: string | EventFilter, listener: Listener): Contract

Inherited from BaseContract.once
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:122
Parameters
- event: string | EventFilter
- listener: Listener
Returns Contract

queryFilter

queryFilter(event: EventFilter, fromBlockOrBlockhash?: BlockTag, toBlock?: BlockTag): Promise<Event[]>

Inherited from BaseContract.queryFilter
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:120
Parameters
- event: EventFilter
- Optional fromBlockOrBlockhash: BlockTag
- Optional toBlock: BlockTag
Returns Promise<Event[]>

removeAllListeners

removeAllListeners(eventName?: string | EventFilter): Contract

Inherited from BaseContract.removeAllListeners
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:126
Parameters
- Optional eventName: string | EventFilter
Returns Contract

removeListener

removeListener(eventName: string | EventFilter, listener: Listener): Contract

Inherited from BaseContract.removeListener
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:128
Parameters
- eventName: string | EventFilter
- listener: Listener
Returns Contract

Static getContractAddress

getContractAddress(transaction: { from: string; nonce: BigNumberish }): string

Inherited from BaseContract.getContractAddress
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:104
Parameters
- transaction: { from: string; nonce: BigNumberish }
  - from: string
  - nonce: BigNumberish
Returns string

Static getInterface

getInterface(contractInterface: ContractInterface): Interface

Inherited from BaseContract.getInterface
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:108
Parameters
- contractInterface: ContractInterface
Returns Interface

Static isIndexed

isIndexed(value: any): value is Indexed

Inherited from BaseContract.isIndexed
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:114
Parameters
- value: any
Returns value is Indexed

Generated using TypeDoc