exonum 1.0.0

An extensible framework for blockchain software projects.
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

// Copyright 2020 The Exonum Team
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use futures::{channel::mpsc, executor, Future, SinkExt};
use thiserror::Error;

use std::fmt;

use crate::messages::{AnyTx, Verified};

/// Asynchronous sender of messages (transactions by default). The receiver of messages is
/// usually an Exonum node, which then processes them with the consensus algorithm.
pub struct ApiSender<T = Verified<AnyTx>>(mpsc::Sender<T>);

impl<T> Clone for ApiSender<T> {
    fn clone(&self) -> Self {
        Self(self.0.clone())
    }
}

impl<T: Send + 'static> ApiSender<T> {
    /// Creates new `ApiSender` with the given channel.
    pub fn new(inner: mpsc::Sender<T>) -> Self {
        Self(inner)
    }

    /// Creates a dummy sender which is not connected to anything and thus cannot send messages.
    pub fn closed() -> Self {
        Self(mpsc::channel(0).0)
    }

    /// Sends a message to the node asynchronously.
    ///
    /// # Return value
    ///
    /// The failure means that the node is being shut down.
    pub async fn send_message(&mut self, message: T) -> Result<(), SendError> {
        self.0.send(message).await.map_err(|_| SendError(()))
    }

    /// Sends a message to the node synchronously.
    ///
    /// # Return value
    ///
    /// The failure means that the node is being shut down.
    pub fn send_message_blocking(&self, message: T) -> Result<(), SendError> {
        let mut this = self.clone();
        executor::block_on(async move { this.send_message(message).await })
    }
}

impl ApiSender {
    /// Sends a transaction over the channel. If this sender is connected to a node,
    /// this will broadcast the transaction to all nodes in the blockchain network.
    ///
    /// # Return value
    ///
    /// The failure means that the node is being shut down.
    pub fn broadcast_transaction(
        &self,
        tx: Verified<AnyTx>,
    ) -> impl Future<Output = Result<(), SendError>> {
        let mut this = self.clone();
        async move { this.send_message(tx).await }
    }

    /// Sends a transaction over the channel synchronously. If this sender is connected to a node,
    /// this will broadcast the transaction to all nodes in the blockchain network.
    ///
    /// This is an blocking operation that can take some time if the node is overloaded
    /// with requests.
    ///
    /// # Return value
    ///
    /// The failure means that the node is being shut down.
    pub fn broadcast_transaction_blocking(&self, tx: Verified<AnyTx>) -> Result<(), SendError> {
        self.send_message_blocking(tx)
    }
}

impl<T> fmt::Debug for ApiSender<T> {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.debug_tuple("ApiSender").field(&"..").finish()
    }
}

/// Errors that can occur during sending a message to the node via `ApiSender`.
#[derive(Debug, Error)]
#[error("Failed to send API request to the node: the node is being shut down")]
pub struct SendError(());