pyth-network_pyth-crosschain/apps/fortuna/src/api/revelation.rs

use {
    crate::api::{ChainId, RequestLabel, RestError},
    anyhow::Result,
    axum::{
        extract::{Path, Query, State},
        Json,
    },
    pythnet_sdk::wire::array,
    serde_with::serde_as,
    tokio::try_join,
    utoipa::{IntoParams, ToSchema},
};

/// Reveal the random value for a given sequence number and blockchain.
///
/// Given a sequence number, retrieve the corresponding random value that this provider has committed to.
/// This endpoint will not return the random value unless someone has requested the sequence number on-chain.
///
/// Every blockchain supported by this service has a distinct sequence of random numbers and chain_id.
/// Callers must pass the appropriate chain_id to ensure they fetch the correct random number.
#[utoipa::path(
get,
path = "/v1/chains/{chain_id}/revelations/{sequence}",
responses(
(status = 200, description = "Random value successfully retrieved", body = GetRandomValueResponse),
(status = 403, description = "Random value cannot currently be retrieved", body = String)
),
params(RevelationPathParams, RevelationQueryParams)
)]
pub async fn revelation(
    State(state): State<crate::api::ApiState>,
    Path(RevelationPathParams { chain_id, sequence }): Path<RevelationPathParams>,
    Query(RevelationQueryParams { encoding }): Query<RevelationQueryParams>,
) -> Result<Json<GetRandomValueResponse>, RestError> {
    state
        .metrics
        .http_requests
        .get_or_create(&RequestLabel {
            value: "/v1/chains/{chain_id}/revelations/{sequence}".to_string(),
        })
        .inc();

    let state = state
        .chains
        .get(&chain_id)
        .ok_or(RestError::InvalidChainId)?;

    let maybe_request_fut = state.contract.get_request(state.provider_address, sequence);

    let current_block_number_fut = state
        .contract
        .get_block_number(state.confirmed_block_status);

    let (maybe_request, current_block_number) =
        try_join!(maybe_request_fut, current_block_number_fut).map_err(|e| {
            tracing::error!(chain_id = chain_id, "RPC request failed {}", e);
            RestError::TemporarilyUnavailable
        })?;

    match maybe_request {
        Some(r)
            if current_block_number.saturating_sub(state.reveal_delay_blocks) >= r.block_number =>
        {
            let value = &state.state.reveal(sequence).map_err(|e| {
                tracing::error!(
                    chain_id = chain_id,
                    sequence = sequence,
                    "Reveal failed {}",
                    e
                );
                RestError::Unknown
            })?;
            let encoded_value = Blob::new(encoding.unwrap_or(BinaryEncoding::Hex), *value);

            Ok(Json(GetRandomValueResponse {
                value: encoded_value,
            }))
        }
        Some(_) => Err(RestError::PendingConfirmation),
        None => Err(RestError::NoPendingRequest),
    }
}

#[derive(Debug, serde::Serialize, serde::Deserialize, IntoParams)]
#[into_params(parameter_in=Path)]
pub struct RevelationPathParams {
    #[param(value_type = String)]
    pub chain_id: ChainId,
    pub sequence: u64,
}

#[derive(Debug, serde::Serialize, serde::Deserialize, IntoParams)]
#[into_params(parameter_in=Query)]
pub struct RevelationQueryParams {
    pub encoding: Option<BinaryEncoding>,
}

#[derive(Debug, serde::Serialize, serde::Deserialize, ToSchema)]
#[serde(rename_all = "kebab-case")]
pub enum BinaryEncoding {
    #[serde(rename = "hex")]
    Hex,
    #[serde(rename = "base64")]
    Base64,
    #[serde(rename = "array")]
    Array,
}

#[derive(Debug, serde::Serialize, serde::Deserialize, ToSchema, PartialEq)]
pub struct GetRandomValueResponse {
    pub value: Blob,
}

#[serde_as]
#[derive(Debug, serde::Serialize, serde::Deserialize, ToSchema, PartialEq)]
#[serde(tag = "encoding", rename_all = "kebab-case")]
pub enum Blob {
    Hex {
        #[serde_as(as = "serde_with::hex::Hex")]
        data: [u8; 32],
    },
    Base64 {
        #[serde_as(as = "serde_with::base64::Base64")]
        data: [u8; 32],
    },
    Array {
        #[serde(with = "array")]
        data: [u8; 32],
    },
}

impl Blob {
    pub fn new(encoding: BinaryEncoding, data: [u8; 32]) -> Blob {
        match encoding {
            BinaryEncoding::Hex => Blob::Hex { data },
            BinaryEncoding::Base64 => Blob::Base64 { data },
            BinaryEncoding::Array => Blob::Array { data },
        }
    }

    pub fn data(&self) -> &[u8; 32] {
        match self {
            Blob::Hex { data } => data,
            Blob::Base64 { data } => data,
            Blob::Array { data } => data,
        }
    }
}