algokit_subscriber.types.arc28

Module Contents

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 when to attempt to process the events.
Arc28EventToProcess	Represents an ARC-28 event to be processed.
EmittedArc28Event	Represents an ARC-28 event that was emitted.

API

class Arc28EventArg

Bases: typing.TypedDict

Represents an argument of an ARC-28 event.

Initialization

Initialize self. See help(type(self)) for accurate signature.

type: str

None

The type of the argument

name: typing_extensions.NotRequired[str]

None

An optional, user-friendly name for the argument

desc: typing_extensions.NotRequired[str]

None

An optional, user-friendly description for the argument

__contains__()

__delattr__()

__delitem__()

__dir__()

__eq__()

__format__()

__ge__()

__getattribute__()

__getitem__()

__getstate__()

__gt__()

__ior__()

__iter__()

__le__()

__len__()

__lt__()

__ne__()

__new__()

__or__()

__reduce__()

__reduce_ex__()

__repr__()

__reversed__()

__ror__()

__setattr__()

__setitem__()

__sizeof__()

__str__()

__subclasshook__()

clear()

copy()

get()

items()

keys()

pop()

popitem()

setdefault()

update()

values()

class Arc28Event

Bases: typing.TypedDict

The definition of metadata for an ARC-28 event as per the ARC-28 specification.

Initialization

Initialize self. See help(type(self)) for accurate signature.

name: str

None

The name of the event

desc: typing_extensions.NotRequired[str]

None

An optional, user-friendly description for the event

args: list[algokit_subscriber.types.arc28.Arc28EventArg]

None

The arguments of the event, in order

__contains__()

__delattr__()

__delitem__()

__dir__()

__eq__()

__format__()

__ge__()

__getattribute__()

__getitem__()

__getstate__()

__gt__()

__ior__()

__iter__()

__le__()

__len__()

__lt__()

__ne__()

__new__()

__or__()

__reduce__()

__reduce_ex__()

__repr__()

__reversed__()

__ror__()

__setattr__()

__setitem__()

__sizeof__()

__str__()

__subclasshook__()

clear()

copy()

get()

items()

keys()

pop()

popitem()

setdefault()

update()

values()

class Arc28EventGroup

Bases: typing.TypedDict

Specifies a group of ARC-28 event definitions along with instructions for when to attempt to process the events.

Initialization

Initialize self. See help(type(self)) for accurate signature.

group_name: str

None

The name to designate for this group of events.

process_for_app_ids: list[int]

None

Optional list of app IDs that this event should apply to.

process_transaction: typing_extensions.NotRequired[collections.abc.Callable[[algokit_subscriber.types.indexer.TransactionResult], bool]]

None

Optional predicate to indicate if these ARC-28 events should be processed for the given transaction.

continue_on_error: bool

None

Whether or not to silently (with warning log) continue if an error is encountered processing the ARC-28 event data; default = False.

events: list[algokit_subscriber.types.arc28.Arc28Event]

None

The list of ARC-28 event definitions.

__contains__()

__delattr__()

__delitem__()

__dir__()

__eq__()

__format__()

__ge__()

__getattribute__()

__getitem__()

__getstate__()

__gt__()

__ior__()

__iter__()

__le__()

__len__()

__lt__()

__ne__()

__new__()

__or__()

__reduce__()

__reduce_ex__()

__repr__()

__reversed__()

__ror__()

__setattr__()

__setitem__()

__sizeof__()

__str__()

__subclasshook__()

clear()

copy()

get()

items()

keys()

pop()

popitem()

setdefault()

update()

values()

class Arc28EventToProcess

Bases: typing.TypedDict

Represents an ARC-28 event to be processed.

Initialization

Initialize self. See help(type(self)) for accurate signature.

group_name: str

None

The name of the ARC-28 event group the event belongs to

event_name: str

None

The name of the ARC-28 event that was triggered

event_signature: str

None

The signature of the event e.g. EventName(type1,type2)

event_prefix: str

None

The 4-byte hex prefix for the event

event_definition: algokit_subscriber.types.arc28.Arc28Event

None

The ARC-28 definition of the event

__contains__()

__delattr__()

__delitem__()

__dir__()

__eq__()

__format__()

__ge__()

__getattribute__()

__getitem__()

__getstate__()

__gt__()

__ior__()

__iter__()

__le__()

__len__()

__lt__()

__ne__()

__new__()

__or__()

__reduce__()

__reduce_ex__()

__repr__()

__reversed__()

__ror__()

__setattr__()

__setitem__()

__sizeof__()

__str__()

__subclasshook__()

clear()

copy()

get()

items()

keys()

pop()

popitem()

setdefault()

update()

values()

class EmittedArc28Event

Bases: algokit_subscriber.types.arc28.Arc28EventToProcess

Represents an ARC-28 event that was emitted.

Initialization

Initialize self. See help(type(self)) for accurate signature.

args: list[Any]

None

The ordered arguments extracted from the event that was emitted

args_by_name: dict[str, Any]

None

The named arguments extracted from the event that was emitted (where the arguments had a name defined)

group_name: str

None

event_name: str

None

event_signature: str

None

event_prefix: str

None

event_definition: algokit_subscriber.types.arc28.Arc28Event

None

__contains__()

__delattr__()

__delitem__()

__dir__()

__eq__()

__format__()

__ge__()

__getattribute__()

__getitem__()

__getstate__()

__gt__()

__ior__()

__iter__()

__le__()

__len__()

__lt__()

__ne__()

__new__()

__or__()

__reduce__()

__reduce_ex__()

__repr__()

__reversed__()

__ror__()

__setattr__()

__setitem__()

__sizeof__()

__str__()

__subclasshook__()

clear()

copy()

get()

items()

keys()

pop()

popitem()

setdefault()

update()

values()