docs for o11y and enable type check

Author: saihaj

.github/workflows/ci.yml

@@ -15,6 +15,7 @@ jobs:
       matrix:
         check:
           - format
+          - types
     name: Check ${{ matrix.check }}
     runs-on: ubuntu-latest
     steps:

README.md

@@ -14,6 +14,8 @@ Here is a high-level overview of what different directories in this repository d
 - [**`substream-listener`**](./substream-listener/): A Node.js service that subscribes an Event Stream from a Substream for a webhook user project and pushes the data to SVIX project configured for the User.
 - [**`utils`**](./substream-listener/): Shared utilities and types between the different services.
 - [**`deployments`**](./deployments/): Pulumi code to deploy infrastructure and services to various providers.
+- [**`prometheus`**](./prometheus/): Local development Prometheus setup to monitor the services.
+- [**`grafana`**](./grafana/): Local development Grafana setup to visualize the metrics from Prometheus.
 
 ## Running the project
 

management-api/package.json

@@ -7,6 +7,7 @@
     "dev": "wrangler dev --port 8787",
     "deploy": "wrangler deploy",
     "cf-typegen": "wrangler types",
+    "check:types": "tsc --noEmit",
     "generate:graphql": "tsx ./scripts/generate-schema.ts",
     "generate:sqlite": "drizzle-kit generate:sqlite",
     "generate": "pnpm run generate:graphql && pnpm run generate:sqlite"

package.json

@@ -8,6 +8,7 @@
   "scripts": {
     "postinstall": "cd erc721-substream && make pack",
     "format": "prettier --write .",
+    "check:types": "pnpm --filter substream-listener --filter management-api --filter web check:types",
     "check:format": "prettier --check .",
     "dev": "pnpm --filter substream-listener --filter management-api --filter web dev",
     "docker:build": "docker build -t graphwebhooks-base:local . && docker buildx bake -f docker/docker.hcl --load build --set service-base.args.BASE_IMAGE=graphwebhooks-base:local"

substream-listener/package.json

@@ -3,7 +3,8 @@
   "version": "0.0.1",
   "scripts": {
     "start": "tsx ./src/index.mts",
-    "dev": "tsx --env-file .env --watch ./src/index.mts | pino-pretty"
+    "dev": "tsx --env-file .env --watch ./src/index.mts | pino-pretty",
+    "check:types": "tsc --noEmit"
   },
   "dependencies": {
     "@connectrpc/connect-node": "1.4.0",

substream-listener/src/index.mts

@@ -1,6 +1,6 @@
 import { createRouter, Response } from "fets";
 import { App } from "uWebSockets.js";
-import { isAddress } from "viem";
+import { Address, isAddress } from "viem";
 import {
   invalidHttpRequests,
   registry,
@@ -139,7 +139,7 @@ const router = createRouter({
       const job = await schedule({
         appId,
         startBlock,
-        contractAddress: contractAddress.toLowerCase(),
+        contractAddress: contractAddress.toLowerCase() as Address,
         token: substreamsToken,
         outputModule: OUTPUT_MODULE,
         substreamsEndpoint: BASE_URL,

substream-listener/src/scheduler.mts

@@ -139,8 +139,10 @@ export function createScheduler(config: {
         const transport = createGrpcWebTransport({
           baseUrl: substreamsEndpoint,
           httpVersion: "2",
+          // @ts-ignore - not sure what the issue is here
           interceptors: [createAuthInterceptor(token)],
           jsonOptions: {
+            // @ts-ignore - not sure what the issue is here
             typeRegistry: registry,
           },
         });
@@ -156,6 +158,7 @@ export function createScheduler(config: {
         });
 
         // NodeJS Events
+        // @ts-ignore - not sure what the issue is here
         const emitter = new BlockEmitter(transport, request, registry);
 
         // Setup tracing of metrics for Prometheus

substream-listener/tsconfig.json

@@ -1,3 +1,6 @@
 {
-  "extends": "@tsconfig/node20/tsconfig.json"
+  "extends": "@tsconfig/node20/tsconfig.json",
+  "compilerOptions": {
+    "skipLibCheck": true
+  }
 }

web/package.json

@@ -10,7 +10,8 @@
     "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
     "preview": "vite preview",
     "relay": "relay-compiler",
-    "relay:clean": "rimraf $(find . -type d -name __generated__)"
+    "relay:clean": "rimraf $(find . -type d -name __generated__)",
+    "check:types": "tsc --noEmit"
   },
   "relay": {
     "src": "./src",

web/src/main.tsx

@@ -1,7 +1,7 @@
 import "./global.css";
 import React from "react";
 import ReactDOM from "react-dom/client";
-import { LogtoProvider, LogtoConfig, Prompt, UserScope } from "@logto/react";
+import { LogtoProvider, LogtoConfig, Prompt } from "@logto/react";
 import { RelayEnvironmentProvider } from "react-relay";
 import { RouterProvider, createRouter } from "@tanstack/react-router";