fix: some docs

eigerco · Jun 7, 2024 · 49bc92c · 49bc92c
1 parent f157bb3
commit 49bc92c
Show file tree

Hide file tree

Showing 9 changed files with 10 additions and 5 deletions.
diff --git a/cli/polka-storage-provider/Cargo.toml b/cli/polka-storage-provider/Cargo.toml
@@ -18,7 +18,7 @@ subxt = { workspace = true }
 subxt-signer = { workspace = true }
 tokio = { workspace = true, features = ["full"] }
 tracing = { workspace = true }
-tracing-subscriber = { workspace = true }
+tracing-subscriber = { workspace = true, features = ["env-filter"] }
 url = { workspace = true }
 
 [lints]

diff --git a/cli/polka-storage-provider/src/commands/info.rs b/cli/polka-storage-provider/src/commands/info.rs
@@ -1,6 +1,7 @@
 use clap::Parser;
 use cli_primitives::Result;
 
+/// Command to display information about the storage provider.
 #[derive(Debug, Clone, Parser)]
 pub(crate) struct InfoCommand {}
 

diff --git a/cli/polka-storage-provider/src/commands/init.rs b/cli/polka-storage-provider/src/commands/init.rs
@@ -2,6 +2,7 @@ use clap::Parser;
 use cli_primitives::Result;
 use tracing::info;
 
+/// Command to initialize the storage provider.s
 #[derive(Debug, Clone, Parser)]
 pub(crate) struct InitCommand {}
 

diff --git a/cli/polka-storage-provider/src/commands/run.rs b/cli/polka-storage-provider/src/commands/run.rs
@@ -13,6 +13,7 @@ use crate::{
 const SERVER_DEFAULT_BIND_ADDR: &str = "127.0.0.1:8000";
 const SUBSTRATE_DEFAULT_RPC_ADDR: &str = "ws://127.0.0.1:9944";
 
+/// Command to start the storage provider.
 #[derive(Debug, Clone, Parser)]
 pub(crate) struct RunCommand {
     /// RPC API endpoint of the parachain node

diff --git a/cli/polka-storage-provider/src/main.rs b/cli/polka-storage-provider/src/main.rs
@@ -1,5 +1,4 @@
 //! A CLI application that facilitates management operations over a running full node and other components.
-
 #![deny(unused_crate_dependencies)]
 
 mod cli;

diff --git a/cli/polka-storage-provider/src/rpc/error.rs b/cli/polka-storage-provider/src/rpc/error.rs
@@ -3,6 +3,7 @@ use std::fmt::Display;
 use jsonrpsee::types::{error::INTERNAL_ERROR_CODE, ErrorObjectOwned};
 use serde_json::Value;
 
+/// Error type for RPC server errors.
 pub struct ServerError {
     inner: ErrorObjectOwned,
 }

diff --git a/cli/polka-storage-provider/src/rpc/methods/common.rs b/cli/polka-storage-provider/src/rpc/methods/common.rs
@@ -4,6 +4,7 @@ use serde::{Deserialize, Serialize};
 
 use crate::rpc::{error::ServerError, ApiVersion, Ctx, RpcMethod};
 
+/// This RPC method exposes the system information.
 #[derive(Debug)]
 pub struct Info;
 

diff --git a/cli/polka-storage-provider/src/rpc/methods/wallet.rs b/cli/polka-storage-provider/src/rpc/methods/wallet.rs
@@ -4,7 +4,7 @@ use subxt_signer::sr25519::dev;
 
 use crate::{
     rpc::{error::ServerError, ApiVersion, Ctx, RpcMethod},
-    substrate::get_balance,
+    substrate::get_system_balances,
 };
 
 /// This RPC method exposes getting the system balances for the particular
@@ -20,7 +20,7 @@ impl RpcMethod for WalletBalance {
         // TODO(@cernicc,05/06/2024): Implement correctly. dev alice is used as a show case for now.
         let account = dev::alice().public_key().into();
         // TODO(@cernicc,05/06/2024): Handle error.
-        let balance = get_balance(&ctx.substrate_client, &account).await?;
+        let balance = get_system_balances(&ctx.substrate_client, &account).await?;
 
         Ok(balance.map(|balance| WalletBalanceResult {
             free: balance.data.free.to_string(),

diff --git a/cli/polka-storage-provider/src/substrate.rs b/cli/polka-storage-provider/src/substrate.rs
@@ -19,7 +19,8 @@ pub async fn init_client(url: impl AsRef<str>) -> Result<Client, Error> {
     Ok(inner)
 }
 
-pub async fn get_balance(
+/// Get system balances for the particular account.
+pub async fn get_system_balances(
     client: &Client,
     account: &AccountId32,
 ) -> Result<Option<AccountInfo<u32, AccountData<u128>>>, Error> {