The USDT REST API Wrapper project is a tool that wraps the USDT (Tether) contract and provides a convenient REST API for interacting with it.

• 🌟 Convenient USDT Contract Interaction: The project wraps a complex USDT contract and offers a user-friendly REST API, enabling users to interact with the contract easily.

• 🧩 Modular Architecture: The project utilizes Spring Boot and follows a modular architecture, making it easy to add new features and maintain.

• 📚 API Documentation: With the use of Swagger V3 and Springdoc-openapi, the project provides comprehensive API documentation, helping users quickly explore available endpoints and their functionality.

• 🛠️ Code Simplicity with Lombok: Leveraging Lombok simplifies the project's code, making it more readable and maintainable.

• 🐳 Easy Deployment with Docker Compose: Docker Compose allows for straightforward project deployment, simplifying its setup and scalability.

• 📈 Monitoring with Zipkin: Integration with Zipkin through Brave offers monitoring and tracking capabilities to ensure stability and performance.

• 🧪 Unit Testing: The project's code is equipped with unit tests, enhancing its reliability and ensuring stable performance.

• Spring Boot Actuator: Monitoring and management of application.
• Spring Boot Validation: Input validation.
• Spring Boot Web: Building web-based applications.
• Spring Boot AOP: Modularization and cross-cutting concerns.
• Web3j: Interaction with the USDT contract.
• Swagger V3: API documentation.
• Springdoc-openapi: OpenAPI documentation generation.
• Lombok: Code simplification.
• Docker Compose: Deployment orchestration.
• Zipkin via Brave: Distributed tracing for monitoring.

To run the project, follow these steps:

1. Clone the repository:

   git clone https://github.com/f3n1b00t/usdt-rest-api.git
   cd usdt-rest-api

2. Build service:

   cd contract-service
   ./gradlew build 

3. Run docker:

   cd ..
   docker compose up

4. Enjoy the project! 🎉

After a successful launch, you can visit the following link to explore the API documentation:

API Documentation

We welcome contributions to the project! If you would like to contribute, please review the CONTRIBUTING.md for more information.

Spring Boot is Open Source software released under the Apache 2.0 license.