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
use crate::{
    database::Database,
    service::adapters::BlockImporterAdapter,
};
use fuel_core_producer::ports::BlockProducerDatabase;
use fuel_core_services::{
    stream::BoxStream,
    RunnableService,
    RunnableTask,
    ServiceRunner,
    SharedMutex,
    StateWatcher,
};
use fuel_core_storage::{
    not_found,
    tables::ConsensusParametersVersions,
    Result as StorageResult,
    StorageAsRef,
};
use fuel_core_txpool::ports::BlockImporter;
use fuel_core_types::{
    blockchain::header::ConsensusParametersVersion,
    fuel_tx::ConsensusParameters,
    services::block_importer::SharedImportResult,
};
use futures::StreamExt;
use std::{
    collections::HashMap,
    fmt::Debug,
    sync::Arc,
};

#[derive(Clone, Debug)]
pub struct SharedState {
    latest_consensus_parameters_version: SharedMutex<ConsensusParametersVersion>,
    consensus_parameters:
        SharedMutex<HashMap<ConsensusParametersVersion, Arc<ConsensusParameters>>>,
    database: Database,
}

pub struct Task {
    blocks_events: BoxStream<SharedImportResult>,
    shared_state: SharedState,
}

impl Debug for Task {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Task")
            .field("shared_state", &self.shared_state)
            .finish()
    }
}

impl SharedState {
    fn new(database: Database) -> Self {
        let genesis_version = 0;
        Self {
            latest_consensus_parameters_version: SharedMutex::new(genesis_version),
            consensus_parameters: Default::default(),
            database,
        }
    }

    fn cache_consensus_parameters(
        &self,
        version: ConsensusParametersVersion,
    ) -> StorageResult<Arc<ConsensusParameters>> {
        let consensus_parameters = self
            .database
            .storage::<ConsensusParametersVersions>()
            .get(&version)?
            .ok_or(not_found!(ConsensusParametersVersions))?
            .into_owned();

        let consensus_parameters = Arc::new(consensus_parameters);
        self.consensus_parameters
            .lock()
            .insert(version, consensus_parameters.clone());
        Ok(consensus_parameters)
    }

    pub fn get_consensus_parameters(
        &self,
        version: &ConsensusParametersVersion,
    ) -> StorageResult<Arc<ConsensusParameters>> {
        {
            let consensus_parameters = self.consensus_parameters.lock();
            if let Some(parameters) = consensus_parameters.get(version) {
                return Ok(parameters.clone());
            }
        }

        self.cache_consensus_parameters(*version)
    }

    pub fn latest_consensus_parameters(&self) -> Arc<ConsensusParameters> {
        let version = *self.latest_consensus_parameters_version.lock();
        self.get_consensus_parameters(&version)
            .expect("The latest consensus parameters always are available unless this function was called before regenesis.")
    }
}

#[async_trait::async_trait]
impl RunnableTask for Task {
    async fn run(&mut self, watcher: &mut StateWatcher) -> anyhow::Result<bool> {
        let should_continue;
        tokio::select! {
            biased;

            _ = watcher.while_started() => {
                should_continue = false;
            }

            Some(event) = self.blocks_events.next() => {
                let new_version = event
                    .sealed_block
                    .entity
                    .header()
                    .application()
                    .consensus_parameters_version;

                if new_version > *self.shared_state.latest_consensus_parameters_version.lock() {
                    match self.shared_state.cache_consensus_parameters(new_version) {
                        Ok(_) => {
                            *self.shared_state.latest_consensus_parameters_version.lock() = new_version;
                        }
                        Err(err) => {
                            tracing::error!("Failed to cache consensus parameters: {:?}", err);
                            should_continue = false;
                            return Ok(should_continue)
                        }
                    }
                }
                should_continue = true;
            }
        }

        Ok(should_continue)
    }

    async fn shutdown(self) -> anyhow::Result<()> {
        // We don't have any resources to clean up.
        Ok(())
    }
}

#[async_trait::async_trait]
impl RunnableService for Task {
    const NAME: &'static str = "ConsensusParametersProviderTask";
    type SharedData = SharedState;
    type Task = Self;
    type TaskParams = ();

    fn shared_data(&self) -> Self::SharedData {
        self.shared_state.clone()
    }

    async fn into_task(
        self,
        _: &StateWatcher,
        _: Self::TaskParams,
    ) -> anyhow::Result<Self::Task> {
        let latest_consensus_parameters_version = self
            .shared_state
            .database
            .latest_consensus_parameters_version()?;
        self.shared_state
            .cache_consensus_parameters(latest_consensus_parameters_version)?;
        *self.shared_state.latest_consensus_parameters_version.lock() =
            latest_consensus_parameters_version;

        Ok(self)
    }
}

pub fn new_service(
    database: Database,
    importer: &BlockImporterAdapter,
) -> ServiceRunner<Task> {
    let blocks_events = importer.block_events();
    ServiceRunner::new(Task {
        blocks_events,
        shared_state: SharedState::new(database),
    })
}

#[cfg(test)]
mod tests {
    use crate::{
        database::Database,
        service::adapters::consensus_parameters_provider::{
            SharedState,
            Task,
        },
    };
    use fuel_core_services::{
        stream::IntoBoxStream,
        RunnableService,
        RunnableTask,
        StateWatcher,
    };
    use fuel_core_storage::{
        tables::ConsensusParametersVersions,
        transactional::IntoTransaction,
        StorageAsMut,
    };
    use fuel_core_types::{
        blockchain::{
            block::Block,
            header::ConsensusParametersVersion,
            SealedBlock,
        },
        fuel_tx::ConsensusParameters,
        services::block_importer::{
            ImportResult,
            SharedImportResult,
        },
    };
    use futures::stream;

    fn add_consensus_parameters(
        database: Database,
        consensus_parameters_version: ConsensusParametersVersion,
        consensus_parameters: &ConsensusParameters,
    ) -> Database {
        let mut database = database.into_transaction();
        database
            .storage_as_mut::<ConsensusParametersVersions>()
            .insert(&consensus_parameters_version, consensus_parameters)
            .unwrap();
        database.commit().unwrap()
    }

    #[tokio::test]
    async fn latest_consensus_parameters_works() {
        let version = 0;
        let consensus_parameters = Default::default();

        // Given
        let database =
            add_consensus_parameters(Database::default(), version, &consensus_parameters);
        let state = SharedState::new(database);

        // When
        let fetched_parameters = state.latest_consensus_parameters();

        // Then
        assert_eq!(fetched_parameters.as_ref(), &consensus_parameters);
    }

    #[tokio::test]
    async fn into_task_works_with_non_empty_database() {
        let version = 0;
        let consensus_parameters = Default::default();

        // Given
        let non_empty_database =
            add_consensus_parameters(Database::default(), version, &consensus_parameters);
        let task = Task {
            blocks_events: stream::empty().into_boxed(),
            shared_state: SharedState::new(non_empty_database),
        };

        // When
        let result = task.into_task(&Default::default(), ()).await;

        // Then
        result.expect("Initialization should succeed because database contains consensus parameters.");
    }

    #[tokio::test]
    async fn into_task_fails_when_no_parameters() {
        // Given
        let empty_database = Database::default();
        let task = Task {
            blocks_events: stream::empty().into_boxed(),
            shared_state: SharedState::new(empty_database),
        };

        // When
        let result = task.into_task(&Default::default(), ()).await;

        // Then
        result.expect_err(
            "Initialization should fails because of lack of consensus parameters",
        );
    }

    fn result_with_new_version(
        version: ConsensusParametersVersion,
    ) -> SharedImportResult {
        let mut block = Block::default();
        block
            .header_mut()
            .application_mut()
            .consensus_parameters_version = version;
        let sealed_block = SealedBlock {
            entity: block,
            consensus: Default::default(),
        };
        std::sync::Arc::new(ImportResult::new_from_local(
            sealed_block,
            Default::default(),
            Default::default(),
        ))
    }

    #[tokio::test]
    async fn run_updates_the_latest_consensus_parameters_from_imported_block() {
        use futures::StreamExt;

        let old_version = 0;
        let new_version = 1234;
        let old_consensus_parameters = ConsensusParameters::default();
        let mut new_consensus_parameters = ConsensusParameters::default();
        new_consensus_parameters.set_privileged_address([123; 32].into());
        assert_ne!(old_consensus_parameters, new_consensus_parameters);

        let (block_sender, block_receiver) =
            tokio::sync::broadcast::channel::<SharedImportResult>(1);
        let database_with_old_parameters = add_consensus_parameters(
            Database::default(),
            old_version,
            &old_consensus_parameters,
        );
        let mut task = Task {
            blocks_events: IntoBoxStream::into_boxed(
                tokio_stream::wrappers::BroadcastStream::new(block_receiver)
                    .filter_map(|r| futures::future::ready(r.ok())),
            ),
            shared_state: SharedState::new(database_with_old_parameters.clone()),
        }
        .into_task(&Default::default(), ())
        .await
        .unwrap();
        assert_eq!(
            task.shared_state.latest_consensus_parameters().as_ref(),
            &old_consensus_parameters
        );

        // Given
        add_consensus_parameters(
            database_with_old_parameters,
            new_version,
            &new_consensus_parameters,
        );

        // When
        let result_with_new_version = result_with_new_version(new_version);
        let _ = block_sender.send(result_with_new_version);
        task.run(&mut StateWatcher::started()).await.unwrap();

        // Then
        assert_eq!(
            task.shared_state.latest_consensus_parameters().as_ref(),
            &new_consensus_parameters
        );
    }
}