griffin-core 0.3.0

UTXO framework for Substrate and Polkadot.
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
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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
use super::{
    error::Error,
    script_context::{sort_voters, DataLookupTable, ResolvedInput, ScriptPurpose, ScriptVersion},
};
use crate::pallas_addresses::{Address, ScriptHash, ShelleyPaymentPart, StakePayload};
use crate::pallas_codec::utils::Nullable;
use crate::pallas_primitives::conway::{
    Certificate, GovAction, MintedTx, PolicyId, RedeemerTag, Redeemers, RedeemersKey,
    RewardAccount, StakeCredential, TransactionOutput, Voter,
};
use crate::uplc::tx::script_context::sort_reward_accounts;
use alloc::{
    borrow::ToOwned,
    string::{String, ToString},
    vec::Vec,
};
use hashbrown::HashMap;
use itertools::Itertools;

type ScriptsNeeded = Vec<(ScriptPurpose, ScriptHash)>;

// subset of phase-1 ledger checks related to scripts
pub fn eval_phase_one(
    tx: &MintedTx,
    utxos: &[ResolvedInput],
    lookup_table: &DataLookupTable,
) -> Result<(), Error> {
    let scripts_needed = scripts_needed(tx, utxos)?;

    validate_missing_scripts(&scripts_needed, lookup_table.scripts())?;

    has_exact_set_of_redeemers(tx, &scripts_needed, lookup_table.scripts())?;

    Ok(())
}

pub fn validate_missing_scripts(
    needed: &ScriptsNeeded,
    txscripts: HashMap<ScriptHash, ScriptVersion>,
) -> Result<(), Error> {
    let received_hashes = txscripts.keys().copied().collect::<Vec<ScriptHash>>();

    let needed_hashes = needed.iter().map(|x| x.1).collect::<Vec<ScriptHash>>();

    let missing: Vec<_> = needed_hashes
        .clone()
        .into_iter()
        .filter(|x| !received_hashes.contains(x))
        .map(|x| x.to_string())
        .collect();

    let extra: Vec<_> = received_hashes
        .into_iter()
        .filter(|x| !needed_hashes.contains(x))
        .map(|x| x.to_string())
        .collect();

    if !missing.is_empty() || !extra.is_empty() {
        return Err(Error::RequiredRedeemersMismatch { missing, extra });
    }

    Ok(())
}

pub fn scripts_needed(tx: &MintedTx, utxos: &[ResolvedInput]) -> Result<ScriptsNeeded, Error> {
    let mut needed = Vec::new();

    let txb = tx.transaction_body.clone();

    let mut spend = Vec::new();

    for input in txb.inputs.iter() {
        let utxo = match utxos.iter().find(|utxo| utxo.input == *input) {
            Some(u) => u,
            None => return Err(Error::ResolvedInputNotFound(input.clone())),
        };

        let address = Address::from_bytes(match &utxo.output {
            TransactionOutput::Legacy(output) => output.address.as_ref(),
            TransactionOutput::PostAlonzo(output) => output.address.as_ref(),
        })?;

        if let Address::Shelley(a) = address {
            if let ShelleyPaymentPart::Script(h) = a.payment() {
                spend.push((ScriptPurpose::Spending(input.clone(), ()), *h));
            }
        }
    }

    let mut reward = txb
        .withdrawals
        .as_deref()
        .map(|w| {
            w.iter()
                .filter_map(|(acnt, _)| {
                    let address = Address::from_bytes(acnt).unwrap();

                    if let Address::Stake(a) = address {
                        if let StakePayload::Script(h) = a.payload() {
                            let cred = StakeCredential::ScriptHash(*h);
                            return Some((ScriptPurpose::Rewarding(cred), *h));
                        }
                    }

                    None
                })
                .collect::<ScriptsNeeded>()
        })
        .unwrap_or_default();

    let mut cert = txb
        .certificates
        .as_deref()
        .map(|m| {
            m.iter()
                .enumerate()
                .filter_map(|(ix, cert)| match cert {
                    Certificate::StakeDeregistration(StakeCredential::ScriptHash(h))
                    | Certificate::UnReg(StakeCredential::ScriptHash(h), _)
                    | Certificate::VoteDeleg(StakeCredential::ScriptHash(h), _)
                    | Certificate::VoteRegDeleg(StakeCredential::ScriptHash(h), _, _)
                    | Certificate::StakeVoteDeleg(StakeCredential::ScriptHash(h), _, _)
                    | Certificate::StakeRegDeleg(StakeCredential::ScriptHash(h), _, _)
                    | Certificate::StakeVoteRegDeleg(StakeCredential::ScriptHash(h), _, _, _)
                    | Certificate::RegDRepCert(StakeCredential::ScriptHash(h), _, _)
                    | Certificate::UnRegDRepCert(StakeCredential::ScriptHash(h), _)
                    | Certificate::UpdateDRepCert(StakeCredential::ScriptHash(h), _)
                    | Certificate::AuthCommitteeHot(StakeCredential::ScriptHash(h), _)
                    | Certificate::ResignCommitteeCold(StakeCredential::ScriptHash(h), _)
                    | Certificate::StakeDelegation(StakeCredential::ScriptHash(h), _) => {
                        Some((ScriptPurpose::Certifying(ix, cert.clone()), *h))
                    }

                    _ => None,
                })
                .collect::<ScriptsNeeded>()
        })
        .unwrap_or_default();

    let mut mint = txb
        .mint
        .as_deref()
        .map(|m| {
            m.iter()
                .map(|(policy_id, _)| (ScriptPurpose::Minting(*policy_id), *policy_id))
                .collect::<ScriptsNeeded>()
        })
        .unwrap_or_default();

    let mut propose = txb
        .proposal_procedures
        .as_deref()
        .map(|m| {
            m.iter()
                .enumerate()
                .filter_map(|(ix, procedure)| match procedure.gov_action {
                    GovAction::ParameterChange(_, _, Nullable::Some(hash)) => {
                        Some((ScriptPurpose::Proposing(ix, procedure.clone()), hash))
                    }
                    GovAction::TreasuryWithdrawals(_, Nullable::Some(hash)) => {
                        Some((ScriptPurpose::Proposing(ix, procedure.clone()), hash))
                    }
                    GovAction::HardForkInitiation(..)
                    | GovAction::Information
                    | GovAction::NewConstitution(..)
                    | GovAction::TreasuryWithdrawals(..)
                    | GovAction::ParameterChange(..)
                    | GovAction::NoConfidence(..)
                    | GovAction::UpdateCommittee(..) => None,
                })
                .collect::<ScriptsNeeded>()
        })
        .unwrap_or_default();

    let mut voting = txb
        .voting_procedures
        .as_deref()
        .map(|m| {
            m.iter()
                .filter_map(|(voter, _)| match voter {
                    Voter::ConstitutionalCommitteeScript(hash) | Voter::DRepScript(hash) => {
                        Some((ScriptPurpose::Voting(voter.clone()), *hash))
                    }
                    Voter::ConstitutionalCommitteeKey(_)
                    | Voter::DRepKey(_)
                    | Voter::StakePoolKey(_) => None,
                })
                .collect::<ScriptsNeeded>()
        })
        .unwrap_or_default();

    needed.append(&mut spend);
    needed.append(&mut reward);
    needed.append(&mut cert);
    needed.append(&mut mint);
    needed.append(&mut propose);
    needed.append(&mut voting);

    Ok(needed)
}

/// hasExactSetOfRedeemers in Ledger Spec, but we pass `txscripts` directly
pub fn has_exact_set_of_redeemers(
    tx: &MintedTx,
    needed: &ScriptsNeeded,
    tx_scripts: HashMap<ScriptHash, ScriptVersion>,
) -> Result<(), Error> {
    let mut redeemers_needed = Vec::new();

    for (script_purpose, script_hash) in needed {
        let redeemer_key = build_redeemer_key(tx, script_purpose)?;
        let script = tx_scripts.get(script_hash);

        if let (Some(key), Some(script)) = (redeemer_key, script) {
            match script {
                ScriptVersion::V1(_) => {
                    redeemers_needed.push((key, script_purpose.clone(), *script_hash))
                }
                ScriptVersion::V2(_) => {
                    redeemers_needed.push((key, script_purpose.clone(), *script_hash))
                }
                ScriptVersion::V3(_) => {
                    redeemers_needed.push((key, script_purpose.clone(), *script_hash))
                }
                ScriptVersion::Native(_) => (),
            }
        }
    }

    let wits_redeemer_keys: Vec<RedeemersKey> = tx
        .transaction_witness_set
        .redeemer
        .as_deref()
        .map(|m| match m {
            Redeemers::List(rs) => rs
                .iter()
                .map(|r| RedeemersKey {
                    index: r.index,
                    tag: r.tag,
                })
                .collect(),
            Redeemers::Map(kv) => kv
                .iter()
                .map(|(k, _)| RedeemersKey {
                    index: k.index,
                    tag: k.tag,
                })
                .collect(),
        })
        .unwrap_or_default();

    let needed_redeemer_keys: Vec<RedeemersKey> =
        redeemers_needed.iter().map(|x| x.0.clone()).collect();

    let missing: Vec<_> = redeemers_needed
        .into_iter()
        .filter(|x| !wits_redeemer_keys.contains(&x.0))
        .map(|x| {
            format!(
                "{}[{:?}] -> {}",
                redeemer_tag_to_string(&x.0.tag),
                x.0.index,
                x.2
            )
        })
        .collect();

    let extra: Vec<_> = wits_redeemer_keys
        .into_iter()
        .filter(|x| !needed_redeemer_keys.contains(x))
        .map(|x| format!("{}[{:?}]", redeemer_tag_to_string(&x.tag), x.index))
        .collect();

    if !missing.is_empty() || !extra.is_empty() {
        Err(Error::RequiredRedeemersMismatch { missing, extra })
    } else {
        Ok(())
    }
}

/// builds a redeemer pointer (tag, index) from a script purpose by setting the tag
/// according to the type of the script purpose, and the index according to the
/// placement of script purpose inside its container.
fn build_redeemer_key(
    tx: &MintedTx,
    script_purpose: &ScriptPurpose,
) -> Result<Option<RedeemersKey>, Error> {
    let tx_body = tx.transaction_body.clone();

    match script_purpose {
        ScriptPurpose::Minting(hash) => {
            let policy_ids: Vec<&PolicyId> = tx_body
                .mint
                .as_deref()
                .map(|m| m.iter().map(|(policy_id, _)| policy_id).sorted().collect())
                .unwrap_or_default();

            let redeemer_key =
                policy_ids
                    .iter()
                    .position(|x| x == &hash)
                    .map(|index| RedeemersKey {
                        tag: RedeemerTag::Mint,
                        index: index as u32,
                    });

            Ok(redeemer_key)
        }

        ScriptPurpose::Spending(txin, ()) => {
            let redeemer_key = tx_body
                .inputs
                .iter()
                .sorted_by(
                    |i_a, i_b| match i_a.transaction_id.cmp(&i_b.transaction_id) {
                        core::cmp::Ordering::Less => core::cmp::Ordering::Less,
                        core::cmp::Ordering::Equal => i_a.index.cmp(&i_b.index),
                        core::cmp::Ordering::Greater => core::cmp::Ordering::Greater,
                    },
                )
                .position(|x| x == txin)
                .map(|index| RedeemersKey {
                    tag: RedeemerTag::Spend,
                    index: index as u32,
                });

            Ok(redeemer_key)
        }

        ScriptPurpose::Rewarding(racnt) => {
            let mut reward_accounts: Vec<&RewardAccount> = tx_body
                .withdrawals
                .as_deref()
                .map(|m| m.iter().map(|(acnt, _)| acnt).collect())
                .unwrap_or_default();

            reward_accounts.sort_by(|acnt_a, acnt_b| sort_reward_accounts(acnt_a, acnt_b));

            let mut redeemer_key = None;

            for (idx, x) in reward_accounts.iter().enumerate() {
                let cred = match Address::from_bytes(x).unwrap() {
                    Address::Stake(a) => match a.payload() {
                        StakePayload::Script(sh) => Some(StakeCredential::ScriptHash(*sh)),
                        StakePayload::Stake(_) => None,
                    },
                    _ => return Err(Error::BadWithdrawalAddress),
                };

                if cred == Some(racnt.to_owned()) {
                    redeemer_key = Some(RedeemersKey {
                        tag: RedeemerTag::Reward,
                        index: idx as u32,
                    });
                }
            }

            Ok(redeemer_key)
        }

        ScriptPurpose::Certifying(_, d) => {
            let redeemer_key = tx_body
                .certificates
                .as_deref()
                .map(|m| m.iter().position(|x| x == d))
                .unwrap_or_default()
                .map(|index| RedeemersKey {
                    tag: RedeemerTag::Cert,
                    index: index as u32,
                });

            Ok(redeemer_key)
        }

        ScriptPurpose::Voting(v) => {
            let redeemer_key = tx_body
                .voting_procedures
                .as_deref()
                .map(|m| {
                    m.iter()
                        .sorted_by(|(a, _), (b, _)| sort_voters(a, b))
                        .position(|x| &x.0 == v)
                })
                .unwrap_or_default()
                .map(|index| RedeemersKey {
                    tag: RedeemerTag::Vote,
                    index: index as u32,
                });

            Ok(redeemer_key)
        }

        ScriptPurpose::Proposing(_, procedure) => {
            let redeemer_key = tx_body
                .proposal_procedures
                .as_deref()
                .map(|m| m.iter().position(|x| x == procedure))
                .unwrap_or_default()
                .map(|index| RedeemersKey {
                    tag: RedeemerTag::Propose,
                    index: index as u32,
                });

            Ok(redeemer_key)
        }
    }
}

pub fn redeemer_tag_to_string(redeemer_tag: &RedeemerTag) -> String {
    match redeemer_tag {
        RedeemerTag::Spend => "Spend",
        RedeemerTag::Mint => "Mint",
        RedeemerTag::Reward => "Withdraw",
        RedeemerTag::Cert => "Publish",
        RedeemerTag::Propose => "Propose",
        RedeemerTag::Vote => "Vote",
    }
    .to_string()
}