Make subnet ID's type-safe #1733

Author: ales-otf

Cargo.lock

@@ -13,9 +13,12 @@ targets = ["x86_64-unknown-linux-gnu"]
 [dependencies]
 codec = { workspace = true }
 frame-support = { workspace = true }
+precompile-utils = { workspace = true }
 scale-info = { workspace = true }
-sp-runtime = { workspace = true }
+serde = { workspace = true }
 sp-core = { workspace = true }
+sp-runtime = { workspace = true }
+subtensor-macros = { workspace = true }
 
 [lints]
 workspace = true
@@ -26,7 +29,9 @@ fast-blocks = []
 std = [
 	"codec/std",
 	"frame-support/std",
+	"precompile-utils/std",
 	"scale-info/std",
+	"serde/std",
 	"sp-core/std",
 	"sp-runtime/std",
 ]

common/Cargo.toml

@@ -1,11 +1,15 @@
 #![cfg_attr(not(feature = "std"), no_std)]
+use core::fmt::{self, Display, Formatter};
 
-use codec::{Decode, Encode, MaxEncodedLen};
+use codec::{Compact, CompactAs, Decode, Encode, Error as CodecError, MaxEncodedLen};
+use frame_support::pallet_prelude::*;
 use scale_info::TypeInfo;
+use serde::{Deserialize, Serialize};
 use sp_runtime::{
     MultiSignature,
     traits::{IdentifyAccount, Verify},
 };
+use subtensor_macros::freeze_struct;
 
 /// Balance of an account.
 pub type Balance = u64;
@@ -31,6 +35,75 @@ pub type Nonce = u32;
 /// Transfers below SMALL_TRANSFER_LIMIT are considered small transfers
 pub const SMALL_TRANSFER_LIMIT: Balance = 500_000_000; // 0.5 TAO
 
+#[freeze_struct("f1746d0b1911967")]
+#[repr(transparent)]
+#[derive(
+    Deserialize,
+    Serialize,
+    Clone,
+    Copy,
+    Decode,
+    Default,
+    Encode,
+    Eq,
+    Hash,
+    MaxEncodedLen,
+    Ord,
+    PartialEq,
+    PartialOrd,
+    RuntimeDebug,
+    TypeInfo,
+)]
+pub struct NetUid(u16);
+
+impl NetUid {
+    pub const ROOT: NetUid = Self(0);
+
+    pub fn is_root(&self) -> bool {
+        *self == Self::ROOT
+    }
+
+    pub fn next(&self) -> NetUid {
+        Self(self.0.saturating_add(1))
+    }
+}
+
+impl Display for NetUid {
+    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
+        Display::fmt(&self.0, f)
+    }
+}
+
+impl CompactAs for NetUid {
+    type As = u16;
+
+    fn encode_as(&self) -> &Self::As {
+        &self.0
+    }
+
+    fn decode_from(v: Self::As) -> Result<Self, CodecError> {
+        Ok(Self(v))
+    }
+}
+
+impl From<Compact<NetUid>> for NetUid {
+    fn from(c: Compact<NetUid>) -> Self {
+        c.0
+    }
+}
+
+impl From<NetUid> for u16 {
+    fn from(val: NetUid) -> Self {
+        val.0
+    }
+}
+
+impl From<u16> for NetUid {
+    fn from(value: u16) -> Self {
+        Self(value)
+    }
+}
+
 #[derive(
     Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Encode, Decode, Debug, MaxEncodedLen, TypeInfo,
 )]

common/src/lib.rs

@@ -32,6 +32,7 @@ substrate-fixed = { workspace = true }
 pallet-evm-chain-id = { workspace = true }
 pallet-drand = { workspace = true, default-features = false }
 sp-consensus-grandpa = { workspace = true }
+subtensor-runtime-common = { workspace = true }
 
 [dev-dependencies]
 sp-core = { workspace = true }
@@ -67,6 +68,7 @@ std = [
 	"sp-tracing/std",
 	"sp-weights/std",
 	"substrate-fixed/std",
+	"subtensor-runtime-common/std"
 ]
 runtime-benchmarks = [
 	"frame-benchmarking/runtime-benchmarks",