Update deployment-related info and config documentation (#105)

* chore: Update deployment

* docs: Add documentation to config files

* feat: Add both relayers to relayer docker compose

* fix: Fix some fields and descriptions in operator config

contracts/evm/script/output/11155420/sffl_rollup_deployment_output.json

@@ -1,13 +1,13 @@
 {
   "addresses": {
     "deployer": "0x70d266e7089f15a963638Ec358D5975fc8dAfb6E",
-    "sfflPauserReg": "0x7E8c0D7f34A2a4FBC384105b32A5051ce46A3E3E",
-    "sfflProxyAdmin": "0x408dd5765DbE189929a4b2cfc40Ab2F52c310781",
-    "sfflRegistryRollup": "0x6eB9b1FAdCEE1a722B3bCf82c14b6C0067a7f123",
-    "sfflRegistryRollupImpl": "0xBB75932Dcf41cCC6C29B45b656d9e53DeCcb3A6E"
+    "sfflPauserReg": "0xad79Cf487e89a9EFF4D9009941786fe199AC8Cc8",
+    "sfflProxyAdmin": "0xCe0480ae3129f22427BC357Cf4CcC3ae8BcE7397",
+    "sfflRegistryRollup": "0x33335e4Be434724cE003B63eAE499Ce7aaee5508",
+    "sfflRegistryRollupImpl": "0x8Fa979b662c7a881435b89DbAC18cd8054a13254"
   },
   "chainInfo": {
     "chainId": 11155420,
-    "deploymentBlock": 10789059
+    "deploymentBlock": 10963385
   }
 }

contracts/evm/script/output/17000/sffl_avs_deployment_output.json

@@ -1,26 +1,26 @@
 {
   "addresses": {
-    "blsApkRegistry": "0xad79Cf487e89a9EFF4D9009941786fe199AC8Cc8",
-    "blsApkRegistryImpl": "0x7D8d41b1b983b720a3970cA5902c5381cB36b098",
+    "blsApkRegistry": "0x0Fa24eA86e60f8277696bF88A3980a8E07B7e5DA",
+    "blsApkRegistryImpl": "0xcEAD489B343485a85c6B32F4285c424A8F08d4d4",
     "deployer": "0x70d266e7089f15a963638Ec358D5975fc8dAfb6E",
-    "indexRegistry": "0x8Fa979b662c7a881435b89DbAC18cd8054a13254",
-    "indexRegistryImpl": "0x08aA5922785793A90A472A0a581833e74db8939a",
-    "operatorSetUpdateRegistry": "0x33335e4Be434724cE003B63eAE499Ce7aaee5508",
-    "operatorSetUpdateRegistryImpl": "0x2C04749e1A69B8E30A345963E4219A4afc5427C6",
-    "operatorStateRetriever": "0x8fab2e26f88bF284fCc930fD97d3B820b90007D5",
-    "registryCoordinator": "0xCe0480ae3129f22427BC357Cf4CcC3ae8BcE7397",
-    "registryCoordinatorImpl": "0x4C5f683AAb3AFC289AfdBB55190c9fBdf083363a",
-    "sfflPauserReg": "0xBB75932Dcf41cCC6C29B45b656d9e53DeCcb3A6E",
-    "sfflProxyAdmin": "0x7E8c0D7f34A2a4FBC384105b32A5051ce46A3E3E",
-    "sfflServiceManager": "0x6eB9b1FAdCEE1a722B3bCf82c14b6C0067a7f123",
-    "sfflServiceManagerImpl": "0x369ABA1BEa573De5f61Ca6F9638De346709BDC8b",
-    "sfflTaskManager": "0x1D51F418e227c44eA6667f70DE6faac5244a62d0",
-    "sfflTaskManagerImpl": "0xad7E2A061E2eB8c73cF62E43f276d86d27678363",
-    "stakeRegistry": "0xd7AcBEBE84eE95C993CaB4F365CD862D1d278df4",
-    "stakeRegistryImpl": "0xB410Ce56e65aAbd9fa73eB78FA387716Ef7d0c88"
+    "indexRegistry": "0x73966B7E0408BBa2BB80D3f5d3cdFBfaC0e323A3",
+    "indexRegistryImpl": "0x27b085229d64f51308Bd1c635E6Ded607f088686",
+    "operatorSetUpdateRegistry": "0xDb2B0ac0964809bCc041d1d687bCDfe6210a8E25",
+    "operatorSetUpdateRegistryImpl": "0x2aD256BD5bCB23824fE84aA3Ea0e96d9ce0dA6a2",
+    "operatorStateRetriever": "0xE965F1469122641E723CdECd70aa8Ca934Ef4722",
+    "registryCoordinator": "0x692A6ee6eC6f857144d222832fB7Ff44216BC0A7",
+    "registryCoordinatorImpl": "0x490ab5736BE21446f10742D5289590fF16e0683C",
+    "sfflPauserReg": "0x0f13080B1985b828066991A73a62e7E071cB6A00",
+    "sfflProxyAdmin": "0x648EB6B7eB4F6359BB801B277C6c8d9173aDA9CA",
+    "sfflServiceManager": "0x7cfF489e3134c3919519e8F7E9fbE31120907d6D",
+    "sfflServiceManagerImpl": "0x36Ac3831d0f2aDe69A995D2dDAdb3589a42ced30",
+    "sfflTaskManager": "0xf32Ed569277974b5f70fB44b8c8E3cCc2E1061ce",
+    "sfflTaskManagerImpl": "0xE3E3313EE805F14Bea65586047F50fB3690CBd0E",
+    "stakeRegistry": "0x8A668BdFB0406e3dEA3b1fb46400c6Cd849b97B8",
+    "stakeRegistryImpl": "0xc8bCe5E0573D88BE64920EaB2624ee02A3d5C7CA"
   },
   "chainInfo": {
     "chainId": 17000,
-    "deploymentBlock": 1366373
+    "deploymentBlock": 1392446
   }
 }

contracts/evm/script/output/421614/sffl_rollup_deployment_output.json

@@ -1,13 +1,13 @@
 {
   "addresses": {
     "deployer": "0x70d266e7089f15a963638Ec358D5975fc8dAfb6E",
-    "sfflPauserReg": "0x7E8c0D7f34A2a4FBC384105b32A5051ce46A3E3E",
-    "sfflProxyAdmin": "0x408dd5765DbE189929a4b2cfc40Ab2F52c310781",
-    "sfflRegistryRollup": "0x6eB9b1FAdCEE1a722B3bCf82c14b6C0067a7f123",
-    "sfflRegistryRollupImpl": "0xBB75932Dcf41cCC6C29B45b656d9e53DeCcb3A6E"
+    "sfflPauserReg": "0xad79Cf487e89a9EFF4D9009941786fe199AC8Cc8",
+    "sfflProxyAdmin": "0xCe0480ae3129f22427BC357Cf4CcC3ae8BcE7397",
+    "sfflRegistryRollup": "0x33335e4Be434724cE003B63eAE499Ce7aaee5508",
+    "sfflRegistryRollupImpl": "0x8Fa979b662c7a881435b89DbAC18cd8054a13254"
   },
   "chainInfo": {
     "chainId": 421614,
-    "deploymentBlock": 34699056
+    "deploymentBlock": 36095633
   }
 }

setup/aggregator/config/aggregator.yaml

@@ -1,15 +1,28 @@
 # production only prints info and above. development also prints debug
 environment: production
+
+# AVS network RPCs
+# Note that these RPCs must follow some conditions:
+# * It must support block-unbounded eth_getLogs calls
+# * It must support block and event subscription
 eth_rpc_url: https://ethereum-holesky-rpc.publicnode.com
 eth_ws_url: wss://ethereum-holesky-rpc.publicnode.com
-# address which the aggregator listens on for operator signed messages
+
+# Address which the aggregator listens on for operator signed messages
 aggregator_server_ip_port_address: 0.0.0.0:4001
 aggregator_rest_server_ip_port_address: 0.0.0.0:4002
+
+# Aggregator messages database path
 aggregator_database_path: "./db"
+
+# How often the aggregator creates a checkpoint task
 aggregator_checkpoint_interval: 3600000 # ms
+
+# Rollup RPCs and Registry addresses
+# Note that these RPCs must allow event subscriptions
 rollup_ids_to_rpc_urls:
   421614: wss://arbitrum-sepolia-rpc.publicnode.com
   11155420: wss://optimism-sepolia-rpc.publicnode.com
 rollup_ids_to_registry_addresses:
-  421614: 0x6eB9b1FAdCEE1a722B3bCf82c14b6C0067a7f123
-  11155420: 0x6eB9b1FAdCEE1a722B3bCf82c14b6C0067a7f123
+  421614: 0x33335e4Be434724cE003B63eAE499Ce7aaee5508
+  11155420: 0x33335e4Be434724cE003B63eAE499Ce7aaee5508

setup/aggregator/config/deployment/17000.json

@@ -1,26 +1,26 @@
 {
   "addresses": {
-    "blsApkRegistry": "0xad79Cf487e89a9EFF4D9009941786fe199AC8Cc8",
-    "blsApkRegistryImpl": "0x7D8d41b1b983b720a3970cA5902c5381cB36b098",
+    "blsApkRegistry": "0x0Fa24eA86e60f8277696bF88A3980a8E07B7e5DA",
+    "blsApkRegistryImpl": "0xcEAD489B343485a85c6B32F4285c424A8F08d4d4",
     "deployer": "0x70d266e7089f15a963638Ec358D5975fc8dAfb6E",
-    "indexRegistry": "0x8Fa979b662c7a881435b89DbAC18cd8054a13254",
-    "indexRegistryImpl": "0x08aA5922785793A90A472A0a581833e74db8939a",
-    "operatorSetUpdateRegistry": "0x33335e4Be434724cE003B63eAE499Ce7aaee5508",
-    "operatorSetUpdateRegistryImpl": "0x2C04749e1A69B8E30A345963E4219A4afc5427C6",
-    "operatorStateRetriever": "0x8fab2e26f88bF284fCc930fD97d3B820b90007D5",
-    "registryCoordinator": "0xCe0480ae3129f22427BC357Cf4CcC3ae8BcE7397",
-    "registryCoordinatorImpl": "0x4C5f683AAb3AFC289AfdBB55190c9fBdf083363a",
-    "sfflPauserReg": "0xBB75932Dcf41cCC6C29B45b656d9e53DeCcb3A6E",
-    "sfflProxyAdmin": "0x7E8c0D7f34A2a4FBC384105b32A5051ce46A3E3E",
-    "sfflServiceManager": "0x6eB9b1FAdCEE1a722B3bCf82c14b6C0067a7f123",
-    "sfflServiceManagerImpl": "0x369ABA1BEa573De5f61Ca6F9638De346709BDC8b",
-    "sfflTaskManager": "0x1D51F418e227c44eA6667f70DE6faac5244a62d0",
-    "sfflTaskManagerImpl": "0xad7E2A061E2eB8c73cF62E43f276d86d27678363",
-    "stakeRegistry": "0xd7AcBEBE84eE95C993CaB4F365CD862D1d278df4",
-    "stakeRegistryImpl": "0xB410Ce56e65aAbd9fa73eB78FA387716Ef7d0c88"
+    "indexRegistry": "0x73966B7E0408BBa2BB80D3f5d3cdFBfaC0e323A3",
+    "indexRegistryImpl": "0x27b085229d64f51308Bd1c635E6Ded607f088686",
+    "operatorSetUpdateRegistry": "0xDb2B0ac0964809bCc041d1d687bCDfe6210a8E25",
+    "operatorSetUpdateRegistryImpl": "0x2aD256BD5bCB23824fE84aA3Ea0e96d9ce0dA6a2",
+    "operatorStateRetriever": "0xE965F1469122641E723CdECd70aa8Ca934Ef4722",
+    "registryCoordinator": "0x692A6ee6eC6f857144d222832fB7Ff44216BC0A7",
+    "registryCoordinatorImpl": "0x490ab5736BE21446f10742D5289590fF16e0683C",
+    "sfflPauserReg": "0x0f13080B1985b828066991A73a62e7E071cB6A00",
+    "sfflProxyAdmin": "0x648EB6B7eB4F6359BB801B277C6c8d9173aDA9CA",
+    "sfflServiceManager": "0x7cfF489e3134c3919519e8F7E9fbE31120907d6D",
+    "sfflServiceManagerImpl": "0x36Ac3831d0f2aDe69A995D2dDAdb3589a42ced30",
+    "sfflTaskManager": "0xf32Ed569277974b5f70fB44b8c8E3cCc2E1061ce",
+    "sfflTaskManagerImpl": "0xE3E3313EE805F14Bea65586047F50fB3690CBd0E",
+    "stakeRegistry": "0x8A668BdFB0406e3dEA3b1fb46400c6Cd849b97B8",
+    "stakeRegistryImpl": "0xc8bCe5E0573D88BE64920EaB2624ee02A3d5C7CA"
   },
   "chainInfo": {
     "chainId": 17000,
-    "deploymentBlock": 1366373
+    "deploymentBlock": 1392446
   }
 }

setup/operator/config/indexer.yaml

@@ -1,7 +1,12 @@
+# RMQ address
 rmq_address: amqp://rmq:5672
+
+# AVS network contract IDs
 da_contract_ids:
-  - sfrelayer421614-0.testnet
-  - sfrelayer11155420-0.testnet
+  - sfrelayer421614-1.testnet
+  - sfrelayer11155420-1.testnet
+
+# Rollup IDs, must follow the same order as da_contract_ids
 rollup_ids:
   - 421614
   - 11155420

setup/operator/config/operator.yaml

@@ -1,30 +1,46 @@
+
+# Production flag for logging - false for printing debug logs
 production: false
 
+# Operator ECDSA address
 operator_address: 0xD5A0359da7B310917d7760385516B2426E86ab7f
 
-avs_registry_coordinator_address: 0xc3e53F4d16Ae77Db1c982e75a937B9f60FE63690
-operator_state_retriever_address: 0x1613beB3B2C4f22Ee086B2b38C1476A3cE7f78E8
+# AVS contract addresses
+avs_registry_coordinator_address: 0x692A6ee6eC6f857144d222832fB7Ff44216BC0A7
+operator_state_retriever_address: 0xDb2B0ac0964809bCc041d1d687bCDfe6210a8E25
 
+# AVS network RPCs
+# *Important*: The WS RPC must allow event subscriptions. As Public Node
+# doesn't support it, you should use a different RPC provider.
 eth_rpc_url: https://ethereum-holesky-rpc.publicnode.com
-eth_ws_url: wss://ethereum-holesky-rpc.publicnode.com
+eth_ws_url: wss://ethereum-holesky-rpc.publicnode.com # You should change this!
 
-ecdsa_private_key_store_path: keys/ecdsa.json
-bls_private_key_store_path: keys/bls.json
+# EigenLayer ECDSA and BLS private key paths
+ecdsa_private_key_store_path: /near-sffl/config/keys/ecdsa.json
+bls_private_key_store_path: /near-sffl/config/keys/bls.json
 
+# Aggregator server IP and port
 aggregator_server_ip_port_address: near-sffl-aggregator:8090
 
-eigen_metrics_ip_port_address: near-sffl-operator0:9090
+# Operator EigenLayer metrics server IP and port
+eigen_metrics_ip_port_address: 0.0.0.0:9090
 enable_metrics: true
-node_api_ip_port_address: near-sffl-operator0:9010
+node_api_ip_port_address: 0.0.0.0:9010
 enable_node_api: true
 
+# Whether to try and register the operator in the AVS and in EL on startup
+# If set, it will not re-register the operator if already registered
 register_operator_on_startup: true
-token_strategy_addr: 0x0000000000000000000000000000000000000000
 
+# RMQ address and indexer rollup IDs
 near_da_indexer_rmq_ip_port_address: amqp://rmq:5672
-near_da_indexer_rollup_ids: [17000, 421614, 11155420]
+near_da_indexer_rollup_ids: [421614, 11155420]
 
+# Rollup RPCs
 rollup_ids_to_rpc_urls:
-  17000: wss://ethereum-holesky-rpc.publicnode.com
   421614: wss://arbitrum-sepolia-rpc.publicnode.com
   11155420: wss://optimism-sepolia-rpc.publicnode.com
+
+# Token strategy address
+# Mock strategy to deposit when registering (only used for testing)
+token_strategy_addr: 0x0000000000000000000000000000000000000000

setup/relayer/.env.example

@@ -2,9 +2,6 @@
 # Tagged release for SFFL containers
 SFFL_RELEASE=latest
 
-# RPC URL of the rollup
-ROLLUP_RPC_URL=wss://arbitrum-sepolia-rpc.publicnode.com
-
 # NEAR chain ID
 NEAR_CHAIN_ID=testnet
 
@@ -13,6 +10,3 @@ NEAR_KEYS_DIR=~/.near-credentials
 
 # RPC URL of the NEAR network
 NEAR_RPC_URL=https://rpc.testnet.near.org
-
-# ID of the relayer DA account
-NEAR_DA_ACCOUNT_ID=sfrelayer421614-0.testnet

setup/relayer/docker-compose.yml

@@ -1,16 +1,31 @@
 version: "3"
 
 services:
-  relayer:
+  relayer_421614:
     image: ghcr.io/nethermindeth/near-sffl/relayer:${SFFL_RELEASE}
-    container_name: near-sffl-relayer
+    container_name: near-sffl-relayer-421614
     volumes:
       - ${NEAR_KEYS_DIR}:/root/.near-credentials
     command:
       - --rpc-url
-      - ${ROLLUP_RPC_URL}
+      - wss://arbitrum-sepolia-rpc.publicnode.com
       - --da-account-id
-      - ${NEAR_DA_ACCOUNT_ID}
+      - sfrelayer421614-1.testnet
+      - --key-path
+      - /root/.near-credentials/${NEAR_CHAIN_ID}/${NEAR_DA_ACCOUNT_ID}.json
+      - --network
+      - ${NEAR_RPC_URL}
+
+  relayer_11155420:
+    image: ghcr.io/nethermindeth/near-sffl/relayer:${SFFL_RELEASE}
+    container_name: near-sffl-relayer-11155420
+    volumes:
+      - ${NEAR_KEYS_DIR}:/root/.near-credentials
+    command:
+      - --rpc-url
+      - wss://optimism-sepolia-rpc.publicnode.com
+      - --da-account-id
+      - sfrelayer11155420-1.testnet
       - --key-path
       - /root/.near-credentials/${NEAR_CHAIN_ID}/${NEAR_DA_ACCOUNT_ID}.json
       - --network