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
//! Types related to blocks

use super::{
    consensus::ConsensusType,
    header::{
        ApplicationHeader,
        BlockHeader,
        ConsensusHeader,
        PartialBlockHeader,
    },
    primitives::{
        BlockId,
        Empty,
    },
};
use crate::{
    blockchain::header::{
        BlockHeaderError,
        BlockHeaderV1,
    },
    fuel_tx::{
        Transaction,
        TxId,
        UniqueIdentifier,
    },
    fuel_types::{
        Bytes32,
        ChainId,
        MessageId,
    },
};

/// Version-able block type
#[derive(Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Block<TransactionRepresentation = Transaction> {
    /// V1 Block
    V1(BlockV1<TransactionRepresentation>),
}

#[cfg(any(test, feature = "test-helpers"))]
impl<T: Default> Default for Block<T> {
    fn default() -> Self {
        Block::V1(BlockV1::default())
    }
}

/// Fuel block with all transaction data included
#[derive(Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(any(test, feature = "test-helpers"), derive(Default))]
pub struct BlockV1<TransactionRepresentation = Transaction> {
    /// Generated complete header.
    header: BlockHeader,
    /// Executed transactions.
    transactions: Vec<TransactionRepresentation>,
}

/// Compressed version of the fuel `Block`.
pub type CompressedBlock = Block<TxId>;

/// Fuel block with all transaction data included
/// but without any data generated.
/// This type can be created with unexecuted
/// transactions to produce a [`Block`] or
/// it can be created with pre-executed transactions in
/// order to validate they were constructed correctly.
#[derive(Clone, Debug)]
pub struct PartialFuelBlock {
    /// The partial header.
    pub header: PartialBlockHeader,
    /// Transactions that can either be pre-executed
    /// or not.
    pub transactions: Vec<Transaction>,
}

impl Block<Transaction> {
    /// Create a new full fuel block from a [`PartialBlockHeader`],
    /// executed transactions and the [`MessageId`]s.
    ///
    /// The order of the transactions must be the same order they were
    /// executed in.
    /// The order of the messages must be the same as they were
    /// produced in.
    ///
    /// Message ids are produced by executed the transactions and collecting
    /// the ids from the receipts of messages outputs.
    pub fn new(
        header: PartialBlockHeader,
        transactions: Vec<Transaction>,
        outbox_message_ids: &[MessageId],
        event_inbox_root: Bytes32,
    ) -> Result<Self, BlockHeaderError> {
        let inner = BlockV1 {
            header: header.generate(
                &transactions,
                outbox_message_ids,
                event_inbox_root,
            )?,
            transactions,
        };
        Ok(Block::V1(inner))
    }

    /// Try creating a new full fuel block from a [`BlockHeader`] and
    /// **previously executed** transactions.
    /// This will fail if the transactions don't match the header.
    pub fn try_from_executed(
        header: BlockHeader,
        transactions: Vec<Transaction>,
    ) -> Option<Self> {
        header
            .validate_transactions(&transactions)
            .then_some(Block::V1(BlockV1 {
                header,
                transactions,
            }))
    }

    /// Compresses the fuel block and replaces transactions with hashes.
    pub fn compress(&self, chain_id: &ChainId) -> CompressedBlock {
        match self {
            Block::V1(inner) => {
                let transactions = inner
                    .transactions
                    .iter()
                    .map(|tx| tx.id(chain_id))
                    .collect();
                let new_inner = BlockV1 {
                    header: inner.header.clone(),
                    transactions,
                };
                Block::V1(new_inner)
            }
        }
    }
}

impl<T> Block<T> {
    /// Destructure into the inner types.
    pub fn into_inner(self) -> (BlockHeader, Vec<T>) {
        match self {
            Block::V1(BlockV1 {
                header,
                transactions,
            }) => (header, transactions),
        }
    }
}

impl CompressedBlock {
    /// Convert from a compressed block back to a the full block.
    pub fn uncompress(self, transactions: Vec<Transaction>) -> Block<Transaction> {
        // TODO: should we perform an extra validation step to ensure the provided
        //  txs match the expected ones in the block?
        match self {
            Block::V1(inner) => Block::V1(BlockV1 {
                header: inner.header,
                transactions,
            }),
        }
    }
}

impl<TransactionRepresentation> Block<TransactionRepresentation> {
    /// Get the hash of the header.
    pub fn id(&self) -> BlockId {
        // The `Block` can be created only via the `Block::new` method, which calculates the
        // identifier based on the header. So the block is immutable and can't change its
        // identifier on the fly.
        //
        // This assertion is a double-checks that this behavior is not changed.
        debug_assert_eq!(self.header().id(), self.header().hash());
        self.header().id()
    }

    /// Get the executed transactions.
    pub fn transactions(&self) -> &[TransactionRepresentation] {
        match self {
            Block::V1(inner) => &inner.transactions,
        }
    }

    /// Get the complete header.
    pub fn header(&self) -> &BlockHeader {
        match self {
            Block::V1(inner) => &inner.header,
        }
    }

    /// The type of consensus this header is using.
    pub fn consensus_type(&self) -> ConsensusType {
        self.header().consensus_type()
    }

    /// Get mutable access to transactions for testing purposes
    #[cfg(any(test, feature = "test-helpers"))]
    pub fn transactions_mut(&mut self) -> &mut Vec<TransactionRepresentation> {
        match self {
            Block::V1(inner) => &mut inner.transactions,
        }
    }

    /// Get mutable access to header for testing purposes
    #[cfg(any(test, feature = "test-helpers"))]
    pub fn header_mut(&mut self) -> &mut BlockHeader {
        match self {
            Block::V1(inner) => &mut inner.header,
        }
    }
}

impl PartialFuelBlock {
    /// Create a new block
    pub fn new(header: PartialBlockHeader, transactions: Vec<Transaction>) -> Self {
        Self {
            header,
            transactions,
        }
    }

    /// Generate a [`Block`] after running this partial block.
    ///
    /// The order of the messages must be the same as they were
    /// produced in.
    ///
    /// Message ids are produced by executed the transactions and collecting
    /// the ids from the receipts of messages outputs.
    pub fn generate(
        self,
        outbox_message_ids: &[MessageId],
        event_inbox_root: Bytes32,
    ) -> Result<Block, BlockHeaderError> {
        Block::new(
            self.header,
            self.transactions,
            outbox_message_ids,
            event_inbox_root,
        )
    }
}

impl From<Block> for PartialFuelBlock {
    fn from(block: Block) -> Self {
        match block {
            Block::V1(BlockV1 {
                header:
                    BlockHeader::V1(BlockHeaderV1 {
                        application:
                            ApplicationHeader {
                                da_height,
                                consensus_parameters_version,
                                state_transition_bytecode_version,
                                ..
                            },
                        consensus:
                            ConsensusHeader {
                                prev_root,
                                height,
                                time,
                                ..
                            },
                        ..
                    }),
                transactions,
            }) => Self {
                header: PartialBlockHeader {
                    application: ApplicationHeader {
                        da_height,
                        consensus_parameters_version,
                        state_transition_bytecode_version,
                        generated: Empty {},
                    },
                    consensus: ConsensusHeader {
                        prev_root,
                        height,
                        time,
                        generated: Empty {},
                    },
                },
                transactions,
            },
        }
    }
}

#[cfg(any(test, feature = "test-helpers"))]
impl CompressedBlock {
    /// Create a compressed header for testing. This does not generate fields.
    pub fn test(header: BlockHeader, transactions: Vec<TxId>) -> Self {
        let inner = BlockV1 {
            header,
            transactions,
        };
        Self::V1(inner)
    }
}