Merge pull request #533 from opentensor/sam-add-freeze-layout

prevent accidental changes to storage structs
opentensor · Jul 8, 2024 · 6b9801f · 6b9801f
2 parents 7d589c4 + c572ed6
commit 6b9801f
Show file tree

Hide file tree

Showing 25 changed files with 260 additions and 21 deletions.
diff --git a/.cargo-husky/hooks/prepare-commit-msg b/.cargo-husky/hooks/prepare-commit-msg
diff --git a/CITATION.cft b/CITATION.cft
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -4,6 +4,7 @@ members = [
     "pallets/commitments",
     "pallets/subtensor",
     "runtime",
+    "support/macros",
 ]
 resolver = "2"
 
@@ -36,6 +37,8 @@ serde_with = { version = "=2.0.0", default-features = false }
 smallvec = "1.13.2"
 litep2p = { git = "https://github.com/paritytech/litep2p", branch = "master" }
 
+subtensor-macros = { path = "support/macros" }
+
 frame-benchmarking = { git = "https://github.com/paritytech/polkadot-sdk.git", tag = "polkadot-v1.10.0", default-features = false }
 frame-benchmarking-cli = { git = "https://github.com/paritytech/polkadot-sdk.git", tag = "polkadot-v1.10.0" }
 frame-executive = { git = "https://github.com/paritytech/polkadot-sdk.git", tag = "polkadot-v1.10.0", default-features = false }

diff --git a/Dockerfile b/Dockerfile
@@ -45,8 +45,9 @@ COPY ./raw_spec_finney.json /subtensor/raw_spec_finney.json
 COPY ./node /subtensor/node
 COPY ./pallets /subtensor/pallets
 COPY ./runtime /subtensor/runtime
+COPY ./support /subtensor/support
 
-# Update to nightly toolchain
+# Copy our toolchain
 COPY rust-toolchain.toml /subtensor/
 RUN /subtensor/scripts/init.sh
 

diff --git a/pallets/admin-utils/Cargo.toml b/pallets/admin-utils/Cargo.toml
@@ -16,6 +16,7 @@ workspace = true
 targets = ["x86_64-unknown-linux-gnu"]
 
 [dependencies]
+subtensor-macros.workspace = true
 codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = [
 	"derive",
 ] }

diff --git a/pallets/collective/Cargo.toml b/pallets/collective/Cargo.toml
@@ -16,6 +16,7 @@ workspace = true
 targets = ["x86_64-unknown-linux-gnu"]
 
 [dependencies]
+subtensor-macros.workspace = true
 codec = { package = "parity-scale-codec", version = "3.2.2", default-features = false, features = [
 	"derive",
 ] }

diff --git a/pallets/collective/src/lib.rs b/pallets/collective/src/lib.rs
@@ -65,6 +65,7 @@ mod benchmarking;
 pub mod weights;
 
 pub use pallet::*;
+use subtensor_macros::freeze_struct;
 pub use weights::WeightInfo;
 
 const LOG_TARGET: &str = "runtime::collective";
@@ -150,6 +151,7 @@ impl<AccountId, I> GetBacking for RawOrigin<AccountId, I> {
 }
 
 /// Info for keeping track of a motion being voted on.
+#[freeze_struct("a8e7b0b34ad52b17")]
 #[derive(PartialEq, Eq, Clone, Encode, Decode, RuntimeDebug, TypeInfo)]
 pub struct Votes<AccountId, BlockNumber> {
     /// The proposal's unique index.

diff --git a/pallets/commitments/Cargo.toml b/pallets/commitments/Cargo.toml
@@ -16,6 +16,7 @@ workspace = true
 targets = ["x86_64-unknown-linux-gnu"]
 
 [dependencies]
+subtensor-macros.workspace = true
 codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = [
 	"derive",
 	"max-encoded-len",

diff --git a/pallets/commitments/src/lib.rs b/pallets/commitments/src/lib.rs
@@ -8,6 +8,7 @@ pub mod types;
 pub mod weights;
 
 pub use pallet::*;
+use subtensor_macros::freeze_struct;
 pub use types::*;
 pub use weights::WeightInfo;
 
@@ -208,6 +209,7 @@ use {
     },
 };
 
+#[freeze_struct("6a00398e14a8a984")]
 #[derive(Encode, Decode, Clone, Eq, PartialEq, TypeInfo)]
 pub struct CommitmentsSignedExtension<T: Config + Send + Sync + TypeInfo>(pub PhantomData<T>);
 

diff --git a/pallets/commitments/src/types.rs b/pallets/commitments/src/types.rs
@@ -29,6 +29,7 @@ use sp_runtime::{
     RuntimeDebug,
 };
 use sp_std::{fmt::Debug, iter::once, prelude::*};
+use subtensor_macros::freeze_struct;
 
 /// Either underlying data blob if it is at most 32 bytes, or a hash of it. If the data is greater
 /// than 32-bytes then it will be truncated when encoding.
@@ -283,11 +284,12 @@ impl Default for Data {
     }
 }
 
+#[freeze_struct("25c84048dcc90813")]
 #[derive(
     CloneNoBound, Encode, Decode, Eq, MaxEncodedLen, PartialEqNoBound, RuntimeDebugNoBound, TypeInfo,
 )]
 #[codec(mel_bound())]
-#[cfg_attr(test, derive(frame_support::DefaultNoBound))]
+#[derive(frame_support::DefaultNoBound)]
 #[scale_info(skip_type_params(FieldLimit))]
 pub struct CommitmentInfo<FieldLimit: Get<u32>> {
     pub fields: BoundedVec<Data, FieldLimit>,

diff --git a/pallets/registry/Cargo.toml b/pallets/registry/Cargo.toml
@@ -16,6 +16,7 @@ workspace = true
 targets = ["x86_64-unknown-linux-gnu"]
 
 [dependencies]
+subtensor-macros.workspace = true
 codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = [
 	"derive",
 	"max-encoded-len",

diff --git a/pallets/registry/src/types.rs b/pallets/registry/src/types.rs
@@ -30,6 +30,7 @@ use sp_runtime::{
     RuntimeDebug,
 };
 use sp_std::{fmt::Debug, iter::once, ops::Add, prelude::*};
+use subtensor_macros::freeze_struct;
 
 /// Either underlying data blob if it is at most 32 bytes, or a hash of it. If the data is greater
 /// than 32-bytes then it will be truncated when encoding.
@@ -278,11 +279,12 @@ impl TypeInfo for IdentityFields {
 ///
 /// NOTE: This should be stored at the end of the storage item to facilitate the addition of extra
 /// fields in a backwards compatible way through a specialized `Decode` impl.
+#[freeze_struct("98e2d7fc7536226b")]
 #[derive(
     CloneNoBound, Encode, Decode, Eq, MaxEncodedLen, PartialEqNoBound, RuntimeDebugNoBound, TypeInfo,
 )]
 #[codec(mel_bound())]
-#[cfg_attr(test, derive(frame_support::DefaultNoBound))]
+#[derive(frame_support::DefaultNoBound)]
 #[scale_info(skip_type_params(FieldLimit))]
 pub struct IdentityInfo<FieldLimit: Get<u32>> {
     /// Additional fields of the identity that are not catered for with the struct's explicit

diff --git a/pallets/subtensor/Cargo.toml b/pallets/subtensor/Cargo.toml
@@ -16,6 +16,7 @@ workspace = true
 targets = ["x86_64-unknown-linux-gnu"]
 
 [dependencies]
+subtensor-macros.workspace = true
 codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = [
 	"derive",
 ] }

diff --git a/pallets/subtensor/src/delegate_info.rs b/pallets/subtensor/src/delegate_info.rs
@@ -7,6 +7,7 @@ extern crate alloc;
 use codec::Compact;
 use sp_core::hexdisplay::AsBytesRef;
 
+#[freeze_struct("5752e4c650a83e0d")]
 #[derive(Decode, Encode, PartialEq, Eq, Clone, Debug)]
 pub struct DelegateInfo<T: Config> {
     delegate_ss58: T::AccountId,

diff --git a/pallets/subtensor/src/lib.rs b/pallets/subtensor/src/lib.rs
@@ -74,6 +74,8 @@ pub mod pallet {
     use sp_std::vec;
     use sp_std::vec::Vec;
 
+    use subtensor_macros::freeze_struct;
+
     #[cfg(not(feature = "std"))]
     use alloc::boxed::Box;
     #[cfg(feature = "std")]
@@ -691,6 +693,7 @@ pub mod pallet {
     pub type AxonInfoOf = AxonInfo;
 
     /// Data structure for Axon information.
+    #[freeze_struct("3545cfb0cac4c1f5")]
     #[derive(Encode, Decode, Default, TypeInfo, Clone, PartialEq, Eq, Debug)]
     pub struct AxonInfo {
         ///  Axon serving block.
@@ -714,6 +717,7 @@ pub mod pallet {
     ///  Struct for Prometheus.
     pub type PrometheusInfoOf = PrometheusInfo;
     /// Data structure for Prometheus information.
+    #[freeze_struct("5dde687e63baf0cd")]
     #[derive(Encode, Decode, Default, TypeInfo, Clone, PartialEq, Eq, Debug)]
     pub struct PrometheusInfo {
         /// Prometheus serving block.
@@ -2235,6 +2239,7 @@ pub enum CallType {
     Other,
 }
 
+#[freeze_struct("61e2b893d5ce6701")]
 #[derive(Encode, Decode, Clone, Eq, PartialEq, TypeInfo)]
 pub struct SubtensorSignedExtension<T: Config + Send + Sync + TypeInfo>(pub PhantomData<T>);
 
@@ -2468,6 +2473,7 @@ use sp_std::vec;
 // used not 25 lines below
 #[allow(unused)]
 use sp_std::vec::Vec;
+use subtensor_macros::freeze_struct;
 
 /// Trait for managing a membership pallet instance in the runtime
 pub trait MemberManagement<AccountId> {

diff --git a/pallets/subtensor/src/neuron_info.rs b/pallets/subtensor/src/neuron_info.rs
@@ -4,6 +4,7 @@ use frame_support::storage::IterableStorageDoubleMap;
 extern crate alloc;
 use codec::Compact;
 
+#[freeze_struct("45e69321f5c74b4b")]
 #[derive(Decode, Encode, PartialEq, Eq, Clone, Debug)]
 pub struct NeuronInfo<T: Config> {
     hotkey: T::AccountId,
@@ -28,6 +29,7 @@ pub struct NeuronInfo<T: Config> {
     pruning_score: Compact<u16>,
 }
 
+#[freeze_struct("c21f0f4f22bcb2a1")]
 #[derive(Decode, Encode, PartialEq, Eq, Clone, Debug)]
 pub struct NeuronInfoLite<T: Config> {
     hotkey: T::AccountId,

diff --git a/pallets/subtensor/src/stake_info.rs b/pallets/subtensor/src/stake_info.rs
@@ -4,6 +4,7 @@ extern crate alloc;
 use codec::Compact;
 use sp_core::hexdisplay::AsBytesRef;
 
+#[freeze_struct("86d64c14d71d44b9")]
 #[derive(Decode, Encode, PartialEq, Eq, Clone, Debug)]
 pub struct StakeInfo<T: Config> {
     hotkey: T::AccountId,

diff --git a/pallets/subtensor/src/subnet_info.rs b/pallets/subtensor/src/subnet_info.rs
@@ -4,6 +4,7 @@ use frame_support::storage::IterableStorageMap;
 extern crate alloc;
 use codec::Compact;
 
+#[freeze_struct("fe79d58173da662a")]
 #[derive(Decode, Encode, PartialEq, Eq, Clone, Debug)]
 pub struct SubnetInfo<T: Config> {
     netuid: Compact<u16>,
@@ -26,6 +27,7 @@ pub struct SubnetInfo<T: Config> {
     owner: T::AccountId,
 }
 
+#[freeze_struct("55b472510f10e76a")]
 #[derive(Decode, Encode, PartialEq, Eq, Clone, Debug)]
 pub struct SubnetHyperparams {
     rho: Compact<u16>,

diff --git a/runtime/Cargo.toml b/runtime/Cargo.toml
@@ -20,6 +20,7 @@ name = "spec_version"
 path = "src/spec_version.rs"
 
 [dependencies]
+subtensor-macros.workspace = true
 subtensor-custom-rpc-runtime-api = { version = "0.0.2", path = "../pallets/subtensor/runtime-api", default-features = false }
 smallvec = { workspace = true }
 log = { workspace = true }

diff --git a/runtime/src/check_nonce.rs b/runtime/src/check_nonce.rs
@@ -11,6 +11,7 @@ use sp_runtime::{
     Saturating,
 };
 use sp_std::vec;
+use subtensor_macros::freeze_struct;
 
 /// Nonce check and increment to give replay protection for transactions.
 ///
@@ -19,6 +20,7 @@ use sp_std::vec;
 /// This extension affects `requires` and `provides` tags of validity, but DOES NOT
 /// set the `priority` field. Make sure that AT LEAST one of the signed extension sets
 /// some kind of priority upon validating transactions.
+#[freeze_struct("610b76f62cdb521e")]
 #[derive(Encode, Decode, Clone, Eq, PartialEq, TypeInfo)]
 #[scale_info(skip_type_params(T))]
 pub struct CheckNonce<T: Config>(#[codec(compact)] pub T::Nonce);

diff --git a/support/macros/Cargo.toml b/support/macros/Cargo.toml
@@ -0,0 +1,21 @@
+[package]
+name = "subtensor-macros"
+version = "0.1.0"
+edition = "2021"
+license = "MIT"
+
+description = "support macros for Subtensor"
+repository = "https://github.com/opentensor/subtensor"
+homepage = "https://bittensor.com/"
+
+[lib]
+proc-macro = true
+
+[dependencies]
+syn = { version = "2", features = ["full", "visit-mut", "extra-traits"] }
+proc-macro2 = "1"
+quote = "1"
+ahash = "0.8"
+
+[lints]
+workspace = true