Class Interface

Hierarchy

Interface

Constructors

constructor

new Interface(fragments: string | readonly (string | JsonFragment | Fragment)[]): Interface

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:52
Parameters
- fragments: string | readonly (string | JsonFragment | Fragment)[]
Returns Interface

Properties

Readonly _abiCoder

_abiCoder: AbiCoder

Readonly _isInterface

_isInterface: boolean

Readonly deploy

deploy: ConstructorFragment

Readonly errors

errors: {}

Type declaration

[name: string]: ErrorFragment

Readonly events

events: {}

Type declaration

[name: string]: EventFragment

Readonly fragments

fragments: readonly Fragment[]

Readonly functions

functions: {}

Type declaration

[name: string]: FunctionFragment

Readonly structs

structs: {}

Type declaration

[name: string]: any

Methods

_decodeParams

_decodeParams(params: readonly ParamType[], data: BytesLike): Result

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:63
Parameters
- params: readonly ParamType[]
- data: BytesLike
Returns Result

_encodeParams

_encodeParams(params: readonly ParamType[], values: readonly any[]): string

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:64
Parameters
- params: readonly ParamType[]
- values: readonly any[]
Returns string

decodeErrorResult

decodeErrorResult(fragment: string | ErrorFragment, data: BytesLike): Result

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:66
Parameters
- fragment: string | ErrorFragment
- data: BytesLike
Returns Result

decodeEventLog

decodeEventLog(eventFragment: string | EventFragment, data: BytesLike, topics?: readonly string[]): Result

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:77
Parameters
- eventFragment: string | EventFragment
- data: BytesLike
- Optional topics: readonly string[]
Returns Result

decodeFunctionData

decodeFunctionData(functionFragment: string | FunctionFragment, data: BytesLike): Result

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:68
Parameters
- functionFragment: string | FunctionFragment
- data: BytesLike
Returns Result

decodeFunctionResult

decodeFunctionResult(functionFragment: string | FunctionFragment, data: BytesLike): Result

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:70
Parameters
- functionFragment: string | FunctionFragment
- data: BytesLike
Returns Result

encodeDeploy

encodeDeploy(values?: readonly any[]): string

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:65
Parameters
- Optional values: readonly any[]
Returns string

encodeErrorResult

encodeErrorResult(fragment: string | ErrorFragment, values?: readonly any[]): string

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:67
Parameters
- fragment: string | ErrorFragment
- Optional values: readonly any[]
Returns string

encodeEventLog

encodeEventLog(eventFragment: EventFragment, values: readonly any[]): { data: string; topics: string[] }

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:73
Parameters
- eventFragment: EventFragment
- values: readonly any[]
Returns { data: string; topics: string[] }
- data: string
- topics: string[]

encodeFilterTopics

encodeFilterTopics(eventFragment: EventFragment, values: readonly any[]): (string | string[])[]

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:72
Parameters
- eventFragment: EventFragment
- values: readonly any[]
Returns (string | string[])[]

encodeFunctionData

encodeFunctionData(functionFragment: string | FunctionFragment, values?: readonly any[]): string

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:69
Parameters
- functionFragment: string | FunctionFragment
- Optional values: readonly any[]
Returns string

encodeFunctionResult

encodeFunctionResult(functionFragment: string | FunctionFragment, values?: readonly any[]): string

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:71
Parameters
- functionFragment: string | FunctionFragment
- Optional values: readonly any[]
Returns string

format

format(format?: string): string | string[]

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:53
Parameters
- Optional format: string
Returns string | string[]

getError

getError(nameOrSignatureOrSighash: string): ErrorFragment

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:60
Parameters
- nameOrSignatureOrSighash: string
Returns ErrorFragment

getEvent

getEvent(nameOrSignatureOrTopic: string): EventFragment

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:59
Parameters
- nameOrSignatureOrTopic: string
Returns EventFragment

getEventTopic

getEventTopic(eventFragment: string | EventFragment): string

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:62
Parameters
- eventFragment: string | EventFragment
Returns string

getFunction

getFunction(nameOrSignatureOrSighash: string): FunctionFragment

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:58
Parameters
- nameOrSignatureOrSighash: string
Returns FunctionFragment

getSighash

getSighash(fragment: string | ErrorFragment | FunctionFragment): string

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:61
Parameters
- fragment: string | ErrorFragment | FunctionFragment
Returns string

parseError

parseError(data: BytesLike): ErrorDescription

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:86
Parameters
- data: BytesLike
Returns ErrorDescription

parseLog

parseLog(log: { data: string; topics: string[] }): LogDescription

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:82
Parameters
- log: { data: string; topics: string[] }
  - data: string
  - topics: string[]
Returns LogDescription

parseTransaction

parseTransaction(tx: { data: string; value?: BigNumberish }): TransactionDescription

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:78
Parameters
- tx: { data: string; value?: BigNumberish }
  - data: string
  - Optional value?: BigNumberish
Returns TransactionDescription

Static getAbiCoder

getAbiCoder(): AbiCoder

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:54
Returns AbiCoder

Static getAddress

getAddress(address: string): string

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:55
Parameters
- address: string
Returns string

Static getEventTopic

getEventTopic(eventFragment: EventFragment): string

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:57
Parameters
- eventFragment: EventFragment
Returns string

Static getSighash

getSighash(fragment: ErrorFragment | FunctionFragment): string

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:56
Parameters
- fragment: ErrorFragment | FunctionFragment
Returns string

Static isInterface

isInterface(value: any): value is Interface

- Defined in node_modules/@ethersproject/abi/lib/interface.d.ts:87
Parameters
- value: any
Returns value is Interface

Generated using TypeDoc