Skip to content

Commit 8152650

Browse files
committed
docs: add documentation to public structs
Signed-off-by: Gustavo Inacio <[email protected]>
1 parent 117ffa9 commit 8152650

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

common/src/tap/checks/value_check.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ use crate::cost_model;
2727
// we only accept receipts with minimal 1 wei grt
2828
const MINIMAL_VALUE: u128 = 1;
2929

30+
/// Represents a query that can be checked against an agora model
31+
///
32+
/// It contains the deployment_id to check which agora model evaluate
33+
/// and also the query and variables to perform the evaluation
3034
pub struct AgoraQuery {
3135
pub deployment_id: DeploymentId,
3236
pub query: String,
@@ -36,6 +40,10 @@ pub struct AgoraQuery {
3640
type CostModelMap = Arc<RwLock<HashMap<DeploymentId, CostModel>>>;
3741
type GlobalModel = Arc<RwLock<Option<CostModel>>>;
3842

43+
/// Represents the check for minimum for a receipt
44+
///
45+
/// It contains all information needed in memory to
46+
/// make it as fast as possible
3947
pub struct MinimumValue {
4048
cost_model_map: CostModelMap,
4149
global_model: GlobalModel,

0 commit comments

Comments
 (0)