chore: setup code formatter

Refactor code to use single quotes for string literals across the project; update workflows for consistency and add CI configuration with Prettier settings.

Author: Emmo00

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run CI
+        run: npm run ci

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "printWidth": 100,
+  "tabWidth": 2
+}

.vscode/settings.json

@@ -1,8 +1,3 @@
 {
-    "cSpell.words": [
-        "AREWEAVE",
-        "Arweave",
-        "m3ter",
-        "m3tering"
-    ]
-}
+  "cSpell.words": ["AREWEAVE", "Arweave", "m3ter", "m3tering"]
+}

README.md

@@ -15,58 +15,58 @@ Before setting up the project, ensure you have the following installed:
 
 1. **Clone the Repository**:
 
-    ```bash
-    git clone <repository-url>
-    cd m3tering-arweave-gateway-interface
-    ```
+   ```bash
+   git clone <repository-url>
+   cd m3tering-arweave-gateway-interface
+   ```
 
 2. **Install Dependencies**:
-    Install the required dependencies using npm:
+   Install the required dependencies using npm:
 
-    ```bash
-    npm install
-    ```
+   ```bash
+   npm install
+   ```
 
 3. **Configure Environment Variables**:
-    Create a `.env` file in the root directory by copying the provided `.env.example` file:
+   Create a `.env` file in the root directory by copying the provided `.env.example` file:
 
-    ```bash
-    cp .env.example .env
-    ```
+   ```bash
+   cp .env.example .env
+   ```
 
-    Update the `.env` file with your Arweave Gateway URL and MongoDB URI:
+   Update the `.env` file with your Arweave Gateway URL and MongoDB URI:
 
-    ```env
-    ARWEAVE_GATEWAY_URL=<your-arweave-gateway-url>
-    MONGODB_URI=<your-mongodb-uri>
-    ```
+   ```env
+   ARWEAVE_GATEWAY_URL=<your-arweave-gateway-url>
+   MONGODB_URI=<your-mongodb-uri>
+   ```
 
 4. **Compile the TypeScript Code**:
-    Compile the TypeScript code into JavaScript:
+   Compile the TypeScript code into JavaScript:
 
-    ```bash
-    npm run compile
-    ```
+   ```bash
+   npm run compile
+   ```
 
 5. **Run the Application**:
-    Start the application:
+   Start the application:
 
-    ```bash
-    npm start
-    ```
+   ```bash
+   npm start
+   ```
 
-    Alternatively, for development with hot-reloading:
+   Alternatively, for development with hot-reloading:
 
-    ```bash
-    npm run dev
-    ```
+   ```bash
+   npm run dev
+   ```
 
 6. **Access the GraphQL Interface**:
-    Once the application is running, you can access the GraphQL interface at:
+   Once the application is running, you can access the GraphQL interface at:
 
-    ```browser
-    http://localhost:4001/graphql
-    ```
+   ```browser
+   http://localhost:4001/graphql
+   ```
 
 ## Project Structure
 

package-lock.json

@@ -5,7 +5,10 @@
   "scripts": {
     "compile": "tsc",
     "start": "npm run compile && node ./dist/index.js",
-    "dev": "nodemon --watch src --watch . --ext ts,graphql --watch .env"
+    "dev": "nodemon --watch src --watch . --ext ts,graphql --watch .env",
+    "format": "prettier --write .",
+    "check-format": "prettier --check .",
+    "ci": "npm run build && npm run check-format"
   },
   "keywords": [],
   "author": "",
@@ -26,6 +29,7 @@
   "devDependencies": {
     "@types/node": "^22.14.1",
     "nodemon": "^3.1.10",
+    "prettier": "^3.6.2",
     "ts-node": "^10.9.2",
     "typescript": "^5.8.3"
   }

package.json

@@ -1,46 +1,41 @@
-import { ARWEAVE_GATEWAY_URL, ARWEAVE_PEERS } from "../constants"
+import { ARWEAVE_GATEWAY_URL, ARWEAVE_PEERS } from '../constants';
 
 class ArweaveConfig {
-  private gatewayUrl: string
+  private gatewayUrl: string;
 
   constructor() {
-    this.gatewayUrl = ARWEAVE_GATEWAY_URL
-      ? ARWEAVE_GATEWAY_URL
-      : ARWEAVE_PEERS[0]
+    this.gatewayUrl = ARWEAVE_GATEWAY_URL ? ARWEAVE_GATEWAY_URL : ARWEAVE_PEERS[0];
 
     if (!this.gatewayUrl) {
-      throw new Error("No Arweave gateway URL provided")
+      throw new Error('No Arweave gateway URL provided');
     }
   }
 
   public getGatewayUrl(): string {
-    return this.gatewayUrl
+    return this.gatewayUrl;
   }
 
   public rotateGatewayUrl() {
     // Rotate to the next gateway URL in the list
-    const currentURL = this.gatewayUrl
-    const currentIndex = ARWEAVE_PEERS.indexOf(currentURL)
+    const currentURL = this.gatewayUrl;
+    const currentIndex = ARWEAVE_PEERS.indexOf(currentURL);
     if (currentIndex === -1 || currentIndex === ARWEAVE_PEERS.length - 1) {
-      this.gatewayUrl = ARWEAVE_PEERS[0]
+      this.gatewayUrl = ARWEAVE_PEERS[0];
     } else {
-      this.gatewayUrl = ARWEAVE_PEERS[currentIndex + 1]
+      this.gatewayUrl = ARWEAVE_PEERS[currentIndex + 1];
     }
 
     // if new url is an ip, make sure it is a full url
-    if (
-      !this.gatewayUrl.startsWith("http://") &&
-      !this.gatewayUrl.startsWith("https://")
-    ) {
-      this.gatewayUrl = `http://${this.gatewayUrl}`
+    if (!this.gatewayUrl.startsWith('http://') && !this.gatewayUrl.startsWith('https://')) {
+      this.gatewayUrl = `http://${this.gatewayUrl}`;
     }
 
     if (this.gatewayUrl === currentURL && ARWEAVE_PEERS.length > 1) {
-      this.rotateGatewayUrl()
+      this.rotateGatewayUrl();
     }
 
-    return this.gatewayUrl
+    return this.gatewayUrl;
   }
 }
 
-export const arweaveConfig = new ArweaveConfig()
+export const arweaveConfig = new ArweaveConfig();

src/config/arweave.ts

@@ -1,5 +1,5 @@
-import mongoose from "mongoose";
-import { MONGODB_URI } from "../constants";
+import mongoose from 'mongoose';
+import { MONGODB_URI } from '../constants';
 
 export const connectDB = async () => {
   try {

src/config/mongo.ts

@@ -1,17 +1,17 @@
-import fs from "fs";
-import http from "http";
-import cors from "cors";
-import express from "express";
-import  logger from "morgan";
-import { ApolloServer } from "@apollo/server";
-import { expressMiddleware } from "@as-integrations/express5";
-import { ApolloServerPluginDrainHttpServer } from "@apollo/server/plugin/drainHttpServer";
-import { resolvers as v1Resolvers } from "../resolvers/v1/index";
-import { resolvers as v2Resolvers } from "../resolvers/v2/index";
+import fs from 'fs';
+import http from 'http';
+import cors from 'cors';
+import express from 'express';
+import logger from 'morgan';
+import { ApolloServer } from '@apollo/server';
+import { expressMiddleware } from '@as-integrations/express5';
+import { ApolloServerPluginDrainHttpServer } from '@apollo/server/plugin/drainHttpServer';
+import { resolvers as v1Resolvers } from '../resolvers/v1/index';
+import { resolvers as v2Resolvers } from '../resolvers/v2/index';
 
 // load graphql schema from file
-const typeDefsV1 = fs.readFileSync("./schema.graphql", "utf-8");
-const typeDefsV2 = fs.readFileSync("./schema.v2.graphql", "utf-8");
+const typeDefsV1 = fs.readFileSync('./schema.graphql', 'utf-8');
+const typeDefsV2 = fs.readFileSync('./schema.v2.graphql', 'utf-8');
 
 const app = express();
 const httpServer = http.createServer(app);
@@ -35,18 +35,18 @@ export async function startServer() {
 
   // configure versioned endpoints
   app.use(cors());
-  app.use(logger("dev"));
-  app.use("/graphql", express.json(), expressMiddleware(serverV1)); // maintain V1 as default for "/graphql"
-  app.use("/v1", express.json(), expressMiddleware(serverV1));
-  app.use("/v1/graphql", express.json(), expressMiddleware(serverV1));
-  app.use("/v2", express.json(), expressMiddleware(serverV2));
-  app.use("/v2/graphql", express.json(), expressMiddleware(serverV2));
-  app.use("/", express.json(), expressMiddleware(serverV1)); // maintain V1 as default for "/graphql"
+  app.use(logger('dev'));
+  app.use('/graphql', express.json(), expressMiddleware(serverV1)); // maintain V1 as default for "/graphql"
+  app.use('/v1', express.json(), expressMiddleware(serverV1));
+  app.use('/v1/graphql', express.json(), expressMiddleware(serverV1));
+  app.use('/v2', express.json(), expressMiddleware(serverV2));
+  app.use('/v2/graphql', express.json(), expressMiddleware(serverV2));
+  app.use('/', express.json(), expressMiddleware(serverV1)); // maintain V1 as default for "/graphql"
 
   return await new Promise<void>((resolve) => {
     const PORT = process.env.PORT || 4000;
     httpServer.listen({ port: PORT }, () => {
-      console.log("Subgraph server started on port", PORT);
+      console.log('Subgraph server started on port', PORT);
       resolve();
     });
   });

src/config/server.ts

@@ -1,3 +1,3 @@
-import { WarpFactory } from "warp-contracts";
+import { WarpFactory } from 'warp-contracts';
 
 export const warp = WarpFactory.forMainnet();