docs: update README with comprehensive test results, CLI documentation, and enhanced feature descriptions

- Update key capabilities to include GPU marketplace, payments, billing, and governance
- Expand CLI section from basic examples to 12 command groups with 90+ subcommands
- Add detailed test results table showing 208 passing tests across 6 test suites
- Update documentation links to reference new CLI reference and coordinator API docs
- Revise test commands to reflect actual test structure (
This commit is contained in:
oib
2026-02-12 20:58:21 +01:00
parent 5120861e17
commit 65b63de56f
47 changed files with 5622 additions and 1148 deletions

View File

@@ -1,41 +1,138 @@
from __future__ import annotations
import time
from collections import defaultdict
from contextlib import asynccontextmanager
from fastapi import APIRouter, FastAPI
from fastapi.responses import PlainTextResponse
from fastapi import APIRouter, FastAPI, Request
from fastapi.middleware.cors import CORSMiddleware
from fastapi.responses import JSONResponse, PlainTextResponse
from starlette.middleware.base import BaseHTTPMiddleware
from .config import settings
from .database import init_db
from .gossip import create_backend, gossip_broker
from .logger import get_logger
from .mempool import init_mempool
from .metrics import metrics_registry
from .rpc.router import router as rpc_router
from .rpc.websocket import router as websocket_router
_app_logger = get_logger("aitbc_chain.app")
class RateLimitMiddleware(BaseHTTPMiddleware):
"""Simple in-memory rate limiter per client IP."""
def __init__(self, app, max_requests: int = 100, window_seconds: int = 60):
super().__init__(app)
self._max_requests = max_requests
self._window = window_seconds
self._requests: dict[str, list[float]] = defaultdict(list)
async def dispatch(self, request: Request, call_next):
client_ip = request.client.host if request.client else "unknown"
now = time.time()
# Clean old entries
self._requests[client_ip] = [
t for t in self._requests[client_ip] if now - t < self._window
]
if len(self._requests[client_ip]) >= self._max_requests:
metrics_registry.increment("rpc_rate_limited_total")
return JSONResponse(
status_code=429,
content={"detail": "Rate limit exceeded"},
headers={"Retry-After": str(self._window)},
)
self._requests[client_ip].append(now)
return await call_next(request)
class RequestLoggingMiddleware(BaseHTTPMiddleware):
"""Log all requests with timing and error details."""
async def dispatch(self, request: Request, call_next):
start = time.perf_counter()
method = request.method
path = request.url.path
try:
response = await call_next(request)
duration = time.perf_counter() - start
metrics_registry.observe("rpc_request_duration_seconds", duration)
metrics_registry.increment("rpc_requests_total")
if response.status_code >= 500:
metrics_registry.increment("rpc_server_errors_total")
_app_logger.error("Server error", extra={
"method": method, "path": path,
"status": response.status_code, "duration_ms": round(duration * 1000, 2),
})
elif response.status_code >= 400:
metrics_registry.increment("rpc_client_errors_total")
return response
except Exception as exc:
duration = time.perf_counter() - start
metrics_registry.increment("rpc_unhandled_errors_total")
_app_logger.exception("Unhandled error in request", extra={
"method": method, "path": path, "error": str(exc),
"duration_ms": round(duration * 1000, 2),
})
return JSONResponse(
status_code=503,
content={"detail": "Internal server error"},
)
@asynccontextmanager
async def lifespan(app: FastAPI):
init_db()
init_mempool(
backend=settings.mempool_backend,
db_path=str(settings.db_path.parent / "mempool.db"),
max_size=settings.mempool_max_size,
min_fee=settings.min_fee,
)
backend = create_backend(
settings.gossip_backend,
broadcast_url=settings.gossip_broadcast_url,
)
await gossip_broker.set_backend(backend)
_app_logger.info("Blockchain node started", extra={"chain_id": settings.chain_id})
try:
yield
finally:
await gossip_broker.shutdown()
_app_logger.info("Blockchain node stopped")
def create_app() -> FastAPI:
app = FastAPI(title="AITBC Blockchain Node", version="0.1.0", lifespan=lifespan)
# Middleware (applied in reverse order)
app.add_middleware(RequestLoggingMiddleware)
app.add_middleware(RateLimitMiddleware, max_requests=200, window_seconds=60)
app.add_middleware(
CORSMiddleware,
allow_origins=["*"],
allow_methods=["GET", "POST"],
allow_headers=["*"],
)
app.include_router(rpc_router, prefix="/rpc", tags=["rpc"])
app.include_router(websocket_router, prefix="/rpc")
metrics_router = APIRouter()
@metrics_router.get("/metrics", response_class=PlainTextResponse, tags=["metrics"], summary="Prometheus metrics")
async def metrics() -> str:
return metrics_registry.render_prometheus()
@metrics_router.get("/health", tags=["health"], summary="Health check")
async def health() -> dict:
return {
"status": "ok",
"chain_id": settings.chain_id,
"proposer_id": settings.proposer_id,
}
app.include_router(metrics_router)
return app