Nomos http API (#476)

* Info api * Da blob api (#487) * Add storage api for new http backend (#488) * Mempool add APIs (#489)
logos-co · Nov 1, 2023 · ba90ed1 · ba90ed1
1 parent ff8fc57
commit ba90ed1
Show file tree

Hide file tree

Showing 18 changed files with 374 additions and 63 deletions.
diff --git a/consensus-engine/Cargo.toml b/consensus-engine/Cargo.toml
@@ -25,7 +25,7 @@ default = []
 serde = ["dep:serde", "nomos-utils/serde"]
 simulation = []
 
-openapi = ["dep:utoipa", "serde_json"]
+openapi = ["dep:utoipa", "serde_json", "serde"]
 
 [dev-dependencies]
 proptest = "1.2.0"

diff --git a/consensus-engine/src/types.rs b/consensus-engine/src/types.rs
@@ -20,6 +20,7 @@ pub use view::View;
 /// can't be directly used in the network as they lack things like cryptographic signatures.
 #[derive(Debug, Clone, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
 pub enum Payload {
     /// Vote for a block in a view
     Vote(Vote),
@@ -32,13 +33,15 @@ pub enum Payload {
 /// Returned
 #[derive(Debug, Clone, Eq, PartialEq, Hash)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
 pub struct Vote {
     pub view: View,
     pub block: BlockId,
 }
 
 #[derive(Debug, Clone, Eq, PartialEq, Hash)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
 pub struct Timeout {
     pub view: View,
     pub sender: NodeId,
@@ -50,6 +53,7 @@ pub struct Timeout {
 // We should consider to remove the TimoutQc from the NewView message and use a hash or id instead.
 #[derive(Debug, Clone, Eq, PartialEq, Hash)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
 pub struct NewView {
     pub view: View,
     pub sender: NodeId,
@@ -59,6 +63,7 @@ pub struct NewView {
 
 #[derive(Debug, Clone, Eq, PartialEq, Hash)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
 pub struct TimeoutQc {
     view: View,
     high_qc: StandardQc,
@@ -96,6 +101,7 @@ impl TimeoutQc {
 
 #[derive(Debug, Clone, Eq, PartialEq, Hash)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
 pub struct Block {
     #[cfg_attr(feature = "serde", serde(skip))]
     pub id: BlockId,
@@ -106,6 +112,7 @@ pub struct Block {
 
 #[derive(Debug, Clone, Eq, PartialEq, Hash)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
 pub enum LeaderProof {
     LeaderId { leader_id: NodeId },
 }
@@ -136,6 +143,7 @@ pub struct Send {
 
 #[derive(Debug, Clone, Eq, PartialEq, Hash)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
 pub struct StandardQc {
     pub view: View,
     pub id: BlockId,
@@ -152,13 +160,15 @@ impl StandardQc {
 
 #[derive(Debug, Clone, Eq, PartialEq, Hash)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
 pub struct AggregateQc {
     pub high_qc: StandardQc,
     pub view: View,
 }
 
 #[derive(Debug, Clone, Eq, PartialEq, Hash)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
 pub enum Qc {
     Standard(StandardQc),
     Aggregated(AggregateQc),

diff --git a/consensus-engine/src/types/committee.rs b/consensus-engine/src/types/committee.rs
@@ -3,6 +3,7 @@ use std::collections::BTreeSet;
 use crate::NodeId;
 
 #[derive(Debug, Default, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
+#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
 pub struct CommitteeId(pub(crate) [u8; 32]);
 
 #[cfg(feature = "serde")]

diff --git a/consensus-engine/src/types/node_id.rs b/consensus-engine/src/types/node_id.rs
@@ -1,4 +1,5 @@
 #[derive(Clone, Copy, Default, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)]
+#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
 pub struct NodeId(pub(crate) [u8; 32]);
 
 #[cfg(feature = "serde")]

diff --git a/consensus-engine/src/types/view.rs b/consensus-engine/src/types/view.rs
@@ -17,6 +17,7 @@ use derive_more::{Add, AddAssign, Sub, SubAssign};
 )]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "serde", serde(transparent))]
+#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
 pub struct View(pub(crate) i64);
 
 impl View {

diff --git a/nodes/nomos-node-api/Cargo.toml b/nodes/nomos-node-api/Cargo.toml
@@ -13,16 +13,26 @@ overwatch-rs = { git = "https://github.com/logos-co/Overwatch", rev = "2f70806"
 overwatch-derive = { git = "https://github.com/logos-co/Overwatch", rev = "ac28d01" }
 tracing = "0.1"
 
-# axum related dependencies
-axum = { version = "0.6", optional = true }
-hyper = { version = "0.14", features = ["full"], optional = true }
 
+consensus-engine = { path = "../../consensus-engine" }
 nomos-core = { path = "../../nomos-core" }
+nomos-consensus = { path = "../../nomos-services/consensus" }
+nomos-network = { path = "../../nomos-services/network" }
 nomos-da = { path = "../../nomos-services/data-availability" }
 nomos-mempool = { path = "../../nomos-services/mempool", features = ["mock", "libp2p", "openapi"] }
-full-replication = { path = "../../nomos-da/full-replication", features = ["openapi"] }
+nomos-storage = { path = "../../nomos-services/storage", features = ["sled"] }
+nomos-libp2p = { path = "../../nomos-libp2p" }
+full-replication = { path = "../../nomos-da/full-replication" }
 serde = { version = "1", features = ["derive"] }
 tokio = { version = "1.33", default-features = false, features = ["sync"] }
+
+
+# axum related dependencies
+axum = { version = "0.6", optional = true }
+hyper = { version = "0.14", features = ["full"], optional = true }
+
+
+# openapi related dependencies
 utoipa = "4.0"
 utoipa-swagger-ui = { version = "4.0" }