cardano-multiplatform-lib 3.1.3

Multiplatform SDK for core Cardano blockchain functionality
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

use crate::*;
use crate::builders::witness_builder::{InputAggregateWitnessData, PartialPlutusWitness};

use super::witness_builder::{RequiredWitnessSet, NativeScriptWitnessInfo, PlutusScriptWitness};

// comes from witsVKeyNeeded in the Ledger spec
pub fn withdrawal_required_wits(address: &RewardAddress, required_witnesses: &mut RequiredWitnessSet) {
    let cred = &address.payment_cred();
    if let Some(keyhash) = &cred.to_keyhash() {
        required_witnesses.add_vkey_key_hash(keyhash);
    }
    if let Some(script_hash) = &cred.to_scripthash() {
        required_witnesses.add_script_hash(script_hash);
        // recall: no datum hash for reward withdrawals
    };
}

#[wasm_bindgen]
#[derive(Clone)]
pub struct WithdrawalBuilderResult {
    pub(crate) address: RewardAddress,
    pub(crate) amount: Coin,
    pub(crate) aggregate_witness: Option<InputAggregateWitnessData>,
    pub(crate) required_wits: RequiredWitnessSet,
}

#[wasm_bindgen]
#[derive(Clone)]
pub struct SingleWithdrawalBuilder {
    address: RewardAddress,
    amount: Coin,
}

#[wasm_bindgen]
impl SingleWithdrawalBuilder {
    pub fn new(address: &RewardAddress, amount: &Coin) -> Self {
        Self {
            address: address.clone(),
            amount: *amount,
        }
    }

    pub fn payment_key(&self) -> Result<WithdrawalBuilderResult, JsError> {
        let mut required_wits = RequiredWitnessSet::default();
        withdrawal_required_wits(&self.address, &mut required_wits);

        if !required_wits.scripts.is_empty() {
            return Err(JsError::from_str(&format!("Withdrawal required a script, not a payment key: \n{:#?}", self.address.to_address().to_bech32(None))));
        }

        Ok(WithdrawalBuilderResult {
            address: self.address.clone(),
            amount: self.amount,
            aggregate_witness: None,
            required_wits,
        })
    }

    pub fn native_script(&self, native_script: &NativeScript, witness_info: &NativeScriptWitnessInfo) -> Result<WithdrawalBuilderResult, JsError> {
        let mut required_wits = RequiredWitnessSet::default();
        withdrawal_required_wits(&self.address, &mut required_wits);
        let mut required_wits_left = required_wits.clone();

        // check the user provided all the required witnesses
        required_wits_left.scripts.remove(&native_script.hash());

        if !required_wits_left.scripts.is_empty() {
            return Err(JsError::from_str(&format!("Missing the following witnesses for the withdrawal: \n{:#?}", required_wits_left.to_str())));
        }

        Ok(WithdrawalBuilderResult {
            address: self.address.clone(),
            amount: self.amount,
            aggregate_witness: Some(InputAggregateWitnessData::NativeScript(native_script.clone(), witness_info.clone())),
            required_wits,
        })
    }

    pub fn plutus_script(&self, partial_witness: &PartialPlutusWitness, required_signers: &RequiredSigners) -> Result<WithdrawalBuilderResult, JsError> {
        let mut required_wits = RequiredWitnessSet::default();
        required_signers.0.iter().for_each(|required_signer| required_wits.add_vkey_key_hash(required_signer));
        withdrawal_required_wits(&self.address, &mut required_wits);
        let mut required_wits_left = required_wits.clone();

        // no way to know these at this time
        required_wits_left.vkeys.clear();

        let script_hash = partial_witness.script.hash();

        // check the user provided all the required witnesses
        required_wits_left.scripts.remove(&script_hash);

        if required_wits_left.len() > 0 {
            return Err(JsError::from_str(&format!("Missing the following witnesses for the withdrawal: \n{:#?}", required_wits_left.to_str())));
        }

        Ok(WithdrawalBuilderResult {
            address: self.address.clone(),
            amount: self.amount,
            aggregate_witness:  Some(InputAggregateWitnessData::PlutusScript(partial_witness.clone(), required_signers.clone(), None)),
            required_wits,
        })
    }
}