Skip to content

Commit 44b2bff

Browse files
committed
Update mailroom README description
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.
1 parent a8c1902 commit 44b2bff

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

payjoin-mailroom/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# Payjoin Mailroom
22

3-
The Payjoin Mailroom is a unified Payjoin Directory and OHTTP Relay server. Combines [payjoin-directory](../payjoin-directory/README.md) and [ohttp-relay](../ohttp-relay/README.md) into a single binary.
3+
payjoin-mailroom is a single, lightweight binary that bundles the two server-side roles required by BIP 77 Async Payjoin:
4+
5+
- **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).
6+
- **OHTTP Relay**: an [Oblivious HTTP](https://en.wikipedia.org/wiki/Oblivious_HTTP) proxy that separates client IP addresses from the directory, preventing the directory from correlating users with their network identity.
47

58
Note that this binary is under active development and thus the CLI and configuration file may be unstable.
69

0 commit comments

Comments
 (0)