Add pallet-rate-limiting

Cargo.toml

@@ -28,6 +28,8 @@ members = [
 	"common",
 	"node",
 	"pallets/*",
+	"pallets/rate-limiting/runtime-api",
+	"pallets/rate-limiting/rpc",
 	"precompiles",
 	"primitives/*",
 	"runtime",
@@ -59,6 +61,9 @@ pallet-subtensor = { path = "pallets/subtensor", default-features = false }
 pallet-subtensor-swap = { path = "pallets/swap", default-features = false }
 pallet-subtensor-swap-runtime-api = { path = "pallets/swap/runtime-api", default-features = false }
 pallet-subtensor-swap-rpc = { path = "pallets/swap/rpc", default-features = false }
+pallet-rate-limiting = { path = "pallets/rate-limiting", default-features = false }
+pallet-rate-limiting-runtime-api = { path = "pallets/rate-limiting/runtime-api", default-features = false }
+pallet-rate-limiting-rpc = { path = "pallets/rate-limiting/rpc", default-features = false }
 procedural-fork = { path = "support/procedural-fork", default-features = false }
 safe-math = { path = "primitives/safe-math", default-features = false }
 share-pool = { path = "primitives/share-pool", default-features = false }
@@ -70,6 +75,7 @@ subtensor-runtime-common = { default-features = false, path = "common" }
 subtensor-swap-interface = { default-features = false, path = "pallets/swap-interface" }
 subtensor-transaction-fee = { default-features = false, path = "pallets/transaction-fee" }
 subtensor-chain-extensions = { default-features = false, path = "chain-extensions" }
+rate-limiting-interface = { default-features = false, path = "pallets/rate-limiting-interface" }
 
 ed25519-dalek = { version = "2.1.0", default-features = false }
 async-trait = "0.1"

chain-extensions/Cargo.toml

@@ -36,6 +36,9 @@ subtensor-swap-interface.workspace = true
 num_enum.workspace = true
 substrate-fixed.workspace = true
 
+[dev-dependencies]
+rate-limiting-interface.workspace = true
+
 [lints]
 workspace = true
 

chain-extensions/src/mock.rs

@@ -18,14 +18,17 @@ use pallet_contracts::HoldReason as ContractsHoldReason;
 use pallet_subtensor::*;
 use pallet_subtensor_proxy as pallet_proxy;
 use pallet_subtensor_utility as pallet_utility;
+use rate_limiting_interface::{RateLimitingInfo, TryIntoRateLimitTarget};
 use sp_core::{ConstU64, H256, U256, offchain::KeyTypeId};
 use sp_runtime::Perbill;
 use sp_runtime::{
     BuildStorage, Percent,
     traits::{BlakeTwo256, Convert, IdentityLookup},
 };
 use sp_std::{cell::RefCell, cmp::Ordering, sync::OnceLock};
-use subtensor_runtime_common::{AlphaCurrency, NetUid, TaoCurrency};
+use subtensor_runtime_common::{
+    AlphaCurrency, NetUid, TaoCurrency, rate_limiting::RateLimitUsageKey,
+};
 
 type Block = frame_system::mocking::MockBlock<Test>;
 
@@ -291,7 +294,6 @@ parameter_types! {
     pub const InitialMinChildKeyTake: u16 = 0; // 0 %;
     pub const InitialMaxChildKeyTake: u16 = 11_796; // 18 %;
     pub const InitialWeightsVersionKey: u16 = 0;
-    pub const InitialServingRateLimit: u64 = 0; // No limit.
     pub const InitialTxRateLimit: u64 = 0; // Disable rate limit for testing
     pub const InitialTxDelegateTakeRateLimit: u64 = 1; // 1 block take rate limit for testing
     pub const InitialTxChildKeyTakeRateLimit: u64 = 1; // 1 block take rate limit for testing
@@ -377,7 +379,6 @@ impl pallet_subtensor::Config for Test {
     type InitialWeightsVersionKey = InitialWeightsVersionKey;
     type InitialMaxDifficulty = InitialMaxDifficulty;
     type InitialMinDifficulty = InitialMinDifficulty;
-    type InitialServingRateLimit = InitialServingRateLimit;
     type InitialTxRateLimit = InitialTxRateLimit;
     type InitialTxDelegateTakeRateLimit = InitialTxDelegateTakeRateLimit;
     type InitialBurn = InitialBurn;
@@ -411,6 +412,7 @@ impl pallet_subtensor::Config for Test {
     type GetCommitments = ();
     type MaxImmuneUidsPercentage = MaxImmuneUidsPercentage;
     type CommitmentsInterface = CommitmentsI;
+    type RateLimiting = NoRateLimiting;
     type EvmKeyAssociateRateLimit = EvmKeyAssociateRateLimit;
 }
 
@@ -449,6 +451,33 @@ impl CommitmentsInterface for CommitmentsI {
     fn purge_netuid(_netuid: NetUid) {}
 }
 
+pub struct NoRateLimiting;
+
+impl RateLimitingInfo for NoRateLimiting {
+    type GroupId = subtensor_runtime_common::rate_limiting::GroupId;
+    type CallMetadata = RuntimeCall;
+    type Limit = BlockNumber;
+    type Scope = subtensor_runtime_common::NetUid;
+    type UsageKey = RateLimitUsageKey<AccountId>;
+
+    fn rate_limit<TargetArg>(_target: TargetArg, _scope: Option<Self::Scope>) -> Option<Self::Limit>
+    where
+        TargetArg: TryIntoRateLimitTarget<Self::GroupId>,
+    {
+        None
+    }
+
+    fn last_seen<TargetArg>(
+        _target: TargetArg,
+        _usage_key: Option<Self::UsageKey>,
+    ) -> Option<Self::Limit>
+    where
+        TargetArg: TryIntoRateLimitTarget<Self::GroupId>,
+    {
+        None
+    }
+}
+
 parameter_types! {
     pub MaximumSchedulerWeight: Weight = Perbill::from_percent(80) *
         BlockWeights::get().max_block;

common/src/lib.rs

@@ -17,6 +17,7 @@ use subtensor_macros::freeze_struct;
 pub use currency::*;
 
 mod currency;
+pub mod rate_limiting;
 
 /// Balance of an account.
 pub type Balance = u64;

common/src/rate_limiting.rs

@@ -0,0 +1,110 @@
+//! Shared rate-limiting types.
+//!
+//! Note: `pallet-rate-limiting` supports multiple independent instances, and is intended to be used
+//! as “one instance per pallet” with pallet-specific scope/usage-key types and resolvers.
+//!
+//! The scope/usage-key types in this module are centralized today due to the current state of
+//! `pallet-subtensor` (a large, centralized pallet) and its coupling with `pallet-admin-utils`,
+//! which share a single `pallet-rate-limiting` instance and resolver implementation in the runtime.
+//!
+//! For new pallets, it is strongly recommended to:
+//! - define their own `LimitScope` and `UsageKey` types (do not extend `RateLimitUsageKey` here),
+//! - provide pallet-local scope/usage resolvers,
+//! - and use a dedicated `pallet-rate-limiting` instance.
+//!
+//! Long-term, we should move away from these shared types by refactoring `pallet-subtensor` into
+//! smaller pallets with dedicated `pallet-rate-limiting` instances.
+
+use codec::{Decode, DecodeWithMemTracking, Encode, MaxEncodedLen};
+use frame_support::pallet_prelude::Parameter;
+use scale_info::TypeInfo;
+use serde::{Deserialize, Serialize};
+
+use crate::{MechId, NetUid};
+
+/// Identifier type for rate-limiting groups.
+pub type GroupId = u32;
+
+/// Group id for serving-related calls.
+pub const GROUP_SERVE: GroupId = 0;
+/// Group id for delegate-take related calls.
+pub const GROUP_DELEGATE_TAKE: GroupId = 1;
+/// Group id for subnet weight-setting calls.
+pub const GROUP_WEIGHTS_SUBNET: GroupId = 2;
+/// Group id for network registration calls.
+pub const GROUP_REGISTER_NETWORK: GroupId = 3;
+/// Group id for owner hyperparameter calls.
+pub const GROUP_OWNER_HPARAMS: GroupId = 4;
+/// Group id for staking operations.
+pub const GROUP_STAKING_OPS: GroupId = 5;
+/// Group id for key swap calls.
+pub const GROUP_SWAP_KEYS: GroupId = 6;
+
+/// Usage-key type currently shared by the centralized `pallet-subtensor` rate-limiting instance.
+///
+/// Do not add new variants for new pallets. Prefer defining pallet-specific types and using a
+/// dedicated `pallet-rate-limiting` instance per pallet.
+#[derive(
+    Serialize,
+    Deserialize,
+    Encode,
+    Decode,
+    DecodeWithMemTracking,
+    Clone,
+    PartialEq,
+    Eq,
+    PartialOrd,
+    Ord,
+    Debug,
+    TypeInfo,
+    MaxEncodedLen,
+)]
+#[scale_info(skip_type_params(AccountId))]
+pub enum RateLimitUsageKey<AccountId: Parameter> {
+    Account(AccountId),
+    Subnet(NetUid),
+    AccountSubnet {
+        account: AccountId,
+        netuid: NetUid,
+    },
+    ColdkeyHotkeySubnet {
+        coldkey: AccountId,
+        hotkey: AccountId,
+        netuid: NetUid,
+    },
+    SubnetNeuron {
+        netuid: NetUid,
+        uid: u16,
+    },
+    SubnetMechanismNeuron {
+        netuid: NetUid,
+        mecid: MechId,
+        uid: u16,
+    },
+    AccountSubnetServing {
+        account: AccountId,
+        netuid: NetUid,
+        endpoint: ServingEndpoint,
+    },
+}
+
+#[derive(
+    Serialize,
+    Deserialize,
+    Encode,
+    Decode,
+    DecodeWithMemTracking,
+    Clone,
+    Copy,
+    PartialEq,
+    Eq,
+    PartialOrd,
+    Ord,
+    Debug,
+    TypeInfo,
+    MaxEncodedLen,
+)]
+pub enum ServingEndpoint {
+    Axon,
+    Prometheus,
+}

contract-tests/README.md

@@ -36,6 +36,9 @@ npx papi add devnet -w ws://localhost:9944
 If the runtime is upgrade, need to get the metadata again.
 
 ```bash
+cd contract-tests/bittensor
+cargo contract build --release
+cd ..
 sh get-metadata.sh
 ```
 

contract-tests/package.json

@@ -1,6 +1,6 @@
 {
   "scripts": {
-    "test": "mocha --timeout 999999 --retries 3 --file src/setup.ts --require ts-node/register test/*test.ts"
+    "test": "TS_NODE_PREFER_TS_EXTS=1 TS_NODE_TRANSPILE_ONLY=1 mocha --timeout 999999 --retries 3 --file src/setup.ts --require ts-node/register --extension ts \"test/**/*.ts\""
   },
   "keywords": [],
   "author": "",