smoldot 1.1.0

Primitives to build a client for Substrate-based blockchains
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
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

// Smoldot
// Copyright (C) 2019-2020  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/>.

use crate::header;
use core::{num::NonZero, time::Duration};

/// Configuration for [`next_slot_claim`].
pub struct Config<'a, TLocAuth> {
    /// Time elapsed since [the Unix Epoch](https://en.wikipedia.org/wiki/Unix_time) (i.e.
    /// 00:00:00 UTC on 1 January 1970), ignoring leap seconds.
    pub now_from_unix_epoch: Duration,

    /// Duration, in milliseconds, of an Aura slot.
    pub slot_duration: NonZero<u64>,

    /// List of the Aura authorities allowed to produce a block. This is either the same as the
    /// ones of the current best block, or a new list if the current best block contains an
    /// authorities list change digest item.
    pub current_authorities: header::AuraAuthoritiesIter<'a>,

    /// Iterator to the list of Sr25519 public keys available locally.
    ///
    /// Must implement `Iterator<Item = &[u8; 32]>`.
    pub local_authorities: TLocAuth,
}

/// Calculates the earliest one of the authorities in [`Config::local_authorities`] is allowed to
/// produce a block.
///
/// Returns `None` if none of the local authorities are allowed to produce blocks.
///
/// The value returned by this function is entirely deterministic based on the [`Config`] and
/// never changes until [`Config::now_from_unix_epoch`] gets past the value returned in
/// [`SlotClaim::slot_end_from_unix_epoch`].
///
/// However, keep in mind that, as the best block changes, the list of authorities
/// ([`Config::current_authorities`]) might change, in which case this function should be
/// called again.
pub fn next_slot_claim<'a>(
    config: Config<'a, impl Iterator<Item = &'a [u8; 32]>>,
) -> Option<SlotClaim> {
    let num_current_authorities = config.current_authorities.clone().count();

    // Note that this calculation (and some other calculations down below) can overflow in the
    // very distant future. This is considered acceptable.
    let current_slot = u64::try_from(
        config.now_from_unix_epoch.as_millis() / u128::from(config.slot_duration.get()),
    )
    .unwrap();

    let current_slot_index =
        usize::try_from(current_slot.checked_rem(u64::try_from(num_current_authorities).unwrap())?)
            .unwrap();
    debug_assert!(current_slot_index < num_current_authorities);

    let mut claim = None;

    for (pub_key_index, local_pub_key) in config.local_authorities.enumerate() {
        // TODO: O(n) complexity
        let mut index = match config
            .current_authorities
            .clone()
            .position(|pk| pk.public_key == local_pub_key)
        {
            Some(idx) => idx,
            None => continue,
        };

        if index < current_slot_index {
            index += num_current_authorities;
        }
        debug_assert!(index >= current_slot_index);

        let claimable_slot = current_slot + u64::try_from(index - current_slot_index).unwrap();

        match claim {
            Some((s, _)) if s <= claimable_slot => {}
            _ => claim = Some((claimable_slot, pub_key_index)),
        }
    }

    if let Some((slot_number, local_authorities_index)) = claim {
        let slot_start_from_unix_epoch =
            Duration::from_millis(slot_number.checked_mul(config.slot_duration.get()).unwrap());
        let slot_end_from_unix_epoch =
            slot_start_from_unix_epoch + Duration::from_secs(config.slot_duration.get());
        debug_assert!(slot_end_from_unix_epoch > config.now_from_unix_epoch);

        Some(SlotClaim {
            slot_start_from_unix_epoch,
            slot_end_from_unix_epoch,
            slot_number,
            local_authorities_index,
        })
    } else {
        None
    }
}

/// Slot happening now or in the future and that can be attributed to one of the authorities in
/// [`Config::local_authorities`].
///
/// See also [`next_slot_claim`].
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct SlotClaim {
    /// UNIX time when the slot starts. Can be inferior to the value passed to
    /// [`Config::now_from_unix_epoch`] if the slot has already started.
    pub slot_start_from_unix_epoch: Duration,
    /// UNIX time when the slot ends. Always superior to the value passed to
    /// [`Config::now_from_unix_epoch`].
    pub slot_end_from_unix_epoch: Duration,
    /// Slot number of the claim. Used when building the block.
    pub slot_number: u64,
    /// Index within [`Config::local_authorities`] of the authority that can produce the block.
    pub local_authorities_index: usize,
}