Skip to content

Update mailroom README description#1402

Open
spacebear21 wants to merge 1 commit intopayjoin:masterfrom
spacebear21:fix-directory-link
Open

Update mailroom README description#1402
spacebear21 wants to merge 1 commit intopayjoin:masterfrom
spacebear21:fix-directory-link

Conversation

@spacebear21
Copy link
Collaborator

Re-use the landing page copy from #1401 to better describe the two server-side roles bundled by payjoin-mailroom, and drop the now-broken links to payjoin-directory and ohttp-relay.

Pull Request Checklist

Please confirm the following before requesting review:

@coveralls
Copy link
Collaborator

coveralls commented Mar 9, 2026

Pull Request Test Coverage Report for Build 22873367759

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 83.507%

Totals Coverage Status
Change from base Build 22866682076: 0.0%
Covered Lines: 10688
Relevant Lines: 12799

💛 - Coveralls

@spacebear21 spacebear21 requested a review from benalleng March 9, 2026 18:22
Copy link
Collaborator

@benalleng benalleng left a comment

Choose a reason for hiding this comment

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

Small nit but I think I'd like it to specifically mention Oblivious Http

payjoin-mailroom is a single, lightweight binary that bundles the two server-side roles required by BIP 77 Async Payjoin:

- **Payjoin Directory**: a store-and-forward mailbox that holds small, ephemeral, end-to-end encrypted payloads so a sender and receiver can complete a payjoin asynchronously (they don't need to be online at the same time).
- **OHTTP Relay**: a simple HTTP proxy that separates client IP addresses from the directory, preventing the directory from correlating users with their network identity.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think its important to specify that this is using oblivious http

Suggested change
- **OHTTP Relay**: a simple HTTP proxy that separates client IP addresses from the directory, preventing the directory from correlating users with their network identity.
- **OHTTP Relay**: a forwarding proxy utilizing Oblivious HTTP that separates client IP addresses from the directory, preventing the directory from correlating users with their network identity.

Copy link
Collaborator Author

@spacebear21 spacebear21 Mar 9, 2026

Choose a reason for hiding this comment

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

Updated with a link to the OHTTP wiki page. I also updated the #1401 with similar wording.

Use the landing page copy to better describe the two
server-side roles bundled by payjoin-mailroom, and drop
the now-broken links to payjoin-directory and ohttp-relay.
@bc1cindy
Copy link
Contributor

bc1cindy commented Mar 9, 2026

LGTM, ACK

@spacebear21 spacebear21 requested a review from benalleng March 10, 2026 00:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants