chia-sdk-bindings 0.34.0

Underlying implementation of chia-wallet-sdk bindings.
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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
use std::sync::{Arc, Mutex};

use bindy::{Error, Result};
use chia_bls::{SecretKey, Signature};
use chia_protocol::{Bytes32, Coin};
use chia_puzzle_types::{LineageProof, singleton::SingletonStruct};
use chia_sdk_driver::{
    Cat, Reserve, RewardDistributor as SdkRewardDistributor, RewardDistributorAddEntryAction,
    RewardDistributorAddIncentivesAction, RewardDistributorCommitIncentivesAction,
    RewardDistributorConstants, RewardDistributorInitiatePayoutAction,
    RewardDistributorNewEpochAction, RewardDistributorRemoveEntryAction,
    RewardDistributorStakeAction, RewardDistributorState, RewardDistributorSyncAction,
    RewardDistributorType, RewardDistributorUnstakeAction,
    RewardDistributorWithdrawIncentivesAction, RoundRewardInfo, RoundTimeInfo, SpendContext,
};
use chia_sdk_types::{
    Conditions, Mod,
    puzzles::{
        IntermediaryCoinProof, NftLauncherProof, NonceWrapperArgs, RewardDistributorSlotNonce,
    },
};
use clvm_utils::{ToTreeHash, TreeHash};

use crate::{
    AsProgram, AsPtr, CatSpend, CommitmentSlot, EntrySlot, Nft, NotarizedPayment, Program, Proof,
    RewardSlot,
};

pub trait RewardDistributorTypeExt {}

impl RewardDistributorTypeExt for RewardDistributorType {}

pub trait RewardDistributorConstantsExt
where
    Self: Sized,
{
    #[allow(clippy::too_many_arguments)]
    fn without_launcher_id(
        reward_distributor_type: RewardDistributorType,
        manager_or_collection_did_launcher_id: Bytes32,
        fee_payout_puzzle_hash: Bytes32,
        epoch_seconds: u64,
        max_seconds_offset: u64,
        payout_threshold: u64,
        fee_bps: u64,
        withdrawal_share_bps: u64,
        reserve_asset_id: Bytes32,
    ) -> Result<Self>;

    fn with_launcher_id(&self, launcher_id: Bytes32) -> Result<Self>;
}

impl RewardDistributorConstantsExt for RewardDistributorConstants {
    #[allow(clippy::too_many_arguments)]
    fn without_launcher_id(
        reward_distributor_type: RewardDistributorType,
        manager_or_collection_did_launcher_id: Bytes32,
        fee_payout_puzzle_hash: Bytes32,
        epoch_seconds: u64,
        max_seconds_offset: u64,
        payout_threshold: u64,
        fee_bps: u64,
        withdrawal_share_bps: u64,
        reserve_asset_id: Bytes32,
    ) -> Result<Self> {
        Ok(RewardDistributorConstants::without_launcher_id(
            reward_distributor_type,
            manager_or_collection_did_launcher_id,
            fee_payout_puzzle_hash,
            epoch_seconds,
            max_seconds_offset,
            payout_threshold,
            fee_bps,
            withdrawal_share_bps,
            reserve_asset_id,
        ))
    }

    fn with_launcher_id(&self, launcher_id: Bytes32) -> Result<Self> {
        Ok(RewardDistributorConstants::with_launcher_id(
            *self,
            launcher_id,
        ))
    }
}

pub trait RoundRewardInfoExt {}

impl RoundRewardInfoExt for RoundRewardInfo {}

pub trait RoundTimeInfoExt {}

impl RoundTimeInfoExt for RoundTimeInfo {}

pub trait RewardDistributorStateExt
where
    Self: Sized,
{
    fn initial(first_epoch_start: u64) -> Result<Self>;
}

impl RewardDistributorStateExt for RewardDistributorState {
    fn initial(first_epoch_start: u64) -> Result<Self> {
        Ok(RewardDistributorState::initial(first_epoch_start))
    }
}

pub trait RewardDistributorLauncherSolutionInfoExt {}

impl RewardDistributorLauncherSolutionInfoExt for RewardDistributorLauncherSolutionInfo {}

#[derive(Clone, Copy)]
pub struct RewardDistributorLauncherSolutionInfo {
    pub constants: RewardDistributorConstants,
    pub initial_state: RewardDistributorState,
    pub coin: Coin,
}

#[derive(Clone)]
pub struct RewardDistributorFinishedSpendResult {
    pub new_distributor: RewardDistributor,
    pub signature: Signature,
}

#[derive(Clone)]
pub struct RewardDistributorInitiatePayoutResult {
    pub conditions: Vec<Program>,
    pub payout_amount: u64,
}

#[derive(Clone)]
pub struct RewardDistributorNewEpochResult {
    pub conditions: Vec<Program>,
    pub epoch_fee: u64,
}

#[derive(Clone)]
pub struct RewardDistributorWithdrawIncentivesResult {
    pub conditions: Vec<Program>,
    pub withdrawn_amount: u64,
}

#[derive(Clone)]
pub struct RewardDistributorRemoveEntryResult {
    pub conditions: Vec<Program>,
    pub last_payment_amount: u64,
}

pub trait IntermediaryCoinProofExt {}

impl IntermediaryCoinProofExt for IntermediaryCoinProof {}

pub trait NftLauncherProofExt {}

impl NftLauncherProofExt for NftLauncherProof {}

#[derive(Clone)]
pub struct RewardDistributorStakeResult {
    pub conditions: Vec<Program>,
    pub notarized_payment: NotarizedPayment,
    pub new_nft: Nft,
}

#[derive(Clone)]
pub struct RewardDistributorUnstakeResult {
    pub conditions: Vec<Program>,
    pub payment_amount: u64,
}

#[derive(Clone)]
pub struct RewardDistributorLaunchResult {
    pub security_signature: Signature,
    pub security_secret_key: SecretKey,
    pub reward_distributor: RewardDistributor,
    pub first_epoch_slot: RewardSlot,
    pub refunded_cat: Cat,
}

#[derive(Clone)]
pub struct RewardDistributorInfoFromLauncher {
    pub constants: RewardDistributorConstants,
    pub initial_state: RewardDistributorState,
    pub eve_singleton: Coin,
}

#[derive(Clone)]
pub struct RewardDistributorInfoFromEveCoin {
    pub distributor: RewardDistributor,
    pub first_reward_slot: RewardSlot,
}

#[derive(Clone)]
pub struct RewardDistributor {
    pub(crate) clvm: Arc<Mutex<SpendContext>>,
    pub(crate) distributor: Arc<Mutex<SdkRewardDistributor>>,
}

impl RewardDistributor {
    pub fn coin(&self) -> Result<Coin> {
        Ok(self.distributor.lock().unwrap().coin)
    }

    pub fn proof(&self) -> Result<Proof> {
        Ok(self.distributor.lock().unwrap().proof.into())
    }

    pub fn state(&self) -> Result<RewardDistributorState> {
        Ok(self.distributor.lock().unwrap().info.state)
    }

    pub fn constants(&self) -> Result<RewardDistributorConstants> {
        Ok(self.distributor.lock().unwrap().info.constants)
    }

    pub fn inner_puzzle_hash(&self) -> Result<TreeHash> {
        Ok(self.distributor.lock().unwrap().info.inner_puzzle_hash())
    }

    pub fn puzzle_hash(&self) -> Result<TreeHash> {
        Ok(self.distributor.lock().unwrap().info.puzzle_hash())
    }

    pub fn reserve_coin(&self) -> Result<Coin> {
        Ok(self.distributor.lock().unwrap().reserve.coin)
    }

    pub fn reserve_asset_id(&self) -> Result<Bytes32> {
        Ok(self.distributor.lock().unwrap().reserve.asset_id)
    }

    pub fn reserve_proof(&self) -> Result<LineageProof> {
        Ok(self.distributor.lock().unwrap().reserve.proof)
    }

    pub fn pending_created_reward_slots(&self) -> Result<Vec<RewardSlot>> {
        let distributor = self.distributor.lock().unwrap();

        Ok(distributor
            .pending_spend
            .created_reward_slots
            .clone()
            .into_iter()
            .map(|slot_value| {
                RewardSlot::from_slot(
                    distributor
                        .created_slot_value_to_slot(slot_value, RewardDistributorSlotNonce::REWARD),
                )
            })
            .collect())
    }

    pub fn pending_created_commitment_slots(&self) -> Result<Vec<CommitmentSlot>> {
        let distributor = self.distributor.lock().unwrap();

        Ok(distributor
            .pending_spend
            .created_commitment_slots
            .clone()
            .into_iter()
            .map(|slot_value| {
                CommitmentSlot::from_slot(
                    distributor.created_slot_value_to_slot(
                        slot_value,
                        RewardDistributorSlotNonce::COMMITMENT,
                    ),
                )
            })
            .collect())
    }

    pub fn pending_created_entry_slots(&self) -> Result<Vec<EntrySlot>> {
        let distributor = self.distributor.lock().unwrap();

        Ok(distributor
            .pending_spend
            .created_entry_slots
            .clone()
            .into_iter()
            .map(|slot_value| {
                EntrySlot::from_slot(
                    distributor
                        .created_slot_value_to_slot(slot_value, RewardDistributorSlotNonce::ENTRY),
                )
            })
            .collect())
    }

    pub fn pending_signature(&self) -> Result<Signature> {
        Ok(self
            .distributor
            .lock()
            .unwrap()
            .pending_spend
            .signature
            .clone())
    }

    pub fn reserve_full_puzzle_hash(
        asset_id: Bytes32,
        distributor_launcher_id: Bytes32,
        nonce: u64,
    ) -> Result<TreeHash> {
        Ok(Reserve::puzzle_hash(
            asset_id,
            SingletonStruct::new(distributor_launcher_id)
                .tree_hash()
                .into(),
            nonce,
        ))
    }

    pub fn parse_launcher_solution(
        launcher_coin: Coin,
        launcher_solution: Program,
    ) -> Result<Option<RewardDistributorInfoFromLauncher>> {
        let mut ctx = launcher_solution.0.lock().unwrap();

        Ok(SdkRewardDistributor::from_launcher_solution(
            &mut ctx,
            launcher_coin,
            launcher_solution.1,
        )?
        .map(|(constants, initial_state, eve_singleton)| {
            RewardDistributorInfoFromLauncher {
                constants,
                initial_state,
                eve_singleton,
            }
        }))
    }

    pub fn finish_spend(
        &self,
        other_cat_spends: Vec<CatSpend>,
    ) -> Result<RewardDistributorFinishedSpendResult> {
        let mut ctx = self.clvm.lock().unwrap();

        let (distributor, signature) = self.distributor.lock().unwrap().clone().finish_spend(
            &mut ctx,
            other_cat_spends.into_iter().map(Into::into).collect(),
        )?;

        Ok(RewardDistributorFinishedSpendResult {
            new_distributor: RewardDistributor {
                clvm: self.clvm.clone(),
                distributor: Arc::new(Mutex::new(distributor)),
            },
            signature,
        })
    }

    fn sdk_conditions_to_program_list(
        &self,
        ctx: &mut SpendContext,
        conditions: Conditions,
    ) -> Result<Vec<Program>> {
        let mut result = Vec::with_capacity(conditions.len());

        for condition in conditions {
            result.push(Program(self.clvm.clone(), ctx.alloc(&condition)?));
        }

        Ok(result)
    }

    pub fn add_incentives(&self, amount: u64) -> Result<Vec<Program>> {
        let mut ctx = self.clvm.lock().unwrap();
        let mut distributor = self.distributor.lock().unwrap();

        let conditions = distributor
            .new_action::<RewardDistributorAddIncentivesAction>()
            .spend(&mut ctx, &mut distributor, amount)?;

        self.sdk_conditions_to_program_list(&mut ctx, conditions)
    }

    pub fn commit_incentives(
        &self,
        reward_slot: RewardSlot,
        epoch_start: u64,
        clawback_ph: Bytes32,
        rewards_to_add: u64,
    ) -> Result<Vec<Program>> {
        let mut ctx = self.clvm.lock().unwrap();
        let mut distributor = self.distributor.lock().unwrap();

        let conditions = distributor
            .new_action::<RewardDistributorCommitIncentivesAction>()
            .spend(
                &mut ctx,
                &mut distributor,
                reward_slot.to_slot(),
                epoch_start,
                clawback_ph,
                rewards_to_add,
            )?;

        self.sdk_conditions_to_program_list(&mut ctx, conditions)
    }

    pub fn initiate_payout(
        &self,
        entry_slot: EntrySlot,
    ) -> Result<RewardDistributorInitiatePayoutResult> {
        let mut ctx = self.clvm.lock().unwrap();
        let mut distributor = self.distributor.lock().unwrap();

        let (conditions, payout_amount) = distributor
            .new_action::<RewardDistributorInitiatePayoutAction>()
            .spend(&mut ctx, &mut distributor, entry_slot.to_slot())?;

        Ok(RewardDistributorInitiatePayoutResult {
            conditions: self.sdk_conditions_to_program_list(&mut ctx, conditions)?,
            payout_amount,
        })
    }

    pub fn new_epoch(&self, reward_slot: RewardSlot) -> Result<RewardDistributorNewEpochResult> {
        let mut ctx = self.clvm.lock().unwrap();
        let mut distributor = self.distributor.lock().unwrap();

        let (conditions, epoch_fee) = distributor
            .new_action::<RewardDistributorNewEpochAction>()
            .spend(&mut ctx, &mut distributor, reward_slot.to_slot())?;

        Ok(RewardDistributorNewEpochResult {
            conditions: self.sdk_conditions_to_program_list(&mut ctx, conditions)?,
            epoch_fee,
        })
    }

    pub fn sync(&self, update_time: u64) -> Result<Vec<Program>> {
        let mut ctx = self.clvm.lock().unwrap();
        let mut distributor = self.distributor.lock().unwrap();

        let conditions = distributor
            .new_action::<RewardDistributorSyncAction>()
            .spend(&mut ctx, &mut distributor, update_time)?;

        self.sdk_conditions_to_program_list(&mut ctx, conditions)
    }

    pub fn withdraw_incentives(
        &self,
        commitment_slot: CommitmentSlot,
        reward_slot: RewardSlot,
    ) -> Result<RewardDistributorWithdrawIncentivesResult> {
        let mut ctx = self.clvm.lock().unwrap();
        let mut distributor = self.distributor.lock().unwrap();

        let (conditions, withdrawn_amount) = distributor
            .new_action::<RewardDistributorWithdrawIncentivesAction>()
            .spend(
                &mut ctx,
                &mut distributor,
                commitment_slot.to_slot(),
                reward_slot.to_slot(),
            )?;

        Ok(RewardDistributorWithdrawIncentivesResult {
            conditions: self.sdk_conditions_to_program_list(&mut ctx, conditions)?,
            withdrawn_amount,
        })
    }

    pub fn add_entry(
        &self,
        payout_puzzle_hash: Bytes32,
        shares: u64,
        manager_singleton_inner_puzzle_hash: Bytes32,
    ) -> Result<Vec<Program>> {
        let mut ctx = self.clvm.lock().unwrap();
        let mut distributor = self.distributor.lock().unwrap();

        if distributor.info.constants.reward_distributor_type != RewardDistributorType::Manager {
            return Err(Error::Custom(
                "Reward distributor is not managed".to_string(),
            ));
        }

        let conditions = distributor
            .new_action::<RewardDistributorAddEntryAction>()
            .spend(
                &mut ctx,
                &mut distributor,
                payout_puzzle_hash,
                shares,
                manager_singleton_inner_puzzle_hash,
            )?;

        self.sdk_conditions_to_program_list(&mut ctx, conditions)
    }

    pub fn remove_entry(
        &self,
        entry_slot: EntrySlot,
        manager_singleton_inner_puzzle_hash: Bytes32,
    ) -> Result<RewardDistributorRemoveEntryResult> {
        let mut ctx = self.clvm.lock().unwrap();
        let mut distributor = self.distributor.lock().unwrap();

        if distributor.info.constants.reward_distributor_type != RewardDistributorType::Manager {
            return Err(Error::Custom(
                "Reward distributor is not managed".to_string(),
            ));
        }

        let (conditions, last_payment_amount) = distributor
            .new_action::<RewardDistributorRemoveEntryAction>()
            .spend(
                &mut ctx,
                &mut distributor,
                entry_slot.to_slot(),
                manager_singleton_inner_puzzle_hash,
            )?;

        Ok(RewardDistributorRemoveEntryResult {
            conditions: self.sdk_conditions_to_program_list(&mut ctx, conditions)?,
            last_payment_amount,
        })
    }

    pub fn stake(
        &self,
        current_nft: Nft,
        nft_launcher_proof: NftLauncherProof,
        entry_custody_puzzle_hash: Bytes32,
    ) -> Result<RewardDistributorStakeResult> {
        let mut ctx = self.clvm.lock().unwrap();
        let mut distributor = self.distributor.lock().unwrap();

        if distributor.info.constants.reward_distributor_type != RewardDistributorType::Nft {
            return Err(Error::Custom(
                "Reward distributor is not an NFT one".to_string(),
            ));
        }

        let sdk_nft = current_nft.as_ptr(&ctx);
        let (conditions, notarized_payment, new_nft) = distributor
            .new_action::<RewardDistributorStakeAction>()
            .spend(
                &mut ctx,
                &mut distributor,
                sdk_nft,
                nft_launcher_proof,
                entry_custody_puzzle_hash,
            )?;

        Ok(RewardDistributorStakeResult {
            conditions: self.sdk_conditions_to_program_list(&mut ctx, conditions)?,
            notarized_payment: notarized_payment.as_program(&self.clvm),
            new_nft: new_nft.as_program(&self.clvm),
        })
    }

    pub fn unstake(
        &self,
        entry_slot: EntrySlot,
        locked_nft: Nft,
    ) -> Result<RewardDistributorUnstakeResult> {
        let mut ctx = self.clvm.lock().unwrap();
        let mut distributor = self.distributor.lock().unwrap();

        let sdk_locked_nft = locked_nft.as_ptr(&ctx);
        let (conditions, payment_amount) = distributor
            .new_action::<RewardDistributorUnstakeAction>()
            .spend(
                &mut ctx,
                &mut distributor,
                entry_slot.to_slot(),
                sdk_locked_nft,
            )?;

        Ok(RewardDistributorUnstakeResult {
            conditions: self.sdk_conditions_to_program_list(&mut ctx, conditions)?,
            payment_amount,
        })
    }

    pub fn locked_nft_hint(
        distributor_launcher_id: Bytes32,
        custody_puzzle_hash: Bytes32,
    ) -> Result<Bytes32> {
        Ok(NonceWrapperArgs::<Bytes32, TreeHash> {
            nonce: custody_puzzle_hash,
            inner_puzzle: RewardDistributorStakeAction::my_p2_puzzle_hash(distributor_launcher_id)
                .into(),
        }
        .curry_tree_hash()
        .into())
    }
}