Class ABIItem`Abstract`

Represents an ABI (Application Binary Interface) item.

Hierarchy (view full)

ABI
- ABIItem
  - ABIEvent
  - ABIFunction

Index

Constructors

constructor

new ABIItem(signature): ABIItem
ABIItem constructor from item (Event, Function...) signature.
Parameters
- signature: SignatureType
  The signature of the ABI item (Function, Event...).
Returns ABIItem
Overrides ABI.constructor
- Defined in packages/core/src/vcdm/abi/ABIItem.ts:25

Properties

`Readonly`signature

signature: AbiEvent | AbiFunction

`Readonly`stringSignature

stringSignature: string

Accessors

bi

get bi(): bigint
Throws an exception because the ABI cannot be represented as a big integer.

Returns bigint
The BigInt representation of the ABI.

Throws
The ABI cannot be represented as a bigint. VeChainDataModel#bi

Remark
The conversion to BigInt is not supported for an ABI.
Inherited from ABI.bi
- Defined in packages/core/src/vcdm/abi/ABI.ts:76

bytes

get bytes(): Uint8Array
Encodes the values according to the specified ABI types when creating the ABI instance.

Returns Uint8Array
The ABI-encoded bytes representing the given values.

Throws
Inherited from ABI.bytes
- Defined in packages/core/src/vcdm/abi/ABI.ts:90

n

get n(): number
Throws an exception because the ABI cannot be represented as a number.

Returns number
The number representation of the ABI.

Throws
The mnemonic cannot be represented as a number. VeChainDataModel#n

Remark
The conversion to number is not supported for an ABI.
Inherited from ABI.n
- Defined in packages/core/src/vcdm/abi/ABI.ts:101

signatureHash

get signatureHash(): string
The signature hash of the ABIItem.

Returns string
The signature hash of the ABIItem.

Remarks
Wrapper for toFunctionHash.
- Defined in packages/core/src/vcdm/abi/ABIItem.ts:87

Methods

compareTo

compareTo(that): number
Compares the current ABIItem instance with another ABIItem instance.
Parameters
- that: ABIItem
  The item to compare with.
Returns number
A non-zero number if the current ABIItem is different to the other ABI or zero if they are equal. VeChainDataModel#compareTo
Overrides ABI.compareTo
- Defined in packages/core/src/vcdm/abi/ABIItem.ts:97

format

format(formatType?): string
Returns a string representation of a JSON object or a string.
Parameters
- formatType: "string" | "json" = 'string'
  Either JSON or String
Returns string
The string representation of the ABI item.
- Defined in packages/core/src/vcdm/abi/ABIItem.ts:76

getFirstDecodedValue

getFirstDecodedValue<ReturnType>(): ReturnType
It gets the first decoded value from the ABI.
Type Parameters
- ReturnType
Returns ReturnType
The first decoded value from the ABI.
Inherited from ABI.getFirstDecodedValue
- Defined in packages/core/src/vcdm/abi/ABI.ts:199

isEqual

isEqual(that): boolean
Checks if the current ABI object is equal to the given ABI object.
Parameters
- that: ABI
  The ABI object to compare with.
Returns boolean
True if the objects are equal, false otherwise. VeChainDataModel#isEqual

Remark
The comparison is done by comparing the types and values of the ABI instances.
Inherited from ABI.isEqual
- Defined in packages/core/src/vcdm/abi/ABI.ts:65

parseObjectValues

parseObjectValues(obj): unknown[]
Recursively parses an object and collects the values of each attribute into an array, with nested arrays for nested objects.
Parameters
- obj: object
  The object to parse.
Returns unknown[]
An array of values from the object, with nested arrays for nested objects.
Inherited from ABI.parseObjectValues
- Defined in packages/core/src/vcdm/abi/ABI.ts:173

toHex

toHex(): Hex
Parses an ABI to its Hex representation.

Returns Hex
The Hex representation of the ABI.
Inherited from ABI.toHex
- Defined in packages/core/src/vcdm/abi/ABI.ts:212

`Static`of

of(types, values): ABI
Instantiates an ABI object from the given types and values.
Parameters
- types: string | AbiParameter[]
  ABI parameters representing the types of the values.
- values: unknown[]
  ABI values.
Returns ABI
The ABI object with the given types and values.
Inherited from ABI.of
- Defined in packages/core/src/vcdm/abi/ABI.ts:115

`Static`ofEncoded

ofEncoded(types, dataEncoded): ABI
Decodes the ABI values from the given ABI types and encoded data.
Parameters
- types: string | AbiParameter[]
  The list of ABI types representing the types of the values to decode.
- dataEncoded: string | Uint8Array
  The encoded data to decode.
Returns ABI
An ABI instance with the decoded values.
Inherited from ABI.ofEncoded
- Defined in packages/core/src/vcdm/abi/ABI.ts:137

`Static`ofSignature

ofSignature<T>(ABIItemConstructor, signature): T
Type Parameters
- T extends ABIItem
Parameters
- ABIItemConstructor: (new (signature: string) => T)
  - - new (signature): T
    - Parameters
      signature: string
      Returns T
- signature: string
Returns T
- Defined in packages/core/src/vcdm/abi/ABIItem.ts:43
ofSignature<T>(ABIItemConstructor, signature): T
Type Parameters
- T extends ABIItem
Parameters
- ABIItemConstructor: (new (signature: AbiFunction) => T)
  - - new (signature): T
    - Parameters
      signature: AbiFunction
      Returns T
- signature: AbiFunction
Returns T
- Defined in packages/core/src/vcdm/abi/ABIItem.ts:48
ofSignature<T>(ABIItemConstructor, signature): T
Type Parameters
- T extends ABIItem
Parameters
- ABIItemConstructor: (new (signature: AbiEvent) => T)
  - - new (signature): T
    - Parameters
      signature: AbiEvent
      Returns T
- signature: AbiEvent
Returns T
- Defined in packages/core/src/vcdm/abi/ABIItem.ts:53

Class ABIItemAbstract

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ABIItem

Properties

Readonlysignature

ReadonlystringSignature

Accessors

bi

Returns bigint

Throws

Remark

bytes

Returns Uint8Array

Throws

n

Returns number

Throws

Remark

signatureHash

Returns string

Remarks

Methods

compareTo

Parameters

Returns number

format

Parameters

Returns string

getFirstDecodedValue

Type Parameters

Returns ReturnType

isEqual

Parameters

Returns boolean

Remark

parseObjectValues

Parameters

Returns unknown[]

toHex

Returns Hex

Staticof

Parameters

Returns ABI

StaticofEncoded

Parameters

Returns ABI

StaticofSignature

Type Parameters

Parameters

Parameters

Returns T

Returns T

Type Parameters

Parameters

Parameters

Returns T

Returns T

Type Parameters

Parameters

Parameters

Returns T

Returns T

Settings

On This Page

Class ABIItem`Abstract`

`Readonly`signature

`Readonly`stringSignature

`Static`of

`Static`ofEncoded

`Static`ofSignature