Merge pull request #1 from willynikes2/codex/provide-scaffolding-for-crypto-payment-gateway-project

Author: willynikes2

.env.example

@@ -0,0 +1,16 @@
+# Database
+POSTGRES_USER=gateway
+POSTGRES_PASSWORD=gateway
+POSTGRES_DB=gateway
+
+# RPC endpoints
+ETHEREUM_RPC_WS=
+SOLANA_RPC=
+BTC_RPC=
+FTM_RPC=
+BSC_RPC=
+
+# API Keys
+DEX_AGGREGATOR_KEY=
+KYC_PROVIDER_KEY=
+WEBHOOK_SECRET=

.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        service: [ingestion, swap-engine, wallet-manager, settlement, compliance, monitoring]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+      - name: Install dependencies
+        run: |
+          cd services/${{ matrix.service }}
+          npm install
+      - name: Run tests
+        run: |
+          cd services/${{ matrix.service }}
+          npm test --if-present

.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+dist/
+.env

README.md

@@ -0,0 +1,26 @@
+# Multi-Chain Crypto Payment Gateway Scaffold
+
+This repository contains a minimal scaffold for a multi-service crypto payment gateway.
+
+## Services
+
+- **ingestion** – Generates invoices and QR codes, listens for chain payments.
+- **swap-engine** – Calls DEX aggregators (1inch, LI.FI, OpenOcean, ParaSwap) for quotes/swaps.
+- **wallet-manager** – Manages MPC key shares for custodial wallets.
+- **settlement** – Handles USDC balances and withdrawals to exchanges.
+- **compliance** – Merchant onboarding with KYC checks.
+- **monitoring** – Emits webhooks for payment and swap events.
+
+## Getting Started
+
+1. Install dependencies in each service directory.
+2. Copy `.env.example` to `.env` and fill in required variables.
+3. Run `docker-compose up --build` to start all services and databases.
+
+## TODO
+
+- Implement API documentation.
+- Complete compliance rules and Travel Rule logic.
+- Add environment variables for RPC URLs, API keys, and database credentials.
+- Flesh out blockchain listeners and swap execution logic.
+- Configure CI pipeline and tests.

docker-compose.yml

@@ -0,0 +1,62 @@
+version: '3.8'
+services:
+  postgres:
+    image: postgres:14
+    restart: always
+    environment:
+      POSTGRES_USER: gateway
+      POSTGRES_PASSWORD: gateway
+      POSTGRES_DB: gateway
+    ports:
+      - "5432:5432"
+
+  mongo:
+    image: mongo:5
+    restart: always
+    ports:
+      - "27017:27017"
+
+  ingestion:
+    build: ./services/ingestion
+    depends_on:
+      - postgres
+    environment:
+      - DATABASE_URL=postgresql://gateway:gateway@postgres:5432/gateway
+    ports:
+      - "3001:3000"
+
+  swap-engine:
+    build: ./services/swap-engine
+    depends_on:
+      - postgres
+    ports:
+      - "3002:3000"
+
+  wallet-manager:
+    build: ./services/wallet-manager
+    depends_on:
+      - postgres
+    ports:
+      - "3003:3000"
+
+  settlement:
+    build: ./services/settlement
+    depends_on:
+      - postgres
+    ports:
+      - "3004:3000"
+
+  compliance:
+    build: ./services/compliance
+    depends_on:
+      - postgres
+    ports:
+      - "3005:3000"
+
+  monitoring:
+    build: ./services/monitoring
+    depends_on:
+      - postgres
+    ports:
+      - "3006:3000"
+

docs/architecture.md

@@ -0,0 +1,5 @@
+# Architecture Overview
+
+This document outlines the microservice layout and key components for the payment gateway.
+
+TODO: expand with sequence diagrams, database schemas, and API contracts.

scripts/start.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+docker-compose up --build

services/compliance/Dockerfile

@@ -0,0 +1,7 @@
+FROM node:18-alpine
+WORKDIR /app
+COPY package.json tsconfig.json ./
+RUN npm install
+COPY src ./src
+RUN npm run build
+CMD ["node", "dist/main.js"]

services/compliance/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "compliance",
+  "version": "0.1.0",
+  "main": "dist/main.js",
+  "scripts": {
+    "start": "nest start",
+    "build": "nest build",
+    "test": "jest"
+  },
+  "dependencies": {
+    "@nestjs/common": "^9.0.0",
+    "@nestjs/core": "^9.0.0",
+    "@nestjs/platform-express": "^9.0.0",
+    "reflect-metadata": "^0.1.13",
+    "rxjs": "^7.5.0",
+    "uuid": "^9.0.0"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "^9.0.0",
+    "@types/node": "^18",
+    "ts-node": "^10.0.0",
+    "typescript": "^4.8.0",
+    "jest": "^29.0.0",
+    "ts-jest": "^29.0.0"
+  }
+}

services/compliance/src/app.module.ts

@@ -0,0 +1,9 @@
+import { Module } from '@nestjs/common';
+import { ComplianceService } from './compliance.service';
+import { OnboardingController } from './onboarding.controller';
+
+@Module({
+  controllers: [OnboardingController],
+  providers: [ComplianceService],
+})
+export class AppModule {}