diff --git a/README.md b/README.md index 902966a696..3f4f811a77 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,9 @@ interaction with the protocol. ## 📓 Docs -* dev docs: built from [dev mdBook](./documentation/dev/) +* [User guides](https://docs.namada.net/) +* [Specs](https://specs.namada.net/) +* Rust docs can be built with `cargo doc --open` (add `--no-deps` to only build docs for local crates) ## Warning diff --git a/crates/ethereum_bridge/src/storage/eth_bridge_queries.rs b/crates/ethereum_bridge/src/storage/eth_bridge_queries.rs index 0627da86c2..07eb6eadaa 100644 --- a/crates/ethereum_bridge/src/storage/eth_bridge_queries.rs +++ b/crates/ethereum_bridge/src/storage/eth_bridge_queries.rs @@ -368,8 +368,7 @@ where }) } - /// Extension of - /// [`read_consensus_validator_set_addresses_with_stake`](namada_proof_of_stake::pos_queries::storage::read_consensus_validator_set_addresses_with_stake), + /// Extension of [`read_consensus_validator_set_addresses_with_stake`], /// which additionally returns all Ethereum addresses of some validator. #[inline] pub fn get_consensus_eth_addresses( diff --git a/crates/sdk/src/masp.rs b/crates/sdk/src/masp.rs index 0fc0430ade..2ae0b48ffa 100644 --- a/crates/sdk/src/masp.rs +++ b/crates/sdk/src/masp.rs @@ -69,7 +69,7 @@ use thiserror::Error; use crate::error::{Error, QueryError}; use crate::io::{Io, ProgressBar}; -pub use crate::masp::shielded_sync::dispatcher::DispatcherCache; +pub use crate::masp::shielded_sync::dispatcher::{Dispatcher, DispatcherCache}; use crate::masp::shielded_sync::utils::MaspClient; #[cfg(not(target_family = "wasm"))] pub use crate::masp::shielded_sync::MaspLocalTaskEnv; diff --git a/crates/sdk/src/masp/shielded_sync/dispatcher.rs b/crates/sdk/src/masp/shielded_sync/dispatcher.rs index 1f3d444fe7..add16c84c8 100644 --- a/crates/sdk/src/masp/shielded_sync/dispatcher.rs +++ b/crates/sdk/src/masp/shielded_sync/dispatcher.rs @@ -239,6 +239,7 @@ pub struct Config { pub shutdown_signal: I, } +/// Shielded sync message dispatcher. pub struct Dispatcher where U: ShieldedUtils, @@ -313,6 +314,7 @@ where T: ProgressBar, I: ShutdownSignal, { + /// Run the dispatcher pub async fn run( mut self, start_query_height: Option,