sc_rpc_server/middleware/
rate_limit.rs

1// This file is part of Substrate.
2
3// Copyright (C) Parity Technologies (UK) Ltd.
4// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
5
6// This program is free software: you can redistribute it and/or modify
7// it under the terms of the GNU General Public License as published by
8// the Free Software Foundation, either version 3 of the License, or
9// (at your option) any later version.
10
11// This program is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14// GNU General Public License for more details.
15
16// You should have received a copy of the GNU General Public License
17// along with this program. If not, see <https://www.gnu.org/licenses/>.
18
19//! RPC rate limit.
20
21use governor::{
22	clock::{DefaultClock, QuantaClock},
23	middleware::NoOpMiddleware,
24	state::{InMemoryState, NotKeyed},
25	Quota,
26};
27use std::{num::NonZeroU32, sync::Arc};
28
29type RateLimitInner = governor::RateLimiter<NotKeyed, InMemoryState, DefaultClock, NoOpMiddleware>;
30
31/// Rate limit.
32#[derive(Debug, Clone)]
33pub struct RateLimit {
34	pub(crate) inner: Arc<RateLimitInner>,
35	pub(crate) clock: QuantaClock,
36}
37
38impl RateLimit {
39	/// Create a new `RateLimit` per minute.
40	pub fn per_minute(n: NonZeroU32) -> Self {
41		let clock = QuantaClock::default();
42		Self {
43			inner: Arc::new(RateLimitInner::direct_with_clock(Quota::per_minute(n), &clock)),
44			clock,
45		}
46	}
47}