Rename "proxy" to "relay" throughout the project#133
Open
abergs wants to merge 1 commit into
Open
Conversation
The zero-knowledge WebSocket server is more accurately a relay than a proxy: it routes opaque ciphertext between authenticated peers without inspecting payloads. This rename aligns crate, type, and user-facing terminology with that role. Crate renames (workspace version bumped 0.11.0 -> 0.12.0): - ap-proxy -> ap-relay - ap-proxy-client -> ap-relay-client - ap-proxy-protocol -> ap-relay-protocol Binary, types, and modules: - bin ap-proxy -> ap-relay - ProxyServer -> RelayServer - ProxyClient (trait) -> RelayClient - DefaultProxyClient -> DefaultRelayClient - ProxyProtocolClient -> RelayProtocolClient - ProxyClientConfig -> RelayClientConfig - ProxyError -> RelayError - ClientError::ProxyAuthFailed -> RelayAuthFailed - src/proxy.rs -> src/relay.rs - server/proxy_server.rs -> server/relay_server.rs - tests/websocket_proxy.rs -> tests/websocket_relay.rs - js-wasm proxy_client.rs -> relay_client.rs User-facing surface: - CLI flag --proxy-url -> --relay-url, DEFAULT_PROXY_URL -> DEFAULT_RELAY_URL - Log/help strings, example bindings (Python, Swift, JS) updated - protocol-v0.md, README, CONTRIBUTING, CLAUDE.md, release.yml updated Breaking change for API consumers and crates.io: old crate names stay stale; downstream callers of ProxyClient/ProxyError/--proxy-url must update. The wire-protocol Messages enum is unchanged.
iinuwa
approved these changes
May 8, 2026
iinuwa
approved these changes
May 12, 2026
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
2 participants
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.
The zero-knowledge WebSocket server is more accurately a relay than a proxy.
I'd also like to avoid using the word "proxy" since in this problem domain, there are many client side proxies.
Crate renames (workspace version bumped 0.11.0 -> 0.12.0):
Binary, types, and modules:
User-facing surface:
Breaking change for API consumers and crates.io: old crate names stay stale; downstream callers of ProxyClient/ProxyError/--proxy-url must update. The wire-protocol Messages enum is unchanged.
Please note that
ap-relayis busy on crates.io, so if we want to publish the server on crates (we don't need to!) we need to find a different name.🎟️ Tracking
📔 Objective
📸 Screenshots
⏰ Reminders before review
🦮 Reviewer guidelines
:+1:) or similar for great changes:memo:) or ℹ️ (:information_source:) for notes or general info:question:) for questions:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion:art:) for suggestions / improvements:x:) or:warning:) for more significant problems or concerns needing attention:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt:pick:) for minor or nitpick changes