Skip to content

Commit 1206b26

Browse files
committed
Re-introducing migration notes
1 parent 31ff3ed commit 1206b26

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/docs/migration_notes.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,17 @@ As we prepare for a bigger `Wallet` interface refactor and the upcoming `WalletS
4444

4545
## [Aztec.nr]
4646

47+
### Private event emission API changes
48+
49+
The private event emission API has been significantly reworked to provide clearer semantics around message delivery guarantees. The key changes are:
50+
51+
1. `emit_event_in_private_log` has been renamed to `emit_event_in_private` and now takes a `delivery_mode` parameter instead of `constraints`
52+
2. `emit_event_as_offchain_message` has been removed in favor of using `emit_event_in_private` with `MessageDelivery.UNCONSTRAINED_OFFCHAIN`
53+
3. `PrivateLogContent` enum has been replaced with `MessageDelivery` enum with the following values:
54+
- `CONSTRAINED_ONCHAIN`: For on-chain delivery with cryptographic guarantees (replaces `CONSTRAINED_ENCRYPTION`)
55+
- `UNCONSTRAINED_OFFCHAIN`: For off-chain delivery without constraints
56+
- `UNCONSTRAINED_ONCHAIN`: For on-chain delivery without constraints (replaces `NO_CONSTRAINTS`)
57+
4758
### Contract functions can no longer be `pub` or `pub(crate)`
4859

4960
With the latest changes to `TestEnvironment`, making contract functions have public visibility is no longer required given the new `call_public` and `simulate_utility` functions. To avoid accidental direct invocation, and to reduce confusion with the autogenerated interfaces, we're forbidding them being public.

0 commit comments

Comments
 (0)