Skip to content

Conversation

tritao
Copy link
Contributor

@tritao tritao commented May 6, 2025

This PR adds two new attributes: #[event] and #[indexed].

The #[event] attribute marks a struct or enum as an event that can be emitted by a contract.

The #[indexed] attribute can be applied to fields within structs that are attributed with #[event]. This is particularly useful for event structs, allowing for efficient filtering and searching of emitted events based on the values of these fields.

When using this attribute, the indexed fields must be applied sequentially to the initial set of fields in a struct.

This attribute can only be applied to fields whose type is an exact size ABI type. The exact size ABI types include:

  • bool
  • u8, u16, u32, u64, u256
  • numeric
  • b256
  • str[N]
  • Tuples containing only exact size types
  • Structs containing only exact size types
  • Arrays of exact size types with a literal length
  • Type aliases to exact size types

Additionally it causes the event types to be included in the JSON ABI representation for the contract and emits an offset for indexed fields.

#[event]
struct MyEventStruct {
    #[indexed]
    id: u64,
    sender: Identity,
}

#[event]
enum MyEventEnum {
    A: (),
    B: (),
}

@tritao tritao added enhancement New feature or request compiler General compiler. Should eventually become more specific as the issue is triaged compiler: frontend Everything to do with type checking, control flow analysis, and everything between parsing and IRgen labels May 6, 2025
@tritao tritao self-assigned this May 6, 2025
@tritao tritao force-pushed the indexed-events branch from 45c41ee to c4c05c2 Compare May 6, 2025 10:16
Copy link

codspeed-hq bot commented Sep 17, 2025

CodSpeed Performance Report

Merging #7158 will not alter performance

Comparing tritao:indexed-events (f3875f2) with master (6553dce)

Summary

✅ 25 untouched

This adds two new attributes: `#[event]` and `#[indexed]`.

The `#[event]` attribute marks a struct or enum as an event that can be
emitted by a contract.

The `#[indexed]` attribute can be applied to fields within structs that
are attributed with `#[event]`. This is particularly useful for event
structs, allowing for efficient filtering and searching of emitted
events based on the values of these fields.

When using this attribute, the indexed fields must be applied
sequentially to the initial set of fields in a struct.

This attribute can only be applied to fields whose type is an exact size
ABI type. The exact size ABI types include:

- `bool`
- `u8`, `u16`, `u32`, `u64`, `u256`
- `numeric`
- `b256`
- `str[N]`
- Tuples containing only exact size types
- Structs containing only exact size types
- Arrays of exact size types with a literal length
- Type aliases to exact size types

Additionally it causes the event types to be included in the JSON ABI
representation for the contract.

```sway
struct MyEventStruct {
    #[indexed]
    id: u64,
    sender: Identity,
}

enum MyEventEnum {
    A: (),
    B: (),
}
```

Additionally this updates the JSON ABI to emit an `offset` for indexed
fields.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
compiler: frontend Everything to do with type checking, control flow analysis, and everything between parsing and IRgen compiler General compiler. Should eventually become more specific as the issue is triaged enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant