init

Author: notEduardo

.github/workflows/deploy.yaml

@@ -0,0 +1,42 @@
+name: Deploy to App Engine
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  deploy:
+    name: Deploying to Google App Engine
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+
+      - name: Install Dependencies
+        run: yarn install
+
+      - name: Authenticate with Google Cloud
+        uses: google-github-actions/auth@v2
+        with:
+          token_format: 'access_token'
+          credentials_json: ${{ secrets.GCP_KEY }}
+
+      - name: Setup Google Cloud SDK
+        uses: google-github-actions/setup-gcloud@v2
+
+      - name: Configure gcloud CLI
+        run: |-
+          gcloud config set account ${{ secrets.SERVICE_ACCOUNT }}
+          gcloud config set project ${{ secrets.PROJECT_ID }}
+
+      - name: Deploy to App Engine
+        uses: google-github-actions/deploy-appengine@v2
+        with:
+          deliverables: app.yaml

README.md

@@ -0,0 +1,186 @@
+
+# Faucet Backend API
+
+This API provides endpoints for interacting with two main tables: `faucet.solana_balances` and `faucet.rate_limits`. Below are the available endpoints for each table.
+
+---
+## How to Run
+
+1. Clone the repository
+   ```bash
+   git clone <repository-url>
+   ```
+
+2. Install dependencies
+   ```bash
+   yarn install
+   ```
+
+3. Set up your `.env` file with the following
+   ```env
+   POSTGRES_STRING=postgresql://<user>:<password>@<host>:<port>/<database>
+   ```
+
+4. Start the server
+   ```bash
+   yarn start
+   ```
+
+5. Access the API at `http://localhost:3000/api`.
+
+---
+
+## Solana Balances Endpoints
+
+### **Create a New Solana Balance**
+
+**POST** `/api/solana-balances`
+
+- **Description**: Adds a new Solana account balance.
+- **Request Body**:
+  ```json
+  {
+    "account": "string",
+    "balance": "number"
+  }
+  ```
+- **Curl Command**:
+  ```bash
+  curl -v -X POST http://localhost:3000/api/solana-balances \
+  -H "Content-Type: application/json" \
+  -d '{"account": "test_account_1", "balance": 100.50}'
+  ```
+- **Response**:
+  ```json
+  {
+    "id": 1,
+    "account": "string",
+    "balance": "number",
+    "date": "timestamp"
+  }
+  ```
+
+### **Get All Balances for an Account**
+
+**GET** `/api/solana-balances/account/:account`
+
+- **Description**: Retrieves all balances for a specific Solana account.
+- **Curl Command**:
+  ```bash
+  curl -v http://localhost:3000/api/solana-balances/account/test_account_1
+  ```
+- **Response**:
+  ```json
+  [
+    {
+      "id": 1,
+      "account": "string",
+      "balance": "number",
+      "date": "timestamp"
+    },
+    ...
+  ]
+  ```
+
+### **Get Recent Balances (Last Month)**
+
+**GET** `/api/solana-balances/recent`
+
+- **Description**: Retrieves all Solana account balances from the past month, ordered by date.
+- **Curl Command**:
+  ```bash
+  curl -v http://localhost:3000/api/solana-balances/recent
+  ```
+- **Response**:
+  ```json
+  [
+    {
+      "account": "string",
+      "balance": "number",
+      "date": "timestamp"
+    },
+    ...
+  ]
+  ```
+
+---
+
+## Rate Limits Endpoints
+
+### **Create a New Rate Limit**
+
+**POST** `/api/rate-limits`
+
+- **Description**: Adds a new rate limit entry.
+- **Request Body**:
+  ```json
+  {
+    "key": "string",
+    "timestamps": ["number"]
+  }
+  ```
+- **Curl Command**:
+  ```bash
+  curl -v -X POST http://localhost:3000/api/rate-limits \
+  -H "Content-Type: application/json" \
+  -d '{"key": "test_key_1", "timestamps": [1635793421]}'
+  ```
+- **Response**:
+  ```json
+  {
+    "key": "string",
+    "timestamps": ["number"]
+  }
+  ```
+
+### **Get a Rate Limit by Key**
+
+**GET** `/api/rate-limits/:key`
+
+- **Description**: Retrieves the rate limit entry for a specific key.
+- **Curl Command**:
+  ```bash
+  curl -v http://localhost:3000/api/rate-limits/test_key_1
+  ```
+- **Response**:
+  ```json
+  {
+    "key": "string",
+    "timestamps": ["number"]
+  }
+  ```
+
+### **Update Timestamps for a Rate Limit**
+
+**PUT** `/api/rate-limits/:key`
+
+- **Description**: Updates the timestamps for a specific rate limit key.
+- **Request Body**:
+  ```json
+  {
+    "timestamps": ["number"]
+  }
+  ```
+- **Curl Command**:
+  ```bash
+  curl -v -X PUT http://localhost:3000/api/rate-limits/test_key_1 \
+  -H "Content-Type: application/json" \
+  -d '{"timestamps": [1635793500]}'
+  ```
+- **Response**:
+  ```json
+  {
+    "key": "string",
+    "timestamps": ["number"]
+  }
+  ```
+
+---
+
+## Error Handling
+
+All endpoints return appropriate HTTP status codes:
+- `201 Created` for successful creations.
+- `200 OK` for successful data retrieval or updates.
+- `404 Not Found` if the requested resource does not exist.
+- `500 Internal Server Error` for unhandled exceptions.

app.yaml

@@ -0,0 +1,35 @@
+runtime: nodejs20
+env: standard
+
+# Define the entry point for your application
+entrypoint: yarn start
+
+# Environment variables (replace with your actual values or secrets)
+env_variables:
+  POSTGRES_STRING: ${{ secrets.POSTGRES_STRING }}
+
+# Automatic scaling configuration
+automatic_scaling:
+  target_cpu_utilization: 0.65
+  target_throughput_utilization: 0.75
+  min_instances: 1
+  max_instances: 5
+
+# Network configuration
+network:
+  instance_tag: solana-devnet-faucet-backend
+  name: default
+
+# Optional: Specify resources
+resources:
+  cpu: 1
+  memory_gb: 0.5
+  disk_size_gb: 10
+
+# Optional: Health check configuration
+health_check:
+  enable_health_check: True
+  check_interval_sec: 10
+  timeout_sec: 4
+  unhealthy_threshold: 2
+  healthy_threshold: 2

package.json

@@ -5,6 +5,7 @@
   "main": "index.js",
   "type": "module",
   "scripts": {
+    "start": "node app.js",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [],

src/db/config.js

@@ -1,5 +1,6 @@
 import dotenv from 'dotenv';
-import { Pool } from 'pg'; // Use 'mysql2/promise' if using MySQL
+import pg from 'pg'; // Use 'mysql2/promise' if using MySQL
+const { Pool } = pg;
 
 dotenv.config();
 

src/db/solanaBalances.js

@@ -0,0 +1,41 @@
+import db from './config.js'; // Import the database config
+
+// CREATE a new Solana balance
+const createSolanaBalance = async (account, balance) => {
+    const query = `
+        INSERT INTO faucet.solana_balances (account, balance)
+        VALUES ($1, $2);
+    `;
+    const values = [account, balance];
+    const result = await db.query(query, values);
+    return result.rows[0];
+};
+
+// READ all Solana balances for an account
+const getSolanaBalancesByAccount = async (account) => {
+    const query = `
+        SELECT * FROM faucet.solana_balances
+        WHERE account = $1
+        ORDER BY date DESC;
+    `;
+    const values = [account];
+    const result = await db.query(query, values);
+    return result.rows;
+};
+
+const getRecentBalances = async () => {
+    const query = `
+        SELECT account, balance, date 
+        FROM faucet.solana_balances
+        WHERE date >= CURRENT_DATE - INTERVAL '1 month'
+        ORDER BY date;
+    `;
+    const result = await db.query(query);
+    return result.rows;
+};
+
+export default {
+    createSolanaBalance,
+    getRecentBalances,
+    getSolanaBalancesByAccount,
+};

src/routes/index.js

@@ -1,9 +1,13 @@
 import express from 'express';
-import rateLimitRoute from './rateLimitRoute.js'; // Import the rate limit routes
+import rateLimitRoute from './rateLimitRoute.js';
+import solanaBalancesRoute from "./solanaBalancesRoute.js"; // Import the rate limit routes
 
 const router = express.Router();
 
 // Use rate limit routes
 router.use(rateLimitRoute);
 
+// Use solana balances routes
+router.use(solanaBalancesRoute);
+
 export default router;

src/routes/solanaBalancesRoute.js

@@ -0,0 +1,41 @@
+import express from 'express';
+import solanaBalances from '../db/solanaBalances.js'; // Import the CRUD methods
+
+const router = express.Router();
+
+// CREATE a new Solana balance
+router.post('/solana-balances', async (req, res, next) => {
+    const { account, balance } = req.body;
+
+    try {
+        const newBalance = await solanaBalances.createSolanaBalance(account, balance);
+        res.status(201).json(newBalance);
+    } catch (error) {
+        next(error);
+    }
+});
+
+// READ all Solana balances for an account
+router.get('/solana-balances/account/:account', async (req, res, next) => {
+    const { account } = req.params;
+
+    try {
+        const balances = await solanaBalances.getSolanaBalancesByAccount(account);
+        res.status(200).json(balances);
+    } catch (error) {
+        next(error);
+    }
+});
+
+// GET recent Solana balances (last month)
+router.get('/solana-balances/recent', async (req, res, next) => {
+    try {
+        const recentBalances = await solanaBalances.getRecentBalances();
+        res.status(200).json(recentBalances);
+    } catch (error) {
+        next(error);
+    }
+});
+
+
+export default router;