lwk_simplicity 0.18.0

Liquid Wallet Kit - Utilities to deal with Simplicity transactions
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

#[derive(Debug, thiserror::Error)]
pub enum WalletAbiError {
    #[error("Invalid request: {0}")]
    InvalidRequest(String),

    #[error("JSON error: {0}")]
    Serde(#[from] serde_json::Error),

    #[error("Program error: {0}")]
    Program(#[from] ProgramError),

    #[error("Bitcoin derivation: {0}")]
    Derivation(#[from] lwk_wollet::bitcoin::bip32::Error),

    #[error("Int conversion: {0}")]
    TryFromInt(#[from] std::num::TryFromIntError),

    #[error("Failed to fund the request: {0}")]
    Funding(String),

    #[error("Runtime signer configuration: {0}")]
    InvalidSignerConfig(String),

    #[error("Runtime response construction: {0}")]
    InvalidResponse(String),

    #[error("PSET error: {0}")]
    Pset(#[from] lwk_wollet::elements::pset::Error),

    #[error("PSET blinding error: {0}")]
    PsetBlind(#[from] lwk_wollet::elements::pset::PsetBlindError),

    #[error("Transaction amount proof verification failed: {0}")]
    AmountProofVerification(#[from] lwk_wollet::elements::VerificationError),

    #[error("Invalid finalization steps: {0}")]
    InvalidFinalizationSteps(String),
}

/// Errors that occur during Simplicity program compilation, execution, or environment setup.
///
/// These errors cover the full lifecycle of working with Simplicity programs:
/// loading source, satisfying witnesses, running on the Bit Machine, and
/// validating transaction environments.
#[derive(Debug, thiserror::Error)]
pub enum ProgramError {
    #[error("Failed to compile Simplicity program: {0}")]
    Compilation(String),

    /// Returned when witness values cannot satisfy the program's requirements.
    #[error("Failed to satisfy witness: {0}")]
    WitnessSatisfaction(String),

    /// Returned when the program cannot be pruned against the transaction environment.
    #[error("Failed to prune program: {0}")]
    Pruning(simplicityhl::simplicity::bit_machine::ExecutionError),

    #[error("Failed to construct a Bit Machine with enough space: {0}")]
    BitMachineCreation(#[from] simplicityhl::simplicity::bit_machine::LimitError),

    #[error("Failed to execute program on the Bit Machine: {0}")]
    Execution(simplicityhl::simplicity::bit_machine::ExecutionError),

    #[error("UTXO index {input_index} out of bounds (have {utxo_count} UTXOs)")]
    UtxoIndexOutOfBounds {
        input_index: usize,
        utxo_count: usize,
    },

    /// Returned when the UTXO's script does not match the expected program address.
    #[error("Script pubkey mismatch: expected hash {expected_hash}, got {actual_hash}")]
    ScriptPubkeyMismatch {
        expected_hash: String,
        actual_hash: String,
    },

    #[error("Input index exceeds u32 maximum: {0}")]
    InputIndexOverflow(#[from] std::num::TryFromIntError),
}