Struct ApiEndpointContext

pub struct ApiEndpointContext<'dbtx> {
    db: Database,
    dbtx: DatabaseTransaction<'dbtx, Committable>,
    has_auth: bool,
    request_auth: Option<ApiAuth>,
}

State made available to all API endpoints for handling a request

Fields

db: Database

dbtx: DatabaseTransaction<'dbtx, Committable>

has_auth: bool

request_auth: Option<ApiAuth>

Implementations

impl<'a> ApiEndpointContext<'a>

pub fn new( db: Database, dbtx: DatabaseTransaction<'a, Committable>, has_auth: bool, request_auth: Option<ApiAuth>, ) -> Self

db and dbtx should be isolated.

pub fn dbtx<'s, 'mtx>(&'s mut self) -> DatabaseTransaction<'mtx, Committable>

where 'a: 'mtx, 's: 'mtx,

Database tx handle, will be committed

pub fn request_auth(&self) -> Option<ApiAuth>

Returns the auth set on the request (regardless of whether it was correct)

pub fn has_auth(&self) -> bool

Whether the request was authenticated as the guardian who controls this fedimint server

pub fn db(&self) -> Database

pub fn wait_key_exists<K>(&self, key: K) -> impl Future<Output = K::Value>

where K: DatabaseKey + DatabaseRecord + DatabaseKeyWithNotify,

Waits for key to be present in database.

pub fn wait_value_matches<K>( &self, key: K, matcher: impl Fn(&K::Value) -> bool + Copy, ) -> impl Future<Output = K::Value>

where K: DatabaseKey + DatabaseRecord + DatabaseKeyWithNotify,

Waits for key to have a value that matches.

pub async fn commit_tx_result(self, path: &'static str) -> Result<(), ApiError>

Attempts to commit the dbtx or returns an ApiError