Skip to main content

Event

type Event​

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`](crate::graphql::query_types::GraphQlEvent).

BCS​

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

```text event = object-id identifier address struct-tag bytes ```

type Event struct {
    // Package id of the top-level function invoked by a MoveCall command which
    // triggered this event to be emitted.
    PackageId *ObjectId
    // Module name of the top-level function invoked by a MoveCall command
    // which triggered this event to be emitted.
    Module string
    // Address of the account that sent the transaction where this event was
    // emitted.
    Sender *Address
    // The type of the event emitted
    StructTag string
    // BCS serialized bytes of the event
    Contents []byte
}

func EventFromBcs​

func EventFromBcs(bcs []byte) (Event, error)

Create an [`Event`] from BCS encoded bytes.

func EventFromJson​

func EventFromJson(json string) (Event, error)

Create an [`Event`] from a JSON encoded string.

func (*Event) Destroy​

func (r *Event) Destroy()