Skip to content

Commit 850b7cd

Browse files
committed
Mailroom README updates
1 parent ab99d64 commit 850b7cd

3 files changed

Lines changed: 7 additions & 13 deletions

File tree

README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,9 @@ The main Payjoin Dev Kit library which provides tools for implementing both Asyn
3737

3838
A CLI tool which performs no-frills Payjoin. It is a reference implementation of the Payjoin Dev Kit which uses a Bitcoin Core wallet.
3939

40-
### [`ohttp-relay`](https://github.com/payjoin/rust-payjoin/tree/master/ohttp-relay)
40+
### [`payjoin-mailroom`](https://github.com/payjoin/rust-payjoin/tree/master/payjoin-mailroom)
4141

42-
A Rust implementation of an Oblivious HTTP (OHTTP) relay resource.
43-
44-
**Disclaimer: Both this crate and the [IETF paper](https://ietf-wg-ohai.github.io/oblivious-http/draft-ietf-ohai-ohttp.html) are undergoing active revision. Use at your own risk.**
45-
46-
### [`payjoin-directory`](https://github.com/payjoin/rust-payjoin/tree/master/payjoin-directory)
47-
48-
A reference implementation for a Payjoin Directory which stores and forwards HTTP client messages between the sender and the receiver to allow for Async Payjoin transactions. Async Payjoin clients make requests to the directory using [Oblivious HTTP (OHTTP)](https://www.ietf.org/rfc/rfc9458.html) which prevents the directory from being able to link payjoins to specific client IP addresses.
42+
An [Oblivious HTTP (OHTTP) Relay](https://github.com/payjoin/rust-payjoin/tree/master/ohttp-relay) and a BIP77 [Payjoin Directory](https://github.com/payjoin/rust-payjoin/tree/master/payjoin-directory) combined in one binary.
4943

5044
### [`payjoin-test-utils`](https://github.com/payjoin/rust-payjoin/tree/master/payjoin-test-utils)
5145

payjoin-mailroom/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[package]
22
name = "payjoin-mailroom"
33
version = "0.0.1"
4-
description = "Unified Payjoin Directory and OHTTP Relay service"
4+
description = "Combined Payjoin Directory and OHTTP Relay"
55
repository = "https://github.com/payjoin/rust-payjoin/tree/master/payjoin-mailroom"
66
keywords = ["bip77", "bitcoin", "ohttp", "payjoin", "privacy"]
77
categories = [

payjoin-mailroom/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# payjoin-mailroom
1+
# Payjoin Mailroom
22

3-
Unified Payjoin Directory and OHTTP Relay service. Combines [payjoin-directory](../payjoin-directory/README.md) and [ohttp-relay](../ohttp-relay/README.md) into a single binary.
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.
44

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

77
## Configuration
88

99
payjoin-mailroom reads configuration from `config.toml` (or the path given with `--config`). Every setting can also be supplied via environment variables prefixed with `PJ_`, using double underscores for nesting (e.g., `PJ_TELEMETRY__ENDPOINT`).
1010

11-
## Running the service
11+
## Usage
1212

1313
### Cargo
1414

@@ -51,4 +51,4 @@ export PJ_TELEMETRY__AUTH_TOKEN="<base64 instanceID:token>"
5151
export PJ_TELEMETRY__OPERATOR_DOMAIN="your-domain.example.com"
5252
```
5353

54-
When no `[telemetry]` section is present and no `PJ_TELEMETRY__*` variables are set, the service uses local-only console tracing.
54+
When no `[telemetry]` section is present and no `PJ_TELEMETRY__*` variables are set, it falls back to local-only console tracing.

0 commit comments

Comments
 (0)