feat: Added new endpoint GET /historical_fee?date=YYYY-MM-DDTHH:MM:SS

Author: kevkevinpal

app/src/main/kotlin/xyz/block/augurref/api/HistoricalFeeEndpoint.kt

@@ -0,0 +1,93 @@
+/*
+ * Copyright (c) 2025 Block, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package xyz.block.augurref.api
+
+import io.ktor.http.ContentType
+import io.ktor.http.HttpStatusCode
+import io.ktor.server.application.call
+import io.ktor.server.response.respond
+import io.ktor.server.response.respondText
+import io.ktor.server.routing.Route
+import io.ktor.server.routing.get
+import org.slf4j.LoggerFactory
+import xyz.block.augurref.service.MempoolCollector
+import java.time.LocalDateTime
+import java.time.format.DateTimeParseException
+
+/**
+ * Configure historical fee estimate endpoint
+ */
+fun Route.configureHistoricalFeesEndpoint(mempoolCollector: MempoolCollector) {
+  val logger = LoggerFactory.getLogger("xyz.block.augurref.api.HistoricalFeeEstimateEndpoint")
+
+  get("/historical_fee") {
+    logger.info("Received request for historical fee estimates")
+
+    // Extract date param from query parameters
+    val dateParam = call.request.queryParameters["date"]
+
+    if (dateParam == null) {
+      call.respondText(
+        "Date parameter is required",
+        status = HttpStatusCode.BadRequest,
+        contentType = ContentType.Text.Plain,
+      )
+      return@get
+    }
+
+    // Validate and parse the date
+    val date = try {
+      dateParam?.let { LocalDateTime.parse(it) }
+    } catch (e: DateTimeParseException) {
+      logger.warn("Invalid date format: $dateParam")
+      call.respondText(
+        "Invalid date format. Use YYYY-MM-DDTHH:MM:SS",
+        status = HttpStatusCode.BadRequest,
+        contentType = ContentType.Text.Plain,
+      )
+      return@get
+    }
+
+    // Fetch historical fee estimate based on date
+    val feeEstimate = if (date != null) {
+      logger.info("Fetching historical fee estimate for date: $date")
+      mempoolCollector.getFeeEstimateForDate(date)
+    } else {
+      logger.warn("date is null")
+      call.respondText(
+        "Failed to parse date",
+        status = HttpStatusCode.InternalServerError,
+        contentType = ContentType.Text.Plain,
+      )
+      return@get
+    }
+
+    if (feeEstimate == null) {
+      logger.warn("No historical fee estimates available for $date")
+      call.respondText(
+        "No historical fee estimates available for $date",
+        status = HttpStatusCode.ServiceUnavailable,
+        contentType = ContentType.Text.Plain,
+      )
+    } else {
+      logger.info("Transforming historical fee estimates for response")
+      val response = transformFeeEstimate(feeEstimate)
+      logger.debug("Returning historical fee estimates with ${response.estimates.size} targets")
+      call.respond(response)
+    }
+  }
+}

app/src/main/kotlin/xyz/block/augurref/server/HttpServer.kt

@@ -26,6 +26,7 @@ import io.ktor.server.plugins.contentnegotiation.ContentNegotiation
 import io.ktor.server.routing.routing
 import org.slf4j.LoggerFactory
 import xyz.block.augurref.api.configureFeesEndpoint
+import xyz.block.augurref.api.configureHistoricalFeesEndpoint
 import xyz.block.augurref.config.ServerConfig
 import xyz.block.augurref.service.MempoolCollector
 
@@ -58,6 +59,7 @@ class HttpServer(
       // Configure routes
       routing {
         configureFeesEndpoint(mempoolCollector)
+        configureHistoricalFeesEndpoint(mempoolCollector)
       }
     }.start(wait = false)
 

app/src/main/kotlin/xyz/block/augurref/service/MempoolCollector.kt

@@ -24,6 +24,7 @@ import xyz.block.augurref.bitcoin.BitcoinRpcClient
 import xyz.block.augurref.persistence.MempoolPersistence
 import java.time.Instant
 import java.time.LocalDateTime
+import java.time.ZoneId
 import java.util.concurrent.atomic.AtomicReference
 import kotlin.concurrent.fixedRateTimer
 
@@ -71,6 +72,36 @@ class MempoolCollector(
     return latestFeeEstimate.get()
   }
 
+  /**
+   * Get the fee estimate for specific date
+   */
+  fun getFeeEstimateForDate(dateTimeUTC: LocalDateTime): FeeEstimate? {
+    val dateTime = dateTimeUTC
+      .atZone(ZoneId.of("UTC")) // Interpret as UTC
+      .withZoneSameInstant(ZoneId.systemDefault())
+      .toLocalDateTime()
+    // Fetch the last day's snapshots
+    logger.debug("Fetching snapshots from the last day")
+    val lastDaySnapshots = persistence.getSnapshots(
+      dateTime.minusDays(1),
+      dateTime,
+    )
+    logger.debug("Retrieved ${lastDaySnapshots.size} snapshots from the last day")
+
+    if (lastDaySnapshots.isNotEmpty()) {
+      // Calculate fee estimate for x blocks
+      logger.debug("Calculating fee estimates")
+      val newFeeEstimate = feeEstimator.calculateEstimates(lastDaySnapshots)
+      return newFeeEstimate
+    } else {
+      logger.warn("No snapshots available for fee estimation")
+    }
+    return FeeEstimate(
+      estimates = emptyMap(),
+      timestamp = dateTime.atZone(ZoneId.of("UTC")).toInstant(),
+    )
+  }
+
   /**
    * Get the latest fee estimate for block target
    */