Add event support via #[event] and #[indexed] attributes
#7158
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add `#[abi_name(name = "foo")` attribute to rename enum and struct ABI
items.
Here is example of how it can be used:
```sway
contract;
struct MyStruct {}
enum MyEnum {
A: ()
}
abi MyAbi {
fn my_struct() -> MyStruct;
fn my_enum() -> MyEnum;
}
impl MyAbi for Contract {
fn my_struct() -> MyStruct { MyStruct{} }
fn my_enum() -> MyEnum { MyEnum::A }
}
```
Closes FuelLabs#5955.
tritao
added
enhancement
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
#[event]
struct MyEventStruct {
#[indexed]
id: u64,
sender: Identity,
}
#[event]
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
boolu8,u16,u32,u64,u256numericb256str[N]Additionally it causes the event types to be included in the JSON ABI representation for the contract and emits an
offsetfor indexed fields.