Merge pull request #320 ATC, PML & Stonks limits + Simply staking reward address

ATC, PML & Stonks limits + Simply staking reward address

Author: iamnp

Dockerfile

@@ -14,12 +14,55 @@
 
 Lido DAO Aragon omnibus voting scripts.
 
-## 🏁 Getting started
-
 - This project uses Brownie development framework. Learn more about
   [Brownie](https://eth-brownie.readthedocs.io/en/stable/index.html).
 - [Poetry](https://python-poetry.org/) dependency and packaging manager is used
   to bootstrap environment and keep the repo sane.
+</br>
+
+## 🐳 Docker: quick and easy environment setup
+**The no-brainer workflow for setting up a Docker container to run scripts & tests**
+
+#### Step 1. Clone the fresh repo and build an image:
+```shell
+git clone git@github.com:lidofinance/scripts.git
+cd scripts
+docker build -t scenv .
+```
+Note: *If you are running on an arm64 processor (including Apple Silicon) - you will have to wait up to 4 hours while the Solidity compilers compile.*
+
+#### Step 2. Set up the ENV VARs, for example:
+- `WEB3_INFURA_PROJECT_ID` - **mandatory** for the execution of tests
+
+#### Step 3. Run the container
+Run the container in the `scripts` directory and specify any ENV VARs:
+```shell
+docker run --name scripts -v "$(pwd)":/root/scripts -e WEB3_INFURA_PROJECT_ID -d -p 2222:22 scenv
+```
+Note: *It may take up to 1 minute for the container to initialize properly the first time.*
+#### Step 4. Now connect to the running container using SSH:
+```shell
+ssh root@localhost -p 2222 # password: 1234
+```
+> [!NOTE]
+> If you see a 'REMOTE HOST IDENTIFICATION HAS CHANGED' error - `ssh-keygen -R "[localhost]:2222"`
+> 
+> If you are asked 'Are you sure you want to continue connecting' - type `yes` and hit `<ENTER>`
+
+</br>
+
+You now have a fully functional environment to run scripts & tests in, which is linked to your local scripts repo, for example:
+```shell
+poetry run brownie test tests/acceptance/test_accounting_oracle.py -s
+```
+If your container has been stopped (for example, by a system reboot), start it:
+```shell
+docker start scripts
+```
+
+</br>
+
+## 🏁 Manual installation
 
 ### Prerequisites
 
@@ -28,6 +71,8 @@ Lido DAO Aragon omnibus voting scripts.
 - Node >= 16.0
 - yarn >= 1.22
 
+</br>
+
 #### Step 1. Install Poetry
 
 Use the following command to install poetry:
@@ -75,6 +120,8 @@ need it.
 poetry shell
 ```
 
+</br>
+
 ## ⚗️ Workflow
 
 ### Network setup
@@ -106,6 +153,7 @@ it also could be useful to go with `holesky` and `holesky-fork` testnets first.
 > **Sepolia is partially supported.**
 > At the moment not all parameters are set in `configs/config_sepolia.py` and acceptance/regression/snapshot tests are not operational.
 
+</br>
 
 ### Environment variables setup
 
@@ -170,6 +218,8 @@ To make default report for acceptance and regression tests after voting executio
 export REPORT_AFTER_VOTE=1
 ```
 
+</br>
+
 ## Tests structure
 
 ### `tests/acceptance`
@@ -188,6 +238,8 @@ Directory contains snapshot-scenario tests. This tests run only if there are any
 
 Tests for current voting
 
+</br>
+
 ### Test run
 
 To run all the test on `mainnet-fork` execute
@@ -214,6 +266,8 @@ See [here](tests/README.md) to learn more about tests
 - To re-use multiple created votes list the ids comma-separated (e.g. `OMNIBUS_VOTE_IDS=104,105`)
 - To force the large CI runner usage, please name your branch with the `large-vote_` prefix.
 
+</br>
+
 ## Code style
 
 Please, use the shared pre-commit hooks to maintain code style:
@@ -222,16 +276,22 @@ Please, use the shared pre-commit hooks to maintain code style:
 poetry run pre-commit install
 ```
 
+</br>
+
 ## Repository housekeeping
 
 Please move your outdated scripts into `archive/scripts` and outdated tests into
 `archive/tests` directories.
 
+</br>
+
 ## Use cases and scripts examples
 
 - [Node operators management](usecase/node_operators_management.md)
 - [Reward manager tokens recovery](usecase/reward_manager_tokens_recovery.md)
 
+</br>
+
 ## Troubleshooting
 
 ### Invalid hashes (step 2)

README.md

@@ -0,0 +1,140 @@
+"""
+Voting 26/11/2024.
+
+I. Change the limits for ET on ATC & PML
+1. ATC: increase from 1,5m per quarter to 7m USDC/USDT/DAI per quarter - set 7'000'000 limit on ATC registry `0x37675423796D39C19351c5C322C3692b23a3d9bd` for 3 mos
+2. PML: decrease from 6m per quarter to 4m USDC/USDT/DAI per quarter - set 4'000'000 limit on PML registry `0x580B23a97F827F2b6E51B3DEc270Ef522Ccf520c` for 3 mos
+
+II. [NO HOLESKY] TMC limits update
+3. [NO HOLESKY] Update TMC limit to 12,000 stETH on TMC registry `0x1a7cFA9EFB4D5BfFDE87B0FaEb1fC65d653868C0` for 6 mos
+4. [NO HOLESKY] Reset the TMC amount spent on TMC registry `0x1a7cFA9EFB4D5BfFDE87B0FaEb1fC65d653868C0`
+
+III. Simply staking reward address change
+5. Change staking reward address to `0x1EC3Cbe8fb1D8019092500CcA2111C158a35bC82` for node operator with id = 16
+"""
+
+import time
+
+from typing import Dict, Tuple, Optional, List
+
+from brownie import interface
+from brownie.network.transaction import TransactionReceipt
+from utils.voting import bake_vote_items, confirm_vote_script, create_vote
+from utils.easy_track import add_evmscript_factory, create_permissions
+from utils.permission_parameters import Param, SpecialArgumentID, ArgumentValue, Op
+from utils.ipfs import upload_vote_ipfs_description, calculate_vote_ipfs_description
+from utils.node_operators import encode_set_node_operator_reward_address
+
+from utils.config import (
+    get_deployer_account,
+    contracts,
+    get_is_live,
+    get_priority_fee,
+)
+
+from utils.easy_track import (
+    add_evmscript_factory,
+    create_permissions,
+    remove_evmscript_factory
+)
+from utils.allowed_recipients_registry import (
+    set_limit_parameters,
+    update_spent_amount,
+    unsafe_set_spent_amount
+)
+
+from utils.agent import agent_forward
+
+description = """
+Voting 26/11/2024.
+
+I. Change the limits for ET on ATC & PML
+1. ATC: increase from 1,5m per quarter to 7m USDC/USDT/DAI per quarter - set 7'000'000 limit on ATC registry `0x37675423796D39C19351c5C322C3692b23a3d9bd` for 3 mos
+2. PML: decrease from 6m per quarter to 4m USDC/USDT/DAI per quarter - set 4'000'000 limit on PML registry `0x580B23a97F827F2b6E51B3DEc270Ef522Ccf520c` for 3 mos
+
+II. [NO HOLESKY] TMC limits update
+3. [NO HOLESKY] Update TMC limit to 12,000 stETH on TMC registry `0x1a7cFA9EFB4D5BfFDE87B0FaEb1fC65d653868C0` for 6 mos
+4. [NO HOLESKY] Reset the TMC amount spent on TMC registry `0x1a7cFA9EFB4D5BfFDE87B0FaEb1fC65d653868C0`
+
+III. Simply staking reward address change
+5. Change staking reward address to `0x1EC3Cbe8fb1D8019092500CcA2111C158a35bC82` for node operator with id = 16
+"""
+
+def start_vote(tx_params: Dict[str, str], silent: bool) -> bool | list[int | TransactionReceipt | None]:
+    """Prepare and run voting."""
+
+    atc_registry = interface.AllowedRecipientRegistry("0x37675423796D39C19351c5C322C3692b23a3d9bd")
+    pml_registry = interface.AllowedRecipientRegistry("0x580B23a97F827F2b6E51B3DEc270Ef522Ccf520c")
+
+    NO_registry = contracts.node_operators_registry
+    simply_staking_id = 16
+    simply_staking_new_reward_address = "0x1EC3Cbe8fb1D8019092500CcA2111C158a35bC82"
+
+    vote_desc_items, call_script_items = zip(
+        #
+        # I. Change the limits for ET on ATC & PML
+        #
+        (
+            "1. Set 7'000'000 limit on ATC registry `0x37675423796D39C19351c5C322C3692b23a3d9bd` for 3 mos",
+            agent_forward(
+                [
+                set_limit_parameters(
+                    registry_address=atc_registry,
+                    limit=7_000_000 * 10 ** 18,
+                    period_duration_months=3
+                ),
+                ]
+            ),
+        ),
+        (
+            "2. Set 4'000'000 limit on PML registry `0x580B23a97F827F2b6E51B3DEc270Ef522Ccf520c` for 3 mos",
+            agent_forward(
+                [
+                set_limit_parameters(
+                    registry_address=pml_registry,
+                    limit=4_000_000 * 10 ** 18,
+                    period_duration_months=3
+                ),
+                ]
+            ),
+        ),
+        #
+        # III. Simply staking reward address change
+        #
+        (
+            "5. Change staking reward address to `0x1EC3Cbe8fb1D8019092500CcA2111C158a35bC82` for node operator with id = 16",
+            agent_forward(
+                [
+                encode_set_node_operator_reward_address(
+                    simply_staking_id,
+                    simply_staking_new_reward_address,
+                    NO_registry
+                ),
+                ]
+            ),
+        ),
+    )
+
+    vote_items = bake_vote_items(list(vote_desc_items), list(call_script_items))
+
+    if silent:
+        desc_ipfs = calculate_vote_ipfs_description(description)
+    else:
+        desc_ipfs = upload_vote_ipfs_description(description)
+
+    return confirm_vote_script(vote_items, silent, desc_ipfs) and list(
+        create_vote(vote_items, tx_params, desc_ipfs=desc_ipfs)
+    )
+
+
+def main():
+    tx_params = {"from": get_deployer_account()}
+
+    if get_is_live():
+        tx_params["priority_fee"] = get_priority_fee()
+
+    vote_id, _ = start_vote(tx_params=tx_params, silent=False)
+
+    vote_id >= 0 and print(f"Vote created: {vote_id}.")
+
+    time.sleep(5)  # hack for waiting thread #2.