docs: add offchain message delivery guide (backport of #24583 to v5-next)#24613
Open
AztecBot wants to merge 2 commits into
Open
docs: add offchain message delivery guide (backport of #24583 to v5-next)#24613AztecBot wants to merge 2 commits into
AztecBot wants to merge 2 commits into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Backports #24583 (docs: add offchain message delivery guide, by @ciaranightingale) onto
v5-next.What's included
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 staleprocess_messageflow and outdated JS example with the currentoffchain_receive/offchainMessagesaztec.js API, adds a cross-link to the new page, and sentence-cases headings.offchain_messages.nr— doc comment updated:process_message→offchain_receive(injected by the#[aztec]macro).docs:start/end:token_transfer_offchain_delivery_testmarkers so the new page can#include_codea real test.Backport notes
v5-next; the only manual step was re-applying three heading-casing edits innote_delivery.mdwhose 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.#include_codetargets resolve onv5-next: thetransfer_in_private_with_offchain_deliverymarker intoken_contract/src/main.nralready exists, and the test marker is added by this PR.next, so the two release lines carry the same docs change separately.v5-next(not the default branch), so no auto-close keywords are used.Refs #24583.
Created by claudebox · group:
slackbot