Skip to main content

Type Alias: Event

type Event = {
  contents: ArrayBuffer;
  module: string;
  packageId: ObjectIdLike;
  sender: AddressLike;
  structTag: string;
};

An event emitted during the successful execution of a transaction.

This mirrors the core chain [iota_sdk::types::Event] one-to-one: every field is required and the type round-trips through BCS/JSON. For events returned by the GraphQL events query — which may originate from system transactions and therefore lack a sender or emitting module — see GraphQlEvent.

BCS

The BCS serialized form for this type is defined by the following ABNF:

event = object-id identifier address struct-tag bytes

Properties​

contents​

contents: ArrayBuffer;

BCS serialized bytes of the event

module​

module: string;

Module name of the top-level function invoked by a MoveCall command which triggered this event to be emitted.

packageId​

packageId: ObjectIdLike;

Package id of the top-level function invoked by a MoveCall command which triggered this event to be emitted.

sender​

sender: AddressLike;

Address of the account that sent the transaction where this event was emitted.

structTag​

structTag: string;

The type of the event emitted