From b41b1fc3155b88f187ad5fecbed01364aa539cc5 Mon Sep 17 00:00:00 2001 From: Nabarun Gogoi Date: Thu, 30 May 2024 11:24:30 +0530 Subject: [PATCH] Create stack for running secured-finanace-watcher-ts (#1) * Clone required repositories * Build container for stack * Create deployment from spec file * Rename directories * Update README for clean up steps * Update README --------- Co-authored-by: neeraj --- README.md | 6 +- ...docker-compose-watcher-secured-finance.yml | 76 ++++++++++++ .../start-job-runner.sh | 24 ++++ .../watcher-secured-finance/start-server.sh | 24 ++++ .../watcher-config-template.toml | 101 ++++++++++++++++ .../cerc-watcher-secured-finance/Dockerfile | 10 ++ .../cerc-watcher-secured-finance/build.sh | 7 ++ .../stacks/secured-finance/README.md | 110 ++++++++++++++++++ .../stacks/secured-finance/stack.yml | 9 ++ 9 files changed, 366 insertions(+), 1 deletion(-) create mode 100644 stack-orchestrator/compose/docker-compose-watcher-secured-finance.yml create mode 100755 stack-orchestrator/config/watcher-secured-finance/start-job-runner.sh create mode 100755 stack-orchestrator/config/watcher-secured-finance/start-server.sh create mode 100644 stack-orchestrator/config/watcher-secured-finance/watcher-config-template.toml create mode 100644 stack-orchestrator/container-build/cerc-watcher-secured-finance/Dockerfile create mode 100755 stack-orchestrator/container-build/cerc-watcher-secured-finance/build.sh create mode 100644 stack-orchestrator/stacks/secured-finance/README.md create mode 100644 stack-orchestrator/stacks/secured-finance/stack.yml diff --git a/README.md b/README.md index fd671fb..3246cc3 100644 --- a/README.md +++ b/README.md @@ -1 +1,5 @@ -# secured-finance-watcher-stack \ No newline at end of file +# secured-finance-watcher-stack + +Stack definitions for [Secured finance watcher](https://git.vdb.to/cerc-io/secured-finance-watcher-ts). + +[stack documentation](./stack-orchestrator/stacks/secured-finance/README.md) diff --git a/stack-orchestrator/compose/docker-compose-watcher-secured-finance.yml b/stack-orchestrator/compose/docker-compose-watcher-secured-finance.yml new file mode 100644 index 0000000..fc0cd2b --- /dev/null +++ b/stack-orchestrator/compose/docker-compose-watcher-secured-finance.yml @@ -0,0 +1,76 @@ +version: '3.2' + +services: + secured-finance-watcher-db: + restart: unless-stopped + image: postgres:14-alpine + environment: + - POSTGRES_USER=vdbm + - POSTGRES_MULTIPLE_DATABASES=secured-finance-watcher,secured-finance-watcher-job-queue + - POSTGRES_EXTENSION=secured-finance-watcher-job-queue:pgcrypto + - POSTGRES_PASSWORD=password + volumes: + - ../config/postgresql/multiple-postgressql-databases.sh:/docker-entrypoint-initdb.d/multiple-postgressql-databases.sh + - secured_finance_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 + + secured-finance-watcher-job-runner: + restart: unless-stopped + depends_on: + secured-finance-watcher-db: + condition: service_healthy + image: cerc/watcher-secured-finance:local + environment: + CERC_SCRIPT_DEBUG: ${CERC_SCRIPT_DEBUG} + CERC_ETH_RPC_ENDPOINTS: ${CERC_ETH_RPC_ENDPOINTS} + command: ["bash", "./start-job-runner.sh"] + volumes: + - ../config/watcher-secured-finance/watcher-config-template.toml:/app/environments/watcher-config-template.toml + - ../config/watcher-secured-finance/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" + + secured-finance-watcher-server: + restart: unless-stopped + depends_on: + secured-finance-watcher-db: + condition: service_healthy + secured-finance-watcher-job-runner: + condition: service_healthy + image: cerc/watcher-secured-finance:local + environment: + CERC_SCRIPT_DEBUG: ${CERC_SCRIPT_DEBUG} + CERC_ETH_RPC_ENDPOINTS: ${CERC_ETH_RPC_ENDPOINTS} + command: ["bash", "./start-server.sh"] + volumes: + - ../config/watcher-secured-finance/watcher-config-template.toml:/app/environments/watcher-config-template.toml + - ../config/watcher-secured-finance/start-server.sh:/app/start-server.sh + 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: + secured_finance_watcher_db_data: diff --git a/stack-orchestrator/config/watcher-secured-finance/start-job-runner.sh b/stack-orchestrator/config/watcher-secured-finance/start-job-runner.sh new file mode 100755 index 0000000..7a7a83b --- /dev/null +++ b/stack-orchestrator/config/watcher-secured-finance/start-job-runner.sh @@ -0,0 +1,24 @@ +#!/bin/sh + +set -e +if [ -n "$CERC_SCRIPT_DEBUG" ]; then + set -x +fi +set -u + +echo "Using 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_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 diff --git a/stack-orchestrator/config/watcher-secured-finance/start-server.sh b/stack-orchestrator/config/watcher-secured-finance/start-server.sh new file mode 100755 index 0000000..9aaa77e --- /dev/null +++ b/stack-orchestrator/config/watcher-secured-finance/start-server.sh @@ -0,0 +1,24 @@ +#!/bin/sh + +set -e +if [ -n "$CERC_SCRIPT_DEBUG" ]; then + set -x +fi +set -u + +echo "Using 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_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 diff --git a/stack-orchestrator/config/watcher-secured-finance/watcher-config-template.toml b/stack-orchestrator/config/watcher-secured-finance/watcher-config-template.toml new file mode 100644 index 0000000..069d610 --- /dev/null +++ b/stack-orchestrator/config/watcher-secured-finance/watcher-config-template.toml @@ -0,0 +1,101 @@ +[server] + host = "0.0.0.0" + port = 3008 + kind = "active" + gqlPath = "/" + + # Checkpointing state. + checkpointing = true + + # Checkpoint interval in number of blocks. + checkpointInterval = 2000 + + # Enable state creation + # CAUTION: Disable only if state creation is not desired or can be filled subsequently + 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 + + # Max block range for which to return events in eventsInRange GQL query. + # Use -1 for skipping check on block range. + maxEventsBlockRange = 1000 + + # Flag to specify whether RPC endpoint supports block hash as block tag parameter + rpcSupportsBlockHashParam = false + + # GQL cache settings + [server.gqlCache] + 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 + +[metrics] + host = "0.0.0.0" + port = 9000 + [metrics.gql] + port = 9001 + +[database] + type = "postgres" + host = "secured-finance-watcher-db" + port = 5432 + database = "secured-finance-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 + + [upstream.cache] + name = "requests" + enabled = false + deleteOnStart = false + +[jobQueue] + dbConnectionString = "postgres://vdbm:password@secured-finance-watcher-db/secured-finance-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 + + # 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 diff --git a/stack-orchestrator/container-build/cerc-watcher-secured-finance/Dockerfile b/stack-orchestrator/container-build/cerc-watcher-secured-finance/Dockerfile new file mode 100644 index 0000000..592d58f --- /dev/null +++ b/stack-orchestrator/container-build/cerc-watcher-secured-finance/Dockerfile @@ -0,0 +1,10 @@ +FROM node:18.17.1-alpine3.18 + +RUN apk --update --no-cache add git python3 alpine-sdk bash curl jq + +WORKDIR /app + +COPY . . + +RUN echo "Installing dependencies and building secured-finance-watcher-ts" && \ + yarn && yarn build diff --git a/stack-orchestrator/container-build/cerc-watcher-secured-finance/build.sh b/stack-orchestrator/container-build/cerc-watcher-secured-finance/build.sh new file mode 100755 index 0000000..d283948 --- /dev/null +++ b/stack-orchestrator/container-build/cerc-watcher-secured-finance/build.sh @@ -0,0 +1,7 @@ +#!/usr/bin/env bash +# Build cerc/secured-finance-watcher-ts + +source ${CERC_CONTAINER_BASE_DIR}/build-base.sh +SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) + +docker build -t cerc/watcher-secured-finance:local -f ${SCRIPT_DIR}/Dockerfile ${build_command_args} ${CERC_REPO_BASE_DIR}/secured-finance-watcher-ts diff --git a/stack-orchestrator/stacks/secured-finance/README.md b/stack-orchestrator/stacks/secured-finance/README.md new file mode 100644 index 0000000..eead049 --- /dev/null +++ b/stack-orchestrator/stacks/secured-finance/README.md @@ -0,0 +1,110 @@ +# Secured finance watcher + +## Clone the stack repo + +```bash +laconic-so fetch-stack git.vdb.to/cerc-io/secured-finance-watcher-stack +``` + +## Clone required repositories + +```bash +laconic-so --stack ~/cerc/secured-finance-watcher-stack/stack-orchestrator/stacks/secured-finance setup-repositories +``` + +## Build the container image + +```bash +laconic-so --stack ~/cerc/secured-finance-watcher-stack/stack-orchestrator/stacks/secured-finance build-containers +``` + +## Create a spec file for the deployment + +```bash +laconic-so --stack ~/cerc/secured-finance-watcher-stack/stack-orchestrator/stacks/secured-finance deploy init --output secured-finance-spec.yml +``` + +### Ports + +Edit `network` in the spec file to map container ports to host ports as required: + +```yml +... +network: + ports: + secured-finance-watcher-db: + - 15432:5432 + secured-finance-watcher-job-runner: + - 9000:9000 + secured-finance-watcher-server: + - 3008:3008 + - 9001:9001 +``` + +## Create a deployment from the spec file + +```bash +laconic-so --stack ~/cerc/secured-finance-watcher-stack/stack-orchestrator/stacks/secured-finance deploy create --spec-file secured-finance-spec.yml --deployment-dir secured-finance-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 +``` + +## Start the deployment + +```bash +laconic-so deployment --dir secured-finance-deployment start +``` + +* To list down and monitor the running containers: + + ```bash + # With status + docker ps -a + + # Check logs for a container + docker logs -f + ``` + +* Open the GQL playground at + + ```graphql + # Example query + query { + _meta { + block { + hash + number + timestamp + } + deployment + hasIndexingErrors + } + ``` + +## Clean up + +Stop all the secured finance services running in background: + +```bash +# Only stop the docker containers +laconic-so deployment --dir secured-finance-deployment stop + +# Run 'start' to restart the deployment +``` + +To stop all the secured finance services and also delete data: + +```bash +# Stop the docker containers +laconic-so deployment --dir secured-finance-deployment stop --delete-volumes + +# Remove deployment directory (deployment will have to be recreated for a re-run) +rm -r secured-finance-deployment +``` diff --git a/stack-orchestrator/stacks/secured-finance/stack.yml b/stack-orchestrator/stacks/secured-finance/stack.yml new file mode 100644 index 0000000..4773c06 --- /dev/null +++ b/stack-orchestrator/stacks/secured-finance/stack.yml @@ -0,0 +1,9 @@ +version: "1.0" +name: secured-finance +description: "Secured finance watcher stack" +repos: + - git.vdb.to/cerc-io/secured-finance-watcher-ts@v0.1.0 +containers: + - cerc/watcher-secured-finance +pods: + - watcher-secured-finance