smplx-sdk 0.0.5

Simplex sdk to simplify the development with simplicity
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

use elements_miniscript::bitcoin::PublicKey;

use simplicityhl::elements::pset::Output;
use simplicityhl::elements::{AssetId, Script};

/// Represents partially prepared output data for Elements transactions.
#[derive(Debug, Clone)]
pub struct PartialOutput {
    /// Represents a bound `ScriptPubKey` for arbitrary output.
    pub script_pubkey: Script,
    /// Amount of a certain transaction output
    pub amount: u64,
    /// Amount of a certain transaction output
    pub asset: AssetId,
    /// Public key of a blinding key
    pub blinding_key: Option<PublicKey>,
}

impl PartialOutput {
    /// Creates a new `PartialOutput` assigning a base script, amount, and `AssetId`.
    #[must_use]
    pub fn new(script: Script, amount: u64, asset: AssetId) -> Self {
        Self {
            script_pubkey: script,
            amount,
            asset,
            blinding_key: None,
        }
    }

    /// Creates a new `PartialOutput` representing an `OP_RETURN` data metadata output.
    #[must_use]
    pub fn new_metadata(data: &[u8]) -> Self {
        Self {
            script_pubkey: Script::new_op_return(data),
            amount: 0,
            asset: AssetId::default(),
            blinding_key: None,
        }
    }

    /// Attaches an optional blinding public key to the partial output.
    #[must_use]
    pub fn with_blinding_key(mut self, blinding_key: PublicKey) -> Self {
        self.blinding_key = Some(blinding_key);

        self
    }

    /// Converts this `PartialOutput` into a fully formed PSET `Output`.
    #[must_use]
    pub fn to_output(&self) -> Output {
        let mut output = Output::new_explicit(self.script_pubkey.clone(), self.amount, self.asset, self.blinding_key);

        // the index doesn't really matter as we are the only signer
        if self.blinding_key.is_some() {
            output.blinder_index = Some(0);
        }

        output
    }
}