dlctix 0.0.3

Ticketed Discreet Log Contracts
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

use bitcoin::{transaction::InputWeightPrediction, Amount, FeeRate};

use std::collections::BTreeMap;

use crate::errors::Error;

/// Compute the fee for a transaction given a fixed [`FeeRate`], input weights,
/// and output script lengths.
pub(crate) fn fee_calc_safe<I, O>(
    fee_rate: FeeRate,
    input_weights: I,
    output_spk_lens: O,
) -> Result<Amount, Error>
where
    I: IntoIterator<Item = InputWeightPrediction>,
    O: IntoIterator<Item = usize>,
{
    let tx_weight = bitcoin::transaction::predict_weight(input_weights, output_spk_lens);
    let fee = fee_rate.fee_wu(tx_weight).ok_or(Error)?;
    Ok(fee)
}

/// Safely compute the given output amount by subtracting the fee
/// amount from the amount of available coins. Returns an error if
/// the result is negative, or is less than the given dust threshold.
pub(crate) fn fee_subtract_safe(
    available_coins: Amount,
    fee: Amount,
    dust_threshold: Amount,
) -> Result<Amount, Error> {
    if fee >= available_coins {
        return Err(Error);
    }
    let after_fee = available_coins.checked_sub(fee).ok_or(Error)?;
    if after_fee <= dust_threshold {
        return Err(Error);
    }
    Ok(after_fee)
}

/// Safely compute the output amounts for a set of outputs by computing
/// and distributing the fee equally among all output values.
///
/// Returns an error if any output value is negative, or is less than the
/// given dust threshold.
pub(crate) fn fee_calc_shared<I, O, T>(
    available_coins: Amount,
    fee_rate: FeeRate,
    input_weights: I,
    output_spk_lens: O,
    dust_threshold: Amount,
    payout_map: &BTreeMap<T, u64>,
) -> Result<BTreeMap<T, Amount>, Error>
where
    I: IntoIterator<Item = InputWeightPrediction>,
    O: IntoIterator<Item = usize>,
    T: Copy + Ord,
{
    let fee_total = fee_calc_safe(fee_rate, input_weights, output_spk_lens)?;

    // Mining fees are distributed equally among all winners, regardless of payout weight.
    let fee_shared = fee_total / payout_map.len() as u64;
    let total_weight: u64 = payout_map.values().copied().sum();

    // Payout amounts are computed by using relative weights.
    payout_map
        .iter()
        .map(|(&key, &weight)| {
            let payout = available_coins * weight / total_weight;
            let payout_value = fee_subtract_safe(payout, fee_shared, dust_threshold)?;
            Ok((key, payout_value))
        })
        .collect()
}