Read Only Mode (#565)

* Read Only Mode

* updates

* updates

Author: farhanW3

docker-compose-infra.yml

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   db:
     image: postgres:latest

docker-compose-prod.yml

@@ -1,4 +1,3 @@
-version: "3.8"
 services:
   engine:
     build:

src/db/transactions/getAllTxs.ts

@@ -73,19 +73,13 @@ export const getAllTxs = async ({
   const totalCountPromise: Promise<number> = prisma.transactions.count({
     where: {
       ...filterQuery,
-      queuedAt: {
-        gte: new Date(Date.now() - 24 * 60 * 60 * 1000),
-      },
     },
   });
 
   // TODO: Cleaning should be handled by zod
   const txsPromise: Promise<Transactions[]> = prisma.transactions.findMany({
     where: {
       ...filterQuery,
-      queuedAt: {
-        gte: new Date(Date.now() - 24 * 60 * 60 * 1000),
-      },
     },
     orderBy: [
       {

src/server/index.ts

@@ -10,6 +10,7 @@ import { withServerUsageReporting } from "../utils/usage";
 import { updateTxListener } from "./listeners/updateTxListener";
 import { withAuth } from "./middleware/auth";
 import { withCors } from "./middleware/cors";
+import { withEnforceEngineMode } from "./middleware/engine-mode";
 import { withErrorHandler } from "./middleware/error";
 import { withExpress } from "./middleware/express";
 import { withRequestLogs } from "./middleware/logs";
@@ -57,6 +58,7 @@ export const initServer = async () => {
   await withCors(server);
   await withRequestLogs(server);
   await withErrorHandler(server);
+  await withEnforceEngineMode(server);
   await withWebSocket(server);
   await withAuth(server);
   await withExpress(server);

src/server/middleware/auth.ts

@@ -106,6 +106,10 @@ export const withAuth = async (server: FastifyInstance) => {
   // Note: in the onRequest hook, request.body will always be undefined, because the body parsing happens before the preValidation hook.
   // https://fastify.dev/docs/latest/Reference/Hooks/#onrequest
   server.addHook("preValidation", async (req, res) => {
+    // Skip auth check in sandbox mode
+    if (env.ENGINE_MODE === "sandbox") {
+      return;
+    }
     let message =
       "Please provide a valid access token or other authentication. See: https://portal.thirdweb.com/engine/features/access-tokens";
 

src/server/middleware/engine-mode.ts

@@ -0,0 +1,16 @@
+import { FastifyInstance } from "fastify";
+import { env } from "../../utils/env";
+
+export const withEnforceEngineMode = async (server: FastifyInstance) => {
+  if (env.ENGINE_MODE === "sandbox") {
+    server.addHook("onRequest", async (request, reply) => {
+      if (request.method !== "GET") {
+        return reply.status(405).send({
+          statusCode: 405,
+          error: "Read Only Mode. Method Not Allowed",
+          message: "Read Only Mode. Method Not Allowed",
+        });
+      }
+    });
+  }
+};

src/utils/env.ts

@@ -72,6 +72,7 @@ export const env = createEnv({
       .nonnegative()
       .default(0),
     REDIS_URL: z.string(),
+    ENGINE_MODE: z.enum(["sandbox", "unrestricted"]).default("unrestricted"),
   },
   clientPrefix: "NEVER_USED",
   client: {},
@@ -96,6 +97,7 @@ export const env = createEnv({
     CONTRACT_SUBSCRIPTIONS_DELAY_SECONDS:
       process.env.CONTRACT_SUBSCRIPTIONS_DELAY_SECONDS,
     REDIS_URL: process.env.REDIS_URL,
+    ENGINE_MODE: process.env.ENGINE_MODE,
   },
   onValidationError: (error: ZodError) => {
     console.error(