feat: support running the app in API/background mode only

src/app.ts

@@ -26,36 +26,44 @@ import cron from './plugins/cron';
 
 async function routes(fastify: FastifyInstance) {
   fastify.log.info(`Process env: ${JSON.stringify(getSafeEnvs(), null, 2)}`);
+  const env = container.resolve('env');
 
-  await fastify.register(cors);
   await fastify.register(sentry);
   fastify.register(sensible);
   fastify.register(compress);
-  fastify.register(swagger);
-  fastify.register(jwt);
-  fastify.register(ipBlock);
-  fastify.register(cache);
-  fastify.register(rateLimit);
-  fastify.register(healthcheck);
 
-  const env = container.resolve('env');
   await container.resolve('bitcoin').checkNetwork(env.NETWORK as NetworkType);
 
-  fastify.register(internalRoutes, { prefix: '/internal' });
-  fastify.register(tokenRoutes, { prefix: '/token' });
-  fastify.register(bitcoinRoutes, { prefix: '/bitcoin/v1' });
-  fastify.register(rgbppRoutes, { prefix: '/rgbpp/v1' });
+  fastify.log.info(`Application mode: ${env.APP_MODE}`);
+  if (['full', 'api'].includes(env.APP_MODE)) {
+    await fastify.register(cors);
+    fastify.register(swagger);
+    fastify.register(jwt);
+    fastify.register(ipBlock);
+    fastify.register(cache);
+    fastify.register(rateLimit);
+    fastify.register(healthcheck);
+
+    fastify.register(internalRoutes, { prefix: '/internal' });
+    fastify.register(tokenRoutes, { prefix: '/token' });
+    fastify.register(bitcoinRoutes, { prefix: '/bitcoin/v1' });
+    fastify.register(rgbppRoutes, { prefix: '/rgbpp/v1' });
+
+    fastify.log.info('Routes are registered');
+  }
 
-  // register cron routes only on Vercel
-  if (provider === 'vercel' || env.NODE_ENV === 'test') {
-    fastify.log.info('Cron routes is registered');
-    fastify.register(cronRoutes, { prefix: '/cron' });
-  } else {
-    fastify.log.info('Cron plugin is registered');
-    await fastify.register(cron);
-    fastify.addHook('onReady', () => {
-      fastify.cron.startAllJobs();
-    });
+  if (['full', 'background'].includes(env.APP_MODE)) {
+    // register cron routes only on Vercel
+    if (provider === 'vercel' || env.NODE_ENV === 'test') {
+      fastify.register(cronRoutes, { prefix: '/cron' });
+      fastify.log.info('Cron routes is registered');
+    } else {
+      await fastify.register(cron);
+      fastify.addHook('onReady', () => {
+        fastify.cron.startAllJobs();
+      });
+      fastify.log.info('Cron plugin is registered');
+    }
   }
 }
 

src/env.ts

@@ -69,6 +69,14 @@ const envSchema = z
       .transform((value) => value.split(','))
       .pipe(z.string().array()),
 
+    /**
+     * Application Mode
+     * - full: Full application mode, includes API and background tasks.
+     * - api_only: API only mode, excludes background tasks.
+     * - background_only: Background tasks only mode, excludes API.
+     */
+    APP_MODE: z.enum(['full', 'api', 'background']).default('full'),
+
     /**
      * Bitcoin SPV service URL
      * https://github.com/ckb-cell/ckb-bitcoin-spv-service
@@ -113,6 +121,14 @@ const envSchema = z
      */
     PAYMASTER_BTC_CONTAINER_FEE_SATS: z.coerce.number().default(7000),
 
+    /**
+     * Enable BTCTimeLock cell unlock cron task
+     * set to false to disable the BTCTimeLock cell unlock cron task
+     */
+    UNLOCKER_CRON_TASK_ENABLE: z
+      .enum(['true', 'false'])
+      .default('true')
+      .transform((value) => value === 'true'),
     /**
      * BTCTimeLock cell unlock batch size
      */

src/options.ts

@@ -16,7 +16,7 @@ const envToLogger = {
           },
         }
       : {}),
-    level: env.LOGGER_LEVEL ?? 'debug',
+    level: 'debug',
   },
   production: {
     level: env.LOGGER_LEVEL ?? 'info',

src/plugins/cron.ts

@@ -1,11 +1,12 @@
 import fp from 'fastify-plugin';
 import TransactionProcessor from '../services/transaction';
-import cron from 'fastify-cron';
+import cron, { Params as CronJobParams } from 'fastify-cron';
 import { Env } from '../env';
 import Unlocker from '../services/unlocker';
 
 export default fp(async (fastify) => {
   try {
+    const cronJobs: CronJobParams[] = [];
     const env: Env = fastify.container.resolve('env');
 
     const getSentryCheckIn = (monitorSlug: string, crontab: string) => {
@@ -77,31 +78,35 @@ export default fp(async (fastify) => {
         });
       },
     };
+    cronJobs.push(retryMissingTransactionsJob);
 
     // processing unlock BTC_TIME_LOCK cells
-    const unlocker: Unlocker = fastify.container.resolve('unlocker');
-    const monitorSlug = env.UNLOCKER_MONITOR_SLUG;
-    const unlockBTCTimeLockCellsJob = {
-      name: monitorSlug,
-      cronTime: env.UNLOCKER_CRON_SCHEDULE,
-      onTick: async () => {
-        fastify.Sentry.startSpan({ op: 'cron', name: monitorSlug }, async () => {
-          const { name, cronTime } = unlockBTCTimeLockCellsJob;
-          const checkIn = getSentryCheckIn(name, cronTime);
-          try {
-            await unlocker.unlockCells();
-            checkIn.ok();
-          } catch (err) {
-            checkIn.error();
-            fastify.log.error(err);
-            fastify.Sentry.captureException(err);
-          }
-        });
-      },
-    };
+    if (env.UNLOCKER_CRON_TASK_ENABLE) {
+      const unlocker: Unlocker = fastify.container.resolve('unlocker');
+      const monitorSlug = env.UNLOCKER_MONITOR_SLUG;
+      const unlockBTCTimeLockCellsJob = {
+        name: monitorSlug,
+        cronTime: env.UNLOCKER_CRON_SCHEDULE,
+        onTick: async () => {
+          fastify.Sentry.startSpan({ op: 'cron', name: monitorSlug }, async () => {
+            const { name, cronTime } = unlockBTCTimeLockCellsJob;
+            const checkIn = getSentryCheckIn(name, cronTime);
+            try {
+              await unlocker.unlockCells();
+              checkIn.ok();
+            } catch (err) {
+              checkIn.error();
+              fastify.log.error(err);
+              fastify.Sentry.captureException(err);
+            }
+          });
+        },
+      };
+      cronJobs.push(unlockBTCTimeLockCellsJob);
+    }
 
     fastify.register(cron, {
-      jobs: [retryMissingTransactionsJob, unlockBTCTimeLockCellsJob],
+      jobs: cronJobs,
     });
   } catch (err) {
     fastify.log.error(err);