Merge pull request #520 from lidofinance/fix-csm-tests

- fix incorrect queue ics

Author: iamnp

tests/regression/test_csm.py

@@ -13,7 +13,10 @@
 )
 from utils.dsm import UnvetArgs, to_bytes, set_single_guardian
 from utils.staking_module import calc_module_reward_shares
-from utils.test.csm_helpers import csm_add_node_operator, csm_upload_keys, get_ics_members, csm_add_ics_node_operator
+from utils.test.csm_helpers import (
+    csm_add_node_operator, csm_upload_keys, csm_add_ics_node_operator,
+    csm_set_ics_tree_members,
+)
 from utils.test.deposits_helpers import fill_deposit_buffer
 from utils.test.easy_track_helpers import _encode_calldata
 from utils.test.helpers import ETH
@@ -90,7 +93,7 @@ def strikes():
 def depositable_node_operator(csm, accounting, permissionless_gate, stranger):
     increase_staking_module_share(module_id=CSM_MODULE_ID, share_multiplier=2)
     csm.cleanDepositQueue(2 * csm.getNonce(), {"from": stranger.address})
-    for queue_priority in range(1, 6):
+    for queue_priority in range(0, 6):
         deposit_batch = csm.depositQueueItem(queue_priority, csm.depositQueuePointers(queue_priority)["head"])
         if deposit_batch:
             node_operator_id = (deposit_batch >> 192) & ((1 << 64) - 1)
@@ -167,14 +170,17 @@ def get_sys_fee_to_eject():
     return int.from_bytes(val, "big")
 
 
-@pytest.mark.parametrize("address, proof", get_ics_members())
-def test_add_node_operator_ics(csm, vetted_gate, accounting, address, proof):
-    no_id = csm_add_ics_node_operator(csm, vetted_gate, accounting, address, proof)
-    no = csm.getNodeOperator(no_id)
+def test_add_node_operators_ics(csm, vetted_gate, accounting, accounts):
+    members = [account.address for account in accounts[3:5]]
+    tree = csm_set_ics_tree_members(members)
+    for address in members:
+        proof = list(tree.tree.get_proof(tree.tree.find(tree.tree.leaf([address]))))
+        no_id = csm_add_ics_node_operator(csm, vetted_gate, accounting, address, proof)
+        no = csm.getNodeOperator(no_id)
 
-    assert no["managerAddress"] == address
-    assert no["rewardAddress"] == address
-    assert accounting.getBondCurveId(no_id) == vetted_gate.curveId()
+        assert no["managerAddress"] == address
+        assert no["rewardAddress"] == address
+        assert accounting.getBondCurveId(no_id) == vetted_gate.curveId()
 
 
 def test_add_node_operator_permissionless(csm, permissionless_gate, accounting, accounts):
@@ -424,18 +430,19 @@ def test_csm_remove_key(csm, parameters_registry, accounting, node_operator):
     assert "KeyRemovalChargeApplied" in tx.events
     assert "BondCharged" in tx.events
 
+    curve_id = accounting.getBondCurveId(node_operator)
     expected_charge_amount = contracts.lido.getPooledEthByShares(
-        contracts.lido.getSharesByPooledEth(parameters_registry.getKeyRemovalCharge(accounting.DEFAULT_BOND_CURVE_ID()))
+        contracts.lido.getSharesByPooledEth(parameters_registry.getKeyRemovalCharge(curve_id))
     )
     assert tx.events["BondCharged"]["toChargeAmount"] == expected_charge_amount
     no = csm.getNodeOperator(node_operator)
     assert no["totalAddedKeys"] == keys_before - 1
 
 
-def test_eject_bad_performer(csm, ejector, strikes, node_operator, stranger):
+def test_eject_bad_performer(csm, accounting, ejector, strikes, node_operator, stranger):
     index_to_eject = 0
     pubkey_to_eject = csm.getSigningKeys(node_operator, index_to_eject, 1)
-    leaf_to_eject = (node_operator, pubkey_to_eject, [1, 1, 1, 0, 0, 0])
+    leaf_to_eject = (node_operator, pubkey_to_eject, [1, 1, 1, 1, 1, 1])
     another_pubkey = csm.getSigningKeys(node_operator, index_to_eject + 1, 1)
     strikes_tree = StrikesTree.new(
         [leaf_to_eject, (node_operator, another_pubkey, [1, 1, 0, 0, 0, 0])]
@@ -450,7 +457,7 @@ def test_eject_bad_performer(csm, ejector, strikes, node_operator, stranger):
 
     eject_payment_value = get_sys_fee_to_eject()
 
-    bad_performer = (node_operator, index_to_eject, [1, 1, 1, 0, 0, 0])
+    bad_performer = (node_operator, index_to_eject, [1, 1, 1, 1, 1, 1])
     tx = strikes.processBadPerformanceProof(
         [bad_performer],
         proof,
@@ -461,7 +468,9 @@ def test_eject_bad_performer(csm, ejector, strikes, node_operator, stranger):
     assert "StrikesPenaltyProcessed" in tx.events
     assert tx.events["StrikesPenaltyProcessed"]["nodeOperatorId"] == node_operator
     assert tx.events["StrikesPenaltyProcessed"]["pubkey"] == pubkey_to_eject
-    penalty = contracts.cs_parameters_registry.defaultBadPerformancePenalty()
+
+    curve_id = accounting.getBondCurveId(node_operator)
+    penalty = contracts.cs_parameters_registry.getBadPerformancePenalty(curve_id)
     assert tx.events["StrikesPenaltyProcessed"]["strikesPenalty"] == penalty
 
     assert "TriggeredExitFeeRecorded" in tx.events
@@ -482,15 +491,17 @@ def test_voluntary_eject(csm, ejector, node_operator):
     assert "TriggeredExitFeeRecorded" not in tx.events
 
 
-def test_report_validator_exit_delay(csm, node_operator):
+def test_report_validator_exit_delay(csm, accounting, parameters_registry, node_operator):
     pubkey = csm.getSigningKeys(node_operator, 0, 1)
     day_in_seconds = 60 * 60 * 24
 
     tx = csm.reportValidatorExitDelay(node_operator, 0, pubkey, 7 * day_in_seconds, {"from": contracts.staking_router})
     assert "ValidatorExitDelayProcessed" in tx.events
     assert tx.events["ValidatorExitDelayProcessed"]["nodeOperatorId"] == node_operator
     assert tx.events["ValidatorExitDelayProcessed"]["pubkey"] == pubkey
-    penalty = contracts.cs_parameters_registry.defaultExitDelayPenalty()
+
+    curve_id = accounting.getBondCurveId(node_operator)
+    penalty = parameters_registry.getExitDelayPenalty(curve_id)
     assert tx.events["ValidatorExitDelayProcessed"]["delayPenalty"] == penalty
 
 

utils/test/csm_helpers.py

@@ -1,71 +1,29 @@
-from brownie import ZERO_ADDRESS
+from brownie import ZERO_ADDRESS, chain
 
 from utils.balance import set_balance_in_wei
+from utils.test.easy_track_helpers import _encode_calldata
 from utils.test.helpers import ETH
 from utils.test.keys_helpers import random_pubkeys_batch, random_signatures_batch
-from utils.config import contracts
-
-def get_ics_members():
-    """Few ICS members from mainnet list"""
-    return ((
-                "0xf4c1b69a65f3fdbafcae0786c5fb02dad3e0f353",
-                [
-                    "0x5f1fbf1cda5a3dd4d863cd96f6513c24f4f5973e9de0d4524ba5c65bdbff09c6",
-                    "0x459f8832de04e639e148bfdf73d008f9496bc5473b76c76fcb2681dd2806b34f",
-                    "0x38b9c0886c7f5a0115688d538e14318a22856470d265c03778b63e775bfce55a",
-                    "0x007c11b18270c5b5ec10e821b3b2763fd7b28f889b11ec0ae297ab3c55ab0dba",
-                    "0x5cb1b7f8a3505a0d36cb64886bfd5d48e28e62d2ff0fd52aa12d3f5933fe1916",
-                    "0x429e5ae3d28582cb7efcebca05bae5430e9915f8f5bef58c79563938479fa791",
-                    "0x31003203efa870c41458f35927908e17c10f24b615b0e6af863d01c0d8ea3065",
-                    "0xbe5b3c65dec940f408d96c86777263868e45fa74b9848871c1f508bde4d731e1"
-                ]
-            ), ("0x9b4064c9d9801f062f377512e61bd19484e7f365",
-                [
-                    "0x3dca0828b389d4a4f72eb381ac3edd6f96f51a04b0446db2e7a77892b61ba7c7",
-                    "0x8f5af01242e34310a430415a1bda6ad42ea09b7ed487de5b38c2626d7acb08b1",
-                    "0x2ae5c4b9c69f91edb90caf2594e595e01758c58ae9719311cd3d5d41a32f0b66",
-                    "0x1f7e8e488cf08018ea5796a648b39f2218f1aad23223dcd6c3733cf775950dff",
-                    "0xdbc36608e64ffee165ab914565b18e83b526b81771c46fc4689e7579c426a567",
-                    "0xf676e62b1ca138f69927c196ec23e6f43e4e430e2865637fa5db83cc26670372",
-                    "0x31003203efa870c41458f35927908e17c10f24b615b0e6af863d01c0d8ea3065",
-                    "0xbe5b3c65dec940f408d96c86777263868e45fa74b9848871c1f508bde4d731e1"
-                ]
-                ), ("0xb8f8e5751b2c5bad790ff0d2f5574ab38246272e",
-                    [
-                        "0x96441bf0ea1e2d069560e692ff9b5baec46e83a364ffe3203c5b16d91bc0321f",
-                        "0x5e7c84656af7b03dc12353898f2cafda93166fc9c85aec6d797e7410a38390b2",
-                        "0x90efa708c8677e4589f86f98d788a2b6096b1202358cabc31558ccc716bab269",
-                        "0x1392ec14e24fb65c06527743cafc6c408653a312511fbeb4f7a385ee62cbb201",
-                        "0xc656eee8bb516c8ef59fa3c73f68276c87aa2e707b1394cfe0d0d2151a60ecb8",
-                        "0x994eb932575dc2f3b0a55262fcdfd0108cdf5573228a2fdac5c82bc689cbb90d",
-                        "0xc878b4f250b6b2616245fe079be412dac4605b48aede5ac8f695fe219931051d",
-                        "0xf0e2720fdd888df5369e9aa081347d97603fadbd22f5a1978b08fbaa7c13e6f7"
-                    ]
-                    ), (
-                "0x88792bee0d8a4c46acb7a2d8bfbef7e3a678639e",
-                [
-                    "0x955c8105dfeed6dd47fccc580e67b00090043c2e0fe00dd9269adaf1864ac073",
-                    "0xfb254edbb3d5dc888dd77e1779146b94268fb5964d0dc9f71815fad8da58612c",
-                    "0x90efa708c8677e4589f86f98d788a2b6096b1202358cabc31558ccc716bab269",
-                    "0x1392ec14e24fb65c06527743cafc6c408653a312511fbeb4f7a385ee62cbb201",
-                    "0xc656eee8bb516c8ef59fa3c73f68276c87aa2e707b1394cfe0d0d2151a60ecb8",
-                    "0x994eb932575dc2f3b0a55262fcdfd0108cdf5573228a2fdac5c82bc689cbb90d",
-                    "0xc878b4f250b6b2616245fe079be412dac4605b48aede5ac8f695fe219931051d",
-                    "0xf0e2720fdd888df5369e9aa081347d97603fadbd22f5a1978b08fbaa7c13e6f7"
-                ]
-            ), (
-                "0x1ea60eaa2883173e2f8d6b7b025fce33ebc08738",
-                [
-                    "0xd5d55039d3530cc365d80d5bdb249c6a21024ecd2d0f3629ab256da3030e5f4a",
-                    "0xad535120c80dea856727178e9ffc03a549ae69c71fa8fd69e7da87500d94ed5e",
-                    "0x18c929c35a4632f9aea2684bba2fb918a1a32035c2c2aa1c50d7d48ab6f84960",
-                    "0x1eae092568547d900432cc755ab381fedac95d4847e6de94bbdec79ca7706b47",
-                    "0xe8c3fe7bc103e7c4da1d5a7d2bafbc6e9d1b1d42cbdb8b75bc9136701e18dd4d",
-                    "0xd456f32b3f050d9204e43c123bb5a81c01c482ea56c9a0249ad60e36c64468af",
-                    "0xbf3f96fd42d14dc9db9126b57923d8845d8434c7e64dcf9a1a23f17afec30aad",
-                    "0xf0e2720fdd888df5369e9aa081347d97603fadbd22f5a1978b08fbaa7c13e6f7"
-                ]
-            ))
+from utils.config import contracts, CSM_COMMITTEE_MS, EASYTRACK_CS_SET_VETTED_GATE_TREE_FACTORY
+from utils.test.merkle_tree import ICSTree
+
+
+
+def csm_set_ics_tree_members(members):
+    tree = ICSTree.new(members)
+    calldata = _encode_calldata(["bytes32", "string"], [tree.root, "0xabc"])
+    tx = contracts.easy_track.createMotion(EASYTRACK_CS_SET_VETTED_GATE_TREE_FACTORY, calldata, {"from": CSM_COMMITTEE_MS})
+    chain.sleep(60 * 60 * 24 * 3)
+    chain.mine()
+    motions = contracts.easy_track.getMotions()
+    contracts.easy_track.enactMotion(
+        motions[-1][0],
+        tx.events["MotionCreated"]["_evmScriptCallData"],
+        {"from": CSM_COMMITTEE_MS},
+    )
+
+    return tree
+
 
 
 def csm_add_node_operator(csm, permissionless_gate, accounting, node_operator, keys_count=5, curve_id=0):

utils/test/merkle_tree.py

@@ -16,6 +16,7 @@
 Strikes: TypeAlias = list[int]
 RewardTreeLeaf: TypeAlias = tuple[NodeOperatorId, Shares]
 StrikesTreeLeaf: TypeAlias = tuple[NodeOperatorId, Pubkey, Strikes]
+ICSTreeLeaf: TypeAlias = str
 
 
 class TreeJSONEncoder(json.JSONEncoder):
@@ -316,3 +317,45 @@ def dump(self) -> Dump[StrikesTreeLeaf]:
     def new(cls, values: Sequence[StrikesTreeLeaf]):
         """Create new instance around the wrapped tree out of the given values"""
         return cls(StandardMerkleTree(values, ("uint256", "bytes", "uint256[]")))
+
+
+@dataclass
+class ICSTree:
+    """A wrapper around StandardMerkleTree to cover use cases of the CSM ICS Vetted Gate"""
+
+    tree: StandardMerkleTree[ICSTreeLeaf]
+
+    @property
+    def root(self) -> HexBytes:
+        return HexBytes(self.tree.root)
+
+    @classmethod
+    def decode(cls, content: bytes):
+        """Restore a tree from a supported binary representation"""
+
+        try:
+            return cls(StandardMerkleTree.load(json.loads(content)))
+        except json.JSONDecodeError as e:
+            raise ValueError("Unsupported tree format") from e
+
+    def encode(self) -> bytes:
+        """Convert the underlying StandardMerkleTree to a binary representation"""
+
+        return (
+            TreeJSONEncoder(
+                indent=None,
+                separators=(',', ':'),
+                sort_keys=True,
+            )
+            .encode(self.dump())
+            .encode()
+        )
+
+    def dump(self) -> Dump[ICSTreeLeaf]:
+        return self.tree.dump()
+
+    @classmethod
+    def new(cls, values: Sequence[ICSTreeLeaf]):
+        """Create new instance around the wrapped tree out of the given values"""
+        values = [[value] for value in values]
+        return cls(StandardMerkleTree(values, ("address",)))