1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
use super::{
error::{APIInternalError, ApiError},
inner_api::InnerAPI,
APICommands, APIResponses,
};
use super::{CreateRequest, CreateType, ExternalEventRequest, GetEventsOfSubject};
use async_trait::async_trait;
use commons::bd::db::DB;
use commons::models::approval_signature::Acceptance;
use commons::models::event::Event;
use commons::models::event_request::{EventRequest, RequestData, RequestPayload};
use commons::models::signature::Signature;
use commons::models::state::SubjectData;
use commons::{
channel::{ChannelData, MpscChannel, SenderEnd},
config::TapleSettings,
crypto::KeyPair,
};
use protocol::command_head_manager::manager::CommandAPI;
use protocol::command_head_manager::{CommandManagerResponses, Commands};
use protocol::request_manager::manager::RequestManagerAPI;
use protocol::request_manager::{RequestManagerMessage, RequestManagerResponse};
use tokio::sync::watch::Sender;
/// Trait that allows implementing the interface of a TAPLE node.
/// The only native implementation is [NodeAPI]. Users can use the trait
/// to add specific behaviors to an existing node interface. For example,
/// a [NodeAPI] wrapper could be created that again implements the trait
/// and perform certain intermediate operations, such as incrementing a counter
/// to find out how many API queries have been made.
#[async_trait]
pub trait ApiModuleInterface {
/// Allows to generate a voting request in the system.
/// This request will be sent to the node that will be in charge of handling
/// the votes of the rest of the nodes belonging to the same governance.
/// # Possible errors
/// • [ApiError::InternalError] if an internal error occurs during operation execution.<br />
/// • [ApiError::InvalidParameters] if the specified request identifier does not match a valid [DigestIdentifier].<br />
async fn create_request(
&self,
request_type: super::CreateRequest,
) -> Result<RequestData, ApiError>;
/// Allows to make a request to the node from an external Invoker
async fn external_request(
&self,
event_request: ExternalEventRequest,
) -> Result<RequestData, ApiError>;
/// Allows adding a new event to the chain of a subject previously existing
/// in the node. The event identifier and its [payload](RequestPayload) are required.
/// This method returns the enumerated [CreateRequestResponse], being the identifier
/// of a request when the event intends to update a governance, in which case
/// it will be communicated to the rest of the nodes aware of the governance with
/// the intention that they vote the change contained in the request. In case the event
/// is from a conventional subject, the system returns the created event.
/// # Possible errors
/// This method will return [ApiError::EventCreationError] if it has not been possible
/// to create the event, while [ApiError::InternalError] will be obtained if an internal error
/// has occurred during the management of the operation. If it has not been possible to create
/// the signature accompanying the creation of the event with the node identity,
/// then [ApiError::SignError] will be obtained.
async fn create_event(
&self,
subject_id: String,
payload: RequestPayload,
) -> Result<RequestData, ApiError>;
/// It allows to simulate the creation of an event, obtaining the state that would
/// result from the subject in case the event is actually created.
/// # Possible errors
/// • [ApiError::InvalidParameters] if the specified identifier does not match a valid [DigestIdentifier]. <br />
/// • [ApiError::SignError] if it has not been possible to create the signature that accompanies
/// the creation of the event with the identity of the node. <br />
/// • [ApiError::NotFound] if the specified subject is not registered in the node. <br />
/// • [ApiError::InternalError] if an error occurred during simulation execution.
async fn simulate_event(
&self,
subject_id: String,
payload: RequestPayload,
) -> Result<SubjectData, ApiError>;
/// Allows to get all subjects that are known to the current node, regardless of their governance.
/// Paging can be performed using the optional arguments `from` and `quantity`.
/// Regarding the first one, note that it admits negative values, in which case the paging is
/// performed in the opposite direction starting from the end of the collection. Note that this method
/// also returns the subjects that model governance.
/// # Possible errors
/// • [ApiError::InternalError] if an internal error occurred during the execution of the operation.
async fn get_all_subjects(
&self,
namespace: String,
from: Option<usize>,
quantity: Option<usize>,
) -> Result<Vec<SubjectData>, ApiError>;
/// It allows to obtain all the subjects that model existing governance in the node.
/// # Possible errors
/// • [ApiError::InternalError] if an internal error occurred during the execution of the operation.
async fn get_all_governances(&self) -> Result<Vec<SubjectData>, ApiError>;
/// Allows to obtain events from a specific subject previously existing in the node.
/// Paging can be performed by means of the optional arguments `from` and `quantity`.
/// Regarding the former, it should be noted that negative values are allowed, in which case
/// the paging is performed in the opposite direction starting from the end of the string.
/// # Possible errors
/// • [ApiError::InvalidParameters] if the specified subject identifier does not match a valid [DigestIdentifier].
async fn get_event_of_subject(
&self,
subject_id: String,
from: Option<i64>,
quantity: Option<i64>,
) -> Result<Vec<Event>, ApiError>;
/// Allows to create a new subject in the node, being its owner the node in question.
/// # Possible errors
/// • [ApiError::InternalError] if an internal error occurred during the execution of the operation.<br />
/// • [ApiError::SignError] if it has not been possible to create the signature that accompanies
/// the creation of the event with the identity of the node.<br />
/// • [ApiError::EventCreationError] if it has not been possible to create the subject,
/// for example, because its governance does not exist.<br />
/// • [ApiError::InvalidParameters] if the specified governance identifier does not match a valid [DigestIdentifier].
async fn create_subject(
&self,
governance_id: String,
schema_id: String,
namespace: String,
payload: RequestPayload,
) -> Result<RequestData, ApiError>;
/// Allows to obtain a specified subject by specifying its identifier.
/// # Possible errors
/// • [ApiError::InvalidParameters] if the specified identifier does not match a valid [DigestIdentifier].<br />
/// • [ApiError::NotFound] if the subject does not exist.
async fn get_subject(&self, subject_id: String) -> Result<SubjectData, ApiError>;
/// Method for creating governance in the system.
/// # Possible errors
/// • [ApiError::InternalError] if an internal error occurred during the execution of the operation.<br />
/// • [ApiError::SignError] if it has not been possible to create the signature that accompanies
/// the creation of the event with the identity of the node.<br />
/// • [ApiError::EventCreationError] if it has not been possible to create the governance.
async fn create_governance(&self, payload: RequestPayload) -> Result<RequestData, ApiError>;
/// Method to obtain the validation signatures of an event from a specified subject.
/// Paging can be performed using the optional arguments `from` and `quantity`.
/// Regarding the first one, it is worth mentioning that it admits negative values, in which case
/// the pagination is performed in the opposite direction starting from the end of the collection.
/// # Possible errors
/// • [ApiError::NotFound] if the specified subject or subject event does not exist.<br />
/// • [ApiError::InvalidParameters] if the specified subject identifier does not match a valid [DigestIdentifier].
async fn get_signatures(
&self,
subject_id: String,
sn: u64,
from: Option<usize>,
quantity: Option<usize>,
) -> Result<Vec<Signature>, ApiError>;
/// Stops the node, consuming the instance on the fly. This implies that any previously created API
/// or [NotificationHandler] instances will no longer be functional.
async fn shutdown(self) -> Result<(), ApiError>;
/// Allows to vote on a voting request that previously exists in the system.
/// This vote will be sent to the corresponding node in charge of its collection.
/// # Possible errors
/// • [ApiError::InternalError] if an internal error occurs during operation execution.<br />
/// • [ApiError::NotFound] if the request does not exist in the system.<br />
/// • [ApiError::InvalidParameters] if the specified request identifier does not match a valid [DigestIdentifier].<br />
/// • [ApiError::VoteNotNeeded] if the node's vote is no longer required. <br />
/// This occurs when the acceptance of the changes proposed by the petition has already been resolved by the rest of the nodes in the network or when the node cannot participate in the voting process because it lacks the voting role.
async fn approval_request(
&self,
request_id: String,
acceptance: Acceptance,
) -> Result<(), ApiError>;
/// It allows to obtain all the voting requests pending to be resolved in the node.
/// These requests are received from other nodes in the network when they try to update
/// a governance subject. It is necessary to vote their agreement or disagreement with
/// the proposed changes in order for the events to be implemented.
/// # Possible errors
/// • [ApiError::InternalError] if an internal error occurs during operation execution.
async fn get_pending_requests(&self) -> Result<Vec<EventRequest>, ApiError>;
/// It allows to obtain a single voting request pending to be resolved in the node.
/// This request is received from other nodes in the network when they try to update
/// a governance subject. It is necessary to vote its agreement or disagreement with
/// the proposed changes in order for the events to be implemented.
/// # Possible errors
/// • [ApiError::InternalError] if an internal error occurs during operation execution.
/// • [ApiError::NotFound] if the requested request does not exist.
async fn get_single_request(self, id: String) -> Result<EventRequest, ApiError>;
}
/// Object that allows interaction with a TAPLE node.
///
/// It has methods to perform all available read and write operations,
/// as well as an additional action to stop a running node.
/// he interaction is performed thanks to the implementation of a trait
/// known as [ApiModuleInterface]. Consequently, it is necessary to import
/// the trait in order to properly use the object.
#[derive(Clone, Debug)]
pub struct NodeAPI {
pub(crate) sender: SenderEnd<APICommands, APIResponses>,
}
/// Feature that allows implementing the API Rest of an Taple node.
#[async_trait]
impl ApiModuleInterface for NodeAPI {
async fn create_request(
&self,
request_type: super::CreateRequest,
) -> Result<RequestData, ApiError> {
let response = self
.sender
.ask(APICommands::CreateRequest(request_type))
.await
.unwrap();
if let APIResponses::CreateRequest(data) = response {
data
} else {
unreachable!()
}
}
async fn external_request(
&self,
event_request: ExternalEventRequest,
) -> Result<RequestData, ApiError> {
let response = self
.sender
.ask(APICommands::ExternalRequest(event_request))
.await
.unwrap();
if let APIResponses::ExternalRequest(data) = response {
data
} else {
unreachable!()
}
}
async fn get_pending_requests(&self) -> Result<Vec<EventRequest>, ApiError> {
let response = self
.sender
.ask(APICommands::GetPendingRequests)
.await
.unwrap();
if let APIResponses::GetPendingRequests(data) = response {
data
} else {
unreachable!()
}
}
async fn get_single_request(self, id: String) -> Result<EventRequest, ApiError> {
let response = self
.sender
.ask(APICommands::GetSingleRequest(id))
.await
.unwrap();
if let APIResponses::GetSingleRequest(data) = response {
data
} else {
unreachable!()
}
}
async fn create_event(
&self,
subject_id: String,
payload: RequestPayload,
) -> Result<RequestData, ApiError> {
let request = CreateRequest::State(crate::api::StateType {
subject_id,
payload,
});
let response = self
.sender
.ask(APICommands::CreateRequest(request))
.await
.unwrap();
if let APIResponses::CreateRequest(data) = response {
data
} else {
unreachable!()
}
}
async fn simulate_event(
&self,
subject_id: String,
payload: RequestPayload,
) -> Result<SubjectData, ApiError> {
let response = self
.sender
.ask(APICommands::SimulateEvent(super::CreateEvent {
subject_id,
payload,
}))
.await
.unwrap();
if let APIResponses::SimulateEvent(data) = response {
data
} else {
unreachable!()
}
}
async fn get_all_subjects(
&self,
namespace: String,
from: Option<usize>,
quantity: Option<usize>,
) -> Result<Vec<SubjectData>, ApiError> {
let response = self
.sender
.ask(APICommands::GetAllSubjects(super::GetAllSubjects {
namespace,
from,
quantity,
}))
.await
.unwrap();
if let APIResponses::GetAllSubjects(data) = response {
data
} else {
unreachable!()
}
}
async fn get_all_governances(&self) -> Result<Vec<SubjectData>, ApiError> {
let response = self
.sender
.ask(APICommands::GetAllGovernances)
.await
.unwrap();
if let APIResponses::GetAllGovernances(data) = response {
data
} else {
unreachable!()
}
}
async fn get_event_of_subject(
&self,
subject_id: String,
from: Option<i64>,
quantity: Option<i64>,
) -> Result<Vec<Event>, ApiError> {
let response = self
.sender
.ask(APICommands::GetEventsOfSubject(GetEventsOfSubject {
subject_id,
from,
quantity,
}))
.await
.unwrap();
if let APIResponses::GetEventsOfSubject(data) = response {
data
} else {
unreachable!()
}
}
async fn create_subject(
&self,
governance_id: String,
schema_id: String,
namespace: String,
payload: RequestPayload,
) -> Result<RequestData, ApiError> {
let request = CreateRequest::Create(CreateType {
governance_id,
schema_id,
namespace,
payload,
});
let response = self
.sender
.ask(APICommands::CreateRequest(request))
.await
.unwrap();
if let APIResponses::CreateRequest(data) = response {
data
} else {
unreachable!()
}
}
async fn get_subject(&self, subject_id: String) -> Result<SubjectData, ApiError> {
let response = self
.sender
.ask(APICommands::GetSingleSubject(super::GetSingleSubject {
subject_id,
}))
.await
.unwrap();
if let APIResponses::GetSingleSubject(data) = response {
data
} else {
unreachable!()
}
}
async fn create_governance(&self, payload: RequestPayload) -> Result<RequestData, ApiError> {
let request = CreateRequest::Create(CreateType {
governance_id: "".into(),
schema_id: "governance".into(),
namespace: "".into(),
payload,
});
let response = self
.sender
.ask(APICommands::CreateRequest(request))
.await
.unwrap();
if let APIResponses::CreateRequest(data) = response {
data
} else {
unreachable!()
}
}
async fn get_signatures(
&self,
subject_id: String,
sn: u64,
from: Option<usize>,
quantity: Option<usize>,
) -> Result<Vec<Signature>, ApiError> {
let response = self
.sender
.ask(APICommands::GetSignatures(super::GetSignatures {
subject_id,
sn,
from,
quantity,
}))
.await
.unwrap();
if let APIResponses::GetSignatures(data) = response {
data
} else {
unreachable!()
}
}
async fn approval_request(
&self,
request_id: String,
acceptance: Acceptance,
) -> Result<(), ApiError> {
let response = self
.sender
.ask(APICommands::VoteResolve(acceptance, request_id))
.await
.unwrap();
if let APIResponses::VoteResolve(data) = response {
data
} else {
unreachable!()
}
}
async fn shutdown(self) -> Result<(), ApiError> {
let response = self.sender.ask(APICommands::Shutdown).await.unwrap();
if let APIResponses::ShutdownCompleted = response {
Ok(())
} else {
unreachable!()
}
}
}
pub struct API {
input: MpscChannel<APICommands, APIResponses>,
_settings_sender: Sender<TapleSettings>,
inner_api: InnerAPI,
shutdown_sender: Option<tokio::sync::broadcast::Sender<()>>,
shutdown_receiver: tokio::sync::broadcast::Receiver<()>,
}
impl API {
pub fn new(
input: MpscChannel<APICommands, APIResponses>,
command_output: SenderEnd<Commands, CommandManagerResponses>,
request_output: SenderEnd<RequestManagerMessage, RequestManagerResponse>,
settings_sender: Sender<TapleSettings>,
initial_settings: TapleSettings,
keys: KeyPair,
shutdown_sender: tokio::sync::broadcast::Sender<()>,
shutdown_receiver: tokio::sync::broadcast::Receiver<()>,
db: DB,
) -> Self {
Self {
input,
_settings_sender: settings_sender,
inner_api: InnerAPI::new(
keys,
&initial_settings,
CommandAPI::new(command_output),
db,
RequestManagerAPI::new(request_output),
),
shutdown_sender: Some(shutdown_sender),
shutdown_receiver: shutdown_receiver,
}
}
pub async fn start(mut self) {
let mut response_channel = None;
loop {
tokio::select! {
msg = self.input.receive() => {
let must_shutdown = if msg.is_none() {
// Channel closed
true
} else {
let result = self.process_input(msg.unwrap()).await;
if result.is_err() {
true
} else {
let response = result.unwrap();
if response.is_some() {
response_channel = response;
true
} else {
false
}
}
};
if must_shutdown {
let sender = self.shutdown_sender.take().unwrap();
sender.send(()).expect("Shutdown Channel Closed");
drop(sender);
_ = self.shutdown_receiver.recv().await;
if response_channel.is_some() {
let response_channel = response_channel.unwrap();
let _ = response_channel.send(APIResponses::ShutdownCompleted);
}
break;
}
},
_ = self.shutdown_receiver.recv() => {
break;
}
}
}
}
async fn process_input(
&mut self,
input: ChannelData<APICommands, APIResponses>,
) -> Result<Option<tokio::sync::oneshot::Sender<APIResponses>>, APIInternalError> {
// TODO: API commands to change the configuration are missing
match input {
ChannelData::AskData(data) => {
let (sx, command) = data.get();
let response = match command {
APICommands::Shutdown => {
return Ok(Some(sx));
}
APICommands::GetAllSubjects(data) => self.inner_api.get_all_subjects(data),
APICommands::GetAllGovernances => self.inner_api.get_all_governances().await,
APICommands::GetEventsOfSubject(data) => {
self.inner_api.get_events_of_subject(data).await
}
APICommands::GetSignatures(data) => self.inner_api.get_signatures(data).await,
APICommands::GetSingleSubject(data) => {
self.inner_api.get_single_subject(data).await
}
APICommands::SimulateEvent(data) => self.inner_api.simulate_event(data).await,
APICommands::VoteResolve(acceptance, id) => {
self.inner_api.approval_acceptance(acceptance, id).await
}
APICommands::GetPendingRequests => self.inner_api.get_pending_request().await,
APICommands::GetSingleRequest(data) => {
self.inner_api.get_single_request(data).await
}
APICommands::CreateRequest(data) => self.inner_api.create_request(data).await,
APICommands::ExternalRequest(event_request) => {
let response = self.inner_api.external_request(event_request).await;
response
}
};
sx.send(response)
.map_err(|_| APIInternalError::OneshotUnavailable)?;
}
ChannelData::TellData(_data) => {
panic!("Tell in API")
}
}
Ok(None)
}
}