dig-store-coin 2.0.0

A wrapper library over the datalayer driver for managing DIG network store coins on chain.
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
use datalayer_driver::async_api::get_all_unspent_coins;
use datalayer_driver::types::TransactionAck;
use datalayer_driver::wallet::{broadcast_spend_bundle, get_unspent_coin_states_by_hint};
use datalayer_driver::{
    Bytes32, Coin, DIG_MIN_HEIGHT, DataStore, DataStoreInnerSpend, DigCollateralCoin, NetworkType,
    PublicKey, SpendBundle, SuccessResponse, add_fee, admin_delegated_puzzle_from_key,
    connect_random, get_fee_estimate, get_header_hash, mint_store, oracle_delegated_puzzle,
    secret_key_to_public_key, select_coins, sign_coin_spends, synthetic_key_to_puzzle_hash,
    update_store_metadata, writer_delegated_puzzle_from_key,
};
use dig_wallet::Wallet;
use num_bigint::BigInt;
use std::cmp::Reverse;

/// 0.005 $DIG per MB. 1000 mojos per $DIG
pub const DIG_MOJO_COLLATERAL_PER_MB: f64 = 5_f64;

pub fn calc_required_collateral(archive_file_size_bytes: u64) -> u64 {
    ((archive_file_size_bytes as f64 / 1000_f64) * DIG_MOJO_COLLATERAL_PER_MB).round() as u64
}

#[derive(Debug, Clone)]
pub struct MintParams<'mp> {
    pub ssl_cert_path: &'mp str,
    pub ssl_key_path: &'mp str,
    pub wallet: &'mp Wallet,
    pub root_hash: Bytes32,
    pub network: NetworkType,
    pub previous_height: Option<u32>,
    pub label: Option<String>,
    pub description: Option<String>,
    pub size_in_bytes: Option<u64>,
    pub size_proof: Option<String>,
    pub writer_public_synthetic_key: Option<PublicKey>,
    pub admin_public_synthetic_key: Option<PublicKey>,
    pub fee: Option<u64>,
}

pub async fn mint(params: MintParams<'_>) -> datalayer_driver::Result<DataStore> {
    let peer = connect_random(params.network, params.ssl_cert_path, params.ssl_key_path).await?;

    let owner_secret_key = params.wallet.get_private_synthetic_key().await?;
    let owner_public_key = secret_key_to_public_key(&owner_secret_key);
    let owner_puzzle_hash = synthetic_key_to_puzzle_hash(&owner_public_key);

    let height = if let Some(specified_height) = params.previous_height {
        specified_height
    } else {
        DIG_MIN_HEIGHT
    };
    let owner_previous_header_hash = get_header_hash(&peer, height).await?;

    let mut delegated_puzzles = vec![oracle_delegated_puzzle(owner_puzzle_hash, 100_000)];

    if let Some(key) = params.admin_public_synthetic_key {
        delegated_puzzles.push(admin_delegated_puzzle_from_key(&key))
    }

    if let Some(key) = params.writer_public_synthetic_key {
        delegated_puzzles.push(writer_delegated_puzzle_from_key(&key))
    }

    let fee = if let Some(specified_fee) = params.fee {
        specified_fee
    } else {
        get_fee_estimate(&peer, 60).await?
    };
    let required_wallet_balance = fee + 1;

    let unspent_coin_states = get_all_unspent_coins(
        &peer,
        owner_puzzle_hash,
        Some(height),
        owner_previous_header_hash,
    )
    .await?;

    let unspent_coins = unspent_coin_states
        .coin_states
        .iter()
        .map(|coin_state| coin_state.coin)
        .collect::<Vec<Coin>>();
    let selected_coins = select_coins(&unspent_coins, required_wallet_balance)?;

    let SuccessResponse {
        coin_spends,
        new_datastore,
    } = mint_store(
        owner_public_key,
        selected_coins,
        params.root_hash,
        params.label,
        params.description,
        params.size_in_bytes,
        params.size_proof,
        owner_puzzle_hash,
        delegated_puzzles,
        fee,
    )?;

    let signature = sign_coin_spends(
        &coin_spends,
        &[owner_secret_key],
        params.network == NetworkType::Testnet11,
    )?;
    let spend_bundle = SpendBundle::new(coin_spends, signature);
    broadcast_spend_bundle(&peer, spend_bundle).await?;

    Ok(new_datastore)
}

#[derive(Debug, Clone)]
pub struct UpdateParams<'up> {
    pub ssl_cert_path: &'up str,
    pub ssl_key_path: &'up str,
    pub wallet: &'up Wallet,
    pub data_store: DataStore,
    pub new_root_hash: Bytes32,
    pub network: NetworkType,
    pub previous_height: Option<u32>,
    pub new_label: Option<String>,
    pub new_description: Option<String>,
    pub new_size_in_bytes: Option<u64>,
    pub new_size_proof: Option<String>,
    pub admin_or_writer_public_key: Option<DataStoreInnerSpend>,
    pub fee: Option<u64>,
}

pub async fn update(params: UpdateParams<'_>) -> datalayer_driver::Result<DataStore> {
    let peer = connect_random(params.network, params.ssl_cert_path, params.ssl_key_path).await?;

    let owner_secret_key = params.wallet.get_private_synthetic_key().await?;
    let owner_public_key = secret_key_to_public_key(&owner_secret_key);
    let inner_spend = if let Some(key) = params.admin_or_writer_public_key {
        key
    } else {
        DataStoreInnerSpend::Owner(owner_public_key)
    };

    let SuccessResponse {
        coin_spends: update_store_coin_spends,
        new_datastore: updated_datastore,
    } = update_store_metadata(
        params.data_store,
        params.new_root_hash,
        params.new_label,
        params.new_description,
        params.new_size_in_bytes,
        params.new_size_proof,
        inner_spend,
    )?;

    let fee = if let Some(specified_fee) = params.fee {
        specified_fee
    } else {
        get_fee_estimate(&peer, 60).await?
    };

    let height = if let Some(specified_height) = params.previous_height {
        specified_height
    } else {
        DIG_MIN_HEIGHT
    };
    let owner_puzzle_hash = synthetic_key_to_puzzle_hash(&owner_public_key);
    let owner_previous_header_hash = get_header_hash(&peer, height).await?;

    let unspent_coin_states = get_all_unspent_coins(
        &peer,
        owner_puzzle_hash,
        Some(height),
        owner_previous_header_hash,
    )
    .await?;

    let unspent_coins = unspent_coin_states
        .coin_states
        .iter()
        .map(|coin_state| coin_state.coin)
        .collect::<Vec<Coin>>();
    let selected_coins = select_coins(&unspent_coins, fee)?;

    let coin_ids: Vec<Bytes32> = selected_coins.iter().map(|coin| coin.coin_id()).collect();
    let mut coin_spends = add_fee(&owner_public_key, &selected_coins, &coin_ids, fee)?;
    coin_spends.extend(update_store_coin_spends);

    let signature = sign_coin_spends(
        &coin_spends,
        &[owner_secret_key],
        params.network == NetworkType::Testnet11,
    )?;
    let spend_bundle = SpendBundle::new(coin_spends, signature);
    broadcast_spend_bundle(&peer, spend_bundle).await?;

    Ok(updated_datastore)
}

#[derive(Debug, Clone)]
pub struct CollateralizeStoreParams<'cp> {
    pub ssl_cert_path: &'cp str,
    pub ssl_key_path: &'cp str,
    pub wallet: &'cp Wallet,
    pub store_id: Bytes32,
    pub archive_file_size_bytes: u64,
    pub network: NetworkType,
    pub fee: Option<u64>,
    pub verbose: bool,
}

pub async fn collateralize_store(
    params: CollateralizeStoreParams<'_>,
) -> datalayer_driver::Result<TransactionAck> {
    let peer = connect_random(params.network, params.ssl_cert_path, params.ssl_key_path).await?;
    let private_key = params.wallet.get_private_synthetic_key().await?;
    let public_key = params.wallet.get_public_synthetic_key().await?;

    let fee = if let Some(specified_fee) = params.fee {
        specified_fee
    } else {
        get_fee_estimate(&peer, 60).await?
    };

    let required_dig_collateral_amount = calc_required_collateral(params.archive_file_size_bytes);

    let dig_cats = params
        .wallet
        .select_unspent_dig_coins(
            &peer,
            required_dig_collateral_amount,
            vec![],
            params.verbose,
        )
        .await?;
    let xch_fee_coins = params
        .wallet
        .select_unspent_coins(&peer, 0, fee, vec![])
        .await?;

    let create_collateral_spends = DigCollateralCoin::create_collateral(
        dig_cats,
        required_dig_collateral_amount,
        params.store_id,
        public_key,
        xch_fee_coins,
        fee,
    )?;
    let coin_spend_signature = sign_coin_spends(
        &create_collateral_spends,
        &[private_key],
        params.network != NetworkType::Mainnet,
    )?;
    let spend_bundle = SpendBundle::new(create_collateral_spends, coin_spend_signature);

    Ok(broadcast_spend_bundle(&peer, spend_bundle).await?)
}

#[derive(Debug, Clone)]
pub struct CheckCollateralizationParams<'ckp> {
    pub ssl_cert_path: &'ckp str,
    pub ssl_key_path: &'ckp str,
    pub wallet: &'ckp Wallet,
    pub store_id: Bytes32,
    pub archive_file_size_bytes: u64,
    pub network: NetworkType,
}

/// fetches and returns the highest value valid collateral coin, if it exists.
/// returns None if there are no coins hinted for the store ID, or if no hinted coins have sufficient value
pub async fn check_store_collateralization(
    params: CheckCollateralizationParams<'_>,
) -> datalayer_driver::Result<Option<DigCollateralCoin>> {
    let wallet_puzzle_hash = params.wallet.get_owner_puzzle_hash().await?;
    let peer = connect_random(params.network, params.ssl_cert_path, params.ssl_key_path).await?;
    let required_dig_collateral_amount = calc_required_collateral(params.archive_file_size_bytes);

    let morphed_store_launcher_id =
        DigCollateralCoin::morph_store_launcher_id_for_collateral(params.store_id);
    // filter coins for amount
    let mut maybe_collateral_coin_states =
        get_unspent_coin_states_by_hint(&peer, morphed_store_launcher_id, params.network)
            .await?
            .coin_states
            .into_iter()
            .filter(|coin_state| coin_state.coin.amount >= required_dig_collateral_amount)
            .collect::<Vec<_>>();

    if maybe_collateral_coin_states.is_empty() {
        return Ok(None);
    }

    // sort by descending coin amount - validate highest value coins first
    maybe_collateral_coin_states.sort_unstable_by_key(|coin_state| Reverse(coin_state.coin.amount));

    for coin_state in maybe_collateral_coin_states {
        if let Ok(collateral_coin) = DigCollateralCoin::from_coin_state(&peer, coin_state).await
            && collateral_coin.proof().parent_inner_puzzle_hash == wallet_puzzle_hash
        {
            return Ok(Some(collateral_coin));
        }
    }

    Ok(None)
}

#[derive(Debug, Clone)]
pub struct GetStoreMirrorCoinsParams<'gmp> {
    pub ssl_cert_path: &'gmp str,
    pub ssl_key_path: &'gmp str,
    pub wallet: &'gmp Wallet,
    pub store_id: Bytes32,
    pub epoch: &'gmp BigInt,
    pub archive_file_size_bytes: u64,
    pub network: NetworkType,
}

#[derive(Debug, Clone)]
pub struct AllMirrorCoins {
    pub store_id: Bytes32,
    pub owned_collateral_coins: Vec<DigCollateralCoin>,
    pub external_collateral_coins: Vec<DigCollateralCoin>,
}

pub async fn get_mirror_coins(
    params: GetStoreMirrorCoinsParams<'_>,
) -> datalayer_driver::Result<AllMirrorCoins> {
    let wallet_puzzle_hash = params.wallet.get_owner_puzzle_hash().await?;
    let peer = connect_random(params.network, params.ssl_cert_path, params.ssl_key_path).await?;
    let required_dig_collateral_amount = calc_required_collateral(params.archive_file_size_bytes);

    let morphed_store_launcher_id =
        DigCollateralCoin::morph_store_launcher_id_for_mirror(params.store_id, params.epoch);
    // filter coins for amount
    let mut maybe_collateral_coin_states =
        get_unspent_coin_states_by_hint(&peer, morphed_store_launcher_id, params.network)
            .await?
            .coin_states
            .into_iter()
            .filter(|coin_state| coin_state.coin.amount >= required_dig_collateral_amount)
            .collect::<Vec<_>>();

    let mut collateral = AllMirrorCoins {
        store_id: params.store_id,
        owned_collateral_coins: vec![],
        external_collateral_coins: vec![],
    };

    if maybe_collateral_coin_states.is_empty() {
        return Ok(collateral);
    }

    // sort by descending coin amount - validate highest value coins first
    maybe_collateral_coin_states.sort_unstable_by_key(|coin_state| Reverse(coin_state.coin.amount));

    for coin_state in maybe_collateral_coin_states {
        if let Ok(collateral_coin) = DigCollateralCoin::from_coin_state(&peer, coin_state).await {
            if collateral_coin.proof().parent_inner_puzzle_hash == wallet_puzzle_hash {
                collateral.owned_collateral_coins.push(collateral_coin);
            } else {
                collateral.external_collateral_coins.push(collateral_coin);
            }
        }
    }

    Ok(collateral)
}

#[derive(Debug, Clone)]
pub struct ReclaimCollateralParams<'rc> {
    pub ssl_cert_path: &'rc str,
    pub ssl_key_path: &'rc str,
    pub wallet: &'rc Wallet,
    pub collateral_coin: DigCollateralCoin,
    pub network: NetworkType,
    pub fee: Option<u64>,
}

/// spend a collateral coin to remove store collateral or mirror coin and return spendable $DIG to wallet
pub async fn reclaim_store_collateral(
    params: ReclaimCollateralParams<'_>,
) -> datalayer_driver::Result<(TransactionAck, Bytes32)> {
    let peer = connect_random(params.network, params.ssl_cert_path, params.ssl_key_path).await?;
    let private_key = params.wallet.get_private_synthetic_key().await?;
    let public_key = params.wallet.get_public_synthetic_key().await?;

    let fee = if let Some(specified_fee) = params.fee {
        specified_fee
    } else {
        get_fee_estimate(&peer, 60).await?
    };

    let xch_fee_coins = params
        .wallet
        .select_unspent_coins(&peer, 0, fee, vec![])
        .await?;

    let collateral_spends = params
        .collateral_coin
        .spend(public_key, xch_fee_coins, fee)?;
    let coin_spend_signature = sign_coin_spends(
        &collateral_spends,
        &[private_key],
        params.network != NetworkType::Mainnet,
    )?;
    let spend_bundle = SpendBundle::new(collateral_spends, coin_spend_signature);

    let ack = broadcast_spend_bundle(&peer, spend_bundle).await?;
    Ok((ack, params.collateral_coin.coin().coin_id()))
}