feat: csm -> staking module(s)

Author: vgorkavenko

.env.example

@@ -2,7 +2,7 @@ CONSENSUS_CLIENT_URI=http://...
 EXECUTION_CLIENT_URI=http://...
 KEYS_API_URI=https://...
 LIDO_LOCATOR_ADDRESS=0x1...
-CSM_MODULE_ADDRESS=0x...
+STAKING_MODULE_ADDRESS=0x...
 MEMBER_PRIV_KEY=aaa...
 PINATA_JWT=...
 STORACHA_AUTH_SECRET=...

.github/PULL_REQUEST_TEMPLATE.md

@@ -14,4 +14,4 @@ Describe how you tested the changes:
 ## Checklist
 - [ ] Documentation updated (if required)
 - [ ] New tests added (if applicable)
-- [ ] `CSM_STATE_VERSION` is bumped (if the new version affects data in the cache)
+- [ ] `STAKING_MODULE_STATE_VERSION` is bumped (if the new version affects data in the cache)

.github/workflows/ci-daily-checks.yml

@@ -22,7 +22,7 @@ jobs:
           CONSENSUS_CLIENT_URI: ${{ secrets.CONSENSUS_CLIENT_URI }}
           KEYS_API_URI: ${{ secrets.KEYS_API_URI }}
           LIDO_LOCATOR_ADDRESS: ${{ secrets.LIDO_LOCATOR_ADDRESS }}
-          CSM_MODULE_ADDRESS: ${{ secrets.CSM_MODULE_ADDRESS }}
+          STAKING_MODULE_ADDRESS: ${{ secrets.CSM_MODULE_ADDRESS }}
           PINATA_JWT: ${{ secrets.PINATA_JWT }}
           PINATA_DEDICATED_GATEWAY_URL: ${{ secrets.PINATA_DEDICATED_GATEWAY_URL }}
           PINATA_DEDICATED_GATEWAY_TOKEN: ${{ secrets.PINATA_DEDICATED_GATEWAY_TOKEN}}

.github/workflows/mainnet_fork_tests.yml

@@ -26,38 +26,6 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      # TODO: Remove after upgrade to CSM v2 on Mainnet.
-      - name: Checkout CSM repo
-        uses: actions/checkout@v4
-        with:
-          repository: 'lidofinance/community-staking-module'
-          ref: 'develop'
-          path: 'testruns/community-staking-module'
-          persist-credentials: false
-
-      - name: Install Foundry
-        uses: foundry-rs/foundry-toolchain@v1
-        with:
-          version: ${{ env.FORGE_REV }}
-
-      - name: Install node
-        uses: actions/setup-node@v4
-        with:
-          node-version-file: "testruns/community-staking-module/.nvmrc"
-          cache: 'yarn'
-          cache-dependency-path: "testruns/community-staking-module/yarn.lock"
-
-      - name: Install Just
-        run: cargo install "[email protected]"
-
-      - name: Install dependencies
-        working-directory: testruns/community-staking-module
-        run: just deps
-
-      - name: Build contracts
-        working-directory: testruns/community-staking-module
-        run: just build
-
       - name: Set up Python 3.12
         uses: actions/setup-python@v4
         with:
@@ -82,7 +50,7 @@ jobs:
           CONSENSUS_CLIENT_URI: ${{ secrets.CONSENSUS_CLIENT_URI }}
           KEYS_API_URI: ${{ secrets.KEYS_API_URI }}
           LIDO_LOCATOR_ADDRESS: "0xC1d0b3DE6792Bf6b4b37EccdcC24e45978Cfd2Eb"
-          CSM_MODULE_ADDRESS: "0xdA7dE2ECdDfccC6c3AF10108Db212ACBBf9EA83F"
+          STAKING_MODULE_ADDRESS: "0xdA7dE2ECdDfccC6c3AF10108Db212ACBBf9EA83F"
           PINATA_JWT: ${{ secrets.PINATA_JWT }}
           PINATA_DEDICATED_GATEWAY_URL: ${{ secrets.PINATA_DEDICATED_GATEWAY_URL }}
           PINATA_DEDICATED_GATEWAY_TOKEN: ${{ secrets.PINATA_DEDICATED_GATEWAY_TOKEN }}

.github/workflows/tests.yml

@@ -40,7 +40,7 @@ jobs:
           TESTNET_EXECUTION_CLIENT_URI: ${{ secrets.TESTNET_EXECUTION_CLIENT_URI }}
           TESTNET_CONSENSUS_CLIENT_URI: ${{ secrets.TESTNET_CONSENSUS_CLIENT_URI }}
           TESTNET_KAPI_URI: ${{ secrets.TESTNET_KAPI_URI }}
-          CSM_MODULE_ADDRESS: "0xdA7dE2ECdDfccC6c3AF10108Db212ACBBf9EA83F"
+          STAKING_MODULE_ADDRESS: "0xdA7dE2ECdDfccC6c3AF10108Db212ACBBf9EA83F"
           PINATA_JWT: ${{ secrets.PINATA_JWT }}
           PINATA_DEDICATED_GATEWAY_URL: ${{ secrets.PINATA_DEDICATED_GATEWAY_URL }}
           PINATA_DEDICATED_GATEWAY_TOKEN: ${{ secrets.PINATA_DEDICATED_GATEWAY_TOKEN }}

README.md

@@ -23,7 +23,7 @@ services:
 
   postgres:
     image: postgres:15
-    container_name: csm-oracle-postgres
+    container_name: staking-module-oracle-postgres
     environment:
       POSTGRES_USER: ${PERFORMANCE_DB_ADMIN_USER:-postgres}
       POSTGRES_PASSWORD: ${PERFORMANCE_DB_ADMIN_PASSWORD:-postgres}
@@ -43,7 +43,7 @@ services:
   # For external PostgreSQL: set PERFORMANCE_DB_HOST to your external host
   init-db:
     image: postgres:15
-    container_name: csm-oracle-init-db
+    container_name: staking-module-oracle-init-db
     depends_on:
       postgres:
         condition: service_healthy
@@ -62,7 +62,7 @@ services:
 
   performance-collector:
     build: .
-    container_name: csm-oracle-performance-collector
+    container_name: staking-module-oracle-performance-collector
     command: ["-m", "src.main", "performance_collector"]
     depends_on:
       init-db:
@@ -80,7 +80,7 @@ services:
 
   performance-web:
     build: .
-    container_name: csm-oracle-performance-web
+    container_name: staking-module-oracle-performance-web
     command: ["-m", "src.main", "performance_web_server"]
     depends_on:
       init-db:
@@ -94,15 +94,15 @@ services:
       test: ["CMD", "curl", "-f", "http://localhost:9020/health"]
 
   # ---------------------------------------------------------------------------
-  # CSM Oracle
+  # Staking Module Oracles
   # ---------------------------------------------------------------------------
 
   csm-oracle:
     build: .
     container_name: csm-oracle
     command: ["-m", "src.main", "csm"]
     environment:
-      CSM_MODULE_ADDRESS: ${CSM_MODULE_ADDRESS}
+      STAKING_MODULE_ADDRESS: ${STAKING_MODULE_ADDRESS}
       CONSENSUS_CLIENT_URI: ${CONSENSUS_CLIENT_URI}
       EXECUTION_CLIENT_URI: ${EXECUTION_CLIENT_URI}
       KEYS_API_URI: ${KEYS_API_URI}
@@ -119,6 +119,28 @@ services:
       <<: *healthcheck-defaults
       test: ["CMD", "curl", "-f", "http://localhost:9010/healthcheck"]
 
+#  cm-oracle:
+#    build: .
+#    container_name: cm-oracle
+#    command: ["-m", "src.main", "cm"]
+#    environment:
+#      STAKING_MODULE_ADDRESS: ${STAKING_MODULE_ADDRESS}
+#      CONSENSUS_CLIENT_URI: ${CONSENSUS_CLIENT_URI}
+#      EXECUTION_CLIENT_URI: ${EXECUTION_CLIENT_URI}
+#      KEYS_API_URI: ${KEYS_API_URI}
+#      PERFORMANCE_COLLECTOR_URI: http://performance-web:9020/
+#      LIDO_IPFS_HOST: ${LIDO_IPFS_HOST:-}
+#      LIDO_IPFS_TOKEN: ${LIDO_IPFS_TOKEN:-}
+#      PROMETHEUS_PORT: 9000
+#      HEALTHCHECK_SERVER_PORT: 9010
+#    ports:
+#      - "${CSM_ORACLE_PROMETHEUS_PORT:-9002}:9000"
+#      - "${CSM_ORACLE_HEALTH_PORT:-9012}:9010"
+#    restart: unless-stopped
+#    healthcheck:
+#      <<: *healthcheck-defaults
+#      test: ["CMD", "curl", "-f", "http://localhost:9010/healthcheck"]
+
 volumes:
   postgres-data:
 

docker-compose.yml

@@ -40,14 +40,14 @@ export KEYS_API_URI=...
 export LIDO_LOCATOR_ADDRESS=...
 ```
 
-Required variables for CSM module
+Required variables for Staking Module Oracle
 
 ```bash
 export EXECUTION_CLIENT_URI=...
 export CONSENSUS_CLIENT_URI=...
 export KEYS_API_URI=...
 export LIDO_LOCATOR_ADDRESS=...
-export CSM_MODULE_ADDRESS=...
+export STAKING_MODULE_ADDRESS=...
 export MAX_CYCLE_LIFETIME_IN_SECONDS=60000  # Reasonable high value to make sure the oracle has enough time to process the whole frame.
 ```
 
@@ -67,6 +67,7 @@ Where `<module>` is one of:
 - `accounting`
 - `ejector`
 - `csm`
+- `cm`
 - `check`
 
 ## Code quality

docs/development.md

@@ -1,6 +1,7 @@
 from packaging.version import Version
 
 from src.types import Gwei
+from src.variables import STAKING_MODULE_ADDRESS
 
 # https://github.com/ethereum/consensus-specs/blob/dev/specs/phase0/beacon-chain.md#misc
 FAR_FUTURE_EPOCH = 2**64 - 1
@@ -50,7 +51,7 @@
 SHARE_RATE_PRECISION_E27 = 10**PRECISION_E27
 TOTAL_BASIS_POINTS = 10000
 
-# Lido CSM constants for network performance calculation
+# Lido Staking Module constants for network performance calculation
 ATTESTATIONS_WEIGHT = 54
 BLOCKS_WEIGHT = 8
 SYNC_WEIGHT = 2
@@ -62,7 +63,7 @@
 UINT256_MAX = 2**256 - 1
 
 ALLOWED_KAPI_VERSION = Version('1.5.0')
-CSM_STATE_VERSION = 1
-CSM_LOGS_VERSION = 1
+STAKING_MODULE_STATE_VERSION = 1
+STAKING_MODULE_LOGS_VERSION = 1
 
 GENESIS_VALIDATORS_ROOT = bytes([0] * 32)  # all zeros for deposits

src/constants.py

@@ -44,9 +44,13 @@ def main(module: OracleModule):
         return ejector_entrypoint.run()
 
     if module is OracleModule.CSM:
-        from src.modules.oracles.csm import entrypoint as csm_entrypoint
+        from src.modules.oracles.staking_modules.community_staking import entrypoint as csm_entrypoint
         return csm_entrypoint.run()
 
+    if module is OracleModule.CM:
+        from src.modules.oracles.staking_modules.curated import entrypoint as cm_entrypoint
+        return cm_entrypoint.run()
+
     raise ValueError(f'Unknown module {module}')