KNIRV-GATEWAY: The Unified Portal & API Gateway

Abstract

The KNIRV-GATEWAY serves as the primary and unified web portal and API gateway for the KNIRV Decentralized Trusted Execution Network (D-TEN). Following the major refactor, KNIRV-GATEWAY has been enhanced with the integration of the GraphChain Explorer frontend, migrated from KNIRVGRAPH to enable Netlify deployment with Server-Sent Events (SSE) functionality. It is designed to be the single entry point for all users, developers, and services within the KNIRV ecosystem. By combining a modern, responsive website with serverless API gateway functionality and the integrated GraphChain Explorer, the KNIRV-GATEWAY provides a seamless and secure interface for interacting with the various layers of the network while offering direct access to the distributed vector graph intelligence.

1. Introduction

The KNIRV-GATEWAY is a critical architectural component that abstracts the complexity of the underlying decentralized network. Following the major refactor, it has been enhanced with the GraphChain Explorer frontend migration, providing users with direct access to the distributed vector graph intelligence through a hybrid integration approach. The gateway provides a modern web portal showcasing the D-TEN's capabilities, a robust serverless API gateway that supports real-time data streaming, and the integrated GraphChain Explorer with static site structure in the graphchain-explorer subdirectory. The gateway is built on a modular architecture, leveraging Netlify Functions for its serverless backend and a responsive front end for an optimal user experience, while enabling the GraphChain Explorer to query any GraphChain instance via the KNIRVGATEWAY API proxy.

2. Architecture

The KNIRV-GATEWAY's architecture is divided into two primary components: the Web Portal and the API Gateway.

2.1. Web Portal Components

The web portal provides the user-facing interface, organized into a clear directory structure. It includes the main entry point (index.html), static assets for styling and functionality, and dedicated sections for a developer portal and documentation. The documentation is powered by Docsify, ensuring an integrated and easily navigable knowledge hub.

2.2. API Gateway Components

The API gateway is implemented using Netlify Functions, enabling a serverless architecture. It is responsible for handling all API requests and features a main gateway with Server-Sent Events (SSE) support (gateway-sse.js) and a dedicated function for service health monitoring (health-monitor.js).

mermaid
graph TD
    subgraph KNIRV-GATEWAY
        A[Web Portal]
        B[API Gateway]
    end

    subgraph "Web Portal Components"
        A1(index.html)
        A2(Static Assets)
        A3(Developer Portal)
        A4(Docsify Documentation)
    end

    subgraph "API Gateway Components (Netlify Functions)"
        B1(gateway-sse.js)
        B2(health-monitor.js)
    end

    A -- "User-facing Interface" --> A1
    A -- "Styling & Functionality" --> A2
    A -- "Developer Resources" --> A3
    A -- "Integrated Knowledge Hub" --> A4

    B -- "Main Gateway (SSE)" --> B1
    B -- "Service Health Monitoring" --> B2

    C(Users) --> A
    D(Developers) --> A
    E(External Services) --> B

    B -- "Proxies Requests To" --> F{KNIRV Ecosystem}

    subgraph "KNIRV Ecosystem"
        G[KNIRVROOT]
        H[KNIRVCHAIN]
        I[KNIRVGRAPH]
        J[KNIRVNEXUS]
    end

    F --> G
    F --> H
    F --> I
    F --> J

3. Core Features

The KNIRV-GATEWAY's design incorporates several key features to provide a superior user and developer experience:
* Modern Web Portal: A responsive website that explains the KNIRV D-TEN's value proposition and features.
* Serverless API Gateway: A gateway built with Netlify Functions that includes support for Server-Sent Events (SSE) for live data streaming.
* Developer Portal & Documentation Hub: An integrated portal that offers comprehensive documentation, tools, and tutorials for developers.
* Real-time Updates: The use of SSE allows for live data streaming of gateway events and health updates.
* Authentication: Secure API access and user management are handled through dedicated authentication endpoints.
* Health Monitoring: Real-time service health and performance metrics are available for the gateway and connected services.
* User Interface: The portal features a modern "Glass Morphism" UI design with a balanced blue/purple color scheme.

4. API Gateway Endpoints

The API gateway exposes a series of endpoints to manage the gateway itself, monitor health, handle authentication, and proxy requests to other KNIRV services.
* Gateway Management: Endpoints like GET /gateway/health and GET /gateway/services provide status and metrics for the gateway.
* Health Monitoring: GET /health-monitor/status and GET /health-monitor/events provide real-time service health updates via SSE.
* Authentication: POST /auth/login and POST /auth/logout manage user sessions and token verification.
Service Proxy: The gateway acts as a proxy for key KNIRV services, including endpoints for KNIRVROOT (/api/*), economics (/economics/*), and the tunnel registry (/tunnel/).

5. Integration with the KNIRV Ecosystem

The KNIRV-GATEWAY is designed to be the central point of contact for the entire D-TEN. It is configured to interact with other sovereign layers through environment variables. Specifically, it establishes connections to KNIRVROOT, KNIRVCHAIN, KNIRVGRAPH, and KNIRVNEXUS, acting as a front-facing proxy that streamlines communication and provides a single, secure entry point to the entire network.

6. Conclusion

The KNIRV-GATEWAY is an essential layer of the KNIRV ecosystem, serving as the "Unified Web Portal and API Gateway". Its serverless, modular, and secure design provides developers with a powerful platform to build on and users with a clear window into the capabilities of the D-TEN. It is the crucial bridge that connects our decentralized architecture to the broader digital world, solidifying KNIRV's position as a leader in decentralized AI and trusted execution networks.