feat: Implement chainhooks durable object and associated changes

Author: whoabuddy

src/config.ts

@@ -50,7 +50,7 @@ export class AppConfig {
 		return {
 			// supported services for API caching
 			// each entry is a durable object that handles requests
-			SUPPORTED_SERVICES: ['/bns', '/hiro-api', '/stx-city', '/supabase', '/contract-calls'],
+			SUPPORTED_SERVICES: ['/bns', '/hiro-api', '/stx-city', '/supabase', '/contract-calls', '/chainhooks'],
 			// VALUES BELOW CAN BE OVERRIDDEN BY DURABLE OBJECTS
 			// default cache TTL used for KV
 			CACHE_TTL: 900, // 15 minutes

src/durable-objects/chainhooks-do.ts

@@ -0,0 +1,111 @@
+import { DurableObject } from 'cloudflare:workers';
+import { Env } from '../../worker-configuration';
+import { AppConfig } from '../config';
+import { handleRequest } from '../utils/request-handler-util';
+import { ApiError } from '../utils/api-error-util';
+import { ErrorCode } from '../utils/error-catalog-util';
+import { Logger } from '../utils/logger-util';
+
+export class ChainhooksDO extends DurableObject<Env> {
+  // Configuration constants
+  private readonly BASE_PATH: string = '/chainhooks';
+  private readonly CACHE_PREFIX: string = this.BASE_PATH.replaceAll('/', '');
+  private readonly SUPPORTED_ENDPOINTS: string[] = ['/post_event'];
+  
+  constructor(ctx: DurableObjectState, env: Env) {
+    super(ctx, env);
+    this.ctx = ctx;
+    this.env = env;
+
+    // Initialize AppConfig with environment
+    const config = AppConfig.getInstance(env).getConfig();
+  }
+
+  async fetch(request: Request): Promise<Response> {
+    const url = new URL(request.url);
+    const path = url.pathname;
+    const method = request.method;
+
+    return handleRequest(
+      async () => {
+        if (!path.startsWith(this.BASE_PATH)) {
+          throw new ApiError(ErrorCode.NOT_FOUND, { resource: path });
+        }
+
+        // Remove base path to get the endpoint
+        const endpoint = path.replace(this.BASE_PATH, '');
+
+        // Handle root path
+        if (endpoint === '' || endpoint === '/') {
+          return {
+            message: `Supported endpoints: ${this.SUPPORTED_ENDPOINTS.join(', ')}`,
+          };
+        }
+
+        // Handle post_event endpoint
+        if (endpoint === '/post_event') {
+          if (method !== 'POST') {
+            throw new ApiError(ErrorCode.INVALID_REQUEST, {
+              reason: `Method ${method} not allowed for this endpoint. Use POST.`,
+            });
+          }
+          
+          return await this.handlePostEvent(request);
+        }
+
+        // If we get here, the endpoint is not supported
+        throw new ApiError(ErrorCode.NOT_FOUND, {
+          resource: endpoint,
+          supportedEndpoints: this.SUPPORTED_ENDPOINTS,
+        });
+      },
+      this.env,
+      {
+        path,
+        method,
+      }
+    );
+  }
+
+  private async handlePostEvent(request: Request): Promise<any> {
+    const logger = Logger.getInstance(this.env);
+    
+    try {
+      // Clone the request to read the body
+      const clonedRequest = request.clone();
+      
+      // Try to parse as JSON first
+      let body;
+      try {
+        body = await clonedRequest.json();
+      } catch (e) {
+        // If JSON parsing fails, get the body as text
+        body = await request.text();
+      }
+      
+      // Log the received event
+      logger.info('Received chainhook event', { 
+        body,
+        headers: Object.fromEntries(request.headers.entries()),
+      });
+      
+      // Store the event in Durable Object storage for later analysis
+      const eventId = crypto.randomUUID();
+      await this.ctx.storage.put(`event_${eventId}`, {
+        timestamp: new Date().toISOString(),
+        body,
+        headers: Object.fromEntries(request.headers.entries()),
+      });
+      
+      return {
+        message: 'Event received and logged successfully',
+        eventId,
+      };
+    } catch (error) {
+      logger.error('Error processing chainhook event', error instanceof Error ? error : new Error(String(error)));
+      throw new ApiError(ErrorCode.INTERNAL_ERROR, {
+        reason: 'Failed to process chainhook event',
+      });
+    }
+  }
+}

src/index.ts

@@ -5,13 +5,14 @@ import { HiroApiDO } from './durable-objects/hiro-api-do';
 import { StxCityDO } from './durable-objects/stx-city-do';
 import { SupabaseDO } from './durable-objects/supabase-do';
 import { ContractCallsDO } from './durable-objects/contract-calls-do';
+import { ChainhooksDO } from './durable-objects/chainhooks-do';
 import { corsHeaders, createErrorResponse, createSuccessResponse } from './utils/requests-responses-util';
 import { ApiError } from './utils/api-error-util';
 import { ErrorCode } from './utils/error-catalog-util';
 import { Logger } from './utils/logger-util';
 
 // export the Durable Object classes we're using
-export { BnsApiDO, HiroApiDO, StxCityDO, SupabaseDO, ContractCallsDO };
+export { BnsApiDO, HiroApiDO, StxCityDO, SupabaseDO, ContractCallsDO, ChainhooksDO };
 
 export default {
 	/**
@@ -90,6 +91,12 @@ export default {
 					let stub = env.CONTRACT_CALLS_DO.get(id); // get the stub for communication
 					return await stub.fetch(request); // forward the request to the Durable Object
 				}
+
+				if (path.startsWith('/chainhooks')) {
+					let id: DurableObjectId = env.CHAINHOOKS_DO.idFromName('chainhooks-do'); // create the instance
+					let stub = env.CHAINHOOKS_DO.get(id); // get the stub for communication
+					return await stub.fetch(request); // forward the request to the Durable Object
+				}
 			} catch (error) {
 				// Log errors from Durable Objects
 				const duration = Date.now() - startTime;

worker-configuration.d.ts

@@ -10,4 +10,5 @@ export interface Env {
 	STX_CITY_DO: DurableObjectNamespace<import('./src/index').StxCityDO>;
 	SUPABASE_DO: DurableObjectNamespace<import('./src/index').SupabaseDO>;
 	CONTRACT_CALLS_DO: DurableObjectNamespace<import('./src/index').ContractCallsDO>;
+	CHAINHOOKS_DO: DurableObjectNamespace<import('./src/index').ChainhooksDO>;
 }

wrangler.toml

@@ -17,6 +17,10 @@ new_classes = ["HiroApiDO", "SupabaseDO", "StxCityDO", "BnsApiDO"]
 tag = "20250323"
 new_classes = ["ContractCallsDO"]
 
+[[migrations]]
+tag = "20250417"
+new_classes = ["ChainhooksDO"]
+
 
 [env.preview]
 
@@ -46,6 +50,10 @@ class_name = "BnsApiDO"
 name = "CONTRACT_CALLS_DO"
 class_name = "ContractCallsDO"
 
+[[env.preview.durable_objects.bindings]]
+name = "CHAINHOOKS_DO"
+class_name = "ChainhooksDO"
+
 
 [env.staging]
 
@@ -75,6 +83,10 @@ class_name = "BnsApiDO"
 name = "CONTRACT_CALLS_DO"
 class_name = "ContractCallsDO"
 
+[[env.staging.durable_objects.bindings]]
+name = "CHAINHOOKS_DO"
+class_name = "ChainhooksDO"
+
 
 [env.production]
 
@@ -103,3 +115,7 @@ class_name = "BnsApiDO"
 [[env.production.durable_objects.bindings]]
 name = "CONTRACT_CALLS_DO"
 class_name = "ContractCallsDO"
+
+[[env.production.durable_objects.bindings]]
+name = "CHAINHOOKS_DO"
+class_name = "ChainhooksDO"