rgb-lib 0.2.2

RGB wallet library
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

use super::*;
use serial_test::parallel;

#[test]
#[parallel]
fn success() {
    initialize();

    // up_to version with 0 allocatable UTXOs
    println!("\n=== up_to true, 0 allocatable");
    let (wallet, online) = get_funded_noutxo_wallet!();
    let bak_info_before = wallet.database.get_backup_info().unwrap().unwrap();
    let num_utxos_created = test_create_utxos(&wallet, &online, true, None, None, FEE_RATE);
    let bak_info_after = wallet.database.get_backup_info().unwrap().unwrap();
    assert!(bak_info_after.last_operation_timestamp > bak_info_before.last_operation_timestamp);
    assert_eq!(num_utxos_created, UTXO_NUM);
    let unspents = test_list_unspents(&wallet, None, false);
    assert_eq!(unspents.len(), (UTXO_NUM + 1) as usize);

    // up_to version with allocatable UTXOs partially available (1 missing)
    println!("\n=== up_to true, need to create 1 more");
    let num_utxos_created =
        test_create_utxos(&wallet, &online, true, Some(UTXO_NUM + 1), None, FEE_RATE);
    assert_eq!(num_utxos_created, 1);
    let unspents = test_list_unspents(&wallet, None, false);
    assert_eq!(unspents.len(), (UTXO_NUM + 2) as usize);

    // forced version always creates UTXOs
    println!("\n=== up_to false");
    let num_utxos_created = test_create_utxos_default(&wallet, &online);
    assert_eq!(num_utxos_created, UTXO_NUM);
    let unspents = test_list_unspents(&wallet, None, false);
    assert_eq!(unspents.len(), (UTXO_NUM * 2 + 2) as usize);
}

#[test]
#[parallel]
fn up_to_allocation_checks() {
    initialize();

    let amount = 66;

    // wallets
    let (wallet, online) = get_funded_noutxo_wallet!();
    let (rcv_wallet, rcv_online) = get_empty_wallet!();

    // MAX_ALLOCATIONS_PER_UTXO failed allocations
    //  - check unspent counted as allocatable
    let num_utxos_created = test_create_utxos(&wallet, &online, false, Some(1), None, FEE_RATE);
    assert_eq!(num_utxos_created, 1);
    let mut blinded_utxos: Vec<String> = vec![];
    let mut txo_list: HashSet<DbTxo> = HashSet::new();
    for _ in 0..MAX_ALLOCATIONS_PER_UTXO {
        let receive_data = test_blind_receive(&wallet);
        let transfer = get_test_transfer_recipient(&wallet, &receive_data.recipient_id);
        let coloring = get_test_coloring(&wallet, transfer.asset_transfer_idx);
        let txo = get_test_txo(&wallet, coloring.txo_idx);
        blinded_utxos.push(receive_data.recipient_id);
        txo_list.insert(txo);
    }
    // check all blinds are on the same UTXO + fail all of them
    assert_eq!(txo_list.len(), 1);
    for blinded_utxo in blinded_utxos {
        assert!(test_fail_transfers_blind(&wallet, &online, &blinded_utxo));
    }
    // request 1 new UTXO, expecting the existing one is still allocatable
    let result = wallet.create_utxos(online.clone(), true, Some(1), None, FEE_RATE);
    assert!(matches!(result, Err(Error::AllocationsAlreadyAvailable)));
    let unspents = test_list_unspents(&wallet, None, false);
    assert_eq!(unspents.len(), 2);

    drain_wallet(&wallet, &online);
    fund_wallet(test_get_address(&wallet));

    // MAX_ALLOCATIONS_PER_UTXO allocations
    let num_utxos_created = test_create_utxos(&wallet, &online, true, Some(1), None, FEE_RATE);
    assert_eq!(num_utxos_created, 1);
    // create MAX_ALLOCATIONS_PER_UTXO blinds on the same UTXO
    let mut txo_list: HashSet<DbTxo> = HashSet::new();
    for _ in 0..MAX_ALLOCATIONS_PER_UTXO {
        let receive_data = test_blind_receive(&wallet);
        let transfer = get_test_transfer_recipient(&wallet, &receive_data.recipient_id);
        let coloring = get_test_coloring(&wallet, transfer.asset_transfer_idx);
        let txo = get_test_txo(&wallet, coloring.txo_idx);
        txo_list.insert(txo);
    }
    assert_eq!(txo_list.len(), 1);
    // request 1 new UTXO, expecting one is created
    let num_utxos_created = test_create_utxos(&wallet, &online, true, Some(1), None, FEE_RATE);
    assert_eq!(num_utxos_created, 1);
    let unspents = test_list_unspents(&wallet, None, false);
    assert_eq!(unspents.len(), 3);

    if MAX_ALLOCATIONS_PER_UTXO > 2 {
        drain_wallet(&wallet, &online);
        fund_wallet(test_get_address(&wallet));
        fund_wallet(test_get_address(&rcv_wallet));

        let num_utxos_created = test_create_utxos(&wallet, &online, true, Some(2), None, FEE_RATE);
        assert_eq!(num_utxos_created, 2);
        let num_utxos_created =
            test_create_utxos(&rcv_wallet, &rcv_online, true, Some(1), None, FEE_RATE);
        assert_eq!(num_utxos_created, 1);
        // issue
        let asset = test_issue_asset_nia(&wallet, &online, None);
        // send
        let receive_data = test_blind_receive(&rcv_wallet);
        let recipient_map = HashMap::from([(
            asset.asset_id.clone(),
            vec![Recipient {
                amount,
                recipient_data: RecipientData::BlindedUTXO(
                    SecretSeal::from_str(&receive_data.recipient_id).unwrap(),
                ),
                transport_endpoints: TRANSPORT_ENDPOINTS.clone(),
            }],
        )]);
        let txid = test_send(&wallet, &online, &recipient_map);
        assert!(!txid.is_empty());

        // - wait counterparty
        // UTXO 1 (input) locked, UTXO 2 (change) has at least 1 free allocation
        show_unspent_colorings(&wallet, "sender after send - WaitingCounterparty");
        let num_utxos_created = test_create_utxos(&wallet, &online, true, Some(2), None, FEE_RATE);
        assert_eq!(num_utxos_created, 1);
        // UTXO 1 (blind) has at least 1 free allocation
        show_unspent_colorings(&rcv_wallet, "receiver after send - WaitingCounterparty");
        let result = rcv_wallet.create_utxos(rcv_online.clone(), true, Some(1), None, FEE_RATE);
        assert!(matches!(result, Err(Error::AllocationsAlreadyAvailable)));

        // - wait confirmations
        stop_mining();
        test_refresh_all(&rcv_wallet, &rcv_online);
        test_refresh_asset(&wallet, &online, &asset.asset_id);
        // UTXO 1 now spent, UTXO 2 (RGB change) has at least 1 free allocation, UTXO 3 is empty, UTXO 4 (BTC change) is empty
        show_unspent_colorings(&wallet, "sender after send - WaitingConfirmations");
        let result = wallet.create_utxos(online.clone(), true, Some(3), None, FEE_RATE);
        assert!(matches!(result, Err(Error::AllocationsAlreadyAvailable)));
        // UTXO 1 (blind) has at least 1 free allocation
        show_unspent_colorings(&rcv_wallet, "receiver after send - WaitingConfirmations");
        let result = rcv_wallet.create_utxos(rcv_online.clone(), true, Some(1), None, FEE_RATE);
        assert!(matches!(result, Err(Error::AllocationsAlreadyAvailable)));

        // - settled
        mine(true);
        test_refresh_all(&rcv_wallet, &rcv_online);
        test_refresh_asset(&wallet, &online, &asset.asset_id);
        // UTXO 1 now spent, UTXO 2 (RGB change) has at least 1 free allocation, UTXOs 3-4 are empty
        show_unspent_colorings(&wallet, "sender after send - Settled");
        let num_utxos_created = test_create_utxos(&wallet, &online, true, Some(4), None, FEE_RATE);
        assert_eq!(num_utxos_created, 1);
        // UTXO 1 (blind) has at least 1 free allocation
        show_unspent_colorings(&rcv_wallet, "receiver after send - Settled");
        let result = rcv_wallet.create_utxos(rcv_online, true, Some(1), None, FEE_RATE);
        assert!(matches!(result, Err(Error::AllocationsAlreadyAvailable)));
    }
}

#[test]
#[parallel]
fn fail() {
    initialize();

    // cannot create UTXOs for an empty wallet
    let (wallet, online) = get_empty_wallet!();
    let result = wallet.create_utxos(online.clone(), true, None, None, FEE_RATE);
    assert!(matches!(
        result,
        Err(Error::InsufficientBitcoins {
            needed: n,
            available: a
        }) if n == (UTXO_SIZE as u64 * UTXO_NUM as u64) + 1000 && a == 0
    ));

    fund_wallet(test_get_address(&wallet));
    test_create_utxos_default(&wallet, &online);

    // don't create UTXOs if enough allocations are already available
    let result = wallet.create_utxos(online.clone(), true, None, None, FEE_RATE);
    assert!(matches!(result, Err(Error::AllocationsAlreadyAvailable)));

    // fee min/max
    let result = test_create_utxos_begin_result(&wallet, &online, false, Some(1), None, 0.9);
    assert!(matches!(result, Err(Error::InvalidFeeRate { details: m }) if m == FEE_MSG_LOW));
    let result = test_create_utxos_begin_result(&wallet, &online, false, Some(1), None, 1000.1);
    assert!(matches!(result, Err(Error::InvalidFeeRate { details: m }) if m == FEE_MSG_HIGH));
}

// create UTXOs of size funds/256 + check UTXO_NUM are created
// if casting to u8 is done improperly, this would result in trying to create 0 UTXOs
//
// see https://github.com/RGB-Tools/rgb-lib/issues/35 for context
#[test]
#[parallel]
fn casting() {
    initialize();

    let funds = 100_000_000;
    let utxo_size = funds as u32 / 256;

    let (wallet, online) = get_empty_wallet!();
    fund_wallet(test_get_address(&wallet));
    let expected_balance = BtcBalance {
        vanilla: Balance {
            settled: 0,
            future: funds,
            spendable: funds,
        },
        colored: Balance {
            settled: 0,
            future: 0,
            spendable: 0,
        },
    };
    wait_for_btc_balance(&wallet, &online, &expected_balance);
    let num_utxos_created =
        test_create_utxos(&wallet, &online, true, None, Some(utxo_size), FEE_RATE);
    assert_eq!(num_utxos_created, UTXO_NUM);
    let unspents = test_list_unspents(&wallet, None, false);
    assert_eq!(unspents.len(), (UTXO_NUM + 1) as usize);
}