Skip to content

docs: add relay integration guide - #824

Merged
brendanjryan merged 1 commit into
tempoxyz:mainfrom
brendanjryan:brendanjryan/docs-relays
Jul 27, 2026
Merged

docs: add relay integration guide#824
brendanjryan merged 1 commit into
tempoxyz:mainfrom
brendanjryan:brendanjryan/docs-relays

Conversation

@brendanjryan

Copy link
Copy Markdown
Collaborator

Motivation

Document relay-based payment validation and finalization for mppx users and relay authors.

Summary

  • Add a Relays advanced-feature guide
  • Document validate and broadcast lifecycle hooks
  • Add Tempo API relay configuration and reference updates

Key design considerations

  • Lead with generic relay hooks, then the Tempo-specific implementation
  • Keep the sequence diagram focused on one settlement exchange

@vercel

vercel Bot commented Jul 27, 2026

Copy link
Copy Markdown

@brendanjryan is attempting to deploy a commit to the Tempo Team on Vercel.

A member of the Team first needs to authorize it.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d656124b52

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Client->>API: Request
API-->>Client: 402 + Challenge
Client->>API: Retry + Credential
API->>Relay: [!emphasis] Validate Credential

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Strip emphasis markers from generated Mermaid

When Vocs publishes this page as Markdown, mermaidDiagram() passes the chart through verbatim, so [!emphasis] remains inside the standard mermaid fence and renders as literal label text instead of emphasis. Strip the custom markers in the Markdown renderer and add a focused renderer test so the published diagram remains semantic.

AGENTS.md reference: AGENTS.md:L324-L327

Useful? React with 👍 / 👎.

Comment on lines +56 to +57
export const charge = Method.toServer(Methods.charge, {
async validate({ credential, request }) {

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Put broadcast before validate

In this new Method.toServer options object, validate precedes broadcast, contrary to the repository-required alphabetical ordering for object properties in documentation examples. Move the complete broadcast hook before validate so the copyable example follows the documented convention.

AGENTS.md reference: AGENTS.md:L291-L294

Useful? React with 👍 / 👎.

@brendanjryan
brendanjryan merged commit 1d6b583 into tempoxyz:main Jul 27, 2026
9 of 10 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.

1 participant