Add stack for steer-protocol watcher

2024-10-13 20:44:04 +05:30 · 2024-10-13 20:44:04 +05:30 · babca78661
commit babca78661
parent 5b954a9dcd
10 changed files with 405 additions and 0 deletions
--- a/stacks/README.md
+++ b/stacks/README.md
@ -0,0 +1,3 @@
+# steer-protocol-watcher-stack
+
+- [steer-protocol-watcher](stack-orchestrator/stacks/steer-protocol)
--- a/stacks/stack-orchestrator/compose/docker-compose-watcher-steer-protocol.yml
+++ b/stacks/stack-orchestrator/compose/docker-compose-watcher-steer-protocol.yml
@ -0,0 +1,82 @@
+version: '3.2'
+
+services:
+  steer-protocol-watcher-db:
+    restart: unless-stopped
+    image: postgres:14-alpine
+    environment:
+      - POSTGRES_USER=vdbm
+      - POSTGRES_MULTIPLE_DATABASES=steer-protocol-watcher,steer-protocol-watcher-job-queue
+      - POSTGRES_EXTENSION=steer-protocol-watcher-job-queue:pgcrypto
+      - POSTGRES_PASSWORD=password
+    volumes:
+      - ../config/postgresql/multiple-postgressql-databases.sh:/docker-entrypoint-initdb.d/multiple-postgressql-databases.sh
+      - steer_protocol_watcher_db_data:/var/lib/postgresql/data
+    ports:
+      - "5432"
+    healthcheck:
+      test: ["CMD", "nc", "-v", "localhost", "5432"]
+      interval: 20s
+      timeout: 5s
+      retries: 15
+      start_period: 10s
+
+  steer-protocol-watcher-job-runner:
+    restart: unless-stopped
+    depends_on:
+      steer-protocol-watcher-db:
+        condition: service_healthy
+    image: cerc/watcher-steer-protocol:local
+    environment:
+      CERC_SCRIPT_DEBUG: ${CERC_SCRIPT_DEBUG}
+      CERC_GQL_SERVER_PATH: ${CERC_GQL_SERVER_PATH:-/graphql}
+      CERC_ETH_RPC_SERVER_PATH: ${CERC_ETH_RPC_SERVER_PATH:-/rpc}
+      CERC_ETH_RPC_ENDPOINTS: ${CERC_ETH_RPC_ENDPOINTS}
+    command: ["bash", "./start-job-runner.sh"]
+    volumes:
+      - ../config/watcher-steer-protocol/watcher-config-template.toml:/app/environments/watcher-config-template.toml
+      - ../config/watcher-steer-protocol/start-job-runner.sh:/app/start-job-runner.sh
+    ports:
+      - "9000"
+    healthcheck:
+      test: ["CMD", "nc", "-vz", "127.0.0.1", "9000"]
+      interval: 20s
+      timeout: 5s
+      retries: 15
+      start_period: 5s
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
+
+  steer-protocol-watcher-server:
+    restart: unless-stopped
+    depends_on:
+      steer-protocol-watcher-db:
+        condition: service_healthy
+      steer-protocol-watcher-job-runner:
+        condition: service_healthy
+    image: cerc/watcher-steer-protocol:local
+    environment:
+      CERC_SCRIPT_DEBUG: ${CERC_SCRIPT_DEBUG}
+      CERC_GQL_SERVER_PATH: ${CERC_GQL_SERVER_PATH:-/graphql}
+      CERC_ETH_RPC_SERVER_PATH: ${CERC_ETH_RPC_SERVER_PATH:-/rpc}
+      CERC_ETH_RPC_ENDPOINTS: ${CERC_ETH_RPC_ENDPOINTS}
+    command: ["bash", "./start-server.sh"]
+    volumes:
+      - ../config/watcher-steer-protocol/watcher-config-template.toml:/app/environments/watcher-config-template.toml
+      - ../config/watcher-steer-protocol/start-server.sh:/app/start-server.sh
+      - steer_protocol_watcher_gql_logs_data:/app/gql-logs
+    ports:
+      - "3008"
+      - "9001"
+    healthcheck:
+      test: ["CMD", "nc", "-vz", "127.0.0.1", "3008"]
+      interval: 20s
+      timeout: 5s
+      retries: 15
+      start_period: 5s
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
+
+volumes:
+  steer_protocol_watcher_db_data:
+  steer_protocol_watcher_gql_logs_data:
--- a/stacks/stack-orchestrator/config/watcher-steer-protocol/start-job-runner.sh
+++ b/stacks/stack-orchestrator/config/watcher-steer-protocol/start-job-runner.sh
@ -0,0 +1,29 @@
+#!/bin/sh
+
+set -e
+if [ -n "$CERC_SCRIPT_DEBUG" ]; then
+  set -x
+fi
+set -u
+
+echo "Using env variables:"
+echo "CERC_GQL_SERVER_PATH: ${CERC_GQL_SERVER_PATH}"
+echo "CERC_ETH_RPC_SERVER_PATH: ${CERC_ETH_RPC_SERVER_PATH}"
+echo "CERC_ETH_RPC_ENDPOINTS: ${CERC_ETH_RPC_ENDPOINTS}"
+
+# Read in the config template TOML file and modify it
+WATCHER_CONFIG_TEMPLATE=$(cat environments/watcher-config-template.toml)
+
+# Convert the comma-separated list in CERC_ETH_RPC_ENDPOINTS to a JSON array
+RPC_ENDPOINTS_ARRAY=$(echo "$CERC_ETH_RPC_ENDPOINTS" | tr ',' '\n' | awk '{print "\"" $0 "\""}' | paste -sd, - | sed 's/^/[/; s/$/]/')
+
+WATCHER_CONFIG=$(echo "$WATCHER_CONFIG_TEMPLATE" | \
+  sed -E "s|REPLACE_WITH_CERC_GQL_SERVER_PATH|\"${CERC_GQL_SERVER_PATH}\"|g; \
+          s|REPLACE_WITH_CERC_ETH_RPC_SERVER_PATH|\"${CERC_ETH_RPC_SERVER_PATH}\"|g; \
+          s|REPLACE_WITH_CERC_ETH_RPC_ENDPOINTS|${RPC_ENDPOINTS_ARRAY}| ")
+
+# Write the modified content to a new file
+echo "$WATCHER_CONFIG" > environments/local.toml
+
+echo "Running job-runner..."
+DEBUG=vulcanize:* exec node --enable-source-maps dist/job-runner.js
--- a/stacks/stack-orchestrator/config/watcher-steer-protocol/start-server.sh
+++ b/stacks/stack-orchestrator/config/watcher-steer-protocol/start-server.sh
@ -0,0 +1,29 @@
+#!/bin/sh
+
+set -e
+if [ -n "$CERC_SCRIPT_DEBUG" ]; then
+  set -x
+fi
+set -u
+
+echo "Using env variables:"
+echo "CERC_GQL_SERVER_PATH: ${CERC_GQL_SERVER_PATH}"
+echo "CERC_ETH_RPC_SERVER_PATH: ${CERC_ETH_RPC_SERVER_PATH}"
+echo "CERC_ETH_RPC_ENDPOINTS: ${CERC_ETH_RPC_ENDPOINTS}"
+
+# Read in the config template TOML file and modify it
+WATCHER_CONFIG_TEMPLATE=$(cat environments/watcher-config-template.toml)
+
+# Convert the comma-separated list in CERC_ETH_RPC_ENDPOINTS to a JSON array
+RPC_ENDPOINTS_ARRAY=$(echo "$CERC_ETH_RPC_ENDPOINTS" | tr ',' '\n' | awk '{print "\"" $0 "\""}' | paste -sd, - | sed 's/^/[/; s/$/]/')
+
+WATCHER_CONFIG=$(echo "$WATCHER_CONFIG_TEMPLATE" | \
+  sed -E "s|REPLACE_WITH_CERC_GQL_SERVER_PATH|\"${CERC_GQL_SERVER_PATH}\"|g; \
+          s|REPLACE_WITH_CERC_ETH_RPC_SERVER_PATH|\"${CERC_ETH_RPC_SERVER_PATH}\"|g; \
+          s|REPLACE_WITH_CERC_ETH_RPC_ENDPOINTS|${RPC_ENDPOINTS_ARRAY}| ")
+
+# Write the modified content to a new file
+echo "$WATCHER_CONFIG" > environments/local.toml
+
+echo "Running server..."
+DEBUG=vulcanize:* exec node --enable-source-maps dist/server.js
--- a/stacks/stack-orchestrator/config/watcher-steer-protocol/watcher-config-template.toml
+++ b/stacks/stack-orchestrator/config/watcher-steer-protocol/watcher-config-template.toml
@ -0,0 +1,121 @@
+[server]
+  host = "0.0.0.0"
+  port = 3008
+  kind = "active"
+
+  # Checkpointing state.
+  checkpointing = true
+
+  # Checkpoint interval in number of blocks.
+  checkpointInterval = 2000
+
+  # Enable state creation
+  enableState = false
+
+  subgraphPath = "./subgraph-build"
+
+  # Interval to restart wasm instance periodically
+  wasmRestartBlocksInterval = 20
+
+  # Interval in number of blocks at which to clear entities cache.
+  clearEntitiesCacheInterval = 1000
+
+  # Flag to specify whether RPC endpoint supports block hash as block tag parameter
+  rpcSupportsBlockHashParam = false
+
+  # GQL server config
+  [server.gql]
+    path = REPLACE_WITH_CERC_GQL_SERVER_PATH
+
+    # Max block range for which to return events in eventsInRange GQL query.
+    # Use -1 for skipping check on block range.
+    maxEventsBlockRange = 1000
+
+    # Log directory for GQL requests
+    logDir = "./gql-logs"
+
+    # GQL cache settings
+    [server.gql.cache]
+      enabled = true
+
+      # Max in-memory cache size (in bytes) (default 8 MB)
+      # maxCacheSize
+
+      # GQL cache-control max-age settings (in seconds)
+      maxAge = 15
+      timeTravelMaxAge = 86400 # 1 day
+
+  # ETH RPC server config
+  [server.ethRPC]
+    enabled = true
+    path = REPLACE_WITH_CERC_ETH_RPC_SERVER_PATH
+
+    # Max number of logs that can be returned in a single getLogs request (default: 10000)
+    getLogsResultLimit = 10000
+
+[metrics]
+  host = "0.0.0.0"
+  port = 9000
+  [metrics.gql]
+    port = 9001
+
+[database]
+  type = "postgres"
+  host = "steer-protocol-watcher-db"
+  port = 5432
+  database = "steer-protocol-watcher"
+  username = "vdbm"
+  password = "password"
+  synchronize = true
+  logging = false
+
+[upstream]
+  [upstream.ethServer]
+    rpcProviderEndpoints = REPLACE_WITH_CERC_ETH_RPC_ENDPOINTS
+
+    # Boolean flag to specify if rpc-eth-client should be used for RPC endpoint instead of ipld-eth-client (ipld-eth-server GQL client)
+    rpcClient = true
+
+    # Boolean flag to specify if rpcProviderEndpoint is an FEVM RPC endpoint
+    isFEVM = true
+
+    # Boolean flag to filter event logs by contracts
+    filterLogsByAddresses = true
+    # Boolean flag to filter event logs by topics
+    filterLogsByTopics = true
+
+    # Switch clients if eth_getLogs call takes more than threshold (in secs)
+    # Set to 0 for disabling switching
+    getLogsClientSwitchThresholdInSecs = 30
+
+  [upstream.cache]
+    name = "requests"
+    enabled = false
+    deleteOnStart = false
+
+[jobQueue]
+  dbConnectionString = "postgres://vdbm:password@steer-protocol-watcher-db/steer-protocol-watcher-job-queue"
+  maxCompletionLagInSecs = 300
+  jobDelayInMilliSecs = 100
+  eventsInBatch = 50
+  subgraphEventsOrder = true
+  # Filecoin block time: https://docs.filecoin.io/basics/the-blockchain/blocks-and-tipsets#blocktime
+  blockDelayInMilliSecs = 30000
+
+  # Number of blocks by which block processing lags behind head
+  blockProcessingOffset = 0
+
+  # Boolean to switch between modes of processing events when starting the server.
+  # Setting to true will fetch filtered events and required blocks in a range of blocks and then process them.
+  # Setting to false will fetch blocks consecutively with its events and then process them (Behaviour is followed in realtime processing near head).
+  useBlockRanges = true
+
+  # Block range in which logs are fetched during historical blocks processing
+  historicalLogsBlockRange = 2000
+
+  # Max block range of historical processing after which it waits for completion of events processing
+  # If set to -1 historical processing does not wait for events processing and completes till latest canonical block
+  historicalMaxFetchAhead = 10000
+
+  # Max number of retries to fetch new block after which watcher will failover to other RPC endpoints
+  maxNewBlockRetries = 3
--- a/stacks/stack-orchestrator/container-build/cerc-watcher-steer-protocol/.dockerignore
+++ b/stacks/stack-orchestrator/container-build/cerc-watcher-steer-protocol/.dockerignore
@ -0,0 +1 @@
+stacks
--- a/stacks/stack-orchestrator/container-build/cerc-watcher-steer-protocol/Dockerfile
+++ b/stacks/stack-orchestrator/container-build/cerc-watcher-steer-protocol/Dockerfile
@ -0,0 +1,15 @@
+FROM node:18.17.1-alpine3.18
+
+RUN apk --update --no-cache add git python3 alpine-sdk bash curl jq
+
+WORKDIR /app
+
+COPY . .
+
+# Get the latest Git commit hash and set in package.json
+RUN COMMIT_HASH=$(git rev-parse HEAD) && \
+  jq --arg commitHash "$COMMIT_HASH" '.commitHash = $commitHash' package.json > tmp.json && \
+  mv tmp.json package.json
+
+RUN echo "Installing dependencies and building steer-protocol-watcher-ts" && \
+  yarn && yarn build
--- a/stacks/stack-orchestrator/container-build/cerc-watcher-steer-protocol/build.sh
+++ b/stacks/stack-orchestrator/container-build/cerc-watcher-steer-protocol/build.sh
@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+# Build cerc/watcher-steer-protocol
+
+source ${CERC_CONTAINER_BASE_DIR}/build-base.sh
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+
+docker build -t cerc/watcher-steer-protocol:local -f ${SCRIPT_DIR}/Dockerfile ${build_command_args} ${CERC_REPO_BASE_DIR}/steer-protocol-watcher-ts
--- a/stacks/stack-orchestrator/stacks/steer-protocol/README.md
+++ b/stacks/stack-orchestrator/stacks/steer-protocol/README.md
@ -0,0 +1,110 @@
+# SteerProtocol Watcher
+
+## Clone the stack repo
+
+```bash
+laconic-so fetch-stack git.vdb.to/cerc-io/steer-protocol-watcher-ts
+```
+
+## Build the container image
+
+```bash
+laconic-so --stack ~/cerc/steer-protocol-watcher-ts/stacks/stack-orchestrator/stacks/steer-protocol build-containers
+```
+
+## Create a spec file for the deployment
+
+```bash
+laconic-so --stack ~/cerc/steer-protocol-watcher-ts/stacks/stack-orchestrator/stacks/steer-protocol deploy init --output steer-protocol-spec.yml
+```
+
+### Ports
+
+Edit `network` in the spec file to map container ports to host ports as required:
+
+```yml
+...
+network:
+  ports:
+    steer-protocol-watcher-db:
+      - 15432:5432
+    steer-protocol-watcher-job-runner:
+      - 9000:9000
+    steer-protocol-watcher-server:
+      - 3008:3008
+      - 9001:9001
+```
+
+## Create a deployment from the spec file
+
+```bash
+laconic-so --stack ~/cerc/steer-protocol-watcher-ts/stacks/stack-orchestrator/stacks/steer-protocol deploy create --spec-file steer-protocol-spec.yml --deployment-dir steer-protocol-deployment
+```
+
+### Configuration
+
+Inside deployment directory, open the `config.env` file  and set following env variables:
+
+```bash
+# External Filecoin (ETH RPC) endpoint to point the watcher to
+CERC_ETH_RPC_ENDPOINTS=https://example-lotus-endpoint-1/rpc/v1,https://example-lotus-endpoint-2/rpc/v1
+
+# GQL path of watcher to set in config (server.gql.path)
+CERC_GQL_SERVER_PATH=/graphql
+
+# ETH RPC path of watcher to set in config (server.ethRPC.path)
+CERC_ETH_RPC_SERVER_PATH=/rpc
+```
+
+## Start the deployment
+
+```bash
+laconic-so deployment --dir steer-protocol-deployment start
+```
+
+* To list down and monitor the running containers:
+
+  ```bash
+  # With status
+  docker ps -a
+
+  # Check logs for a container
+  docker logs -f <CONTAINER_ID>
+  ```
+
+* Open the GQL playground at <http://localhost:3008/graphql>
+
+  ```graphql
+  # Example query
+  query {
+    _meta {
+      block {
+        hash
+        number
+        timestamp
+      }
+      deployment
+      hasIndexingErrors
+    }
+  ```
+
+## Clean up
+
+Stop all the steer-protocol services running in background:
+
+```bash
+# Only stop the docker containers
+laconic-so deployment --dir steer-protocol-deployment stop
+
+# Run 'start' to restart the deployment
+```
+
+To stop all the steer-protocol services and also delete data:
+
+```bash
+# Stop the docker containers
+laconic-so deployment --dir steer-protocol-deployment stop --delete-volumes
+
+# Remove deployment directory (deployment will have to be recreated for a re-run)
+rm -r steer-protocol-deployment
+```
--- a/stacks/stack-orchestrator/stacks/steer-protocol/stack.yml
+++ b/stacks/stack-orchestrator/stacks/steer-protocol/stack.yml
@ -0,0 +1,8 @@
+version: "1.0"
+name: steer-protocol
+description: "SteerProtocol watcher stack"
+repos:
+containers:
+  - cerc/watcher-steer-protocol
+pods:
+  - watcher-steer-protocol