Added doc for transaction mod

Author: deadblackclover

src/transaction/data_entry.rs

@@ -1,6 +1,19 @@
 use std::fmt;
 
 /// Structure that sets key and value of account data storage entry.
+///
+/// Account data storage is a key-value storage associated with an account.
+///
+/// The key of each entry is a unique string.
+///
+/// The value is the data of one of the types:
+///
+/// * string
+/// * boolean
+/// * integral
+/// * array of bytes
+///
+/// The size of an account data storage is unlimited.
 #[derive(Debug, Eq, PartialEq)]
 pub enum DataEntry<'a> {
     Integer(&'a str, u64),

src/transaction/hash.rs

@@ -1,23 +1,34 @@
 use base58::{FromBase58, ToBase58};
 use std::fmt;
 
+/// The Transaction ID is a [`struct@Hash`]
 pub type TransactionId = Hash;
+/// The Asset ID is a [`struct@Hash`]
 pub type Asset = Hash;
 
 pub(crate) const HASH_LENGTH: usize = 32;
 
+/// The [`struct@Hash`] struct is a representation of hashes.
+///
+/// Example hash:
+/// ```plain_text
+/// YwVPf35VckF4Yu5XwF18P9VwWwfQVGAQmqDp4bpgtuV
+/// ```
 #[derive(Debug, Default, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
 pub struct Hash([u8; HASH_LENGTH]); //// converge w/ Address using macro
 
 impl Hash {
+    /// Decode an [`struct@Hash`] from base58 to an inner byte value.
     pub fn to_bytes(&self) -> [u8; HASH_LENGTH] {
         self.0
     }
 
+    /// Create an [`struct@Hash`] from inner byte value.
     pub fn new(bytes: [u8; HASH_LENGTH]) -> Hash {
         Hash(bytes)
     }
 
+    /// Create an [`struct@Hash`] from the base58 string.
     pub fn from_string(base58: &str) -> Asset {
         let mut bytes = [0u8; HASH_LENGTH];
         bytes.copy_from_slice(base58.from_base58().unwrap().as_slice()); ////map unwrap, handle bad length

src/transaction/type_id.rs

@@ -1,19 +1,42 @@
 use std::fmt;
 
 /// Transaction type
+///
+/// There are various types of transactions implemented on the Waves blockchain.
+///
+/// Transaction is an action on the blockchain on behalf of an account.
+///
+/// The Waves blockchain provides various types of transactions. For example:
+///
+/// * Data transaction writes data to the account data storage,
+/// * Transfer transaction sends a certain amount of token to another account.
+///
+/// Content of transaction depends on its type.
 #[derive(Debug, Eq, PartialEq)]
 pub enum Type {
+    /// Issue Transaction
     Issue = 3,
+    /// Transfer Transaction
     Transfer = 4,
+    /// Reissue Transaction
     Reissue = 5,
+    /// Burn Transaction
     Burn = 6,
+    /// Lease Transaction
     Lease = 8,
+    /// Lease Cancel Transaction
     LeaseCancel = 9,
+    /// Create Alias Transaction
     Alias = 10,
+    /// Mass Transfer Transaction
     MassTransfer = 11,
+    /// Data Transaction
     Data = 12,
+    /// Set Script Transaction
     SetScript = 13,
+    /// Sponsor Fee Transaction
     Sponsor = 14,
+    /// Set Asset Script Transaction
     SetAssetScript = 15,
 }