fix-api

Author: m30m

apps/fortuna/README.md

@@ -10,6 +10,14 @@ Each blockchain is configured in `config.yaml`.
 
 ## Build & Test
 
+We use sqlx query macros to check the SQL queries at compile time. This requires
+a database to be available at build time. You can create an sqlite db and apply the schema migrations on it
+via the following command:
+
+```bash
+DATABASE_URL="sqlite:fortuna.db?mode=rwc" cargo sqlx migrate run
+```
+
 Fortuna uses Cargo for building and dependency management.
 Simply run `cargo build` and `cargo test` to build and test the project.
 

apps/fortuna/src/api.rs

@@ -111,6 +111,8 @@ pub enum RestError {
     InvalidSequenceNumber,
     /// The caller passed an unsupported chain id
     InvalidChainId,
+    /// The query is not parsable to a transaction hash, address, or sequence number
+    InvalidQueryString,
     /// The caller requested a random value that can't currently be revealed (because it
     /// hasn't been committed to on-chain)
     NoPendingRequest,
@@ -120,7 +122,6 @@ pub enum RestError {
     /// The server cannot currently communicate with the blockchain, so is not able to verify
     /// which random values have been requested.
     TemporarilyUnavailable,
-    BadFilterParameters(String),
     /// The server is not able to process the request because the blockchain initialization
     /// has not been completed yet.
     Uninitialized,
@@ -139,6 +140,11 @@ impl IntoResponse for RestError {
             RestError::InvalidChainId => {
                 (StatusCode::BAD_REQUEST, "The chain id is not supported").into_response()
             }
+            RestError::InvalidQueryString => (
+                StatusCode::BAD_REQUEST,
+                "The query string is not parsable to a transaction hash, address, or sequence number",
+            )
+                .into_response(),
             RestError::NoPendingRequest => (
                 StatusCode::FORBIDDEN,
                 "The request with the given sequence number has not been made yet, or the random value has already been revealed on chain.",
@@ -163,11 +169,6 @@ impl IntoResponse for RestError {
                 "An unknown error occurred processing the request",
             )
                 .into_response(),
-            RestError::BadFilterParameters(message) => (
-                StatusCode::BAD_REQUEST,
-                format!("Invalid filter parameters: {}", message),
-            )
-                .into_response(),
         }
     }
 }
@@ -179,7 +180,7 @@ pub fn routes(state: ApiState) -> Router<(), Body> {
         .route("/metrics", get(metrics))
         .route("/ready", get(ready))
         .route("/v1/chains", get(chain_ids))
-        .route("/v1/explorer", get(explorer))
+        .route("/v1/logs", get(explorer))
         .route(
             "/v1/chains/:chain_id/revelations/:sequence",
             get(revelation),

apps/fortuna/src/api/explorer.rs

@@ -2,32 +2,46 @@ use crate::api::{ChainId, RestError};
 use crate::history::RequestStatus;
 use axum::extract::{Query, State};
 use axum::Json;
+use chrono::{DateTime, Utc};
 use ethers::types::{Address, TxHash};
 use std::str::FromStr;
-use utoipa::{IntoParams, ToSchema};
+use utoipa::IntoParams;
 
 #[derive(Debug, serde::Serialize, serde::Deserialize, IntoParams)]
 #[into_params(parameter_in=Query)]
 pub struct ExplorerQueryParams {
-    pub min_timestamp: Option<u64>,
-    pub max_timestamp: Option<u64>,
+    /// Only return logs that are newer or equal to this timestamp.
+    #[param(value_type = Option<String>, example = "2023-10-01T00:00:00Z")]
+    pub min_timestamp: Option<DateTime<Utc>>,
+    /// Only return logs that are older or equal to this timestamp.
+    #[param(value_type = Option<String>, example = "2023-10-01T00:00:00Z")]
+    pub max_timestamp: Option<DateTime<Utc>>,
+    /// The query string to search for. This can be a transaction hash, sender address, or sequence number.
     pub query: Option<String>,
     #[param(value_type = Option<String>)]
+    /// The chain ID to filter the results by.
     pub chain_id: Option<ChainId>,
 }
 
+const LOG_RETURN_LIMIT: u64 = 1000;
+
 #[utoipa::path(
     get,
-    path = "/v1/explorer",
+    path = "/v1/logs",
     responses(
-    (status = 200, description = "Random value successfully retrieved", body = Vec<RequestJournal>)
+    (status = 200, description = "Entropy request logs", body = Vec<RequestStatus>)
     ),
     params(ExplorerQueryParams)
 )]
 pub async fn explorer(
     State(state): State<crate::api::ApiState>,
     Query(query_params): Query<ExplorerQueryParams>,
 ) -> anyhow::Result<Json<Vec<RequestStatus>>, RestError> {
+    if let Some(chain_id) = &query_params.chain_id {
+        if !state.chains.read().await.contains_key(chain_id) {
+            return Err(RestError::InvalidChainId);
+        }
+    }
     if let Some(query) = query_params.query {
         if let Ok(tx_hash) = TxHash::from_str(&query) {
             return Ok(Json(state.history.get_requests_by_tx_hash(tx_hash).await));
@@ -48,7 +62,17 @@ pub async fn explorer(
                     .await,
             ));
         }
+        return Err(RestError::InvalidQueryString);
     }
-    //TODO: handle more types of queries
-    Ok(Json(vec![]))
+    Ok(Json(
+        state
+            .history
+            .get_requests_by_time(
+                query_params.chain_id,
+                LOG_RETURN_LIMIT,
+                query_params.min_timestamp,
+                query_params.max_timestamp,
+            )
+            .await,
+    ))
 }

apps/fortuna/src/eth_utils/utils.rs

@@ -1,4 +1,3 @@
-use crate::history::History;
 use ethabi::ethereum_types::U64;
 use {
     crate::eth_utils::nonce_manager::NonceManaged,
@@ -183,7 +182,6 @@ pub async fn submit_tx_with_backoff<T: Middleware + NonceManaged + 'static>(
                 padded_gas_limit,
                 gas_multiplier_pct,
                 fee_multiplier_pct,
-                history.clone(),
             )
             .await
         },
@@ -223,7 +221,6 @@ pub async fn submit_tx<T: Middleware + NonceManaged + 'static>(
     // A value of 100 submits the tx with the same gas/fee as the estimate.
     gas_estimate_multiplier_pct: u64,
     fee_estimate_multiplier_pct: u64,
-    history: Arc<History>,
 ) -> Result<TransactionReceipt, backoff::Error<anyhow::Error>> {
     let gas_estimate_res = call.estimate_gas().await;
 

apps/fortuna/src/history.rs

@@ -207,7 +207,7 @@ impl History {
         let tx_hash: String = tx_hash.encode_hex();
         let rows = sqlx::query_as!(
             RequestRow,
-            "SELECT * FROM request WHERE request_tx_hash = ? || reveal_tx_hash = ?",
+            "SELECT * FROM request WHERE request_tx_hash = ? OR reveal_tx_hash = ?",
             tx_hash,
             tx_hash
         )
@@ -269,9 +269,9 @@ impl History {
         rows.into_iter().map(|row| row.into()).collect()
     }
 
-    pub async fn get_latest_requests(
+    pub async fn get_requests_by_time(
         &self,
-        chain_id: Option<&ChainId>,
+        chain_id: Option<ChainId>,
         limit: u64,
         min_timestamp: Option<DateTime<chrono::Utc>>,
         max_timestamp: Option<DateTime<chrono::Utc>>,
@@ -302,8 +302,7 @@ impl History {
 }
 
 mod tests {
-    use crate::history::{History, RequestEntryState, RequestStatus};
-    use ethers::types::{Address, TxHash};
+    use super::*;
     use tokio::time::sleep;
 
     #[tokio::test]