sc_rpc_server/middleware/
rate_limit.rs

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
// 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/>.

//! RPC rate limit.

use governor::{
	clock::{DefaultClock, QuantaClock},
	middleware::NoOpMiddleware,
	state::{InMemoryState, NotKeyed},
	Quota,
};
use std::{num::NonZeroU32, sync::Arc};

type RateLimitInner = governor::RateLimiter<NotKeyed, InMemoryState, DefaultClock, NoOpMiddleware>;

/// Rate limit.
#[derive(Debug, Clone)]
pub struct RateLimit {
	pub(crate) inner: Arc<RateLimitInner>,
	pub(crate) clock: QuantaClock,
}

impl RateLimit {
	/// Create a new `RateLimit` per minute.
	pub fn per_minute(n: NonZeroU32) -> Self {
		let clock = QuantaClock::default();
		Self {
			inner: Arc::new(RateLimitInner::direct_with_clock(Quota::per_minute(n), &clock)),
			clock,
		}
	}
}