pelith-assessment

README

Pelith Assessment

Introduction

Pelith Assessment is a backend system designed to address specific engineering challenges. It focuses on building a campaign management platform for Uniswap users, enabling them to complete tasks, earn points, and redeem rewards.

Project Goals

• Task System: Implement a configurable multitask system, including onboarding and share pool tasks.
• Campaign Modes: Support real-time event handling and backtesting mode for analyzing historical data.
• Data Integrity: Ensure accuracy in task tracking and point distribution.
• Scalability: Allow dynamic addition of new tasks and trading pairs to meet diverse business requirements.

Features

1. Task System

   • Onboarding Task: Users receive 100 points by completing a transaction of at least 1000u.
   • Share Pool Task: Distribute 10,000 points among users based on their transaction volume proportion in a specific pool.

2. Data Modes

   • Real-Time Mode: Process live data for immediate task updates.
   • Backtest Mode: Simulate past campaigns using historical data.

3. APIs

   • Fetch user task completion status.
   • Retrieve task point distribution history.

4. Extensibility

   • Dynamically add new trading pair tasks.
   • Provide WebSocket support for real-time updates.

Technical Overview

• Architecture: Built with Go, PostgreSQL for persistent storage, and Redis for caching if needed.
• Data Storage: Campaign parameters and user data are stored in PostgreSQL, ensuring ACID compliance.
• Implementation Details:
  • Computation Module: Calculates user transaction volume proportions and point distribution based on Uniswap V2 data.
  • Campaign Status Management: Configure campaign start time via environment variables or the database.
• Testing: Focus on testing core logic with a minimum of 50% unit test coverage.

Future Enhancements

• Add a leaderboard API for user rankings based on points.
• Introduce CI/CD pipelines for automated testing and deployment.
• Optimize system performance for large-scale data processing.

---

How to Use

Prerequisites

1. Install Docker and Docker Compose.

2. Create a .env file in the project root directory with the following content:

   ETHERSCAN_API_KEY=your_etherscan_api_key
   INFURA_PROJECT_ID=your_infura_project_id
   

---

Start the Application

1. Start the application and its related services:

   make run
   

2. Open the application in your browser at

   http://localhost:8080

---

Documentation

For more detailed information, please refer to the documentation in the docs/ directory:

• System Architecture: Explanation of the system's architecture and components.
• Project Layout: Overview of the project's directory structure and organization.

---

Explore the docs/ folder for additional details.

References

• Uniswap V2 Documentation
• Etherscan Pool Events

Author

blackhorseya

---

Feel free to raise issues or provide suggestions!