feat: implement type safety for tfgrid and smart contract (#361)

Author: DylanVerstraete

substrate-node/Cargo.lock

@@ -1,6 +1,7 @@
 #![cfg_attr(not(feature = "std"), no_std)]
 #![recursion_limit = "128"]
 
+use pallet_tfgrid::pallet::{InterfaceOf, PubConfigOf};
 use sp_runtime::traits::Hash;
 use sp_std::prelude::*;
 
@@ -42,7 +43,10 @@ pub mod pallet {
     use super::*;
     use frame_support::pallet_prelude::*;
     use frame_system::pallet_prelude::*;
+    use pallet_tfgrid::farm::FarmName;
+    use pallet_tfgrid::pub_ip::{GatewayIP, PublicIP};
     use sp_std::convert::TryInto;
+    use tfchain_support::types::PublicIP as SupportPublicIP;
 
     #[pallet::config]
     pub trait Config:
@@ -66,8 +70,12 @@ pub mod pallet {
         /// The minimum amount of vetos to dissaprove a proposal
         type MinVetos: Get<u32>;
 
-        type Tfgrid: Tfgrid<Self::AccountId>;
-        type NodeChanged: ChangeNode;
+        type Tfgrid: Tfgrid<
+            Self::AccountId,
+            FarmName<Self>,
+            SupportPublicIP<PublicIP<Self>, GatewayIP<Self>>,
+        >;
+        type NodeChanged: ChangeNode<PubConfigOf<Self>, InterfaceOf<Self>>;
 
         /// Weight information for extrinsics in this pallet.
         type WeightInfo: WeightInfo;
@@ -510,8 +518,11 @@ impl<T: Config> Pallet<T> {
     }
 }
 
-impl<T: Config> ChangeNode for Pallet<T> {
-    fn node_changed(old_node: Option<&Node>, new_node: &Node) {
+impl<T: Config> ChangeNode<PubConfigOf<T>, InterfaceOf<T>> for Pallet<T> {
+    fn node_changed(
+        old_node: Option<&Node<PubConfigOf<T>, InterfaceOf<T>>>,
+        new_node: &Node<PubConfigOf<T>, InterfaceOf<T>>,
+    ) {
         let new_node_weight = Self::get_node_weight(new_node.resources);
         match old_node {
             Some(node) => {
@@ -542,7 +553,7 @@ impl<T: Config> ChangeNode for Pallet<T> {
         };
     }
 
-    fn node_deleted(node: &Node) {
+    fn node_deleted(node: &Node<PubConfigOf<T>, InterfaceOf<T>>) {
         let node_weight = Self::get_node_weight(node.resources);
         let mut farm_weight = FarmWeight::<T>::get(node.farm_id);
         farm_weight = farm_weight.checked_sub(node_weight).unwrap_or(0);

substrate-node/pallets/pallet-dao/src/lib.rs

@@ -4,6 +4,12 @@ use frame_support::{construct_runtime, parameter_types, traits::ConstU32};
 use frame_system::EnsureRoot;
 use pallet_collective;
 use pallet_tfgrid;
+use pallet_tfgrid::{
+    farm::FarmName,
+    pub_config::{Domain, GW4, GW6, IP4, IP6},
+    pub_ip::{GatewayIP, PublicIP},
+    twin::TwinIp,
+};
 use pallet_timestamp;
 use sp_core::H256;
 use sp_runtime::{
@@ -72,13 +78,14 @@ parameter_types! {
     pub const MinVetos: u32 = 2;
 }
 
+pub(crate) type PubConfig = pallet_tfgrid::pallet::PubConfigOf<Test>;
 pub struct NodeChanged;
-impl ChangeNode for NodeChanged {
-    fn node_changed(old_node: Option<&Node>, new_node: &Node) {
+impl ChangeNode<PubConfig> for NodeChanged {
+    fn node_changed(old_node: Option<&Node<PubConfig>>, new_node: &Node<PubConfig>) {
         DaoModule::node_changed(old_node, new_node)
     }
 
-    fn node_deleted(node: &Node) {
+    fn node_deleted(node: &Node<PubConfig>) {
         DaoModule::node_deleted(node);
     }
 }
@@ -99,14 +106,32 @@ parameter_types! {
     pub const MaxFarmNameLength: u32 = 40;
 }
 
+pub(crate) type TestTwinIp = TwinIp<Test>;
+pub(crate) type TestFarmName = FarmName<Test>;
+pub(crate) type TestPublicIP = PublicIP<Test>;
+pub(crate) type TestGatewayIP = GatewayIP<Test>;
+
+pub(crate) type TestIP4 = IP4<Test>;
+pub(crate) type TestGW4 = GW4<Test>;
+pub(crate) type TestIP6 = IP6<Test>;
+pub(crate) type TestGW6 = GW6<Test>;
+pub(crate) type TestDomain = Domain<Test>;
+
 impl pallet_tfgrid::Config for Test {
     type Event = Event;
     type RestrictedOrigin = EnsureRoot<Self::AccountId>;
     type WeightInfo = pallet_tfgrid::weights::SubstrateWeight<Test>;
     type NodeChanged = NodeChanged;
-    type TwinIp = pallet_tfgrid::twin::TwinIp<Test>;
+    type TwinIp = TestTwinIp;
+    type FarmName = TestFarmName;
     type MaxFarmNameLength = MaxFarmNameLength;
-    type FarmName = pallet_tfgrid::farm::FarmName<Test>;
+    type PublicIP = TestPublicIP;
+    type GatewayIP = TestGatewayIP;
+    type IP4 = TestIP4;
+    type GW4 = TestGW4;
+    type IP6 = TestIP6;
+    type GW6 = TestGW6;
+    type Domain = TestDomain;
 }
 
 impl pallet_timestamp::Config for Test {
@@ -147,6 +172,10 @@ impl pallet_membership::Config<pallet_membership::Instance1> for Test {
     type WeightInfo = pallet_membership::weights::SubstrateWeight<Test>;
 }
 
+pub(crate) fn get_twin_ip(twin_ip_input: &[u8]) -> TestTwinIp {
+    TwinIp::try_from(twin_ip_input.to_vec()).expect("Invalid twin ip input.")
+}
+
 // Build genesis storage according to the mock runtime.
 pub fn new_test_ext() -> sp_io::TestExternalities {
     let mut t = frame_system::GenesisConfig::default()

substrate-node/pallets/pallet-dao/src/mock.rs

@@ -296,8 +296,8 @@ fn motion_approval_works() {
         assert_ok!(DaoModule::vote(Origin::signed(11), 2, hash.clone(), true));
 
         // // Check farm certification type before we close
-        let f1 = TfgridModule::farms(1);
-        assert_eq!(f1.certification, FarmCertification::NotCertified);
+        let farm_1 = TfgridModule::farms(1).unwrap();
+        assert_eq!(farm_1.certification, FarmCertification::NotCertified);
 
         System::set_block_number(5);
         assert_ok!(DaoModule::close(Origin::signed(2), hash.clone(), 0,));
@@ -366,8 +366,8 @@ fn motion_approval_works() {
         );
 
         // // FarmCertification type of farm should be set to certified.
-        let f1 = TfgridModule::farms(1);
-        assert_eq!(f1.certification, FarmCertification::Gold);
+        let farm_1 = TfgridModule::farms(1).unwrap();
+        assert_eq!(farm_1.certification, FarmCertification::Gold);
     });
 }
 
@@ -507,8 +507,8 @@ fn weighted_voting_works() {
         assert_ok!(DaoModule::vote(Origin::signed(11), 2, hash.clone(), false));
 
         // // Check farm certification type before we close
-        let f1 = TfgridModule::farms(1);
-        assert_eq!(f1.certification, FarmCertification::NotCertified);
+        let farm_1 = TfgridModule::farms(1).unwrap();
+        assert_eq!(farm_1.certification, FarmCertification::NotCertified);
 
         System::set_block_number(5);
         assert_ok!(DaoModule::close(Origin::signed(2), hash.clone(), 0,));
@@ -570,8 +570,8 @@ fn weighted_voting_works() {
         );
 
         // FarmCertification type of farm should still be the same.
-        let f1 = TfgridModule::farms(1);
-        assert_eq!(f1.certification, FarmCertification::NotCertified);
+        let farm_1 = TfgridModule::farms(1).unwrap();
+        assert_eq!(farm_1.certification, FarmCertification::NotCertified);
     });
 }
 
@@ -602,7 +602,7 @@ fn voting_tfgridmodule_call_works() {
         assert_ok!(DaoModule::vote(Origin::signed(11), 2, hash.clone(), true));
 
         // Check connection price of node 1
-        let n1 = TfgridModule::nodes(1);
+        let n1 = TfgridModule::nodes(1).unwrap();
         assert_eq!(n1.connection_price, 80);
 
         System::set_block_number(5);
@@ -677,7 +677,7 @@ fn voting_tfgridmodule_call_works() {
         // Connection price should have been modified, any new node should have set the new price
         prepare_twin(15);
         prepare_node(15, 1);
-        let n3 = TfgridModule::nodes(3);
+        let n3 = TfgridModule::nodes(3).unwrap();
         assert_eq!(n3.connection_price, 100);
     });
 }
@@ -780,10 +780,12 @@ pub fn prepare_twin(account_id: u64) {
         document.clone(),
         hash.clone(),
     ));
-    let ip = "::1";
-    let ip_v = ip.as_bytes().to_vec();
-    let ip_bv: BoundedVec<u8, ConstU32<39>> = BoundedVec::try_from(ip_v).unwrap();
-    TfgridModule::create_twin(Origin::signed(account_id), ip_bv).unwrap();
+
+    let ip = get_twin_ip(b"::1");
+    assert_ok!(TfgridModule::create_twin(
+        Origin::signed(account_id),
+        ip.clone().0
+    ));
 }
 
 const GIGABYTE: u64 = 1024 * 1024 * 1024;
@@ -850,17 +852,20 @@ fn prepare_big_node(account_id: u64, farm_id: u32) {
 pub fn prepare_farm(account_id: u64, farm_name: Vec<u8>) {
     let mut pub_ips = Vec::new();
     pub_ips.push(PublicIP {
-        ip: "1.1.1.0".as_bytes().to_vec(),
-        gateway: "1.1.1.1".as_bytes().to_vec(),
+        ip: "185.206.122.33/24".as_bytes().to_vec().try_into().unwrap(),
+        gateway: "185.206.122.1".as_bytes().to_vec().try_into().unwrap(),
         contract_id: 0,
     });
 
-    let farm_name_bv = BoundedVec::try_from(farm_name).unwrap();
-    TfgridModule::create_farm(Origin::signed(account_id), farm_name_bv, pub_ips.clone()).unwrap();
+    assert_ok!(TfgridModule::create_farm(
+        Origin::signed(account_id),
+        farm_name.try_into().unwrap(),
+        pub_ips.clone(),
+    ));
 }
 
 fn create_farming_policies() {
-    let name = "farm1".as_bytes().to_vec();
+    let name = "farm_1".as_bytes().to_vec();
     assert_ok!(TfgridModule::create_farming_policy(
         RawOrigin::Root.into(),
         name,

substrate-node/pallets/pallet-dao/src/tests.rs

@@ -40,13 +40,11 @@ pallet-timestamp =  { git = "https://github.com/paritytech/substrate", branch =
 tfchain-support = { path = "../../support", default-features = false }
 sp-io = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.24", default-features = false }
 frame-try-runtime = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.24", default-features = false, optional = true }
+sp-core = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.24", default-features = false }
 
 # Benchmarking
 frame-benchmarking = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.24", default-features = false, optional = true }
 
-[dev-dependencies]
-sp-core =  { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.24", default-features = false }
-
 [features]
 default = ['std']
 std = [
@@ -65,6 +63,7 @@ std = [
 	'frame-benchmarking/std',
 	'sp-io/std',
 	'frame-try-runtime/std',
+	'sp-core/std'
 ]
 runtime-benchmarks = [
 	"frame-benchmarking",
@@ -73,4 +72,4 @@ runtime-benchmarks = [
 ]
 try-runtime = [
 	"frame-support/try-runtime"
-] 
+]