Merge pull request #995 from anoma/tiago/ethbridge/misc-fixes

Fix `cargo doc` and the makefile

Makefile

@@ -26,7 +26,7 @@ build-release:
 	NAMADA_DEV=false $(cargo) build --release --package namada_apps --manifest-path Cargo.toml
 
 build-debug:
-	ANOMA_DEV=false $(cargo) build --package namada_apps --manifest-path Cargo.toml
+	NAMADA_DEV=false $(cargo) build --package namada_apps --manifest-path Cargo.toml
 
 install-release:
 	NAMADA_DEV=false $(cargo) install --path ./apps --locked

apps/src/lib/node/ledger/shell/block_space_alloc/states.rs

@@ -28,6 +28,8 @@ mod protocol_txs;
 mod remaining_txs;
 
 use super::{AllocFailure, BlockSpaceAllocator};
+#[allow(unused_imports)]
+use crate::node::ledger::shell::block_space_alloc;
 
 /// Convenience wrapper for a [`BlockSpaceAllocator`] state that allocates
 /// encrypted transactions.
@@ -44,21 +46,21 @@ pub enum EncryptedTxBatchAllocator {
 /// a new batch of DKG decrypted transactions.
 ///
 /// For more info, read the module docs of
-/// [`crate::node::ledger::shell::prepare_proposal::block_space_alloc::states`].
+/// [`block_space_alloc::states`].
 pub enum BuildingDecryptedTxBatch {}
 
 /// The leader of the current Tendermint round is building
 /// a new batch of Namada protocol transactions.
 ///
 /// For more info, read the module docs of
-/// [`crate::node::ledger::shell::prepare_proposal::block_space_alloc::states`].
+/// [`block_space_alloc::states`].
 pub enum BuildingProtocolTxBatch {}
 
 /// The leader of the current Tendermint round is building
 /// a new batch of DKG encrypted transactions.
 ///
 /// For more info, read the module docs of
-/// [`crate::node::ledger::shell::prepare_proposal::block_space_alloc::states`].
+/// [`block_space_alloc::states`].
 pub struct BuildingEncryptedTxBatch<Mode> {
     /// One of [`WithEncryptedTxs`] and [`WithoutEncryptedTxs`].
     _mode: Mode,
@@ -70,25 +72,25 @@ pub struct BuildingEncryptedTxBatch<Mode> {
 /// block, yet.
 ///
 /// For more info, read the module docs of
-/// [`crate::node::ledger::shell::prepare_proposal::block_space_alloc::states`].
+/// [`block_space_alloc::states`].
 pub enum FillingRemainingSpace {}
 
 /// Allow block proposals to include encrypted txs.
 ///
 /// For more info, read the module docs of
-/// [`crate::node::ledger::shell::prepare_proposal::block_space_alloc::states`].
+/// [`block_space_alloc::states`].
 pub enum WithEncryptedTxs {}
 
 /// Prohibit block proposals from including encrypted txs.
 ///
 /// For more info, read the module docs of
-/// [`crate::node::ledger::shell::prepare_proposal::block_space_alloc::states`].
+/// [`block_space_alloc::states`].
 pub enum WithoutEncryptedTxs {}
 
 /// Try to allocate a new transaction on a [`BlockSpaceAllocator`] state.
 ///
 /// For more info, read the module docs of
-/// [`crate::node::ledger::shell::prepare_proposal::block_space_alloc::states`].
+/// [`block_space_alloc::states`].
 pub trait TryAlloc {
     /// Try to allocate space for a new transaction.
     fn try_alloc(&mut self, tx: &[u8]) -> Result<(), AllocFailure>;
@@ -101,7 +103,7 @@ pub trait TryAlloc {
 /// [`NextStateWithoutEncryptedTxs`].
 ///
 /// For more info, read the module docs of
-/// [`crate::node::ledger::shell::prepare_proposal::block_space_alloc::states`].
+/// [`block_space_alloc::states`].
 pub trait NextStateImpl<Transition = ()> {
     /// The next state in the [`BlockSpaceAllocator`] state machine.
     type Next;
@@ -115,7 +117,7 @@ pub trait NextStateImpl<Transition = ()> {
 /// state with encrypted txs in a block.
 ///
 /// For more info, read the module docs of
-/// [`crate::node::ledger::shell::prepare_proposal::block_space_alloc::states`].
+/// [`block_space_alloc::states`].
 pub trait NextStateWithEncryptedTxs: NextStateImpl<WithEncryptedTxs> {
     /// Transition to the next state in the [`BlockSpaceAllocator`] state,
     /// ensuring we include encrypted txs in a block.
@@ -134,7 +136,7 @@ impl<S> NextStateWithEncryptedTxs for S where S: NextStateImpl<WithEncryptedTxs>
 /// state without encrypted txs in a block.
 ///
 /// For more info, read the module docs of
-/// [`crate::node::ledger::shell::prepare_proposal::block_space_alloc::states`].
+/// [`block_space_alloc::states`].
 pub trait NextStateWithoutEncryptedTxs:
     NextStateImpl<WithoutEncryptedTxs>
 {
@@ -158,7 +160,7 @@ impl<S> NextStateWithoutEncryptedTxs for S where
 /// state with a null transition function.
 ///
 /// For more info, read the module docs of
-/// [`crate::node::ledger::shell::prepare_proposal::block_space_alloc::states`].
+/// [`block_space_alloc::states`].
 pub trait NextState: NextStateImpl {
     /// Transition to the next state in the [`BlockSpaceAllocator`] state,
     /// using a null transiiton function.

apps/src/lib/node/ledger/shell/prepare_proposal.rs

@@ -26,6 +26,8 @@ use super::block_space_alloc::{AllocFailure, BlockSpaceAllocator};
 #[cfg(feature = "abcipp")]
 use crate::facade::tendermint_proto::abci::ExtendedCommitInfo;
 use crate::facade::tendermint_proto::abci::RequestPrepareProposal;
+#[allow(unused_imports)]
+use crate::node::ledger::shell::block_space_alloc;
 #[cfg(not(feature = "abcipp"))]
 use crate::node::ledger::shell::vote_extensions::deserialize_vote_extensions;
 #[cfg(feature = "abcipp")]

apps/src/lib/node/ledger/shell/vote_extensions.rs

@@ -297,8 +297,7 @@ pub fn deserialize_vote_extensions(
 }
 
 /// Given a slice of [`TxBytes`], return an iterator over the
-/// ones we could deserialize to vote extension [`ProtocolTx`]
-/// instances.
+/// ones we could deserialize to vote extension protocol txs.
 #[cfg(not(feature = "abcipp"))]
 pub fn deserialize_vote_extensions<'shell>(
     txs: &'shell [TxBytes],

core/src/ledger/eth_bridge/storage/bridge_pool.rs

@@ -217,7 +217,7 @@ impl BridgePoolTree {
     /// bridge pool.
     ///
     /// It should have one string segment which should
-    /// parse into a [Hash]
+    /// parse into a [`struct@Hash`].
     fn parse_key(key: &Key) -> Result<KeccakHash, Error> {
         if key.segments.len() == 1 {
             match &key.segments[0] {