check if shard is descendant of already monitored shards when adding collator

Author: yungwine

modules/collator.py

@@ -1,6 +1,6 @@
 from modules.module import MtcModule
 from mypylib import color_print, print_table
-from mytoncore import b642hex, signed_int_to_hex64
+from mytoncore import b642hex, signed_int_to_hex64, shard_prefix_len, hex_shard_to_int, shard_prefix, shard_is_ancestor
 from mytonctrl.utils import pop_arg_from_args
 
 
@@ -15,6 +15,32 @@ def add_collator_to_vc(self, adnl_addr: str, shard: str):
         result = self.ton.validatorConsole.Run(f"add-collator {adnl_addr} {shard}")
         return result
 
+    @staticmethod
+    def _check_input_shards(node_shards: list, shards_need_to_add: list, monitor_min_split: int):
+        true_monitoring_shards = []
+        for sh in node_shards:
+            shard_id = hex_shard_to_int(sh)
+            if shard_id['workchain'] == -1:
+                continue
+            shard = shard_id['shard']
+            if shard_prefix_len(shard) > monitor_min_split:
+                shard_id['shard'] = shard_prefix(shard, monitor_min_split)
+            true_monitoring_shards.append(shard_id)
+        for sh in shards_need_to_add:
+            shard_id = hex_shard_to_int(sh)
+            found = False
+            for true_shard in true_monitoring_shards:
+                if shard_id['workchain'] == true_shard['workchain'] and \
+                        shard_is_ancestor(true_shard['shard'], shard_id['shard']):
+                    found = True
+                    break
+            if not found:
+                raise Exception(
+                    f'This node already has shards to monitor, '
+                    f'but shard {shard_id} is not monitored by the node: {true_monitoring_shards} It\'s highly not recommended to add new shards for node to monitor. '
+                    f'If you are sure you want to add new collator use option `--force`.'
+                )
+
     def setup_collator(self, args: list):
         from mytoninstaller.mytoninstaller import set_node_argument
         from mytoninstaller.node_args import get_node_args
@@ -29,10 +55,12 @@ def setup_collator(self, args: list):
         node_args = get_node_args()
         if '--add-shard' not in node_args:
             node_args['--add-shard'] = []
-        shards_need_to_add = [shard for shard in shards if shard not in node_args['--add-shard']]
-        if '-M' in node_args and shards_need_to_add and not force:
-            raise Exception(f'This node already has shards to monitor. It\'s highly not recommended to add new shards for node to monitor. If you are sure you want to add new collator use option `--force`.')
 
+        node_shards = node_args['--add-shard']
+        shards_need_to_add = [shard for shard in shards if shard not in node_shards]
+        if not force and shards_need_to_add and '-M' in node_args:
+            monitor_min_split = self.ton.get_basechain_config()['monitor_min_split']
+            self._check_input_shards(node_shards, shards_need_to_add, monitor_min_split)
         if adnl_addr is None:
             adnl_addr = self.ton.CreateNewKey()
         self.ton.AddAdnlAddrToValidator(adnl_addr)

mytoncore/mytoncore.py

@@ -636,11 +636,14 @@ def GetMinStake(self):
 
 	def GetRootWorkchainEnabledTime(self):
 		self.local.add_log("start GetRootWorkchainEnabledTime function", "debug")
-		config12 = self.GetConfig(12)
-		enabledTime = config12["workchains"]["root"]["node"]["value"]["enabled_since"]
+		enabledTime = self.get_basechain_config()["enabled_since"]
 		return enabledTime
 	#end define
 
+	def get_basechain_config(self):
+		config12 = self.GetConfig(12)
+		return config12["workchains"]["root"]["node"]["value"]
+
 	def GetTotalValidators(self):
 		self.local.add_log("start GetTotalValidators function", "debug")
 		config34 = self.GetConfig34()

mytoncore/utils.py

@@ -117,3 +117,63 @@ def signed_int_to_hex64(value):
     if value < 0:
         value = (1 << 64) + value
     return f"{value:016X}"
+
+
+_MASK64 = (1 << 64) - 1
+
+
+def _to_unsigned64(v: int) -> int:
+    return v & _MASK64
+
+
+def _lower_bit64(u: int) -> int:
+    if u == 0:
+        return 0
+    return u & ((-u) & _MASK64)
+
+
+def _bits_negate64(u: int) -> int:
+    return ~u + 1
+
+
+def shard_prefix_len(shard_id: int):
+    def _count_trailing_zeroes64(value: int) -> int:
+        u = value & _MASK64
+        if u == 0:
+            return 64
+        return ((u & -u).bit_length()) - 1
+    return 63 - _count_trailing_zeroes64(_to_unsigned64(shard_id))
+
+
+def shard_prefix(shard_id: int, length_: int):
+
+    def _to_signed64(v: int) -> int:
+        return v - (1 << 64) if v >= (1 << 63) else v
+
+    if not (0 <= length_ <= 63):
+        raise ValueError("length must be between 0 and 63 inclusive")
+    u = _to_unsigned64(shard_id)
+    x = _lower_bit64(u)
+    y = 1 << (63 - length_)
+    if y < x:
+        raise ValueError("requested prefix length is longer (more specific) than current shard id")
+    mask_non_lower = (~(y - 1)) & _MASK64  # equals -y mod 2^64; clears bits below y
+    res_u = (u & mask_non_lower) | y
+    return _to_signed64(res_u)
+
+
+def shard_contains(parent: int, child: int) -> bool:
+    parent = _to_unsigned64(parent)
+    child = _to_unsigned64(child)
+    x = _lower_bit64(parent)
+    mask = (_bits_negate64(x) << 1) & _MASK64
+    return not ((parent ^ child) & mask)
+
+
+def shard_is_ancestor(parent: int, child: int) -> bool:
+    up = _to_unsigned64(parent)
+    uc = _to_unsigned64(child)
+    x = _lower_bit64(up)
+    y = _lower_bit64(uc)
+    mask = (_bits_negate64(x) << 1) & _MASK64
+    return x >= y and not ((up ^ uc) & mask)