Skip to content

Align AEAD key-nonce docs with runtime contract#3036

Merged
huitseeker merged 3 commits into0xMiden:nextfrom
Keemosty12:aead-contract-order-sync
Apr 24, 2026
Merged

Align AEAD key-nonce docs with runtime contract#3036
huitseeker merged 3 commits into0xMiden:nextfrom
Keemosty12:aead-contract-order-sync

Conversation

@Keemosty12
Copy link
Copy Markdown
Contributor

@Keemosty12 Keemosty12 commented Apr 21, 2026

Describe your changes

This PR aligns AEAD key/nonce ordering across MASM comments, handler documentation, and user-facing docs to match the actual runtime/event contract (key then nonce).
It removes contradictory contract descriptions that could cause integration or review mistakes, while keeping behavior and APIs unchanged.

Checklist before requesting a review

  • Repo forked and branch created from next according to naming convention.
  • Commit messages and codestyle follow conventions.
  • Commits are signed.
  • Relevant issues are linked in the PR description.
  • Tests added for new functionality.
  • Documentation/comments updated according to changes.
  • Updated CHANGELOG.md

@github-actions
Copy link
Copy Markdown

Automated check (CONTRIBUTING.md)

Findings:

Recommendations:

  • Consider adding a Test plan or clear review steps.

Next steps:

  • Link a relevant issue (e.g., "Fixes Implement SHA256 in Miden Assembly #123") and ensure it is assigned to you.
  • See CONTRIBUTING.md for expectations.
  • If this is a false positive, comment: /quality-review.

@huitseeker huitseeker requested a review from Al-Kindi-0 April 21, 2026 16:50
Copy link
Copy Markdown
Collaborator

@huitseeker huitseeker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This partially addresses the broader core-lib docs drift tracked in #2694. In particular, #2547 moved the executable contract toward the unified LE stack convention, but some user-facing and inline AEAD docs kept the older key/nonce wording.

Comment thread CHANGELOG.md Outdated
Copy link
Copy Markdown
Contributor

@Al-Kindi-0 Al-Kindi-0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for fixing these

Comment thread crates/lib/core/src/handlers/aead_decrypt.rs Outdated
@huitseeker huitseeker force-pushed the aead-contract-order-sync branch from 3114416 to 7ea1929 Compare April 24, 2026 11:59
@huitseeker huitseeker merged commit 4546b30 into 0xMiden:next Apr 24, 2026
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants