Skip to content

docs: add offchain message delivery guide (backport of #24583 to v5-next)#24613

Open
AztecBot wants to merge 2 commits into
v5-nextfrom
cb/backport-24583-offchain-docs-v5-next
Open

docs: add offchain message delivery guide (backport of #24583 to v5-next)#24613
AztecBot wants to merge 2 commits into
v5-nextfrom
cb/backport-24583-offchain-docs-v5-next

Conversation

@AztecBot

@AztecBot AztecBot commented Jul 8, 2026

Copy link
Copy Markdown
Collaborator

Backports #24583 (docs: add offchain message delivery guide, by @ciaranightingale) onto v5-next.

What's included

  • New page offchain_message_delivery.md — full offchain delivery workflow (contract emission → sender-side extraction → transport → offchain_receive → processing lifecycle → TXE testing), pulling real code from the token contract and its offchain-delivery test via #include_code.
  • note_delivery.md — replaces the stale process_message flow and outdated JS example with the current offchain_receive / offchainMessages aztec.js API, adds a cross-link to the new page, and sentence-cases headings.
  • offchain_messages.nr — doc comment updated: process_messageoffchain_receive (injected by the #[aztec] macro).
  • Test file — adds docs:start/end:token_transfer_offchain_delivery_test markers so the new page can #include_code a real test.

Backport notes

  • The original PR's diff applies cleanly on v5-next; the only manual step was re-applying three heading-casing edits in note_delivery.md whose surrounding context differs on this line (v5-next carries an extra "Tagging secret strategy" section). Content is otherwise identical to docs: add offchain message delivery guide #24583.
  • Both #include_code targets resolve on v5-next: the transfer_in_private_with_offchain_delivery marker in token_contract/src/main.nr already exists, and the test marker is added by this PR.
  • This is an independent PR, not a cherry-pick: docs: add offchain message delivery guide #24583 is still open/unmerged on next, so the two release lines carry the same docs change separately.
  • Base is v5-next (not the default branch), so no auto-close keywords are used.

Refs #24583.


Created by claudebox · group: slackbot

@AztecBot AztecBot added ci-draft Run CI on draft PRs. ci-no-fail-fast Sets NO_FAIL_FAST in the CI so the run is not aborted on the first failure claudebox Owned by claudebox. it can push to this PR. labels Jul 8, 2026
@alejoamiras alejoamiras marked this pull request as ready for review July 9, 2026 18:56
@alejoamiras alejoamiras requested a review from nventuro as a code owner July 9, 2026 18:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci-draft Run CI on draft PRs. ci-no-fail-fast Sets NO_FAIL_FAST in the CI so the run is not aborted on the first failure claudebox Owned by claudebox. it can push to this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants