Class ABI

Interface that should be implemented by ABI serializable objects.

Hierarchy

Implements

ABISerializableObject

Index

Constructors

constructor

new ABI(args: Partial<Def>): ABI
Parameters
- args: Partial<Def>
Returns ABI
- Defined in src/chain/abi.ts:28

Properties

actions

actions: ABI.Action[]

ricardian_clauses

ricardian_clauses: Clause[]

structs

structs: ABI.Struct[]

tables

tables: Table[]

types

types: TypeDef[]

variants

variants: ABI.Variant[]

version

version: string

`Static` abiName

abiName: string = 'abi'

`Static` version

version: string = 'eosio::abi/1.1'

Methods

equals

equals(other: ABIDef): boolean
Return true if the object equals the other object passed.
Parameters
- other: ABIDef
Returns boolean
Implementation of ABISerializableObject.equals
- Defined in src/chain/abi.ts:266

getActionType

getActionType(actionName: NameType): undefined | string
Return arguments type of an action in this ABI.
Parameters
- actionName: NameType
Returns undefined | string
- Defined in src/chain/abi.ts:258

getStruct

getStruct(name: string): undefined | ABI.Struct
Parameters
- name: string
Returns undefined | ABI.Struct
- Defined in src/chain/abi.ts:249

getVariant

getVariant(name: string): undefined | ABI.Variant
Parameters
- name: string
Returns undefined | ABI.Variant
- Defined in src/chain/abi.ts:253

resolveAll

resolveAll(): {
    structs: ResolvedType[];
    types: ResolvedType[];
    variants: ResolvedType[];
}
Returns {
    structs: ResolvedType[];
    types: ResolvedType[];
    variants: ResolvedType[];
}
- structs: ResolvedType[]
- types: ResolvedType[]
- variants: ResolvedType[]
- Defined in src/chain/abi.ts:202

resolveType

resolveType(name: string): ResolvedType
Parameters
- name: string
Returns ResolvedType
- Defined in src/chain/abi.ts:197

toABI

toABI(encoder: ABIEncoder): void
Called when encoding to binary abi format.
Parameters
- encoder: ABIEncoder
Returns void
Implementation of ABISerializableObject.toABI
- Defined in src/chain/abi.ts:143

toJSON

toJSON(): {
    abi_extensions: never[];
    actions: ABI.Action[];
    error_messages: never[];
    ricardian_clauses: Clause[];
    structs: ABI.Struct[];
    tables: Table[];
    types: TypeDef[];
    variants: ABI.Variant[];
    version: string;
}
Called when encoding to json abi format.

Returns {
    abi_extensions: never[];
    actions: ABI.Action[];
    error_messages: never[];
    ricardian_clauses: Clause[];
    structs: ABI.Struct[];
    tables: Table[];
    types: TypeDef[];
    variants: ABI.Variant[];
    version: string;
}
- abi_extensions: never[]
- actions: ABI.Action[]
- error_messages: never[]
- ricardian_clauses: Clause[]
- structs: ABI.Struct[]
- tables: Table[]
- types: TypeDef[]
- variants: ABI.Variant[]
- version: string
Implementation of ABISerializableObject.toJSON
- Defined in src/chain/abi.ts:282

`Static` from

from(value: ABIDef): ABI
Parameters
- value: ABIDef
Returns ABI
- Defined in src/chain/abi.ts:38

`Static` fromABI

fromABI(decoder: ABIDecoder): ABI
Parameters
- decoder: ABIDecoder
Returns ABI
- Defined in src/chain/abi.ts:54

Class ABI

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

args: Partial<Def>

Returns ABI

Properties

actions

ricardian_clauses

structs

tables

types

variants

version

Static abiName

Static version

Methods

equals

Parameters

other: ABIDef

Returns boolean

getActionType

Parameters

actionName: NameType

Returns undefined | string

getStruct

Parameters

name: string

Returns undefined | ABI.Struct

getVariant

Parameters

name: string

Returns undefined | ABI.Variant

resolveAll

Returns { structs: ResolvedType[]; types: ResolvedType[]; variants: ResolvedType[]; }

structs: ResolvedType[]

types: ResolvedType[]

variants: ResolvedType[]

resolveType

Parameters

name: string

Returns ResolvedType

toABI

Parameters

encoder: ABIEncoder

Returns void

toJSON

Returns { abi_extensions: never[]; actions: ABI.Action[]; error_messages: never[]; ricardian_clauses: Clause[]; structs: ABI.Struct[]; tables: Table[]; types: TypeDef[]; variants: ABI.Variant[]; version: string; }

abi_extensions: never[]

actions: ABI.Action[]

error_messages: never[]

ricardian_clauses: Clause[]

structs: ABI.Struct[]

tables: Table[]

types: TypeDef[]

variants: ABI.Variant[]

version: string

Static from

Parameters

value: ABIDef

Returns ABI

Static fromABI

Parameters

decoder: ABIDecoder

Returns ABI

Settings

Member Visibility

Theme

`Static` abiName

`Static` version

Returns {
structs: ResolvedType[];
types: ResolvedType[];
variants: ResolvedType[];
}

Returns {
abi_extensions: never[];
actions: ABI.Action[];
error_messages: never[];
ricardian_clauses: Clause[];
structs: ABI.Struct[];
tables: Table[];
types: TypeDef[];
variants: ABI.Variant[];
version: string;
}

`Static` from

`Static` fromABI