miden_protocol/transaction/kernel/
tx_event_id.rs

1use core::fmt;
2
3use crate::errors::TransactionEventError;
4use crate::vm::{EventId, EventName};
5
6// CONSTANTS
7// ================================================================================================
8// Include the generated event constants
9include!(concat!(env!("OUT_DIR"), "/assets/transaction_events.rs"));
10
11// TRANSACTION EVENT
12// ================================================================================================
13
14/// Events which may be emitted by a transaction kernel.
15///
16/// The events are emitted via the `emit.<event_id>` instruction. The event ID is a Felt
17/// derived from the `EventId` string which is used to identify the event type. Events emitted
18/// by the transaction kernel are in the `miden` namespace.
19#[repr(u64)]
20#[derive(Debug, Clone, Eq, PartialEq)]
21pub enum TransactionEventId {
22    AccountBeforeForeignLoad = ACCOUNT_BEFORE_FOREIGN_LOAD_ID,
23
24    AccountVaultBeforeAddAsset = ACCOUNT_VAULT_BEFORE_ADD_ASSET_ID,
25    AccountVaultAfterAddAsset = ACCOUNT_VAULT_AFTER_ADD_ASSET_ID,
26
27    AccountVaultBeforeRemoveAsset = ACCOUNT_VAULT_BEFORE_REMOVE_ASSET_ID,
28    AccountVaultAfterRemoveAsset = ACCOUNT_VAULT_AFTER_REMOVE_ASSET_ID,
29
30    AccountVaultBeforeMintAsset = ACCOUNT_VAULT_BEFORE_MINT_ASSET_ID,
31    AccountVaultBeforeBurnAsset = ACCOUNT_VAULT_BEFORE_BURN_ASSET_ID,
32
33    AccountBeforeAssetDeltaComputation = ACCOUNT_BEFORE_ASSET_DELTA_COMPUTATION_ID,
34    AccountOnAssetDeltaComputation = ACCOUNT_ON_ASSET_DELTA_COMPUTATION_ID,
35
36    AccountVaultBeforeGetAsset = ACCOUNT_VAULT_BEFORE_GET_ASSET_ID,
37
38    AccountStorageBeforeSetItem = ACCOUNT_STORAGE_BEFORE_SET_ITEM_ID,
39    AccountStorageAfterSetItem = ACCOUNT_STORAGE_AFTER_SET_ITEM_ID,
40
41    AccountStorageBeforeGetMapItem = ACCOUNT_STORAGE_BEFORE_GET_MAP_ITEM_ID,
42
43    AccountStorageBeforeSetMapItem = ACCOUNT_STORAGE_BEFORE_SET_MAP_ITEM_ID,
44    AccountStorageAfterSetMapItem = ACCOUNT_STORAGE_AFTER_SET_MAP_ITEM_ID,
45
46    AccountBeforeIncrementNonce = ACCOUNT_BEFORE_INCREMENT_NONCE_ID,
47    AccountAfterIncrementNonce = ACCOUNT_AFTER_INCREMENT_NONCE_ID,
48
49    AccountPushProcedureIndex = ACCOUNT_PUSH_PROCEDURE_INDEX_ID,
50
51    NoteBeforeCreated = NOTE_BEFORE_CREATED_ID,
52    NoteAfterCreated = NOTE_AFTER_CREATED_ID,
53
54    NoteBeforeAddAsset = NOTE_BEFORE_ADD_ASSET_ID,
55    NoteAfterAddAsset = NOTE_AFTER_ADD_ASSET_ID,
56
57    NoteBeforeAddAttachment = NOTE_BEFORE_ADD_ATTACHMENT_ID,
58
59    InputNoteIndexLookup = INPUT_NOTE_INDEX_LOOKUP_ID,
60
61    AuthRequest = AUTH_REQUEST_ID,
62
63    PrologueStart = PROLOGUE_START_ID,
64    PrologueEnd = PROLOGUE_END_ID,
65
66    NotesProcessingStart = NOTES_PROCESSING_START_ID,
67    NotesProcessingEnd = NOTES_PROCESSING_END_ID,
68
69    NoteExecutionStart = NOTE_EXECUTION_START_ID,
70    NoteExecutionEnd = NOTE_EXECUTION_END_ID,
71
72    TxScriptProcessingStart = TX_SCRIPT_PROCESSING_START_ID,
73    TxScriptProcessingEnd = TX_SCRIPT_PROCESSING_END_ID,
74
75    EpilogueStart = EPILOGUE_START_ID,
76    EpilogueEnd = EPILOGUE_END_ID,
77
78    EpilogueAuthProcStart = EPILOGUE_AUTH_PROC_START_ID,
79    EpilogueAuthProcEnd = EPILOGUE_AUTH_PROC_END_ID,
80
81    LinkMapSet = LINK_MAP_SET_ID,
82    LinkMapGet = LINK_MAP_GET_ID,
83
84    Unauthorized = AUTH_UNAUTHORIZED_ID,
85}
86
87impl TransactionEventId {
88    /// Returns `true` if the event is privileged, i.e. it is only allowed to be emitted from the
89    /// root context of the VM, which is where the transaction kernel executes.
90    ///
91    /// The host enforces this: a privileged event emitted from a non-root context is rejected.
92    pub fn is_privileged(&self) -> bool {
93        let is_unprivileged =
94            matches!(self, Self::AuthRequest | Self::InputNoteIndexLookup | Self::Unauthorized);
95        !is_unprivileged
96    }
97
98    /// Returns the [`EventId`] of the transaction event.
99    pub fn event_id(&self) -> EventId {
100        EventId::from_u64(self.clone() as u64)
101    }
102
103    /// Returns the [`EventName`] of the transaction event.
104    pub fn event_name(&self) -> &'static EventName {
105        match self {
106            Self::AccountBeforeForeignLoad => &ACCOUNT_BEFORE_FOREIGN_LOAD_NAME,
107            Self::AccountVaultBeforeAddAsset => &ACCOUNT_VAULT_BEFORE_ADD_ASSET_NAME,
108            Self::AccountVaultAfterAddAsset => &ACCOUNT_VAULT_AFTER_ADD_ASSET_NAME,
109            Self::AccountVaultBeforeRemoveAsset => &ACCOUNT_VAULT_BEFORE_REMOVE_ASSET_NAME,
110            Self::AccountVaultAfterRemoveAsset => &ACCOUNT_VAULT_AFTER_REMOVE_ASSET_NAME,
111            Self::AccountVaultBeforeMintAsset => &ACCOUNT_VAULT_BEFORE_MINT_ASSET_NAME,
112            Self::AccountVaultBeforeBurnAsset => &ACCOUNT_VAULT_BEFORE_BURN_ASSET_NAME,
113            Self::AccountBeforeAssetDeltaComputation => {
114                &ACCOUNT_BEFORE_ASSET_DELTA_COMPUTATION_NAME
115            },
116            Self::AccountOnAssetDeltaComputation => &ACCOUNT_ON_ASSET_DELTA_COMPUTATION_NAME,
117            Self::AccountVaultBeforeGetAsset => &ACCOUNT_VAULT_BEFORE_GET_ASSET_NAME,
118            Self::AccountStorageBeforeSetItem => &ACCOUNT_STORAGE_BEFORE_SET_ITEM_NAME,
119            Self::AccountStorageAfterSetItem => &ACCOUNT_STORAGE_AFTER_SET_ITEM_NAME,
120            Self::AccountStorageBeforeGetMapItem => &ACCOUNT_STORAGE_BEFORE_GET_MAP_ITEM_NAME,
121            Self::AccountStorageBeforeSetMapItem => &ACCOUNT_STORAGE_BEFORE_SET_MAP_ITEM_NAME,
122            Self::AccountStorageAfterSetMapItem => &ACCOUNT_STORAGE_AFTER_SET_MAP_ITEM_NAME,
123            Self::AccountBeforeIncrementNonce => &ACCOUNT_BEFORE_INCREMENT_NONCE_NAME,
124            Self::AccountAfterIncrementNonce => &ACCOUNT_AFTER_INCREMENT_NONCE_NAME,
125            Self::AccountPushProcedureIndex => &ACCOUNT_PUSH_PROCEDURE_INDEX_NAME,
126            Self::NoteBeforeCreated => &NOTE_BEFORE_CREATED_NAME,
127            Self::NoteAfterCreated => &NOTE_AFTER_CREATED_NAME,
128            Self::NoteBeforeAddAsset => &NOTE_BEFORE_ADD_ASSET_NAME,
129            Self::NoteAfterAddAsset => &NOTE_AFTER_ADD_ASSET_NAME,
130            Self::NoteBeforeAddAttachment => &NOTE_BEFORE_ADD_ATTACHMENT_NAME,
131            Self::InputNoteIndexLookup => &INPUT_NOTE_INDEX_LOOKUP_NAME,
132            Self::AuthRequest => &AUTH_REQUEST_NAME,
133            Self::PrologueStart => &PROLOGUE_START_NAME,
134            Self::PrologueEnd => &PROLOGUE_END_NAME,
135            Self::NotesProcessingStart => &NOTES_PROCESSING_START_NAME,
136            Self::NotesProcessingEnd => &NOTES_PROCESSING_END_NAME,
137            Self::NoteExecutionStart => &NOTE_EXECUTION_START_NAME,
138            Self::NoteExecutionEnd => &NOTE_EXECUTION_END_NAME,
139            Self::TxScriptProcessingStart => &TX_SCRIPT_PROCESSING_START_NAME,
140            Self::TxScriptProcessingEnd => &TX_SCRIPT_PROCESSING_END_NAME,
141            Self::EpilogueStart => &EPILOGUE_START_NAME,
142            Self::EpilogueEnd => &EPILOGUE_END_NAME,
143            Self::EpilogueAuthProcStart => &EPILOGUE_AUTH_PROC_START_NAME,
144            Self::EpilogueAuthProcEnd => &EPILOGUE_AUTH_PROC_END_NAME,
145            Self::LinkMapSet => &LINK_MAP_SET_NAME,
146            Self::LinkMapGet => &LINK_MAP_GET_NAME,
147            Self::Unauthorized => &AUTH_UNAUTHORIZED_NAME,
148        }
149    }
150}
151
152impl fmt::Display for TransactionEventId {
153    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
154        write!(f, "{}", self.event_name())
155    }
156}
157
158impl TryFrom<EventId> for TransactionEventId {
159    type Error = TransactionEventError;
160
161    fn try_from(event_id: EventId) -> Result<Self, Self::Error> {
162        let raw = event_id.as_felt().as_canonical_u64();
163
164        match raw {
165            ACCOUNT_BEFORE_FOREIGN_LOAD_ID => Ok(TransactionEventId::AccountBeforeForeignLoad),
166
167            ACCOUNT_VAULT_BEFORE_ADD_ASSET_ID => Ok(TransactionEventId::AccountVaultBeforeAddAsset),
168            ACCOUNT_VAULT_AFTER_ADD_ASSET_ID => Ok(TransactionEventId::AccountVaultAfterAddAsset),
169
170            ACCOUNT_VAULT_BEFORE_REMOVE_ASSET_ID => {
171                Ok(TransactionEventId::AccountVaultBeforeRemoveAsset)
172            },
173            ACCOUNT_VAULT_AFTER_REMOVE_ASSET_ID => {
174                Ok(TransactionEventId::AccountVaultAfterRemoveAsset)
175            },
176
177            ACCOUNT_VAULT_BEFORE_MINT_ASSET_ID => {
178                Ok(TransactionEventId::AccountVaultBeforeMintAsset)
179            },
180            ACCOUNT_VAULT_BEFORE_BURN_ASSET_ID => {
181                Ok(TransactionEventId::AccountVaultBeforeBurnAsset)
182            },
183
184            ACCOUNT_ON_ASSET_DELTA_COMPUTATION_ID => {
185                Ok(TransactionEventId::AccountOnAssetDeltaComputation)
186            },
187            ACCOUNT_BEFORE_ASSET_DELTA_COMPUTATION_ID => {
188                Ok(TransactionEventId::AccountBeforeAssetDeltaComputation)
189            },
190
191            ACCOUNT_VAULT_BEFORE_GET_ASSET_ID => Ok(TransactionEventId::AccountVaultBeforeGetAsset),
192
193            ACCOUNT_STORAGE_BEFORE_SET_ITEM_ID => {
194                Ok(TransactionEventId::AccountStorageBeforeSetItem)
195            },
196            ACCOUNT_STORAGE_AFTER_SET_ITEM_ID => Ok(TransactionEventId::AccountStorageAfterSetItem),
197
198            ACCOUNT_STORAGE_BEFORE_GET_MAP_ITEM_ID => {
199                Ok(TransactionEventId::AccountStorageBeforeGetMapItem)
200            },
201
202            ACCOUNT_STORAGE_BEFORE_SET_MAP_ITEM_ID => {
203                Ok(TransactionEventId::AccountStorageBeforeSetMapItem)
204            },
205            ACCOUNT_STORAGE_AFTER_SET_MAP_ITEM_ID => {
206                Ok(TransactionEventId::AccountStorageAfterSetMapItem)
207            },
208
209            ACCOUNT_BEFORE_INCREMENT_NONCE_ID => {
210                Ok(TransactionEventId::AccountBeforeIncrementNonce)
211            },
212            ACCOUNT_AFTER_INCREMENT_NONCE_ID => Ok(TransactionEventId::AccountAfterIncrementNonce),
213
214            ACCOUNT_PUSH_PROCEDURE_INDEX_ID => Ok(TransactionEventId::AccountPushProcedureIndex),
215
216            NOTE_BEFORE_CREATED_ID => Ok(TransactionEventId::NoteBeforeCreated),
217            NOTE_AFTER_CREATED_ID => Ok(TransactionEventId::NoteAfterCreated),
218
219            NOTE_BEFORE_ADD_ASSET_ID => Ok(TransactionEventId::NoteBeforeAddAsset),
220            NOTE_AFTER_ADD_ASSET_ID => Ok(TransactionEventId::NoteAfterAddAsset),
221
222            NOTE_BEFORE_ADD_ATTACHMENT_ID => Ok(TransactionEventId::NoteBeforeAddAttachment),
223
224            INPUT_NOTE_INDEX_LOOKUP_ID => Ok(TransactionEventId::InputNoteIndexLookup),
225
226            AUTH_REQUEST_ID => Ok(TransactionEventId::AuthRequest),
227
228            PROLOGUE_START_ID => Ok(TransactionEventId::PrologueStart),
229            PROLOGUE_END_ID => Ok(TransactionEventId::PrologueEnd),
230
231            NOTES_PROCESSING_START_ID => Ok(TransactionEventId::NotesProcessingStart),
232            NOTES_PROCESSING_END_ID => Ok(TransactionEventId::NotesProcessingEnd),
233
234            NOTE_EXECUTION_START_ID => Ok(TransactionEventId::NoteExecutionStart),
235            NOTE_EXECUTION_END_ID => Ok(TransactionEventId::NoteExecutionEnd),
236
237            TX_SCRIPT_PROCESSING_START_ID => Ok(TransactionEventId::TxScriptProcessingStart),
238            TX_SCRIPT_PROCESSING_END_ID => Ok(TransactionEventId::TxScriptProcessingEnd),
239
240            EPILOGUE_START_ID => Ok(TransactionEventId::EpilogueStart),
241            EPILOGUE_AUTH_PROC_START_ID => Ok(TransactionEventId::EpilogueAuthProcStart),
242            EPILOGUE_AUTH_PROC_END_ID => Ok(TransactionEventId::EpilogueAuthProcEnd),
243            EPILOGUE_END_ID => Ok(TransactionEventId::EpilogueEnd),
244
245            LINK_MAP_SET_ID => Ok(TransactionEventId::LinkMapSet),
246            LINK_MAP_GET_ID => Ok(TransactionEventId::LinkMapGet),
247
248            AUTH_UNAUTHORIZED_ID => Ok(TransactionEventId::Unauthorized),
249
250            _ => Err(TransactionEventError::InvalidTransactionEvent(event_id)),
251        }
252    }
253}
miden_protocol/transaction/kernel/tx_event_id.rs

miden_protocol/transaction/kernel/
tx_event_id.rs
