doc: fix typos and mistakes in BIP324 code comments

This commit is contained in:
Pieter Wuille 2023-09-08 14:45:56 -04:00
parent 9bde93df2c
commit 64704386b2
2 changed files with 7 additions and 7 deletions

View file

@ -548,17 +548,17 @@ private:
/** Waiting for the other side's public key. /** Waiting for the other side's public key.
* *
* This is the initial state for initiators. The public key is sent out. When the receiver * This is the initial state for initiators. The public key and garbage is sent out. When
* receives the other side's public key and transitions to GARB_GARBTERM, the sender state * the receiver receives the other side's public key and transitions to GARB_GARBTERM, the
* becomes READY. */ * sender state becomes READY. */
AWAITING_KEY, AWAITING_KEY,
/** Normal sending state. /** Normal sending state.
* *
* In this state, the ciphers are initialized, so packets can be sent. When this state is * In this state, the ciphers are initialized, so packets can be sent. When this state is
* entered, the garbage, garbage terminator, garbage authentication packet, and version * entered, the garbage terminator, garbage authentication packet, and version
* packet are appended to the send buffer (in addition to the key which may still be * packet are appended to the send buffer (in addition to the key and garbage which may
* there). In this state a message can be provided if the send buffer is empty. */ * still be there). In this state a message can be provided if the send buffer is empty. */
READY, READY,
/** This transport is using v1 fallback. /** This transport is using v1 fallback.

View file

@ -1021,7 +1021,7 @@ CKey GenerateRandomTestKey() noexcept
* Each V2TransportTester encapsulates a V2Transport (the one being tested), and can be told to * Each V2TransportTester encapsulates a V2Transport (the one being tested), and can be told to
* interact with it. To do so, it also encapsulates a BIP324Cipher to act as the other side. A * interact with it. To do so, it also encapsulates a BIP324Cipher to act as the other side. A
* second V2Transport is not used, as doing so would not permit scenarios that involve sending * second V2Transport is not used, as doing so would not permit scenarios that involve sending
* invalid data, or ones scenarios using BIP324 features that are not implemented on the sending * invalid data, or ones using BIP324 features that are not implemented on the sending
* side (like decoy packets). * side (like decoy packets).
*/ */
class V2TransportTester class V2TransportTester