algokit_subscriber.types.arc28
Classes
Section titled “Classes”Arc28EventArg | Represents an argument of an ARC-28 event. |
|---|---|
Arc28Event | The definition of metadata for an ARC-28 event as per the ARC-28 specification. |
Arc28EventGroup | Specifies a group of ARC-28 event definitions along with instructions for |
Arc28EventFilter | A reference to an ARC-28 group and event, used to filter for transactions that emit it |
EmittedArc28Event | Represents an ARC-28 event that was emitted. |
Module Contents
Section titled “Module Contents”class Arc28EventArg
Section titled “class Arc28EventArg”Represents an argument of an ARC-28 event.
type : str
Section titled “type : str”The type of the argument
name : str | None = None
Section titled “name : str | None = None”An optional, user-friendly name for the argument
desc : str | None = None
Section titled “desc : str | None = None”An optional, user-friendly description for the argument
class Arc28Event
Section titled “class Arc28Event”The definition of metadata for an ARC-28 event as per the ARC-28 specification.
name : str
Section titled “name : str”The name of the event
The arguments of the event, in order
desc : str | None = None
Section titled “desc : str | None = None”An optional, user-friendly description for the event
property signature : str
Section titled “property signature : str”The signature of the event e.g. EventName(type1,type2)
property prefix : bytes
Section titled “property prefix : bytes”The prefix for the event
property abitype : algokitabi.abi.ABIType
Section titled “property abitype : algokitabi.abi.ABIType”The ABI type of the event
class Arc28EventGroup
Section titled “class Arc28EventGroup”Specifies a group of ARC-28 event definitions along with instructions for when to attempt to process the events.
group*name *: str_
Section titled “group*name *: str_”The name to designate for this group of events.
events : list[Arc28Event] = []
Section titled “events : list[Arc28Event] = []”The list of ARC-28 event definitions.
process*for_app_ids *: list[int] | None_ = None
Section titled “process*for_app_ids *: list[int] | None_ = None”Optional list of app IDs that this group should apply to.
process*transaction *: Callable[[algokit_indexer_client.models.Transaction], bool] | None_ = None
Section titled “process*transaction *: Callable[[algokit_indexer_client.models.Transaction], bool] | None_ = None”Optional predicate to indicate if these ARC-28 events should be processed for the given transaction.
continue*on_error *: bool_ = False
Section titled “continue*on_error *: bool_ = False”Whether or not to silently (with warning log) continue if an error is encountered processing the ARC-28 event data; default = False.
class Arc28EventFilter
Section titled “class Arc28EventFilter”A reference to an ARC-28 group and event, used to filter for transactions that emit it
group*name *: str_
Section titled “group*name *: str_”The name of the ARC-28 event group the event belongs to
event*name *: str_
Section titled “event*name *: str_”The name of the ARC-28 event that was triggered
class EmittedArc28Event
Section titled “class EmittedArc28Event”Represents an ARC-28 event that was emitted.
group*name *: str_
Section titled “group*name *: str_”The name of the ARC-28 event group the event belongs to
event*name *: str_
Section titled “event*name *: str_”The name of the ARC-28 event that was triggered
event*signature *: str_
Section titled “event*signature *: str_”The signature of the event e.g. EventName(type1,type2)
event*prefix *: str_
Section titled “event*prefix *: str_”The 4-byte hex prefix for the event
event*definition *: Arc28Event_
Section titled “event*definition *: Arc28Event_”The ARC-28 definition of the event
args : list[Any]
Section titled “args : list[Any]”The ordered arguments extracted from the event that was emitted
args*by_name *: dict[str, Any]_
Section titled “args*by_name *: dict[str, Any]_”The named arguments extracted from the event that was emitted (where the arguments had a name defined)