Skip to content

Added simple docs to structs and enums of error #447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 23, 2025
Merged

Added simple docs to structs and enums of error #447

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e79bcd7
Added simple docs to structs and enums of error
lucad70 Apr 17, 2025
6260053
Added link to ChainState
lucad70 Apr 22, 2025
a4cfc75
Added docs to TransactionError fields
lucad70 Apr 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions crates/floresta-chain/src/pruned_utreexo/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ use floresta_common::impl_error_from;
use crate::prelude::*;
pub trait DatabaseError: Debug + Send + Sync + 'static {}
#[derive(Debug)]
/// This is the highest level error type in floresta-chain, returned by the [crate::ChainState] methods.
/// It represents errors encountered during blockchain validation.
pub enum BlockchainError {
BlockNotPresent,
Parsing(String),
Expand All @@ -31,13 +33,19 @@ pub enum BlockchainError {
ScriptValidationFailed(script::Error),
Io(ioError),
}

#[derive(Clone, Debug, PartialEq)]
/// Represents errors encountered during transaction validation.
pub struct TransactionError {
/// The id of the transaction that caused this error
pub txid: Txid,

/// The error we've encountered
pub error: BlockValidationErrors,
}

#[derive(Clone, Debug, PartialEq)]
/// Represents errors encountered during block validation.
pub enum BlockValidationErrors {
InvalidCoinbase(String),
UtxoNotFound(OutPoint),
Expand Down