Skip to content

Commit

Permalink
upgrade doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
fluidvanadium committed Jan 18, 2024
1 parent f4608f4 commit 17d6ff5
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions zingo-status/src/confirmation_status.rs
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
use zcash_primitives::consensus::BlockHeight;
/// Transaction confirmation states. Every transaction maps to exactly one of these variants.
/// Transitions between states are enforced by ????
/// TODO: If we want an exhaustive partition of states, do we have all necessary variants?
/// Transaction confirmation states. Every transaction record includes exactly one of these variants.

#[derive(Clone, Copy, Debug, PartialEq)]
pub enum ConfirmationStatus {
/// The value the client has for the height of the chain when the transaction is broadcast.
/// The transaction has been broadcast to the zcash blockchain. It may be waiting in the mempool.
/// The height of the chain as the transaction was broadcast.
/// # Examples
///
/// ```
Expand All @@ -17,6 +16,7 @@ pub enum ConfirmationStatus {
/// assert_eq!(status.get_height(), BlockHeight::from_u32(100));
/// ```
Broadcast(BlockHeight),
/// The transaction has been included in at-least one block mined to the zcash blockchain.
/// The height of a confirmed block that contains the transaction.
/// # Examples
///
Expand All @@ -33,7 +33,6 @@ pub enum ConfirmationStatus {

impl ConfirmationStatus {
/// Converts a blockheight and unconfirmed status into a `ConfirmationStatus`.
/// TODO: I think we are missing a state, what about after a record is created, but before it's broadcast?!
/// # Examples
///
/// ```
Expand Down

0 comments on commit 17d6ff5

Please sign in to comment.