fix: consistent documentation usage of "BIP-324"

Author: nyonson

README.md

@@ -1,6 +1,6 @@
-# BIP324 Encrypted Transport Protocol
+# BIP-324 Encrypted Transport Protocol
 
-[BIP324](https://github.com/bitcoin/bips/blob/master/bip-0324.mediawiki) describes the V2 encrypted communication protocol for the bitcoin P2P network. 
+[BIP-324](https://github.com/bitcoin/bips/blob/master/bip-0324.mediawiki) describes the V2 encrypted communication protocol for the bitcoin P2P network. 
 
 ## Motivation
 
@@ -10,9 +10,9 @@ Bitcoin's original P2P protocol, "V1", was designed without any encryption. Even
 * 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.
 
-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.
+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.
 
 ## Packages
 
-* `protocol` - Exports the `BIP324` client library.
+* `protocol` - Exports the `bip324` client library.
 * `proxy` - A small side-car application to enable V2 communication for V1-only applications.

protocol/Cargo.toml

@@ -27,6 +27,6 @@ bitcoin_hashes = { version ="0.15.0", default-features = false }
 chacha20-poly1305 = { version = "0.1.1", default-features = false }
 
 [dev-dependencies]
-# bitcoind version 26.0 includes support for BIP324's V2 protocol, but it is disabled by default.
+# bitcoind version 26.0 includes support for BIP-324's V2 protocol, but it is disabled by default.
 bitcoind = { package = "corepc-node", version = "0.7.1", default-features = false, features = ["26_0","download"] }
 hex = { package = "hex-conservative", version = "0.2.0" }

protocol/README.md

@@ -1,6 +1,6 @@
 # Protocol
 
-A BIP324 library to establish and communicate over an encrypted channel.
+A BIP-324 library to establish and communicate over an encrypted channel.
 
 The library is designed with a bare `no_std` and "Sans I/O" interface to keep it as agnostic as possible to application runtimes, but higher level interfaces are exposed for ease of use.
 

protocol/doc/DESIGN.md

@@ -8,6 +8,6 @@ With Bob's public key, Alice derives the shared secret and ensures the decrypted
 
 ## ChaCha20Poly1305
 
-BIP324 elects to use the ChaCha20Poly1305 Authenticated Encryption with Addition Data (AEAD) algorithm under the hood. This is a combination of the ChaCha20 stream cipher and the Poly1305 message authentication code (MAC). In this context, "authentication" refers to the encrypted message's integrity, not to the identity of either party communicating.
+BIP-324 elects to use the ChaCha20Poly1305 Authenticated Encryption with Addition Data (AEAD) algorithm under the hood. This is a combination of the ChaCha20 stream cipher and the Poly1305 message authentication code (MAC). In this context, "authentication" refers to the encrypted message's integrity, not to the identity of either party communicating.
 
 Poly1305 is a purpose-built MAC, as opposed to something like an HMAC using SHA256 which leverages an existing hash scheme to build a message authentication code. Purpose-built introduces new complexity, but also allows for increased performance.

protocol/src/fschacha20poly1305.rs

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: CC0-1.0
 
 //! Wrap ciphers with automatic re-keying in order to provide [forward secrecy](https://eprint.iacr.org/2001/035.pdf) within a session.
-//! Logic is covered by the BIP324 test vectors.
+//! Logic is covered by the BIP-324 test vectors.
 //!
 //! ## Performance Considerations
 //!
@@ -51,7 +51,7 @@ impl std::error::Error for Error {
 /// A wrapper over ChaCha20Poly1305 AEAD stream cipher which handles automatically changing
 /// nonces and re-keying, providing forward secrecy within the session.
 ///
-/// FSChaCha20Poly1305 is used for message packets in BIP324.
+/// FSChaCha20Poly1305 is used for message packets in BIP-324.
 #[derive(Clone)]
 pub struct FSChaCha20Poly1305 {
     key: Key,
@@ -138,7 +138,7 @@ impl FSChaCha20Poly1305 {
 /// A wrapper over ChaCha20 (unauthenticated) stream cipher which handles automatically changing
 /// nonces and re-keying, providing forward secrecy within the session.
 ///
-/// FSChaCha20 is used for lengths in BIP324. Should be noted that the lengths are still
+/// FSChaCha20 is used for lengths in BIP-324. Should be noted that the lengths are still
 /// implicitly authenticated by the message packets.
 #[derive(Clone)]
 pub struct FSChaCha20 {

protocol/src/io.rs

@@ -444,7 +444,7 @@ impl AsyncProtocolWriter {
     }
 }
 
-/// Perform a BIP324 handshake and return ready-to-use session components.
+/// Perform a BIP-324 handshake and return ready-to-use session components.
 ///
 /// This function handles the complete handshake process and returns the
 /// cryptographic ciphers and a session reader prepared for encrypted communication.

protocol/src/lib.rs

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: CC0-1.0
 
-//! BIP324 encrypted transport for exchanging bitcoin P2P *messages*. Much like TLS, a connection begins by exchanging ephemeral
+//! BIP-324 encrypted transport for exchanging bitcoin P2P *messages*. Much like TLS, a connection begins by exchanging ephemeral
 //! elliptic curve public keys and performing a Diffie-Hellman handshake. Thereafter, each participant derives shared session secrets, and may
 //! freely exchange encrypted packets.
 //!
@@ -558,7 +558,7 @@ impl OutboundCipher {
     }
 }
 
-/// Manages cipher state for a BIP324 encrypted connection.
+/// Manages cipher state for a BIP-324 encrypted connection.
 #[derive(Clone)]
 pub struct CipherSession {
     /// A unique identifier for the communication session.
@@ -877,7 +877,7 @@ mod tests {
             .unwrap();
     }
 
-    // The rest are sourced from [the BIP324 test vectors](https://github.com/bitcoin/bips/blob/master/bip-0324/packet_encoding_test_vectors.csv).
+    // The rest are sourced from [the BIP-324 test vectors](https://github.com/bitcoin/bips/blob/master/bip-0324/packet_encoding_test_vectors.csv).
 
     #[test]
     fn test_vector_1() {

protocol/src/serde.rs

@@ -2,7 +2,7 @@
 
 //! Serialize and deserialize V2 messages over the wire.
 //!
-//! A subset of commands are represented with a single byte in V2 instead of the 12-byte ASCII encoding like V1. Message ID mappings are defined in [BIP324](https://github.com/bitcoin/bips/blob/master/bip-0324.mediawiki#user-content-v2_Bitcoin_P2P_message_structure).
+//! A subset of commands are represented with a single byte in V2 instead of the 12-byte ASCII encoding like V1. Message ID mappings are defined in [BIP-324](https://github.com/bitcoin/bips/blob/master/bip-0324.mediawiki#user-content-v2_Bitcoin_P2P_message_structure).
 
 use core::fmt;
 

protocol/tests/round_trips.rs

@@ -267,7 +267,7 @@ fn regtest_handshake() {
         receiver: from_and_recv.clone(),
         sender: from_and_recv,
         nonce: 1,
-        user_agent: "BIP324 Client".to_string(),
+        user_agent: "BIP-324 Client".to_string(),
         start_height: 0,
         relay: false,
     };
@@ -313,7 +313,7 @@ fn regtest_handshake_std() {
     let stream = TcpStream::connect(bitcoind.params.p2p_socket.unwrap()).unwrap();
 
     // Initialize high-level protocol with handshake using the new into_bip324 method
-    println!("Starting BIP324 handshake using into_bip324");
+    println!("Starting BIP-324 handshake using into_bip324");
     let mut protocol = stream
         .into_bip324(
             bip324::Network::Regtest,
@@ -339,7 +339,7 @@ fn regtest_handshake_std() {
         receiver: from_and_recv.clone(),
         sender: from_and_recv,
         nonce: 1,
-        user_agent: "BIP324 Client".to_string(),
+        user_agent: "BIP-324 Client".to_string(),
         start_height: 0,
         relay: false,
     };

proxy/Cargo.toml

@@ -3,7 +3,7 @@ name = "bip324-proxy"
 version = "0.4.0"
 edition = "2021"
 license = "CC0-1.0"
-description = "BIP324 proxy enabling v1-only clients to use the v2 Bitcoin P2P Protocol"
+description = "BIP-324 proxy enabling v1-only clients to use the v2 bitcoin p2p protocol"
 repository = "https://github.com/rust-bitcoin/bip324"
 readme = "README.md"