feat: allow twin to connect to a relay (#570)

Author: DylanVerstraete

docs/architecture/0004-twin-changed.md

@@ -0,0 +1,26 @@
+# 4. Twin relay address
+
+Date: 2023-01-11
+
+## Status
+
+Accepted
+
+## Context
+
+See [here](https://github.com/threefoldtech/tfchain/issues/569) for more details.
+
+## Decision
+
+We decided to rework the twin Object, removing:
+
+- Version
+- IP
+
+and Adding:
+
+- Relay
+- Pk (PublicKey)
+
+We removed the version because we don't use that anymore. The IP becomes a relay address, this is some dns name where the twin can be contacted through. This will be set by RMB.
+The Pk fields is a public key used for encrypting twin messages, with this public key anyone can verify the source.

substrate-node/Cargo.lock

@@ -9,11 +9,8 @@ use pallet_tfgrid::{
     interface::{InterfaceIp, InterfaceMac, InterfaceName},
     node::{Location, SerialNumber},
     terms_cond::TermsAndConditions,
-    twin::TwinIp,
-    DocumentHashInput, DocumentLinkInput, TwinIpInput,
-};
-use pallet_tfgrid::{
-    CityNameInput, CountryNameInput, Gw4Input, Ip4Input, LatitudeInput, LongitudeInput,
+    CityNameInput, CountryNameInput, DocumentHashInput, DocumentLinkInput, Gw4Input, Ip4Input,
+    LatitudeInput, LongitudeInput, PkInput, RelayInput,
 };
 use pallet_timestamp;
 use sp_core::H256;
@@ -123,7 +120,6 @@ parameter_types! {
 
 pub(crate) type TestTermsAndConditions = TermsAndConditions<Test>;
 
-pub(crate) type TestTwinIp = TwinIp<Test>;
 pub(crate) type TestFarmName = FarmName<Test>;
 
 pub(crate) type TestInterfaceName = InterfaceName<Test>;
@@ -142,7 +138,6 @@ impl pallet_tfgrid::Config for Test {
     type NodeChanged = NodeChanged;
     type PublicIpModifier = PublicIpModifierType;
     type TermsAndConditions = TestTermsAndConditions;
-    type TwinIp = TestTwinIp;
     type FarmName = TestFarmName;
     type MaxFarmNameLength = MaxFarmNameLength;
     type MaxFarmPublicIps = MaxFarmPublicIps;
@@ -203,8 +198,12 @@ pub(crate) fn get_document_hash_input(document_hash_input: &[u8]) -> DocumentHas
     BoundedVec::try_from(document_hash_input.to_vec()).expect("Invalid document hash input.")
 }
 
-pub(crate) fn get_twin_ip_input(twin_ip_input: &[u8]) -> TwinIpInput {
-    BoundedVec::try_from(twin_ip_input.to_vec()).expect("Invalid twin ip input.")
+pub(crate) fn get_relay_input(relay_input: &[u8]) -> RelayInput {
+    Some(BoundedVec::try_from(relay_input.to_vec()).expect("Invalid relay input."))
+}
+
+pub(crate) fn get_public_key_input(pk_input: &[u8]) -> PkInput {
+    Some(BoundedVec::try_from(pk_input.to_vec()).expect("Invalid document hash input."))
 }
 
 pub(crate) fn get_public_ip_ip_input(ip_input: &[u8]) -> Ip4Input {

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

@@ -834,10 +834,13 @@ pub fn prepare_twin(account_id: u64) {
         get_document_hash_input(b"some_hash"),
     ));
 
-    let ip = get_twin_ip_input(b"::1");
+    let relay = get_relay_input(b"somerelay.io");
+    let pk =
+        get_public_key_input(b"0x6c8fd181adc178cea218e168e8549f0b0ff30627c879db9eac4318927e87c901");
     assert_ok!(TfgridModule::create_twin(
         RuntimeOrigin::signed(account_id),
-        ip
+        relay,
+        pk
     ));
 }
 

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

@@ -1,6 +1,4 @@
 use crate::*;
-#[cfg(feature = "try-runtime")]
-use codec::{Decode, Encode};
 use frame_support::{traits::OnRuntimeUpgrade, weights::Weight};
 use log::debug;
 use sp_std::collections::btree_map::BTreeMap;
@@ -31,7 +29,7 @@ impl<T: Config> OnRuntimeUpgrade for FixTwinLockedBalances<T> {
     }
 
     #[cfg(feature = "try-runtime")]
-    fn post_upgrade(pre_contracts_count: Vec<u8>) -> Result<(), &'static str> {
+    fn post_upgrade(_: Vec<u8>) -> Result<(), &'static str> {
         debug!("current pallet version: {:?}", PalletVersion::<T>::get());
         assert!(PalletVersion::<T>::get() >= types::StorageVersion::V7);
 

substrate-node/pallets/pallet-smart-contract/src/migrations/v7.rs

@@ -17,9 +17,8 @@ use pallet_tfgrid::{
     node::{CityName, CountryName},
     node::{Location, SerialNumber},
     terms_cond::TermsAndConditions,
-    twin::TwinIp,
     CityNameInput, CountryNameInput, DocumentHashInput, DocumentLinkInput, Gw4Input, Ip4Input,
-    LatitudeInput, LongitudeInput, TwinIpInput,
+    LatitudeInput, LongitudeInput, PkInput, RelayInput,
 };
 use parking_lot::RwLock;
 use sp_core::{
@@ -198,7 +197,6 @@ parameter_types! {
 
 pub(crate) type TestTermsAndConditions = TermsAndConditions<TestRuntime>;
 
-pub(crate) type TestTwinIp = TwinIp<TestRuntime>;
 pub(crate) type TestFarmName = FarmName<TestRuntime>;
 
 pub(crate) type TestInterfaceName = InterfaceName<TestRuntime>;
@@ -217,7 +215,6 @@ impl pallet_tfgrid::Config for TestRuntime {
     type NodeChanged = NodeChanged;
     type PublicIpModifier = PublicIpModifierType;
     type TermsAndConditions = TestTermsAndConditions;
-    type TwinIp = TestTwinIp;
     type FarmName = TestFarmName;
     type MaxFarmNameLength = MaxFarmNameLength;
     type MaxFarmPublicIps = MaxFarmPublicIps;
@@ -372,8 +369,12 @@ pub(crate) fn get_document_hash_input(document_hash_input: &[u8]) -> DocumentHas
     BoundedVec::try_from(document_hash_input.to_vec()).expect("Invalid document hash input.")
 }
 
-pub(crate) fn get_twin_ip_input(twin_ip_input: &[u8]) -> TwinIpInput {
-    BoundedVec::try_from(twin_ip_input.to_vec()).expect("Invalid twin ip input.")
+pub(crate) fn get_relay_input(relay_input: &[u8]) -> RelayInput {
+    Some(BoundedVec::try_from(relay_input.to_vec()).expect("Invalid relay input."))
+}
+
+pub(crate) fn get_public_key_input(pk_input: &[u8]) -> PkInput {
+    Some(BoundedVec::try_from(pk_input.to_vec()).expect("Invalid document hash input."))
 }
 
 pub(crate) fn get_public_ip_ip_input(public_ip_ip_input: &[u8]) -> Ip4Input {

substrate-node/pallets/pallet-smart-contract/src/mock.rs

@@ -3361,8 +3361,14 @@ pub fn create_twin(origin: AccountId) {
         get_document_hash_input(b"some_hash"),
     ));
 
-    let ip = get_twin_ip_input(b"::1");
-    assert_ok!(TfgridModule::create_twin(RuntimeOrigin::signed(origin), ip));
+    let relay = get_relay_input(b"somerelay.io");
+    let pk =
+        get_public_key_input(b"0x6c8fd181adc178cea218e168e8549f0b0ff30627c879db9eac4318927e87c901");
+    assert_ok!(TfgridModule::create_twin(
+        RuntimeOrigin::signed(origin),
+        relay,
+        pk
+    ));
 }
 
 fn create_farming_policies() {

substrate-node/pallets/pallet-smart-contract/src/tests.rs

@@ -42,6 +42,7 @@ frame-try-runtime = { git = "https://github.com/paritytech/substrate", branch =
 hex-literal = "0.3.1"
 pallet-membership = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.36", default-features = false }
 pallet-collective = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.36", default-features = false }
+env_logger = "*"
 
 [features]
 default = ['std']

substrate-node/pallets/pallet-tfgrid/Cargo.toml

@@ -39,7 +39,6 @@ pub mod interface;
 pub mod migrations;
 pub mod node;
 pub mod terms_cond;
-pub mod twin;
 
 // Definition of the pallet logic, to be aggregated at runtime definition
 // through `construct_runtime`.
@@ -191,9 +190,9 @@ pub mod pallet {
 
     pub type TwinIndex = u32;
     pub type AccountIdOf<T> = <T as frame_system::Config>::AccountId;
-    type TwinInfoOf<T> = types::Twin<<T as Config>::TwinIp, AccountIdOf<T>>;
-    pub type TwinIpInput = BoundedVec<u8, ConstU32<{ twin::MAX_IP_LENGTH }>>;
-    pub type TwinIpOf<T> = <T as Config>::TwinIp;
+    type TwinInfoOf<T> = types::Twin<AccountIdOf<T>>;
+    pub type RelayInput = Option<BoundedVec<u8, ConstU32<{ types::MAX_RELAY_LENGTH }>>>;
+    pub type PkInput = Option<BoundedVec<u8, ConstU32<{ types::MAX_PK_LENGTH }>>>;
 
     #[pallet::storage]
     #[pallet::getter(fn twins)]
@@ -294,15 +293,6 @@ pub mod pallet {
             + TryFrom<TermsAndConditionsInput<Self>, Error = Error<Self>>
             + MaxEncodedLen;
 
-        /// The type of a twin IP.
-        type TwinIp: FullCodec
-            + Debug
-            + PartialEq
-            + Clone
-            + TypeInfo
-            + TryFrom<TwinIpInput, Error = Error<Self>>
-            + MaxEncodedLen;
-
         /// The type of a farm name.
         type FarmName: FullCodec
             + Debug
@@ -413,8 +403,8 @@ pub mod pallet {
         EntityUpdated(TfgridEntity<T>),
         EntityDeleted(u32),
 
-        TwinStored(types::Twin<T::TwinIp, T::AccountId>),
-        TwinUpdated(types::Twin<T::TwinIp, T::AccountId>),
+        TwinStored(types::Twin<T::AccountId>),
+        TwinUpdated(types::Twin<T::AccountId>),
 
         TwinEntityStored(u32, u32, Vec<u8>),
         TwinEntityRemoved(u32, u32),
@@ -492,9 +482,9 @@ pub mod pallet {
 
         FarmingPolicyNotExists,
 
-        TwinIpTooShort,
-        TwinIpTooLong,
-        InvalidTwinIp,
+        RelayTooShort,
+        RelayTooLong,
+        InvalidRelay,
 
         FarmNameTooShort,
         FarmNameTooLong,
@@ -563,6 +553,7 @@ pub mod pallet {
         InvalidDocumentHashInput,
 
         InvalidPublicConfig,
+        InvalidRelayAddress,
     }
 
     #[pallet::genesis_config]
@@ -1397,7 +1388,11 @@ pub mod pallet {
 
         #[pallet::call_index(17)]
         #[pallet::weight(<T as Config>::WeightInfo::create_twin())]
-        pub fn create_twin(origin: OriginFor<T>, ip: TwinIpInput) -> DispatchResultWithPostInfo {
+        pub fn create_twin(
+            origin: OriginFor<T>,
+            relay: RelayInput,
+            pk: PkInput,
+        ) -> DispatchResultWithPostInfo {
             let account_id = ensure_signed(origin)?;
 
             ensure!(
@@ -1413,14 +1408,19 @@ pub mod pallet {
             let mut twin_id = TwinID::<T>::get();
             twin_id = twin_id + 1;
 
-            let twin_ip = Self::get_twin_ip(ip)?;
+            if let Some(relay_addr) = relay.clone() {
+                ensure!(
+                    Self::validate_relay_address(relay_addr.into()),
+                    Error::<T>::InvalidRelayAddress
+                );
+            }
 
-            let twin = types::Twin::<T::TwinIp, T::AccountId> {
-                version: TFGRID_TWIN_VERSION,
+            let twin = types::Twin::<T::AccountId> {
                 id: twin_id,
                 account_id: account_id.clone(),
+                relay,
                 entities: Vec::new(),
-                ip: twin_ip,
+                pk,
             };
 
             Twins::<T>::insert(&twin_id, &twin);
@@ -1436,7 +1436,11 @@ pub mod pallet {
 
         #[pallet::call_index(18)]
         #[pallet::weight(100_000_000 + T::DbWeight::get().writes(1).ref_time() + T::DbWeight::get().reads(3).ref_time())]
-        pub fn update_twin(origin: OriginFor<T>, ip: TwinIpInput) -> DispatchResultWithPostInfo {
+        pub fn update_twin(
+            origin: OriginFor<T>,
+            relay: RelayInput,
+            pk: PkInput,
+        ) -> DispatchResultWithPostInfo {
             let account_id = ensure_signed(origin)?;
 
             let twin_id =
@@ -1450,9 +1454,15 @@ pub mod pallet {
                 Error::<T>::UnauthorizedToUpdateTwin
             );
 
-            let twin_ip = Self::get_twin_ip(ip)?;
+            if let Some(relay_addr) = relay.clone() {
+                ensure!(
+                    Self::validate_relay_address(relay_addr.into()),
+                    Error::<T>::InvalidRelayAddress
+                );
+            }
 
-            twin.ip = twin_ip;
+            twin.relay = relay;
+            twin.pk = pk;
 
             Twins::<T>::insert(&twin_id, &twin);
 
@@ -2171,11 +2181,6 @@ impl<T: Config> Pallet<T> {
         Ok(parsed_terms_cond)
     }
 
-    fn get_twin_ip(ip: TwinIpInput) -> Result<TwinIpOf<T>, DispatchErrorWithPostInfo> {
-        let ip_parsed = <T as Config>::TwinIp::try_from(ip)?;
-        Ok(ip_parsed)
-    }
-
     fn get_farm_name(name: FarmNameInput<T>) -> Result<FarmNameOf<T>, DispatchErrorWithPostInfo> {
         let name_parsed = <T as Config>::FarmName::try_from(name)?;
         Ok(name_parsed)
@@ -2299,6 +2304,34 @@ impl<T: Config> Pallet<T> {
         let parsed_serial_number = <T as Config>::SerialNumber::try_from(serial_number)?;
         Ok(parsed_serial_number)
     }
+
+    fn validate_relay_address(relay_input: Vec<u8>) -> bool {
+        if relay_input.len() == 0 {
+            return false;
+        }
+
+        if relay_input[relay_input.len() - 1] == b'.' {
+            return false;
+        }
+
+        let mut prev_idx = 0;
+
+        for (idx, c) in relay_input.iter().enumerate() {
+            match c {
+                b'.' => {
+                    if idx == 0 || idx - prev_idx == 1 {
+                        return false;
+                    } else {
+                        prev_idx = idx
+                    }
+                }
+                b'a'..=b'z' | b'A'..=b'Z' | b'-' | b'_' => (),
+                _ => return false,
+            }
+        }
+
+        true
+    }
 }
 
 impl<T: Config> tfchain_support::traits::Tfgrid<T::AccountId, T::FarmName> for Pallet<T> {

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

@@ -4,3 +4,4 @@ pub mod v11;
 pub mod v12;
 pub mod v13;
 pub mod v14;
+pub mod v15;