bitcoin-coinselect 0.1.16-alpha.0

abstractions for filtering which OutputGroups we may use in coin selection -- an OutputGroup is a group of UTXOs paid to the same output script
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

crate::ix!();

//-------------------------------------------[.cpp/bitcoin/src/wallet/coinselection.h]

/**
  | target minimum change amount
  |
  */
pub const MIN_CHANGE: Amount = COIN / 100;

/**
  | final minimum change amount after paying
  | for fees
  |
  */
pub const MIN_FINAL_CHANGE: Amount = MIN_CHANGE / 2;

/**
  | Parameters for one iteration of Coin
  | Selection.
  |
  */
pub struct CoinSelectionParams {

    /**
      | Size of a change output in bytes, determined
      | by the output type.
      |
      */
    change_output_size:   usize, // default = 0

    /**
      | Size of the input to spend a change output
      | in virtual bytes.
      |
      */
    change_spend_size:    usize, // default = 0

    /**
      | Cost of creating the change output.
      |
      */
    change_fee:           Amount, // default = { 0 }

    /**
      | Cost of creating the change output +
      | cost of spending the change output in
      | the future.
      |
      */
    cost_of_change:       Amount, // default = { 0 }

    /**
      | The targeted feerate of the transaction
      | being built.
      |
      */
    effective_feerate:    FeeRate,

    /**
      | The feerate estimate used to estimate
      | an upper bound on what should be sufficient
      | to spend the change output sometime
      | in the future.
      |
      */
    long_term_feerate:    FeeRate,

    /**
      | If the cost to spend a change output at
      | the discard feerate exceeds its value,
      | drop it to fees.
      |
      */
    discard_feerate:      FeeRate,

    /**
      | Size of the transaction before coin
      | selection, consisting of the header
      | and recipient output(s), excluding
      | the inputs and change output(s).
      |
      */
    tx_noinputs_size:     usize, // default = 0

    /**
      | Indicate that we are subtracting the
      | fee from outputs
      |
      */
    subtract_fee_outputs: bool, // default = false

    /**
      | When true, always spend all (up to OUTPUT_GROUP_MAX_ENTRIES)
      | or none of the outputs associated with
      | the same address. This helps reduce
      | privacy leaks resulting from address
      | reuse. Dust outputs are not eligible
      | to be added to output groups and thus
      | not considered.
      |
      */
    avoid_partial_spends: bool, // default = false
}

impl CoinSelectionParams {

    pub fn new(
        change_output_size: usize,
        change_spend_size:  usize,
        effective_feerate:  FeeRate,
        long_term_feerate:  FeeRate,
        discard_feerate:    FeeRate,
        tx_noinputs_size:   usize,
        avoid_partial:      bool) -> Self {
    
        todo!();
        /*
            :
            change_output_size(change_output_size),
            change_spend_size(change_spend_size),
            m_effective_feerate(effective_feerate),
            m_long_term_feerate(long_term_feerate),
            m_discard_feerate(discard_feerate),
            tx_noinputs_size(tx_noinputs_size),
            m_avoid_partial_spends(avoid_partial)
        */
    }
}