fix: split off proxy into its own repository

Author: nyonson

proxy/CHANGELOG.md CHANGELOG.mdproxy/CHANGELOG.md renamed to CHANGELOG.md

@@ -1,4 +1,24 @@
-[workspace]
-members = ["protocol", "proxy", "protocol/fuzz", "traffic"]
-default-members = ["protocol", "proxy", "traffic"]
+[package]
+name = "bip324-proxy"
+version = "0.4.0"
+edition = "2021"
+license = "CC0-1.0"
 resolver = "2"
+description = "BIP-324 proxy enabling v1-only clients to use the v2 bitcoin p2p protocol"
+repository = "https://github.com/nyonson/bip324-proxy"
+readme = "README.md"
+
+[package.metadata.configure_me]
+spec = "config_spec.toml"
+
+[dependencies]
+bitcoin = { version = "0.32.4" }
+tokio = { version = "1", features = ["full"] }
+hex = { package = "hex-conservative", version = "0.2.0" }
+bip324 = { version = "0.10.0", features = ["tokio"] }
+configure_me = "0.4.0"
+log = "0.4.8"
+env_logger = "0.10"
+
+[build-dependencies]
+configure_me_codegen = { version = "0.4.8", default-features = false }

Cargo.toml

@@ -1,19 +1,29 @@
-# BIP-324 Encrypted Transport Protocol
+# BIP-324 V2 Proxy
 
-[BIP-324](https://github.com/bitcoin/bips/blob/master/bip-0324.mediawiki) describes the V2 encrypted communication protocol for the bitcoin P2P network. 
+A proxy sidecar process which allows V1-only clients to communicate over the V2 protocol. The process listens on port `1324` for V1 connections and requires the V1 client to send along the remote peer's IP address in the `addr_recv` field.
 
-## Motivation
+## Running the Proxy
 
-Bitcoin's original P2P protocol, "V1", was designed without any encryption. Even though the data exchanged over the bitcoin P2P network is public to some degree, encrypted communications offers a number of benefits over plaintext communication. 
+`cargo run --bin proxy`
 
-* Internet Service Providers (ISPs) can easily detect and censor plaintext bitcoin communication.  
-* Plaintext message tampering, without detection, is trivial for a man in the middle (MitM) attacker. 
-* Nefarious actors may associate metadata, such as IP addresses and transaction origins, without explicitly having to connect directly to peers.
+The `--v1-fallback=true` flag can be used to fallback to the V1 protocol if the remote client does not support V2.
 
-BIP-324 - "V2" - encrypted communication protects against the above issues increasing the privacy and censorship-resistance of the bitcoin ecosystem. Any applications communicating with bitcoin nodes, including light clients, should make use of the V2 protocol.
+## Testing with Nakamoto
 
-## Crates
+[Nakamoto](https://github.com/cloudhead/nakamoto) is a BIP-157/BIP-158 Light Client that communicates over the Bitcoin P2P network. With a single change, Nakamoto may be modified to use the proxy. This patch hardcodes Nakamoto to connect to the localhost on port 1324 where the proxy should be running.
 
-* [`protocol`](./protocol) - Exports the `bip324` client library.
-* [`proxy`](./proxy) - A small side-car application to enable V2 communication for V1-only applications.
-* [`traffic`](./traffic) - Traffic shape hiding layer over the base client.
+```diff
+diff --git a/net/poll/src/reactor.rs b/net/poll/src/reactor.rs
+
+--- a/net/poll/src/reactor.rs
++++ b/net/poll/src/reactor.rs
+@@ -468,7 +468,7 @@ fn dial(addr: &net::SocketAddr) -> Result<net::TcpStream, io::Error> {
+     sock.set_write_timeout(Some(WRITE_TIMEOUT))?;
+     sock.set_nonblocking(true)?;
+
+-    match sock.connect(&(*addr).into()) {
++    match sock.connect(&net::SocketAddr::from(([127, 0, 0, 1], 1324)).into()) {
+         Ok(()) => {}
+         Err(e) if e.raw_os_error() == Some(libc::EINPROGRESS) => {}
+         Err(e) if e.raw_os_error() == Some(libc::EALREADY) => {
+```