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

miden_protocol/transaction/kernel/
tx_event_id.rs
