sc-mixnet 0.19.0

Substrate mixnet service
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

// This file is part of Substrate.

// Copyright (C) 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 <https://www.gnu.org/licenses/>.

use super::{config::Config, error::Error, request::Request};
use futures::{
	channel::{mpsc, oneshot},
	SinkExt,
};
use sp_core::Bytes;
use std::future::Future;

/// The other end of an [`Api`]. This should be passed to [`run`](super::run::run).
pub struct ApiBackend {
	pub(super) request_receiver: mpsc::Receiver<Request>,
}

/// Interface to the mixnet service.
#[derive(Clone)]
pub struct Api {
	request_sender: mpsc::Sender<Request>,
}

impl Api {
	/// Create a new `Api`. The [`ApiBackend`] should be passed to [`run`](super::run::run).
	pub fn new(config: &Config) -> (Self, ApiBackend) {
		let (request_sender, request_receiver) = mpsc::channel(config.substrate.request_buffer);
		(Self { request_sender }, ApiBackend { request_receiver })
	}

	/// Submit an extrinsic via the mixnet.
	///
	/// Returns a [`Future`] which returns another `Future`.
	///
	/// The first `Future` resolves as soon as there is space in the mixnet service queue. The
	/// second `Future` resolves once a reply is received over the mixnet (or sooner if there is an
	/// error).
	///
	/// The first `Future` references `self`, but the second does not. This makes it possible to
	/// submit concurrent mixnet requests using a single `Api` instance.
	pub async fn submit_extrinsic(
		&mut self,
		extrinsic: Bytes,
	) -> impl Future<Output = Result<(), Error>> {
		let (reply_sender, reply_receiver) = oneshot::channel();
		let res = self
			.request_sender
			.feed(Request::SubmitExtrinsic { extrinsic, reply_sender })
			.await;
		async move {
			res.map_err(|_| Error::ServiceUnavailable)?;
			reply_receiver.await.map_err(|_| Error::ServiceUnavailable)?
		}
	}
}