ree-exchange-sdk 0.7.0

REE exchange rust SDK.
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

use crate::{CoinBalance, CoinId, Utxo};
use alloc::collections::BTreeSet;
use candid::CandidType;
use serde::{Deserialize, Serialize};

/// Represents a coin input in an intention.
#[derive(CandidType, Clone, Debug, Deserialize, Serialize, PartialEq, Eq, PartialOrd, Ord)]
pub struct InputCoin {
    /// The address of the owner of the coins
    pub from: String,
    pub coin: CoinBalance,
}

/// Represents a coin output in an intention.
#[derive(CandidType, Clone, Debug, Deserialize, Serialize, PartialEq, Eq, PartialOrd, Ord)]
pub struct OutputCoin {
    /// The address of the receiver of the coins
    pub to: String,
    pub coin: CoinBalance,
}

/// Represents an intention to perform an action in a specific pool of an exchange.
#[derive(CandidType, Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
pub struct Intention {
    pub exchange_id: String,
    pub action: String,
    pub action_params: String,
    pub pool_address: String,
    pub nonce: u64,
    pub pool_utxo_spent: Vec<String>,
    pub pool_utxo_received: Vec<Utxo>,
    pub input_coins: Vec<InputCoin>,
    pub output_coins: Vec<OutputCoin>,
}

/// Represents a set of intentions to be executed in a transaction.
#[derive(CandidType, Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
pub struct IntentionSet {
    /// The address of the initiator of the transaction
    pub initiator_address: String,
    /// The fee in satoshis for the transaction
    pub tx_fee_in_sats: u64,
    /// The list of intentions to be executed in the transaction
    pub intentions: Vec<Intention>,
}

impl Intention {
    pub fn input_coin_ids(&self) -> Vec<CoinId> {
        self.input_coins
            .iter()
            .map(|input_coin| input_coin.coin.id.clone())
            .collect()
    }

    pub fn output_coin_ids(&self) -> Vec<CoinId> {
        self.output_coins
            .iter()
            .map(|output_coin| output_coin.coin.id.clone())
            .collect()
    }

    pub fn all_coin_ids(&self) -> Vec<CoinId> {
        let mut coin_ids: BTreeSet<CoinId> = BTreeSet::new();
        for coin_id in self.input_coin_ids().into_iter() {
            coin_ids.insert(coin_id);
        }
        for coin_id in self.output_coin_ids().into_iter() {
            coin_ids.insert(coin_id);
        }
        coin_ids.into_iter().collect()
    }
}

impl IntentionSet {
    pub fn all_input_coins(&self) -> Vec<InputCoin> {
        let mut input_coins = BTreeSet::new();
        for intention in self.intentions.iter() {
            for input_coin in intention.input_coins.iter() {
                input_coins.insert(input_coin.clone());
            }
        }
        input_coins.into_iter().collect()
    }

    pub fn all_output_coins(&self) -> Vec<OutputCoin> {
        let mut output_coins = BTreeSet::new();
        for intention in self.intentions.iter() {
            for output_coin in intention.output_coins.iter() {
                output_coins.insert(output_coin.clone());
            }
        }
        output_coins.into_iter().collect()
    }

    pub fn all_coin_ids(&self) -> Vec<CoinId> {
        let mut coin_ids: BTreeSet<CoinId> = BTreeSet::new();
        for intention in self.intentions.iter() {
            for coin_id in intention.all_coin_ids().into_iter() {
                coin_ids.insert(coin_id);
            }
        }
        coin_ids.into_iter().collect()
    }
}