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
// Copyright (c) 2022 MASSA LABS <info@massa.net>
use crate::{
address::{Address, AddressDeserializer, AddressSerializer},
amount::{Amount, AmountDeserializer, AmountSerializer},
error::ModelsError,
error::ModelsResult as Result,
prehash::{PreHashMap, PreHashSet},
};
use massa_serialization::{
Deserializer, SerializeError, Serializer, U64VarIntDeserializer, U64VarIntSerializer,
};
use nom::{
branch::alt,
bytes::complete::tag,
combinator::value,
error::{context, ContextError, ParseError},
multi::length_count,
sequence::tuple,
IResult, Parser,
};
use serde::{Deserialize, Serialize};
use std::collections::hash_map;
use std::ops::Bound::Included;
/// a consensus ledger entry
#[derive(Debug, Default, Deserialize, Clone, Copy, Serialize)]
pub struct LedgerData {
/// the balance in coins
pub balance: Amount,
}
/// Basic serializer for `LedgerData`
#[derive(Default)]
pub struct LedgerDataSerializer {
amount_serializer: AmountSerializer,
}
impl LedgerDataSerializer {
/// Creates a `LedgerDataSerializer`
pub fn new() -> Self {
Self {
amount_serializer: AmountSerializer::new(),
}
}
}
impl Serializer<LedgerData> for LedgerDataSerializer {
/// ## Example:
/// ```rust
/// use massa_models::amount::Amount;
/// use massa_serialization::Serializer;
/// use std::str::FromStr;
/// use massa_models::ledger::{LedgerData, LedgerDataSerializer};
///
/// let ledger_data = LedgerData {
/// balance: Amount::from_str("1349").unwrap(),
/// };
/// let mut buffer = Vec::new();
/// LedgerDataSerializer::new().serialize(&ledger_data, &mut buffer).unwrap();
/// ```
fn serialize(&self, value: &LedgerData, buffer: &mut Vec<u8>) -> Result<(), SerializeError> {
self.amount_serializer.serialize(&value.balance, buffer)?;
Ok(())
}
}
/// Basic deserializer for `LedgerData`
pub struct LedgerDataDeserializer {
amount_deserializer: AmountDeserializer,
}
impl LedgerDataDeserializer {
/// Creates a `LedgerDataDeserializer`
pub fn new() -> Self {
Self {
amount_deserializer: AmountDeserializer::new(
Included(Amount::MIN),
Included(Amount::MAX),
),
}
}
}
impl Default for LedgerDataDeserializer {
fn default() -> Self {
Self::new()
}
}
impl Deserializer<LedgerData> for LedgerDataDeserializer {
/// ## Example:
/// ```rust
/// use massa_models::amount::Amount;
/// use massa_serialization::{Serializer, Deserializer, DeserializeError};
/// use std::str::FromStr;
/// use massa_models::ledger::{LedgerData, LedgerDataDeserializer, LedgerDataSerializer};
///
/// let ledger_data = LedgerData {
/// balance: Amount::from_str("1349").unwrap(),
/// };
/// let mut buffer = Vec::new();
/// LedgerDataSerializer::new().serialize(&ledger_data, &mut buffer).unwrap();
/// let (rest, ledger_data_deserialized) = LedgerDataDeserializer::new().deserialize::<DeserializeError>(&buffer).unwrap();
/// assert_eq!(rest.len(), 0);
/// assert_eq!(ledger_data.balance, ledger_data_deserialized.balance);
/// ```
fn deserialize<'a, E: ParseError<&'a [u8]> + ContextError<&'a [u8]>>(
&self,
buffer: &'a [u8],
) -> IResult<&'a [u8], LedgerData, E> {
context("Failed LedgerData deserialization", |input| {
self.amount_deserializer.deserialize(input)
})
.map(|balance| LedgerData { balance })
.parse(buffer)
}
}
impl LedgerData {
/// new `LedgerData` from an initial balance
pub fn new(starting_balance: Amount) -> LedgerData {
LedgerData {
balance: starting_balance,
}
}
/// apply a `LedgerChange` for an entry
/// Can fail in overflow or underflow occur
pub fn apply_change(&mut self, change: &LedgerChange) -> Result<()> {
if change.balance_increment {
self.balance = self
.balance
.checked_add(change.balance_delta)
.ok_or_else(|| {
ModelsError::InvalidLedgerChange(
"balance overflow in LedgerData::apply_change".into(),
)
})?;
} else {
self.balance = self
.balance
.checked_sub(change.balance_delta)
.ok_or_else(|| {
ModelsError::InvalidLedgerChange(
"balance overflow in LedgerData::apply_change".into(),
)
})?;
}
Ok(())
}
/// returns true if the balance is zero
pub fn is_nil(&self) -> bool {
self.balance == Amount::default()
}
}
/// A balance change that can be applied to an address
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct LedgerChange {
/// Amount to add or subtract
pub balance_delta: Amount,
/// whether to increment or decrements balance of delta
pub balance_increment: bool,
}
impl Default for LedgerChange {
fn default() -> Self {
LedgerChange {
balance_delta: Amount::default(),
balance_increment: true,
}
}
}
/// Basic serializer for `LedgerChange`
#[derive(Default)]
pub struct LedgerChangeSerializer {
amount_serializer: AmountSerializer,
}
impl LedgerChangeSerializer {
/// Creates a `LedgerChangeSerializer`
pub fn new() -> Self {
Self {
amount_serializer: AmountSerializer::new(),
}
}
}
impl Serializer<LedgerChange> for LedgerChangeSerializer {
/// ## Example
/// ```rust
/// use massa_models::{address::Address, amount::Amount};
/// use std::str::FromStr;
/// use massa_models::ledger::{LedgerChange, LedgerChangeSerializer};
/// use massa_serialization::Serializer;
/// let ledger_change = LedgerChange {
/// balance_delta: Amount::from_str("1149").unwrap(),
/// balance_increment: true
/// };
/// let mut serialized = Vec::new();
/// LedgerChangeSerializer::new().serialize(&ledger_change, &mut serialized).unwrap();
/// ```
fn serialize(&self, value: &LedgerChange, buffer: &mut Vec<u8>) -> Result<(), SerializeError> {
buffer.push(u8::from(value.balance_increment));
self.amount_serializer
.serialize(&value.balance_delta, buffer)?;
Ok(())
}
}
/// Basic deserializer for `LedgerChange`
pub struct LedgerChangeDeserializer {
amount_deserializer: AmountDeserializer,
}
impl LedgerChangeDeserializer {
/// Creates a `LedgerChangeDeserializer`
pub fn new() -> Self {
Self {
amount_deserializer: AmountDeserializer::new(
Included(Amount::MIN),
Included(Amount::MAX),
),
}
}
}
impl Default for LedgerChangeDeserializer {
fn default() -> Self {
Self::new()
}
}
impl Deserializer<LedgerChange> for LedgerChangeDeserializer {
/// ## Example
/// ```rust
/// use massa_models::{address::Address, amount::Amount};
/// use std::str::FromStr;
/// use massa_models::ledger::{LedgerChange, LedgerChangeDeserializer, LedgerChangeSerializer};
/// use massa_serialization::{Serializer, Deserializer, DeserializeError};
/// let ledger_change = LedgerChange {
/// balance_delta: Amount::from_str("1149").unwrap(),
/// balance_increment: true
/// };
/// let mut serialized = Vec::new();
/// LedgerChangeSerializer::new().serialize(&ledger_change, &mut serialized).unwrap();
/// let (rest, serialized) = LedgerChangeDeserializer::new().deserialize::<DeserializeError>(&serialized).unwrap();
/// assert_eq!(rest.len(), 0);
/// assert_eq!(ledger_change.balance_delta, serialized.balance_delta);
/// assert_eq!(ledger_change.balance_increment, serialized.balance_increment);
/// ```
fn deserialize<'a, E: ParseError<&'a [u8]> + ContextError<&'a [u8]>>(
&self,
buffer: &'a [u8],
) -> IResult<&'a [u8], LedgerChange, E> {
context(
"Failed LedgerChange deserialization",
tuple((
context(
"Failed balance_increment deserialization",
alt((value(true, tag(&[1u8])), value(false, tag(&[0u8])))),
),
context("Failed balance_delta deserialization", |input| {
self.amount_deserializer.deserialize(input)
}),
)),
)
.map(|(balance_increment, balance_delta)| LedgerChange {
balance_delta,
balance_increment,
})
.parse(buffer)
}
}
impl LedgerChange {
/// Applies another ledger change on top of self
pub fn chain(&mut self, change: &LedgerChange) -> Result<(), ModelsError> {
if self.balance_increment == change.balance_increment {
self.balance_delta = self
.balance_delta
.checked_add(change.balance_delta)
.ok_or_else(|| {
ModelsError::InvalidLedgerChange("overflow in LedgerChange::chain".into())
})?;
} else if change.balance_delta > self.balance_delta {
self.balance_delta = change
.balance_delta
.checked_sub(self.balance_delta)
.ok_or_else(|| {
ModelsError::InvalidLedgerChange("underflow in LedgerChange::chain".into())
})?;
self.balance_increment = !self.balance_increment;
} else {
self.balance_delta = self
.balance_delta
.checked_sub(change.balance_delta)
.ok_or_else(|| {
ModelsError::InvalidLedgerChange("underflow in LedgerChange::chain".into())
})?;
}
if self.balance_delta == Amount::default() {
self.balance_increment = true;
}
Ok(())
}
/// true if the change is 0
pub fn is_nil(&self) -> bool {
self.balance_delta == Amount::default()
}
}
/// Map an address to a `LedgerChange`
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct LedgerChanges(pub PreHashMap<Address, LedgerChange>);
/// Basic serializer for `LedgerChanges`
pub struct LedgerChangesSerializer {
length_serializer: U64VarIntSerializer,
address_serializer: AddressSerializer,
ledger_change_serializer: LedgerChangeSerializer,
}
impl LedgerChangesSerializer {
/// Creates a `LedgerChangesSerializer`
pub fn new() -> Self {
Self {
length_serializer: U64VarIntSerializer::new(),
address_serializer: AddressSerializer::new(),
ledger_change_serializer: LedgerChangeSerializer::new(),
}
}
}
impl Default for LedgerChangesSerializer {
fn default() -> Self {
Self::new()
}
}
impl Serializer<LedgerChanges> for LedgerChangesSerializer {
fn serialize(&self, value: &LedgerChanges, buffer: &mut Vec<u8>) -> Result<(), SerializeError> {
self.length_serializer
.serialize(&(value.0.len() as u64), buffer)?;
for (address, change) in value.0.iter() {
self.address_serializer.serialize(address, buffer)?;
self.ledger_change_serializer.serialize(change, buffer)?;
}
Ok(())
}
}
/// Basic deserializer for `LedgerChanges`
pub struct LedgerChangesDeserializer {
length_deserializer: U64VarIntDeserializer,
address_deserializer: AddressDeserializer,
ledger_change_deserializer: LedgerChangeDeserializer,
}
impl LedgerChangesDeserializer {
/// Creates a `LedgerChangesDeserializer`
pub fn new(max_ledger_changes_count: u64) -> Self {
Self {
length_deserializer: U64VarIntDeserializer::new(
Included(0),
Included(max_ledger_changes_count),
),
address_deserializer: AddressDeserializer::new(),
ledger_change_deserializer: LedgerChangeDeserializer::new(),
}
}
}
impl Deserializer<LedgerChanges> for LedgerChangesDeserializer {
/// ## Example
/// ```rust
/// # use massa_models::{address::Address, amount::Amount};
/// # use std::str::FromStr;
/// use massa_models::ledger::{LedgerChange, LedgerChanges, LedgerChangesDeserializer, LedgerChangeSerializer, LedgerChangesSerializer};
/// # use massa_serialization::{Serializer, Deserializer, DeserializeError};
/// # let ledger_changes = LedgerChanges(vec![
/// # (
/// # Address::from_str("AU12hgh5ULW9o8fJE9muLNXhQENaUUswQbxPyDSq8ridnDGu5gRiJ").unwrap(),
/// # LedgerChange {
/// # balance_delta: Amount::from_str("1149").unwrap(),
/// # balance_increment: true
/// # },
/// # ),
/// # (
/// # Address::from_str("AU12htxRWiEm8jDJpJptr6cwEhWNcCSFWstN1MLSa96DDkVM9Y42G").unwrap(),
/// # LedgerChange {
/// # balance_delta: Amount::from_str("1020").unwrap(),
/// # balance_increment: true
/// # },
/// # )
/// # ].into_iter().collect());
/// let mut serialized = Vec::new();
/// let ledger_change_serializer = LedgerChangeSerializer::new();
/// LedgerChangesSerializer::new().serialize(&ledger_changes, &mut serialized).unwrap();
/// let (_, res) = LedgerChangesDeserializer::new(10000).deserialize::<DeserializeError>(&serialized).unwrap();
/// for (address, data) in &ledger_changes.0 {
/// let mut data_serialized = Vec::new();
/// ledger_change_serializer.serialize(data, &mut data_serialized).unwrap();
/// assert!(res.0.iter().filter(|(addr, dta)| {
/// let mut dta_serialized = Vec::new();
/// ledger_change_serializer.serialize(dta, &mut dta_serialized).unwrap();
/// &address == addr && dta_serialized == data_serialized
/// }).count() == 1);
/// data_serialized = Vec::new();
/// }
/// assert_eq!(ledger_changes.0.len(), res.0.len());
/// ```
fn deserialize<'a, E: ParseError<&'a [u8]> + ContextError<&'a [u8]>>(
&self,
buffer: &'a [u8],
) -> IResult<&'a [u8], LedgerChanges, E> {
context(
"Failed LedgerChanges deserialization",
length_count(
|input| self.length_deserializer.deserialize(input),
tuple((
|input| self.address_deserializer.deserialize(input),
|input| self.ledger_change_deserializer.deserialize(input),
)),
),
)
.map(|changes| LedgerChanges(changes.into_iter().collect()))
.parse(buffer)
}
}
impl LedgerChanges {
/// addresses that are impacted by these ledger changes
pub fn get_involved_addresses(&self) -> PreHashSet<Address> {
self.0.keys().copied().collect()
}
/// applies a `LedgerChange`
pub fn apply(&mut self, addr: &Address, change: &LedgerChange) -> Result<()> {
match self.0.entry(*addr) {
hash_map::Entry::Occupied(mut occ) => {
occ.get_mut().chain(change)?;
if occ.get().is_nil() {
occ.remove();
}
}
hash_map::Entry::Vacant(vac) => {
let mut res = LedgerChange::default();
res.chain(change)?;
if !res.is_nil() {
vac.insert(res);
}
}
}
Ok(())
}
/// chain with another `LedgerChange`
pub fn chain(&mut self, other: &LedgerChanges) -> Result<()> {
for (addr, change) in other.0.iter() {
self.apply(addr, change)?;
}
Ok(())
}
/// merge another ledger changes into self, overwriting existing data
/// addresses that are in not other are removed from self
pub fn sync_from(&mut self, addrs: &PreHashSet<Address>, mut other: LedgerChanges) {
for addr in addrs.iter() {
if let Some(new_val) = other.0.remove(addr) {
self.0.insert(*addr, new_val);
} else {
self.0.remove(addr);
}
}
}
/// clone subset
#[must_use]
pub fn clone_subset(&self, addrs: &PreHashSet<Address>) -> Self {
LedgerChanges(
self.0
.iter()
.filter_map(|(a, dta)| {
if addrs.contains(a) {
Some((*a, dta.clone()))
} else {
None
}
})
.collect(),
)
}
}