From d69fa9b9500a3da0ad677b8feccb6d10a28e6352 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Miko=C5=82aj=20Florkiewicz?= <mikolaj@florkiewicz.me>
Date: Wed, 30 Oct 2024 15:03:33 +0100
Subject: [PATCH] fix docs

---
 types/src/auth.rs | 15 +++++++++++++++
 types/src/blob.rs |  3 +++
 2 files changed, 18 insertions(+)

diff --git a/types/src/auth.rs b/types/src/auth.rs
index dae8b4cf0..a954036aa 100644
--- a/types/src/auth.rs
+++ b/types/src/auth.rs
@@ -1,18 +1,33 @@
+//! TODO:
+
 use cosmrs::crypto::PublicKey;
 
+/// Params defines the parameters for the auth module.
 #[derive(Debug)]
 pub struct AuthParams {
+    /// Maximum number of memo characters
     pub max_memo_characters: u64,
+    /// Maximum nubmer of signatures
     pub tx_sig_limit: u64,
+    /// Cost per transaction byte
     pub tx_size_cost_per_byte: u64,
+    /// Cost to verify ed25519 signature
     pub sig_verify_cost_ed25519: u64,
+    /// Cost to verify secp255k1 signature
     pub sig_verify_cost_secp256k1: u64,
 }
 
+// BaseAccount defines a base account type. It contains all the necessary fields
+// for basic account functionality. Any custom account type should extend this
+// type for additional functionality (e.g. vesting).
 #[derive(Debug)]
 pub struct BaseAccount {
+    /// hex encoded hash address of the account
     pub address: String,
+    /// Public key associated with the account
     pub pub_key: PublicKey,
+    /// TODO:
     pub account_number: u64,
+    /// TODO:
     pub sequence: u64,
 }
diff --git a/types/src/blob.rs b/types/src/blob.rs
index da003c905..c7b622ed6 100644
--- a/types/src/blob.rs
+++ b/types/src/blob.rs
@@ -37,9 +37,12 @@ pub struct Blob {
     pub index: Option<u64>,
 }
 
+/// Params defines the parameters for the blob module.
 #[derive(Debug)]
 pub struct BlobParams {
+    /// Gas cost per blob byte
     pub gas_per_blob_byte: u32,
+    /// Max square size
     pub gov_max_square_size: u64,
 }