Class ABIContract<TAbi>

Represents an ABI (Application Binary Interface).

Type Parameters

TAbi extends ViemABI

Hierarchy (view full)

ABI
- ABIContract

Index

Constructors

constructor

new ABIContract<TAbi>(abi): ABIContract<TAbi>
Type Parameters
- TAbi extends Abi
Parameters
- abi: TAbi
Returns ABIContract<TAbi>
Overrides ABI.constructor
- Defined in packages/core/src/vcdm/abi/ABIContract.ts:24

Properties

`Readonly`abi

abi: TAbi

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

Methods

compareTo

compareTo(that): number
Compares the current ABI instance with another ABI instance.
Parameters
- that: ABI
  The ABI to compare with.
Returns number
A non-zero number if the current ABI is different to the other ABI or zero if they are equal. VeChainDataModel#compareTo

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

decodeEventLog

decodeEventLog<TEventName>(eventName, eventToDecode): DecodeEventLogReturnType<TAbi, TEventName>
Decodes event log data based on the provided event name, and data/topics to decode.
Type Parameters
- TEventName extends string
Parameters
- eventName: string | TEventName
  The name of the event to be decoded.
- eventToDecode: ABIEventData
  An object containing the data and topics to be decoded.
Returns DecodeEventLogReturnType<TAbi, TEventName>
The decoded data of the event log.

Throws
- Defined in packages/core/src/vcdm/abi/ABIContract.ts:233

decodeFunctionInput

decodeFunctionInput<TFunctionName>(functionName, encodedFunctionInput): DecodeFunctionDataReturnType<TAbi, TFunctionName>
Decode the function data of an encoded function
Type Parameters
- TFunctionName extends string
Parameters
- functionName: string | TFunctionName
  The name of the function defined in the ABI.
- encodedFunctionInput: Hex
  The encoded function data.
Returns DecodeFunctionDataReturnType<TAbi, TFunctionName>
an array of the decoded function data

Throws
- Defined in packages/core/src/vcdm/abi/ABIContract.ts:129

decodeFunctionOutput

decodeFunctionOutput<TFunctionName>(functionName, encodedFunctionOutput): DecodeFunctionResultReturnType<TAbi, TFunctionName>
Decodes the output from a contract function using the specified ABI and function name. It takes the encoded function output and attempts to decode it according to the ABI definition.
Type Parameters
- TFunctionName extends string
Parameters
- functionName: string | TFunctionName
  The name of the function in the contract to decode the output for.
- encodedFunctionOutput: Hex
  The encoded output data from the contract function.
Returns DecodeFunctionResultReturnType<TAbi, TFunctionName>
- The decoded output, which provides a user-friendly way to interact with the decoded data.
Throws
Example
```
// Example of decoding output for a function called "getValue":
const decodedOutput = decodeFunctionOutput('getValue', encodedValue);
```
- Defined in packages/core/src/vcdm/abi/ABIContract.ts:170

encodeEventLog

encodeEventLog<TEventName>(eventName, eventArgs): ABIEventData
Encodes event log data based on the provided event name, and data to encode.
Type Parameters
- TEventName extends string
Parameters
- eventName: string | TEventName
  The name of the event to be encoded.
- eventArgs: unknown[]
  An array of data to be encoded in the event log.
Returns ABIEventData
An object containing the encoded data and topics.

Throws
- Defined in packages/core/src/vcdm/abi/ABIContract.ts:203

encodeFunctionInput

encodeFunctionInput<TFunctionName>(functionName, functionData?): Hex
Encode function data that can be used to send a transaction.
Type Parameters
- TFunctionName extends string
Parameters
- functionName: string | TFunctionName
  The name of the function defined in the ABI.
- OptionalfunctionData: unknown[]
  The data to pass to the function.
Returns Hex
The encoded data in hexadecimal that can be used to send a transaction.

Throws
- Defined in packages/core/src/vcdm/abi/ABIContract.ts:99

getEvent

getEvent<TEventName>(name): ABIEvent<TAbi, TEventName>
Returns the event with the given name.
Type Parameters
- TEventName extends string
Parameters
- name: string | TEventName
  The event's name.
Returns ABIEvent<TAbi, TEventName>
The event with the given name.

Throws
- Defined in packages/core/src/vcdm/abi/ABIContract.ts:72

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

getFunction

getFunction<TFunctionName>(name): ABIFunction<TAbi, TFunctionName>
Returns the function with the given name.
Type Parameters
- TFunctionName extends string
Parameters
- name: string | TFunctionName
  The function's name.
Returns ABIFunction<TAbi, TFunctionName>
The function with the given name.

Throws
- Defined in packages/core/src/vcdm/abi/ABIContract.ts:44

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

parseLog

parseLog<TEventName>(data, topics): DecodeEventLogReturnType<TAbi, TEventName>
Decodes a VeChain log based on the ABI definition.

This method takes raw data and topics from a VeChain log and attempts to decode them using the contract's ABI definition. If the decoding is successful, it returns a log object representing the decoded information. If the decoding fails, it throws a custom error with detailed information.
Type Parameters
- TEventName extends string
Parameters
- data: Hex
  The hexadecimal string of the data field in the log.
- topics: Hex[]
  An array of hexadecimal strings representing the topics of the log.
Returns DecodeEventLogReturnType<TAbi, TEventName>
- A log object representing the decoded log or null if decoding fails.
Throws
- Defined in packages/core/src/vcdm/abi/ABIContract.ts:269

parseLogAsArray

parseLogAsArray(data, topics): unknown[]
Parses the log data and topics into an array of values.
Parameters
- data: Hex
  The hexadecimal string of the data field in the log.
- topics: Hex[]
  An array of hexadecimal strings representing the topics of the log.
Returns unknown[]
- An array of values of the decoded log data.
- Defined in packages/core/src/vcdm/abi/ABIContract.ts:296

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`ofAbi

ofAbi<TAbi>(abi): ABIContract<TAbi>
Creates an ABIContract instance from a viem ABI.
Type Parameters
- TAbi extends Abi
Parameters
- abi: TAbi
  representation of the contract.
Returns ABIContract<TAbi>
New instance of ABIContract.
- Defined in packages/core/src/vcdm/abi/ABIContract.ts:34

`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

Class ABIContract<TAbi>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ABIContract<TAbi>

Properties

Readonlyabi

Accessors

bi

Returns bigint

Throws

Remark

bytes

Returns Uint8Array

Throws

n

Returns number

Throws

Remark

Methods

compareTo

Parameters

Returns number

Remark

decodeEventLog

Type Parameters

Parameters

Returns DecodeEventLogReturnType<TAbi, TEventName>

Throws

decodeFunctionInput

Type Parameters

Parameters

Returns DecodeFunctionDataReturnType<TAbi, TFunctionName>

Throws

decodeFunctionOutput

Type Parameters

Parameters

Returns DecodeFunctionResultReturnType<TAbi, TFunctionName>

Throws

Example

encodeEventLog

Type Parameters

Parameters

Returns ABIEventData

Throws

encodeFunctionInput

Type Parameters

Parameters

Returns Hex

Throws

getEvent

Type Parameters

Parameters

Returns ABIEvent<TAbi, TEventName>

Throws

getFirstDecodedValue

Type Parameters

Returns ReturnType

getFunction

Type Parameters

Parameters

Returns ABIFunction<TAbi, TFunctionName>

Throws

isEqual

Parameters

Returns boolean

Remark

parseLog

Type Parameters

Parameters

Returns DecodeEventLogReturnType<TAbi, TEventName>

Throws

`Readonly`abi

`Static`of

`Static`ofAbi

`Static`ofEncoded