Class FunctionFragment

A Fragment which represents a method.

Hierarchy

Constructors

constructor

Properties

constant gas inputs name outputs payable stateMutability type

Accessors

selector

Methods

format from getSelector isConstructor isError isEvent isFragment isFunction isStruct

Constructors

constructor

  • new FunctionFragment(guard, name, stateMutability, inputs, outputs, gas): FunctionFragment
  • Private

    Parameters

    • guard: any
    • name: string
    • stateMutability: "view" | "payable" | "nonpayable" | "pure"
    • inputs: readonly ParamType[]
    • outputs: readonly ParamType[]
    • gas: bigint

    Returns FunctionFragment

Properties

Readonly constant

constant: boolean

If the function is constant (e.g. pure or view functions).

Readonly gas

gas: bigint

The recommended gas limit to send when calling this function.

Readonly inputs

inputs: readonly ParamType[]

The inputs for the fragment.

Readonly name

name: string

The name of the fragment.

Readonly outputs

outputs: readonly ParamType[]

The returned types for the result of calling this function.

Readonly payable

payable: boolean

If the function can be sent value during invocation.

Readonly stateMutability

stateMutability: "view" | "payable" | "nonpayable" | "pure"

The state mutability (e.g. payable, nonpayable, view or pure)

Readonly type

type: FragmentType

The type of the fragment.

Accessors

selector

  • get selector(): string

  • The Function selector.

    Returns string

Methods

format

  • format(format?): string

  • Returns a string representation of this function as %%format%%.

    Parameters

    Returns string

Static from

Static getSelector

  • getSelector(name, params?): string

  • Return the selector for a function with %%name%% and %%params%%.

    Parameters

    • name: string
    • Optional params: any[]

    Returns string

Static isConstructor

Static isError

  • isError(value): value is ErrorFragment

  • Returns true if %%value%% is an [[ErrorFragment]].

    Parameters

    • value: any

    Returns value is ErrorFragment

Static isEvent

  • isEvent(value): value is EventFragment

  • Returns true if %%value%% is an [[EventFragment]].

    Parameters

    • value: any

    Returns value is EventFragment

Static isFragment

  • isFragment(value): value is FunctionFragment

  • Returns true and provides a type guard if %%value%% is a FunctionFragment.

    Parameters

    • value: any

    Returns value is FunctionFragment

Static isFunction

Static isStruct

  • isStruct(value): value is StructFragment

  • Returns true if %%value%% is a [[StructFragment]].

    Parameters

    • value: any

    Returns value is StructFragment

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc