Class Interface

Hierarchy

Interface

Constructors

constructor

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

Properties

`Readonly` _abiCoder

_abiCoder: AbiCoder

`Readonly` _isInterface

_isInterface: boolean

`Readonly` deploy

deploy: ConstructorFragment

`Readonly` errors

errors: {
[name: string]: ErrorFragment;
}

Type declaration

[name: string]: ErrorFragment

`Readonly` events

events: {
[name: string]: EventFragment;
}

Type declaration

[name: string]: EventFragment

`Readonly` fragments

fragments: readonly Fragment[]

`Readonly` functions

functions: {
[name: string]: FunctionFragment;
}

Type declaration

[name: string]: FunctionFragment

`Readonly` structs

structs: {
[name: string]: any;
}

Type declaration

[name: string]: any

Methods

_decodeParams

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

_encodeParams

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

decodeErrorResult

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

decodeEventLog

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

decodeFunctionData

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

decodeFunctionResult

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

encodeDeploy

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

encodeErrorResult

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

encodeEventLog

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

encodeFilterTopics

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

encodeFunctionData

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

encodeFunctionResult

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

format

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

getError

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

getEvent

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

getEventTopic

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

getFunction

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

getSighash

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

parseError

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

parseLog

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

parseTransaction

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

`Static` getAbiCoder

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

`Static` getAddress

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

`Static` getEventTopic

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

`Static` getSighash

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

`Static` isInterface

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

Generated using TypeDoc