Improve documentation, add missing fields

Author: gmosx

xrpl_api/src/api/random.rs

@@ -1,10 +1,11 @@
+//! The random command provides a random number to be used as a source of
+//! entropy for random number generation by clients.
+//!
+//! - https://xrpl.org/random.html
+
 use crate::Request;
 use serde::{Deserialize, Serialize};
 
-/// The random command provides a random number to be used as a source of
-/// entropy for random number generation by clients.
-///
-/// - https://xrpl.org/random.html
 #[derive(Default, Clone, Serialize)]
 pub struct RandomRequest {}
 

xrpl_api/src/api/submit.rs

@@ -1,7 +1,31 @@
+//! The submit method applies a transaction and sends it to the network to be
+//! confirmed and included in future ledgers.
+//!
+//! This command has two modes:
+//!
+//! Submit-only mode takes a signed, serialized transaction as a binary blob,
+//! and submits it to the network as-is. Since signed transaction objects are
+//! immutable, no part of the transaction can be modified or automatically
+//! filled in after submission.
+//!
+//! Sign-and-submit mode takes a JSON-formatted Transaction object, completes
+//! and signs the transaction in the same manner as the sign method, and then
+//! submits the signed transaction. We recommend only using this mode for
+//! testing and development.
+//!
+//! To send a transaction as robustly as possible, you should construct and
+//! sign it in advance, persist it somewhere that you can access even after a
+//! power outage, then submit it as a tx_blob. After submission, monitor the
+//! network with the tx method command to see if the transaction was
+//! successfully applied; if a restart or other problem occurs, you can safely
+//! re-submit the tx_blob transaction: it won't be applied twice since it has
+//! the same sequence number as the old transaction.
+//!
+//! - https://xrpl.org/submit.html
+
 use crate::Request;
 use serde::Serialize;
 
-/// - https://xrpl.org/submit.html
 #[derive(Default, Clone, Serialize)]
 pub struct SubmitRequest {
     /// Hex representation of the signed transaction to submit. This can be a

xrpl_api/src/api/subscribe.rs

@@ -1,7 +1,11 @@
+//! The subscribe method requests periodic notifications from the server when
+//! certain events happen.
+//!
+//! - https://xrpl.org/subscribe.html
+
 use crate::Request;
 use serde::{Deserialize, Serialize};
 
-/// https://xrpl.org/subscribe.html
 #[derive(Default, Clone, Serialize)]
 pub struct SubscribeRequest {
     #[serde(skip_serializing_if = "Option::is_none")]
@@ -46,14 +50,43 @@ impl SubscribeRequest {
     }
 }
 
+#[derive(Debug, Deserialize)]
+pub struct SubscribeResponse {}
+
+// Streaming Events
+
 #[derive(Debug, Serialize, Deserialize)]
 pub struct LedgerClosedEvent {
     #[serde(rename = "type")]
     pub event_type: String,
     pub fee_base: u32,
     pub fee_ref: u32,
+    pub ledger_hash: String,
+    pub ledger_index: u64,
+    pub ledger_time: i64,
+    pub reserve_base: u32,
+    pub reserve_inc: u32,
     pub txn_count: u32,
+    pub validated_ledgers: String,
 }
 
-#[derive(Debug, Deserialize)]
-pub struct SubscribeResponse {}
+#[derive(Debug, Serialize, Deserialize)]
+pub struct ValidationReceivedEvent {
+    #[serde(rename = "type")]
+    pub event_type: String,
+    pub base_fee: u32,
+    pub cookie: Option<String>,
+    pub flags: u32,
+    pub ledger_hash: String,
+    pub ledger_index: String,
+    pub signature: String,
+    // #TODO add missing fields
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct TransactionEvent {
+    #[serde(rename = "type")]
+    pub event_type: String,
+    pub engine_result: String,
+    // #TODO add missing fields
+}