RATE LIMITING

Screen.Recording.2025-08-29.at.22.51.44.mov

OTHER TESTS

Screen.Recording.2025-08-29.at.22.49.04.mov

Solana Balance API

Features

• Concurrent Balance Fetching: Fetches balances for multiple wallets in parallel for maximum speed.
• IP Rate Limiting: Limits clients to 10 requests per minute to prevent abuse.
• Caching with 10s TTL: Caches results for wallet addresses to reduce RPC calls and improve response times.
• Mutex on Concurrent Requests: Prevents duplicate RPC calls ("thundering herd") if multiple requests for the same uncached wallet arrive simultaneously.
• MongoDB Authentication: Secures the endpoint with API keys stored in a MongoDB database.
• Production-Ready Docker Image: Built using a multi-stage, non-root, minimal (alpine) Docker image for security and small size.
• Automated CI/CD: A GitHub Actions workflow automatically builds and pushes the Docker image to Docker Hub on every push to the main branch.

Prerequisites

• Docker must be installed and running on your machine.

---

How to Run the Application

Step 1: Start Everything with One Command

docker-compose up -d

That's it! The API is now running and accessible at http://localhost:8080.

How to Test the API

You can use curl or any API client to test the running endpoint.

Test 1: Successful Request (Single Wallet)

This is the standard "happy path" test.

curl -X POST http://localhost:8080/api/get-balance \
-H "Content-Type: application/json" \
-H "X-API-Key: my-secret-api-key" \
-d '{"wallets": ["7xLk17EQQ5KLDLDe44wCmupJKJjTGd8hs3eSVVhCx932"]}'

Test 2: Authentication Failure

This shows the authMiddleware blocking a request with an invalid key.

curl -X POST http://localhost:8080/api/get-balance \
-H "Content-Type: application/json" \
-H "X-API-Key: some-wrong-key" \
-d '{"wallets": ["7xLk17EQQ5KLDLDe44wCmupJKJjTGd8hs3eSVVhCx932"]}'

Expected Response: Invalid API Key

Test 3: Rate Limiting

This loop will send 10 rapid requests. The first 5 will succeed, and the rest will be blocked, proving the rate limiter is working.

for i in {1..10}; do
  curl --silent -X POST http://localhost:8080/api/get-balance \
  -H "Content-Type: application/json" \
  -H "X-API-Key: my-secret-api-key" \
  -d "{\"wallets\": [\"GeJbA8a4e8G4gZass5xG4f2G38p2G2G38p2G$(date +%s%N)\"]}" # Unique wallet to bypass cache
  echo ""
done

Expected Output: The first 5 requests will return a JSON error for an invalid address, and the next 5 will return Too Many Requests.

---

Force Refresh after updates.

docker-compose pull api && docker-compose up -d --force-recreate api