grix-argus v1.0.0

Argus

Overview

This directory contains the Argus project for the Grix protocol.

Technical Overview

1. Framework

   • Node.js: Server-side scripting and scalable network applications.

2. Libraries and Tools

   • TypeScript: Adds type safety to the codebase.
   • Jest: Testing framework.
   • AWS: Cloud computing platform.
   • Serverless Framework: Simplifies serverless application deployment.
   • PostgreSQL: Relational database management system.

Functionality

• API Endpoints: Interact with the Grix protocol.
• Lambda Functions: Handle backend tasks.
• SQS Queues: Asynchronous task processing.
• Environment Management: Configurations for various environments.
• Caching: Improves API Gateway performance.
• Testing: Ensures code quality.
• Deployment: Uses Serverless Framework on AWS.

Architecture

1. AWS Lambda Functions

   • Data Fetching: Triggered by SQS events.
   • Data Processing: Updates the database.

2. AWS SQS

   • Message Queuing: Manages data fetching and processing tasks.
   • Asynchronous Processing: Handles large data volumes efficiently.

3. Database

   • Data Storage: Regularly updated with DeFi options information.

4. API Gateway

   • Serving the Grix Interface: Routes requests to Lambda functions.
   • Caching: Reduces latency.

Resources

• Database

  • src/database.ts
  • entities: Directory containing database entity definitions.
  • migration: Directory for database migration scripts.

• Configuration

  • serverless.ts
  • serverlessConfig/lambdas.ts
  • serverlessConfig/queues.ts

• Source Code

• functions: Directory containing Lambda function handlers and related code.

• ogi: Directory containing various utility functions and protocol connectors.

• Monitoring Structure

• STRUCTURE.md