pallet-feeless 0.0.2

A pallet to implement a feeless Substrate blockchain node.
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

// GNU General Public License (GPL)
// Version 3, 29 June 2007
// http://www.gnu.org/licenses/gpl-3.0.html
//
// Copyright 2024 Benjamin Gallois
//
// Licensed under the GNU General Public License, Version 3 (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.gnu.org/licenses/gpl-3.0.html
//
// 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.
//
// You may not distribute modified versions of the software without providing
// the source code, and any derivative works must be licensed under the GPL
// License as well. This ensures that the software remains free and open
// for all users.
//
// You should have received a copy of the GPL along with this program.
// If not, see <http://www.gnu.org/licenses/>.
use codec::{Decode, DecodeWithMemTracking, Encode, MaxEncodedLen};
use frame_system::pallet_prelude::BlockNumberFor;
use scale_info::TypeInfo;
use sp_runtime::RuntimeDebug;

#[derive(
    Encode,
    Decode,
    DecodeWithMemTracking,
    Clone,
    PartialEq,
    Eq,
    Default,
    RuntimeDebug,
    MaxEncodedLen,
    TypeInfo,
)]
pub enum Status {
    #[default]
    Limited,
    Unlimited,
}

/// Tracks transaction rates for an account over blocks.
#[derive(
    Encode,
    Decode,
    DecodeWithMemTracking,
    Clone,
    PartialEq,
    Eq,
    Default,
    RuntimeDebug,
    MaxEncodedLen,
    TypeInfo,
)]
pub struct Rate<BlockNumber> {
    /// Block number of the last transaction.
    pub last_block: BlockNumber,
    /// Number of transactions since the last block.
    pub tx_since_last: u32,
    /// Size of transactions since the last block.
    pub size_since_last: u32,
    pub status: Status,
}

/// Custom account data structure with rate limiting.
#[derive(
    Encode,
    Decode,
    DecodeWithMemTracking,
    Clone,
    PartialEq,
    Eq,
    Default,
    RuntimeDebug,
    MaxEncodedLen,
    TypeInfo,
)]
pub struct AccountData<Balance, BlockNumber> {
    /// Balance data from the `pallet_balances` module.
    pub balance: pallet_balances::AccountData<Balance>,
    /// Rate limiter data.
    pub rate: Rate<BlockNumber>,
}

/// Rate-limiting behavior.
pub trait RateLimiter<T: frame_system::Config> {
    /// Checks if a transaction is allowed for the current block.
    fn is_allowed(&self, b: BlockNumberFor<T>, size: u32) -> bool;
    /// Updates the rate limiter after a transaction.
    fn update_rate(&mut self, b: BlockNumberFor<T>, size: u32);
}