smoldot-full-node 0.9.1

Substrate/Polkadot full node using smoldot
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
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

// Smoldot
// Copyright (C) 2019-2022  Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

//! As explained in the documentation of smoldot, the database uses synchronous I/O operations.
//! For this reason, it is undesirable to access it from an asynchronous context.

use futures_channel::oneshot;
use smol::{channel, lock::Mutex, stream::StreamExt as _};
use smoldot::database::full_sqlite::SqliteFullDatabase;
use std::{pin::pin, thread};

pub use smoldot::database::full_sqlite::StorageAccessError;

/// Handle to the thread were the database accesses are performed.
///
/// Destroying this object stops the thread.
///
/// Use the `From` trait implementation to build a [`DatabaseThread`].
pub struct DatabaseThread {
    sender: Mutex<channel::Sender<Exec>>,
}

type Exec = Box<dyn FnOnce(&SqliteFullDatabase) + Send>;

impl DatabaseThread {
    /// Sends a closure to the database thread, executes it, then returns the value that the
    /// closure returned.
    pub async fn with_database<T: Send + 'static>(
        &self,
        closure: impl FnOnce(&SqliteFullDatabase) -> T + Send + 'static,
    ) -> T {
        let (tx, rx) = oneshot::channel();
        self.sender
            .lock()
            .await
            .send(Box::new(move |db| {
                let _ = tx.send(closure(db));
            }))
            .await
            .unwrap();
        rx.await.unwrap()
    }

    /// Similar to [`DatabaseThread::with_database`], but without any return value. This function
    /// is slightly more optimized for this use case.
    pub async fn with_database_detached(
        &self,
        closure: impl FnOnce(&SqliteFullDatabase) + Send + 'static,
    ) {
        self.sender
            .lock()
            .await
            .send(Box::new(move |db| {
                closure(db);
            }))
            .await
            .unwrap();
    }
}

impl From<SqliteFullDatabase> for DatabaseThread {
    fn from(db: SqliteFullDatabase) -> DatabaseThread {
        let (sender, rx) = channel::bounded::<Box<dyn FnOnce(&SqliteFullDatabase) + Send>>(256);

        thread::Builder::new()
            .name("sqlite-database".into())
            .spawn(move || {
                // When the `DatabaseThread` is dropped, the sender will close, `rx.next()`
                // will return `None`, and the closure here will finish, ending the thread.
                let mut rx = pin!(rx);
                while let Some(closure) = smol::block_on(rx.next()) {
                    closure(&db)
                }
            })
            .unwrap();

        DatabaseThread {
            sender: Mutex::new(sender),
        }
    }
}