Merge 982c619 into 89907ce

lerna.json

@@ -3,6 +3,7 @@
   "useWorkspaces": true,
   "packages": [
     "packages/*",
+    "packages/rfq-indexer/*",
     "docs/*"
   ],
   "version": "independent"

package.json

@@ -6,6 +6,7 @@
   "workspaces": {
     "packages": [
       "packages/*",
+      "packages/rfq-indexer/*",
       "docs/*"
     ],
     "nohoist": [
@@ -73,7 +74,8 @@
     "ts-mocha": "^10.0.0",
     "typedoc": "^0.23.24",
     "typedoc-plugin-markdown": "^3.14.0",
-    "typescript": "^5.0.4"
+    "typescript": "^5.0.4",
+    "wagmi": "^2.12.12"
   },
   "dependencies": {
     "@changesets/cli": "2.22.0",

packages/rfq-indexer/README.md

@@ -0,0 +1,25 @@
+# RFQ Indexer
+
+## Overview
+
+The RFQ (Request for Quote) Indexer is a system designed to index and track bridge events across multiple blockchain networks. It consists of two main parts: the indexer and the API.
+
+1. What does the rfq-indexer do?
+   The rfq-indexer captures and stores bridge events from various blockchain networks, including Ethereum, Optimism, Arbitrum, Base, Blast, Scroll, Linea, and BNB Chain. It indexes events such as bridge requests, relays, proofs, refunds, and claims.
+
+2. Parts of the indexer and their users:
+   - Indexer: Used by developers and system administrators to collect and store blockchain data.
+   - API: Used by front-end applications, other services, or developers to query the indexed data.
+
+## Directory Structure
+rfq-indexer/
+├── api/ # API service
+│ ├── src/ # API source code
+│ ├── package.json # API dependencies and scripts
+│ └── README.md # API documentation
+├── indexer/ # Indexer service
+│ ├── src/ # Indexer source code
+│ ├── abis/ # Contract ABIs
+│ ├── package.json # Indexer dependencies and scripts
+│ └── README.md # Indexer documentation
+└── README.md # This file

packages/rfq-indexer/api/.gitignore

@@ -0,0 +1,4 @@
+node_modules
+.env
+
+.env.*

packages/rfq-indexer/api/README.md

@@ -0,0 +1,40 @@
+# RFQ Indexer API
+
+This API provides access to the indexed bridge event data.
+
+## API Calls
+
+1. GET /api/hello
+   - Description: A simple hello world endpoint
+   - Example: `curl http://localhost:3001/api/hello`
+
+2. GET /api/pending-transactions-missing-relay
+   - Description: Retrieves pending transactions that are missing relay events
+   - Example:
+     ```
+     curl http://localhost:3001/api/pending-transactions-missing-relay
+     ```
+
+3. GET /api/pending-transactions-missing-proof
+   - Description: Retrieves pending transactions that are missing proof events
+   - Example:
+     ```
+     curl http://localhost:3001/api/pending-transactions-missing-proof
+     ```
+
+4. GET /api/pending-transactions-missing-claim
+   - Description: Retrieves pending transactions that are missing claim events
+   - Example:
+     ```
+     curl http://localhost:3001/api/pending-transactions-missing-claim
+     ```
+
+5. GraphQL endpoint: /graphql
+   - Description: Provides a GraphQL interface for querying indexed data, the user is surfaced an interface to query the data via GraphiQL
+
+## Important Scripts
+
+- `yarn dev:local`: Runs the API in development mode using local environment variables
+- `yarn dev:prod`: Runs the API in development mode using production environment variables
+- `yarn start`: Starts the API in production mode
+

packages/rfq-indexer/api/nixpacks.toml

@@ -0,0 +1,4 @@
+providers = ["node"]
+
+[phases.install]
+cmds = ["npm install -g corepack", "corepack enable", "corepack prepare [email protected] --activate", "pnpm install"]

packages/rfq-indexer/api/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@synapsecns/rfq-indexer-api",
+  "private": true,
+  "version": "1.0.1",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "check-env": "dotenv -e .env.local -- printenv | grep DATABASE_URL",
+    "dev:local": "dotenv -e .env.local -- tsx watch src/index.ts",
+    "dev:prod": "dotenv -e .env.production -- tsx watch src/index.ts",
+    "start": "tsx src/index.ts",
+    "start:local": "dotenv -e .env -- tsx src/index.ts",
+    "dev": "dotenv -e .env -- tsx watch src/index.ts",
+    "lint:check": " ",
+    "ci:lint": " ",
+    "build:go": " ",
+    "build": " ",
+    "build:slither": " ",
+    "test:coverage": "echo 'No tests defined.'"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@graphql-tools/load-files": "^7.0.0",
+    "@graphql-tools/merge": "^9.0.7",
+    "@graphql-tools/schema": "^10.0.6",
+    "@types/express": "^4.17.21",
+    "@types/node": "^22.5.4",
+    "express": "^4.21.0",
+    "graphql": "^16.9.0",
+    "graphql-yoga": "^5.7.0",
+    "kysely": "^0.27.4",
+    "pg": "^8.12.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.6.2",
+    "viem": "^2.21.6",
+    "tsx": "^4.19.1",
+    "dotenv-cli": "^7.4.2"
+  },
+  "engines": {
+    "node": ">=18.17"
+  },
+  "devDependencies": {
+    "@types/pg": "^8.11.9",
+    "dotenv": "^16.4.5"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/synapsecns/sanguine",
+    "directory": "packages/rfq-indexer/api"
+  }
+}