whisky/builder/
withdrawal.rs

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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
use sidan_csl_rs::model::*;

use super::{TxBuilder, WRedeemer};

impl TxBuilder {
    /// ## Transaction building method
    ///
    /// Indicate that the transaction is withdrawing using a plutus staking script in the TxBuilder instance
    ///
    /// ### Arguments
    ///
    /// * `language_version` - The language version of the script
    ///
    /// ### Returns
    ///
    /// * `Self` - The TxBuilder instance
    pub fn withdrawal_plutus_script(&mut self, language_version: &LanguageVersion) -> &mut Self {
        match language_version {
            LanguageVersion::V1 => self.withdrawal_plutus_script_v1(),
            LanguageVersion::V2 => self.withdrawal_plutus_script_v2(),
            LanguageVersion::V3 => self.withdrawal_plutus_script_v3(),
        }
    }

    /// ## Transaction building method
    ///
    /// Indicate that the transaction is withdrawing using a plutus V1 staking script in the TxBuilder instance
    ///
    /// ### Returns
    ///
    /// * `Self` - The TxBuilder instance
    pub fn withdrawal_plutus_script_v1(&mut self) -> &mut Self {
        self.adding_plutus_withdrawal = Some(LanguageVersion::V1);
        self
    }

    /// ## Transaction building method
    ///
    /// Indicate that the transaction is withdrawing using a plutus V2 staking script in the TxBuilder instance
    ///
    /// ### Returns
    ///
    /// * `Self` - The TxBuilder instance
    pub fn withdrawal_plutus_script_v2(&mut self) -> &mut Self {
        self.adding_plutus_withdrawal = Some(LanguageVersion::V2);
        self
    }

    /// ## Transaction building method
    ///
    /// Indicate that the transaction is withdrawing using a plutus V3 staking script in the TxBuilder instance
    ///
    /// ### Returns
    ///
    /// * `Self` - The TxBuilder instance
    pub fn withdrawal_plutus_script_v3(&mut self) -> &mut Self {
        self.adding_plutus_withdrawal = Some(LanguageVersion::V3);
        self
    }

    /// ## Transaction building method
    ///
    /// Add a withdrawal reference to the TxBuilder instance
    ///
    /// ### Arguments
    ///
    /// * `tx_hash` - The transaction hash
    /// * `tx_index` - The transaction index
    /// * `withdrawal_script_hash` - The withdrawal script hash
    /// * `script_size` - Size of the script
    ///
    /// ### Returns
    ///
    /// * `Self` - The TxBuilder instance
    pub fn withdrawal_tx_in_reference(
        &mut self,
        tx_hash: &str,
        tx_index: u32,
        withdrawal_script_hash: &str,
        script_size: usize,
    ) -> &mut Self {
        let withdrawal_item = self.withdrawal_item.take();
        if withdrawal_item.is_none() {
            panic!("Undefined output")
        }
        let withdrawal_item = withdrawal_item.unwrap();
        match withdrawal_item {
            Withdrawal::PubKeyWithdrawal(_) => {
                panic!("Script reference cannot be defined for a pubkey withdrawal")
            }
            Withdrawal::SimpleScriptWithdrawal(mut withdrawal) => {
                withdrawal.script_source = Some(SimpleScriptSource::InlineSimpleScriptSource(
                    InlineSimpleScriptSource {
                        ref_tx_in: RefTxIn {
                            tx_hash: tx_hash.to_string(),
                            tx_index,
                            script_size: None,
                        },
                        simple_script_hash: withdrawal_script_hash.to_string(),
                        script_size,
                    },
                ))
            }
            Withdrawal::PlutusScriptWithdrawal(mut withdrawal) => {
                withdrawal.script_source =
                    Some(ScriptSource::InlineScriptSource(InlineScriptSource {
                        ref_tx_in: RefTxIn {
                            tx_hash: tx_hash.to_string(),
                            tx_index,
                            // Script size is already accounted for in script source
                            script_size: None,
                        },
                        script_hash: withdrawal_script_hash.to_string(),
                        language_version: self
                            .adding_plutus_withdrawal
                            .clone()
                            .expect("Plutus withdrawals require a language version"),
                        script_size,
                    }));
                self.withdrawal_item = Some(Withdrawal::PlutusScriptWithdrawal(withdrawal));
            }
        }
        self
    }

    /// ## Transaction building method
    ///
    /// Withdraw stake rewards in the TxBuilder instance
    ///
    /// ### Arguments
    ///
    /// * `stake_address` - The address corresponding to the stake key
    /// * `coin` - The amount of lovelaces in the withdrawal
    ///
    /// ### Returns
    ///
    /// * `Self` - The TxBuilder instance
    pub fn withdrawal(&mut self, stake_address: &str, coin: u64) -> &mut Self {
        if self.withdrawal_item.is_some() {
            self.queue_withdrawal();
        }

        match self.adding_plutus_withdrawal {
            Some(_) => {
                let withdrawal_item = Withdrawal::PlutusScriptWithdrawal(PlutusScriptWithdrawal {
                    address: stake_address.to_string(),
                    coin,
                    script_source: None,
                    redeemer: None,
                });
                self.withdrawal_item = Some(withdrawal_item);
            }
            None => {
                let withdrawal_item = Withdrawal::PubKeyWithdrawal(PubKeyWithdrawal {
                    address: stake_address.to_string(),
                    coin,
                });
                self.withdrawal_item = Some(withdrawal_item);
            }
        }
        self
    }

    /// ## Transaction building method
    ///
    /// Add a withdrawal script to the TxBuilder instance
    ///
    /// ### Arguments
    ///
    /// * `script_cbor` - The script in CBOR format
    ///
    /// ### Returns
    ///
    /// * `Self` - The TxBuilder instance
    pub fn withdrawal_script(&mut self, script_cbor: &str) -> &mut Self {
        let withdrawal_item = self.withdrawal_item.take();
        if withdrawal_item.is_none() {
            panic!("Undefined withdrawal")
        }
        let withdrawal_item = withdrawal_item.unwrap();
        match withdrawal_item {
            Withdrawal::PubKeyWithdrawal(_) => {
                panic!("Script cannot be defined for a pubkey withdrawal")
            }
            Withdrawal::SimpleScriptWithdrawal(mut withdraw) => {
                withdraw.script_source = Some(SimpleScriptSource::ProvidedSimpleScriptSource(
                    ProvidedSimpleScriptSource {
                        script_cbor: script_cbor.to_string(),
                    },
                ));
                self.withdrawal_item = Some(Withdrawal::SimpleScriptWithdrawal(withdraw));
            }
            Withdrawal::PlutusScriptWithdrawal(mut withdraw) => {
                withdraw.script_source =
                    Some(ScriptSource::ProvidedScriptSource(ProvidedScriptSource {
                        script_cbor: script_cbor.to_string(),
                        language_version: self
                            .adding_plutus_withdrawal
                            .clone()
                            .expect("Plutus withdrawals require a language version"),
                    }));
                self.withdrawal_item = Some(Withdrawal::PlutusScriptWithdrawal(withdraw));
                self.adding_plutus_withdrawal = None;
            }
        }
        self
    }

    /// ## Transaction building method
    ///
    /// Set the transaction withdrawal redeemer value in the TxBuilder instance
    ///
    /// ### Arguments
    ///
    /// * `redeemer` - The redeemer value
    ///
    /// ### Returns
    ///
    /// * `Self` - The TxBuilder instance
    pub fn withdrawal_redeemer_value(&mut self, redeemer: &WRedeemer) -> &mut Self {
        let withdrawal_item = self.withdrawal_item.take();
        if withdrawal_item.is_none() {
            panic!("Undefined input")
        }
        let withdrawal_item = withdrawal_item.unwrap();
        match withdrawal_item {
            Withdrawal::PubKeyWithdrawal(_) => {
                panic!("Redeemer cannot be defined for a pubkey withdrawal")
            }
            Withdrawal::SimpleScriptWithdrawal(_) => {
                panic!("Redeemer cannot be defined for a native script withdrawal")
            }
            Withdrawal::PlutusScriptWithdrawal(mut withdraw) => match redeemer.data.to_cbor() {
                Ok(raw_redeemer) => {
                    withdraw.redeemer = Some(Redeemer {
                        data: raw_redeemer,
                        ex_units: redeemer.clone().ex_units,
                    });
                    self.withdrawal_item = Some(Withdrawal::PlutusScriptWithdrawal(withdraw));
                }
                Err(_) => panic!("Error converting redeemer to CBOR"),
            },
        }
        self
    }

    /// ## Transaction building method
    ///
    /// Set the withdrawal reference redeemer value in the TxBuilder instance
    ///
    /// ### Arguments
    ///
    /// * `redeemer` - The redeemer value
    ///
    /// ### Returns
    ///
    /// * `Self` - The TxBuilder instance
    pub fn withdrawal_reference_tx_in_redeemer_value(&mut self, redeemer: &WRedeemer) -> &mut Self {
        self.withdrawal_redeemer_value(redeemer)
    }
}