whisky-csl 1.0.13

Wrapper around the cardano-serialization-lib for easier transaction building, heavily inspired by cardano-cli APIs
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

use whisky_common::{TxBuildable, *};

use crate::WhiskyCSL;

impl TxBuildable for WhiskyCSL {
    fn reset_builder(&mut self) -> &mut Self {
        self.core.reset_after_build();
        self
    }

    fn set_protocol_params(&mut self, protocol_params: Protocol) -> &mut Self {
        self.core.protocol_params = protocol_params.clone();
        self
    }

    fn set_tx_builder_body(&mut self, tx_builder_body: TxBuilderBody) -> &mut Self {
        self.tx_builder_body = tx_builder_body.clone();
        self
    }

    /// ## Transaction building method
    ///
    /// Serialize the transaction body
    ///
    /// ### Arguments
    ///
    /// * `tx_builder_body` - The transaction builder body information
    /// * `params` - Optional protocol parameters, default as Cardano mainnet configuration
    ///
    /// ### Returns
    ///
    /// * `String` - the built transaction hex
    fn serialize_tx_body(&mut self) -> Result<String, WError> {
        if self.tx_builder_body.change_address.is_empty() {
            return Err(WError::new(
                "serialize_tx_body",
                "change address cannot be empty",
            ));
        }
        self.add_all_inputs()?
            .add_all_outputs()?
            .add_all_collaterals()?
            .add_all_reference_inputs()?
            .add_all_withdrawals()?
            .add_all_mints()?
            .add_all_certificates()?
            .add_all_votes()?
            .add_validity_range()?
            .add_all_required_signature()?
            .add_all_metadata()?
            .add_script_hash()?
            .set_fee_if_needed()?
            .add_collateral_return()?
            .add_change_utxo()?;

        self.core.build_tx(true)
    }

    fn unbalanced_serialize_tx_body(&mut self) -> Result<String, WError> {
        if self.tx_builder_body.change_address.is_empty() {
            return Err(WError::new(
                "serialize_tx_body",
                "change address cannot be empty",
            ));
        }
        self.add_all_inputs()?
            .add_all_outputs()?
            .add_all_collaterals()?
            .add_all_reference_inputs()?
            .add_all_withdrawals()?
            .add_all_mints()?
            .add_all_certificates()?
            .add_all_votes()?
            .add_validity_range()?
            .add_all_required_signature()?
            .add_all_metadata()?
            .add_script_hash()?
            .set_fee_if_needed()?
            .add_collateral_return()?;

        self.core.build_tx(false)
    }

    /// ## Transaction building method
    ///
    /// Complete the signing process
    ///
    /// ### Returns
    ///
    /// * `String` - The signed transaction in hex
    fn complete_signing(&mut self) -> Result<String, WError> {
        let signing_keys = self.tx_builder_body.signing_key.clone();
        self.add_all_signing_keys(
            &signing_keys
                .iter()
                .map(|s| s.as_str())
                .collect::<Vec<&str>>(),
        )?;
        Ok(self.core.tx_hex.to_string())
    }

    fn tx_hex(&mut self) -> String {
        self.core.tx_hex.clone()
    }
}