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
use super::{
    AccountDeltaError, Asset, ByteReader, ByteWriter, Deserializable, DeserializationError,
    Serializable,
};
use crate::utils::{collections::*, string::*};

// ACCOUNT VAULT DELTA
// ================================================================================================

/// [AccountVaultDelta] stores the difference between the initial and final account vault states.
///
/// The difference is represented as follows:
/// - added_assets: a vector of assets that were added to the account vault.
/// - removed_assets: a vector of assets that were removed from the account vault.
#[derive(Clone, Debug, Default, PartialEq, Eq)]
pub struct AccountVaultDelta {
    pub added_assets: Vec<Asset>,
    pub removed_assets: Vec<Asset>,
}

impl AccountVaultDelta {
    /// Checks whether this vault delta is valid.
    ///
    /// # Errors
    /// Returns an error if:
    /// - The number added assets is greater than [u16::MAX].
    /// - The number of removed assets is greater than [u16::MAX].
    /// - The same asset was added more than once, removed more than once, or both added and
    ///   removed.
    pub fn validate(&self) -> Result<(), AccountDeltaError> {
        if self.added_assets.len() > u16::MAX as usize {
            return Err(AccountDeltaError::TooManyAddedAsset {
                actual: self.added_assets.len(),
                max: u16::MAX as usize,
            });
        } else if self.removed_assets.len() > u16::MAX as usize {
            return Err(AccountDeltaError::TooManyRemovedAssets {
                actual: self.removed_assets.len(),
                max: u16::MAX as usize,
            });
        }

        // make sure all added assets are unique
        for (pos, asset) in self.added_assets.iter().enumerate() {
            if self.added_assets[..pos].iter().any(|a| a.is_same(asset)) {
                return Err(AccountDeltaError::DuplicateVaultUpdate(*asset));
            }
        }

        // make sure all removed assets are the same
        for (pos, asset) in self.removed_assets.iter().enumerate() {
            if self.removed_assets[..pos].iter().any(|a| a.is_same(asset)) {
                return Err(AccountDeltaError::DuplicateVaultUpdate(*asset));
            }

            if self.added_assets.iter().any(|a| a.is_same(asset)) {
                return Err(AccountDeltaError::DuplicateVaultUpdate(*asset));
            }
        }

        Ok(())
    }

    /// Returns true if this vault delta contains no updates.
    pub fn is_empty(&self) -> bool {
        self.added_assets.is_empty() && self.removed_assets.is_empty()
    }
}

impl Serializable for AccountVaultDelta {
    fn write_into<W: ByteWriter>(&self, target: &mut W) {
        assert!(self.added_assets.len() <= u16::MAX as usize, "too many added assets");
        target.write_u16(self.added_assets.len() as u16);
        for asset in self.added_assets.iter() {
            asset.write_into(target);
        }

        assert!(self.removed_assets.len() <= u16::MAX as usize, "too many removed assets");
        target.write_u16(self.removed_assets.len() as u16);
        for asset in self.removed_assets.iter() {
            asset.write_into(target);
        }
    }
}

impl Deserializable for AccountVaultDelta {
    fn read_from<R: ByteReader>(source: &mut R) -> Result<Self, DeserializationError> {
        // deserialize and validate added assets
        let num_added_assets = source.read_u16()? as usize;
        let mut added_assets: Vec<Asset> = Vec::with_capacity(num_added_assets);
        for _ in 0..num_added_assets {
            let asset = Asset::read_from(source)?;
            if added_assets.iter().any(|a| a.is_same(&asset)) {
                return Err(DeserializationError::InvalidValue(
                    "asset added more than once".to_string(),
                ));
            }

            added_assets.push(asset);
        }

        // deserialize and validate removed assets
        let num_removed_assets = source.read_u16()? as usize;
        let mut removed_assets: Vec<Asset> = Vec::with_capacity(num_removed_assets);
        for _ in 0..num_removed_assets {
            let asset = Asset::read_from(source)?;

            if removed_assets.iter().any(|a| a.is_same(&asset)) {
                return Err(DeserializationError::InvalidValue(
                    "asset added more than once".to_string(),
                ));
            }

            if added_assets.iter().any(|a| a.is_same(&asset)) {
                return Err(DeserializationError::InvalidValue(
                    "asset both added and removed".to_string(),
                ));
            }
            removed_assets.push(asset);
        }

        Ok(Self { added_assets, removed_assets })
    }
}

// TESTS
// ================================================================================================

#[cfg(test)]
mod tests {
    use super::{AccountVaultDelta, Asset, Deserializable, Serializable};
    use crate::{
        accounts::{AccountId, AccountType},
        assets::{FungibleAsset, NonFungibleAsset, NonFungibleAssetDetails},
    };

    #[test]
    fn account_vault_delta_validation() {
        // generate test data
        let ffid1 = AccountId::new_dummy([0; 32], AccountType::FungibleFaucet);
        let ffid2 = AccountId::new_dummy([1; 32], AccountType::FungibleFaucet);
        let nffid1 = AccountId::new_dummy([0; 32], AccountType::NonFungibleFaucet);
        let nffid2 = AccountId::new_dummy([1; 32], AccountType::NonFungibleFaucet);

        let asset1: Asset = FungibleAsset::new(ffid1, 10).unwrap().into();
        let asset2: Asset = FungibleAsset::new(ffid1, 30).unwrap().into();
        let asset3: Asset = FungibleAsset::new(ffid2, 20).unwrap().into();

        let asset4: Asset =
            NonFungibleAsset::new(&NonFungibleAssetDetails::new(nffid1, vec![1, 2, 3]).unwrap())
                .unwrap()
                .into();
        let asset5: Asset =
            NonFungibleAsset::new(&NonFungibleAssetDetails::new(nffid1, vec![4, 5, 6]).unwrap())
                .unwrap()
                .into();
        let asset6: Asset =
            NonFungibleAsset::new(&NonFungibleAssetDetails::new(nffid2, vec![7, 8, 9]).unwrap())
                .unwrap()
                .into();

        // control case
        let delta = AccountVaultDelta {
            added_assets: vec![asset1, asset4, asset5],
            removed_assets: vec![asset3, asset6],
        };
        assert!(delta.validate().is_ok());

        let bytes = delta.to_bytes();
        assert_eq!(AccountVaultDelta::read_from_bytes(&bytes), Ok(delta));

        // duplicate asset in added assets
        let delta = AccountVaultDelta {
            added_assets: vec![asset1, asset4, asset5, asset2],
            removed_assets: vec![],
        };
        assert!(delta.validate().is_err());

        let bytes = delta.to_bytes();
        assert!(AccountVaultDelta::read_from_bytes(&bytes).is_err());

        // duplicate asset in removed assets
        let delta = AccountVaultDelta {
            added_assets: vec![],
            removed_assets: vec![asset1, asset4, asset5, asset2],
        };
        assert!(delta.validate().is_err());

        let bytes = delta.to_bytes();
        assert!(AccountVaultDelta::read_from_bytes(&bytes).is_err());

        // duplicate asset across added and removed assets
        let delta = AccountVaultDelta {
            added_assets: vec![asset1, asset3],
            removed_assets: vec![asset4, asset5, asset2],
        };
        assert!(delta.validate().is_err());

        let bytes = delta.to_bytes();
        assert!(AccountVaultDelta::read_from_bytes(&bytes).is_err());
    }
}