dig-offers 0.3.1

The DIG Network canonical Chia offers expert crate: a pure, key-free, network-free SpendBundle-builder for Chia offers (make, take, combine, cancel, summarize) over XCH/CAT/NFT. Never holds a key, never signs, never broadcasts.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

//! The crate error taxonomy.
//!
//! Every fallible operation in dig-offers returns [`Result`], whose error is [`Error`]. The
//! variants separate the failure sources a pure, key-free offer builder can hit: a lower-level
//! driver failure while constructing a spend, a signer failure while computing the required
//! signatures, a malformed `offer1…` string, a combine that merges two incompatible offers, and
//! caller-supplied input that cannot produce a valid offer.

use chia_wallet_sdk::driver::DriverError;
use chia_wallet_sdk::signer::SignerError;

/// The result of a dig-offers operation.
pub type Result<T> = std::result::Result<T, Error>;

/// Everything that can go wrong while building, taking, combining, cancelling, or inspecting a
/// Chia offer.
#[derive(Debug, thiserror::Error)]
pub enum Error {
    /// A failure in the underlying chia-wallet-sdk driver while constructing a spend
    /// (allocation, currying, settlement assembly, coin selection inside the action system).
    #[error("driver error: {0}")]
    Driver(#[from] DriverError),

    /// A failure while computing the BLS signatures a coin spend requires.
    #[error("signer error: {0}")]
    Signer(#[from] SignerError),

    /// A malformed offer string: not a bech32 `offer1…`, or a payload that does not decode to a
    /// valid offer spend bundle. The message states the precise fault.
    #[error("decode error: {0}")]
    Decode(String),

    /// Two offers cannot be combined: they share an offered coin, or their asset metadata
    /// conflicts. The message states the conflict.
    #[error("incompatible offers: {0}")]
    Incompatible(String),

    /// Caller-supplied input that cannot produce a valid offer (an empty side, a zero requested
    /// amount, or funds too small to cover what is offered/taken). The message states the
    /// precise violation, including any shortfall.
    #[error("invalid input: {0}")]
    InvalidInput(String),
}

impl Error {
    /// Construct an [`Error::InvalidInput`] from any displayable message.
    pub(crate) fn invalid(message: impl Into<String>) -> Self {
        Error::InvalidInput(message.into())
    }

    /// Construct an [`Error::Decode`] from any displayable message.
    pub(crate) fn decode(message: impl Into<String>) -> Self {
        Error::Decode(message.into())
    }

    /// Construct an [`Error::Incompatible`] from any displayable message.
    pub(crate) fn incompatible(message: impl Into<String>) -> Self {
        Error::Incompatible(message.into())
    }
}