types/arc-28
types/arc-28
Section titled “types/arc-28”Interfaces
Section titled “Interfaces”Arc28Event
Section titled “Arc28Event”Defined in: src/types/arc-28.ts:8
The definition of metadata for an ARC-28 event per https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0028.md#event.
Properties
Section titled “Properties”| Property | Type | Description | Defined in |
|---|---|---|---|
args | object[] | The arguments of the event, in order | src/types/arc-28.ts:14 |
desc? | string | Optional, user-friendly description for the event | src/types/arc-28.ts:12 |
name | string | The name of the event | src/types/arc-28.ts:10 |
Arc28EventGroup
Section titled “Arc28EventGroup”Defined in: src/types/arc-28.ts:47
Specifies a group of ARC-28 event definitions along with instructions for when to attempt to process the events.
Properties
Section titled “Properties”| Property | Type | Description | Defined in |
|---|---|---|---|
continueOnError? | boolean | Whether or not to silently (with warning log) continue if an error is encountered processing the ARC-28 event data; default = false | src/types/arc-28.ts:55 |
events | Arc28Event[] | The list of ARC-28 event definitions | src/types/arc-28.ts:57 |
groupName | string | The name to designate for this group of events. | src/types/arc-28.ts:49 |
processForAppIds? | bigint[] | Optional list of app IDs that this event should apply to | src/types/arc-28.ts:51 |
processTransaction? | (transaction) => boolean | Optional predicate to indicate if these ARC-28 events should be processed for the given transaction | src/types/arc-28.ts:53 |
Arc28EventToProcess
Section titled “Arc28EventToProcess”Defined in: src/types/arc-28.ts:25
An ARC-28 event to be processed
Extended by
Section titled “Extended by”Properties
Section titled “Properties”| Property | Type | Description | Defined in |
|---|---|---|---|
eventDefinition | Arc28Event | The ARC-28 definition of the event | src/types/arc-28.ts:35 |
eventName | string | The name of the ARC-28 event that was triggered | src/types/arc-28.ts:29 |
eventPrefix | string | The 4-byte hex prefix for the event | src/types/arc-28.ts:33 |
eventSignature | string | The signature of the event e.g. EventName(type1,type2) | src/types/arc-28.ts:31 |
groupName | string | The name of the ARC-28 event group the event belongs to | src/types/arc-28.ts:27 |
EmittedArc28Event
Section titled “EmittedArc28Event”Defined in: src/types/arc-28.ts:39
An emitted ARC-28 event extracted from an app call log.
Extends
Section titled “Extends”Properties
Section titled “Properties”| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
args | ABIValue[] | The ordered arguments extracted from the event that was emitted | - | src/types/arc-28.ts:41 |
argsByName | Record<string, ABIValue> | The named arguments extracted from the event that was emitted (where the arguments had a name defined) | - | src/types/arc-28.ts:43 |
eventDefinition | Arc28Event | The ARC-28 definition of the event | Arc28EventToProcess.eventDefinition | src/types/arc-28.ts:35 |
eventName | string | The name of the ARC-28 event that was triggered | Arc28EventToProcess.eventName | src/types/arc-28.ts:29 |
eventPrefix | string | The 4-byte hex prefix for the event | Arc28EventToProcess.eventPrefix | src/types/arc-28.ts:33 |
eventSignature | string | The signature of the event e.g. EventName(type1,type2) | Arc28EventToProcess.eventSignature | src/types/arc-28.ts:31 |
groupName | string | The name of the ARC-28 event group the event belongs to | Arc28EventToProcess.groupName | src/types/arc-28.ts:27 |