bee-ledger-types 1.0.1

All types required to compute and maintain the ledger state.
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

// Copyright 2020-2021 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

use crate::{Receipt, TreasuryOutput};

/// A type to tie together the receipt, consumed treasury and created treasury of a migration.
pub struct Migration {
    receipt: Receipt,
    consumed_treasury: TreasuryOutput,
    created_treasury: TreasuryOutput,
}

impl Migration {
    /// Creates a new [`Migration`].
    pub fn new(receipt: Receipt, consumed_treasury: TreasuryOutput, created_treasury: TreasuryOutput) -> Self {
        Self {
            receipt,
            consumed_treasury,
            created_treasury,
        }
    }

    /// Returns the receipt of the [`Migration`].
    pub fn receipt(&self) -> &Receipt {
        &self.receipt
    }

    /// Returns the consumed treasury output of the [`Migration`].
    pub fn consumed_treasury(&self) -> &TreasuryOutput {
        &self.consumed_treasury
    }

    /// Returns the created treasury output of the [`Migration`].
    pub fn created_treasury(&self) -> &TreasuryOutput {
        &self.created_treasury
    }

    /// Consumes the [`Migration`] and returns the receipt.
    pub fn into_receipt(self) -> Receipt {
        self.receipt
    }
}