Sovereign-Labs · neysofu · Sep 5, 2023 · Sep 4, 2023 · Sep 4, 2023 · Sep 4, 2023
diff --git a/.config/nextest.toml b/.config/nextest.toml
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -267,9 +267,9 @@ jobs:
       - run: cargo deny check licenses
   cargo-doc-artifact:
     runs-on: ubuntu-latest
-    # `cargo doc` requires `cargo check`, so we can share caches.
-    needs: check
     timeout-minutes: 90
+    env:
+      RUSTDOCFLAGS: "-D warnings"
     steps:
       - uses: actions/checkout@v3
         # Not sure installing `mold` is actually needed, but it's what the
@@ -281,7 +281,7 @@ jobs:
       - uses: Swatinem/rust-cache@v2
         with:
           cache-provider: "buildjet"
-          shared-key: cargo-check
+          shared-key: cargo-doc
           save-if: ${{ github.ref == 'refs/heads/nightly' }}
           workspaces: |
             .

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/adapters/celestia/src/celestia.rs b/adapters/celestia/src/celestia.rs
@@ -301,7 +301,8 @@ impl BlockHeader for CelestiaHeader {
     }
 }
 
-/// We implement [`SlotData`] for [`CelestiaHeader`] in a similar fashion as for [`FilteredCelestiaBlock`]
+/// We implement [`SlotData`] for [`CelestiaHeader`] in a similar fashion as for
+/// [`FilteredCelestiaBlock`](crate::types::FilteredCelestiaBlock).
 impl SlotData for CelestiaHeader {
     type BlockHeader = CelestiaHeader;
     type Cond = ChainValidityCondition;

diff --git a/adapters/celestia/src/verifier/address.rs b/adapters/celestia/src/verifier/address.rs
@@ -12,9 +12,9 @@ const HRP: &str = "celestia";
 const VARIANT: bech32::Variant = bech32::Variant::Bech32;
 
 /// Representation of the address in the Celestia network
-/// https://github.com/celestiaorg/celestia-specs/blob/e59efd63a2165866584833e91e1cb8a6ed8c8203/src/specs/data_structures.md#address
+/// <https://github.com/celestiaorg/celestia-specs/blob/e59efd63a2165866584833e91e1cb8a6ed8c8203/src/specs/data_structures.md#address>
 /// Spec says: "Addresses have a length of 32 bytes.", but in reality it is 32 `u5` elements, which can be compressed as 20 bytes.
-/// TODO: Switch to bech32::u5 when it has repr transparent: https://github.com/Sovereign-Labs/sovereign-sdk/issues/646
+/// TODO: Switch to bech32::u5 when it has repr transparent: <https://github.com/Sovereign-Labs/sovereign-sdk/issues/646>
 #[derive(
     Debug, PartialEq, Clone, Eq, Serialize, Deserialize, BorshDeserialize, BorshSerialize, Hash,
 )]

diff --git a/examples/demo-nft-module/README.md b/examples/demo-nft-module/README.md
@@ -24,7 +24,7 @@ simplicity, each token represents only an ID and won't hold any metadata.
 The Sovereign SDK provides a [module-template](../../module-system/module-implementations/module-template/README.md),
 which is boilerplate that can be customized to easily build modules.
 
-```ignore
+```text
 
 ├── Cargo.toml
 ├── README.md
@@ -38,7 +38,7 @@ which is boilerplate that can be customized to easily build modules.
 
 Here are defining basic dependencies in `Cargo.toml` that module needs to get started:
 
-```toml, ignore
+```toml
 [dependencies]
 anyhow = { anyhow = "1.0.62" }
 sov-modules-api = { git = "https://github.com/Sovereign-Labs/sovereign-sdk.git", branch = "stable", features = ["macros"] }
@@ -110,7 +110,7 @@ Before we start implementing the `Module` trait, there are several preparatory s
 
 1.  Define `native` feature in `Cargo.toml` and add additional dependencies:
 
-    ```toml, ignore
+    ```toml
     [dependencies]
     anyhow = "1.0.62"
     borsh = { version = "0.10.3", features = ["bytes"] }
@@ -140,19 +140,18 @@ Before we start implementing the `Module` trait, there are several preparatory s
     pub enum CallMessage<C: sov_modules_api::Context> {
         Mint {
             /// The id of new token. Caller is an owner
-            id: u64
+            id: u64,
         },
         Transfer {
             /// The address to which the token will be transferred.
             to: C::Address,
-            /// The token id to transfer
+            /// The token id to transfer.
             id: u64,
         },
         Burn {
             id: u64,
         }
     }
-
     ```
 
     As you can see, we derive the `borsh` serialization format for these messages. Unlike most serialization libraries,
@@ -243,7 +242,6 @@ impl<C: sov_modules_api::Context> NonFungibleToken<C> {
         Ok(())
     }
 }
-
 ```
 
 ### Call message
@@ -351,7 +349,6 @@ use sov_modules_api::macros::rpc_gen;
 use sov_modules_api::Context;
 use sov_state::WorkingSet;
 
-
 #[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)]
 /// Response for `getOwner` method
 pub struct OwnerResponse<C: Context> {
@@ -381,7 +378,7 @@ that all public APIs function as intended.
 
 Temporary storage is needed for testing, so we enable the `temp` feature of `sov-state` as a `dev-dependency`
 
-```toml, ignore
+```toml,text
 [dev-dependencies]
 sov-state = { git = "https://github.com/Sovereign-Labs/sovereign-sdk.git", branch = "stable", features = ["temp"] }
 ```
@@ -463,4 +460,4 @@ pub struct Runtime<C: sov_modules_api::Context> {
     #[allow(unused)]
     nft: demo_nft_module::NonFungibleToken<C>,
 }
-```
+```
diff --git a/examples/demo-rollup/README.md b/examples/demo-rollup/README.md
@@ -61,7 +61,7 @@ understand how to build your own state transition function, check out at the doc
 
 ### Run a local DA layer instance
 
-1. Install Docker: https://www.docker.com.
+1. Install Docker: <https://www.docker.com>.
 
 2. Switch to the `examples/demo-rollup` directory (which is where this `README.md` is located!).
 

diff --git a/examples/demo-simple-stf/README.md b/examples/demo-simple-stf/README.md
@@ -47,6 +47,7 @@ impl StateTransitionFunction for CheckHashPreimageStf {
 
     // This represents a proof of misbehavior by the sequencer, but we won't utilize it in this tutorial.
     type MisbehaviorProof = ();
+}
 ```
 
 Now that we have defined the necessary types, we need to implement the following functions:

diff --git a/full-node/db/sov-db/src/schema/tables.rs b/full-node/db/sov-db/src/schema/tables.rs
@@ -1,25 +1,25 @@
 //! This module defines the following tables:
 //!
 //! Slot Tables:
-//! - SlotNumber -> StoredSlot
-//! - SlotNumber -> Vec<BatchNumber>
+//! - `SlotNumber -> StoredSlot`
+//! - `SlotNumber -> Vec<BatchNumber>`
 //!
 //! Batch Tables:
-//! - BatchNumber -> StoredBatch
-//! - BatchHash -> BatchNumber
+//! - `BatchNumber -> StoredBatch`
+//! - `BatchHash -> BatchNumber`
 //!
 //! Tx Tables:
-//! - TxNumber -> (TxHash,Tx)
-//! - TxHash -> TxNumber
+//! - `TxNumber -> (TxHash,Tx)`
+//! - `TxHash -> TxNumber`
 //!
 //! Event Tables:
-//! - (EventKey, TxNumber) -> EventNumber
-//! - EventNumber -> (EventKey, EventValue)
+//! - `(EventKey, TxNumber) -> EventNumber`
+//! - `EventNumber -> (EventKey, EventValue)`
 //!
 //! JMT Tables:
-//! - KeyHash -> Key
-//! - (Key, Version) -> JmtValue
-//! - NodeKey -> Node
+//! - `KeyHash -> Key`
+//! - `(Key, Version) -> JmtValue`
+//! - `NodeKey -> Node`
 
 use borsh::{maybestd, BorshDeserialize, BorshSerialize};
 use byteorder::{BigEndian, ReadBytesExt, WriteBytesExt};

diff --git a/full-node/db/sov-schema-db/src/lib.rs b/full-node/db/sov-schema-db/src/lib.rs
@@ -94,7 +94,7 @@ impl DB {
     }
 
     /// Open db in secondary mode. A secondary db is does not support writes, but can be dynamically caught up
-    /// to the primary instance by a manual call. See https://github.com/facebook/rocksdb/wiki/Read-only-and-Secondary-instances
+    /// to the primary instance by a manual call. See <https://github.com/facebook/rocksdb/wiki/Read-only-and-Secondary-instances>
     /// for more details.
     pub fn open_cf_as_secondary<P: AsRef<Path>>(
         opts: &rocksdb::Options,

diff --git a/module-system/module-implementations/integration-tests/Cargo.toml b/module-system/module-implementations/integration-tests/Cargo.toml
@@ -22,7 +22,6 @@ sov-rollup-interface = { path = "../../../rollup-interface" }
 sov-schema-db = { path = "../../../full-node/db/sov-schema-db" }
 sov-data-generators = { path = "../../utils/sov-data-generators" }
 sov-modules-stf-template = { path = "../../sov-modules-stf-template", features = ["native"] }
-sov-modules-macros = { path = "../../sov-modules-macros", features = ["native"] }
 
 sov-chain-state = { path = "../sov-chain-state", features = ["native"] }
 sov-value-setter = { path = "../examples/sov-value-setter", features = ["native"] }
diff --git a/module-system/module-implementations/integration-tests/src/chain_state/helpers.rs b/module-system/module-implementations/integration-tests/src/chain_state/helpers.rs
@@ -1,9 +1,11 @@
 use sov_chain_state::{ChainState, ChainStateConfig};
 use sov_modules_api::capabilities::{BlobRefOrOwned, BlobSelector};
 use sov_modules_api::hooks::{ApplyBlobHooks, SlotHooks, TxHooks};
+use sov_modules_api::macros::DefaultRuntime;
 use sov_modules_api::transaction::Transaction;
-use sov_modules_api::{BlobReaderTrait, Context, DaSpec, PublicKey, Spec};
-use sov_modules_macros::{DefaultRuntime, DispatchCall, Genesis, MessageCodec};
+use sov_modules_api::{
+    BlobReaderTrait, Context, DaSpec, DispatchCall, Genesis, MessageCodec, PublicKey, Spec,
+};
 use sov_modules_stf_template::{AppTemplate, Runtime, SequencerOutcome};
 use sov_rollup_interface::mocks::MockZkvm;
 use sov_value_setter::{ValueSetter, ValueSetterConfig};

diff --git a/module-system/module-implementations/sov-attester-incentives/Cargo.toml b/module-system/module-implementations/sov-attester-incentives/Cargo.toml
@@ -28,7 +28,6 @@ serde_json = { workspace = true, optional = true }
 sov-bank = { path = "../sov-bank", version = "0.1" }
 sov-chain-state = { path = "../sov-chain-state", version = "0.1" }
 sov-modules-api = { path = "../../sov-modules-api", version = "0.1" }
-sov-modules-macros = { path = "../../sov-modules-macros", version = "0.1" }
 sov-state = { path = "../../sov-state", version = "0.1" }
 
 
@@ -38,7 +37,6 @@ native = [
     "serde",
     "serde_json",
     "sov-modules-api/native",
-    "sov-modules-macros/native",
     "sov-bank/native",
     "sov-chain-state/native",
     "sov-state/native",

diff --git a/module-system/module-implementations/sov-attester-incentives/src/lib.rs b/module-system/module-implementations/sov-attester-incentives/src/lib.rs
@@ -20,9 +20,8 @@ use call::Role;
 use sov_bank::Amount;
 use sov_chain_state::TransitionHeight;
 use sov_modules_api::{
-    Context, DaSpec, Error, StoredCodeCommitment, ValidityConditionChecker, Zkvm,
+    Context, DaSpec, Error, ModuleInfo, StoredCodeCommitment, ValidityConditionChecker, Zkvm,
 };
-use sov_modules_macros::ModuleInfo;
 use sov_state::{Storage, WorkingSet};
 
 /// Configuration of the attester incentives module

diff --git a/module-system/module-implementations/sov-bank/src/call.rs b/module-system/module-implementations/sov-bank/src/call.rs
@@ -97,7 +97,6 @@ impl<C: sov_modules_api::Context> Bank<C> {
     }
 
     /// Transfers the set of `coins` to the address specified by `to`.
-    /// Helper function that calls the [`transfer_from`] method from the bank module
     pub fn transfer(
         &self,
         to: C::Address,
@@ -108,9 +107,11 @@ impl<C: sov_modules_api::Context> Bank<C> {
         self.transfer_from(context.sender(), &to, coins, working_set)
     }
 
-    /// Burns the set of `coins`. If there is no token at the address specified in the
-    /// `Coins` structure, return an error.
-    /// Calls the [`Token::burn`] function and updates the total supply of tokens.
+    /// Burns the set of `coins`.
+    ///
+    /// If there is no token at the address specified in the
+    /// [`Coins`] structure, return an error; on success it updates the total
+    /// supply of tokens.
     pub fn burn(
         &self,
         coins: Coins<C>,
@@ -145,7 +146,8 @@ impl<C: sov_modules_api::Context> Bank<C> {
     /// Mints the `coins`to the address `mint_to_address` using the externally owned account ("EOA") supplied by
     /// `context.sender()` as the authorizer.
     /// Returns an error if the token address doesn't exist or `context.sender()` is not authorized to mint tokens.
-    /// Calls the [`Token::mint`] function and update the `self.tokens` set to store the new balance.
+    ///
+    /// On success, it updates the `self.tokens` set to store the new balance.
     pub fn mint_from_eoa(
         &self,
         coins: &Coins<C>,
@@ -158,7 +160,8 @@ impl<C: sov_modules_api::Context> Bank<C> {
 
     /// Mints the `coins` to the address `mint_to_address` if `authorizer` is an allowed minter.
     /// Returns an error if the token address doesn't exist or `context.sender()` is not authorized to mint tokens.
-    /// Calls the [`Token::mint`] function and update the `self.tokens` set to store the new minted address.
+    ///
+    /// On success, it updates the `self.tokens` set to store the new minted address.
     pub fn mint(
         &self,
         coins: &Coins<C>,
@@ -215,7 +218,8 @@ impl<C: sov_modules_api::Context> Bank<C> {
 
 impl<C: sov_modules_api::Context> Bank<C> {
     /// Transfers the set of `coins` from the address `from` to the address `to`.
-    /// Returns an error if the token address doesn't exist. Otherwise, call the [`Token::transfer`] function.
+    ///
+    /// Returns an error if the token address doesn't exist.
     pub fn transfer_from(
         &self,
         from: &C::Address,
@@ -239,7 +243,7 @@ impl<C: sov_modules_api::Context> Bank<C> {
         Ok(CallResponse::default())
     }
 
-    /// Helper function used by the rpc method [`balance_of`] to return the balance of the token stored at `token_address`
+    /// Helper function used by the rpc method [`balance_of`](Bank::balance_of) to return the balance of the token stored at `token_address`
     /// for the user having the address `user_address` from the underlying storage. If the token address doesn't exist, or
     /// if the user doesn't have tokens of that type, return `None`. Otherwise, wrap the resulting balance in `Some`.
     pub fn get_balance_of(

diff --git a/module-system/module-implementations/sov-bank/src/token.rs b/module-system/module-implementations/sov-bank/src/token.rs
@@ -16,7 +16,8 @@ use crate::call::prefix_from_address_with_parent;
 pub type Amount = u64;
 
 /// Structure that stores information specifying
-/// a given `amount` (type [`Amount`]) of coins stored at a `token_address` (type [`Context::Address`]).
+/// a given `amount` (type [`Amount`]) of coins stored at a `token_address`
+/// (type [`sov_modules_api::Spec::Address`]).
 #[cfg_attr(
     feature = "native",
     derive(serde::Serialize),

diff --git a/module-system/module-implementations/sov-blob-storage/Cargo.toml b/module-system/module-implementations/sov-blob-storage/Cargo.toml
@@ -21,7 +21,6 @@ tracing = { workspace = true }
 hex = { workspace = true }
 
 sov-modules-api = { path = "../../sov-modules-api", version = "0.1" }
-sov-modules-macros = { path = "../../sov-modules-macros", version = "0.1" }
 sov-state = { path = "../../sov-state", version = "0.1" }
 sov-sequencer-registry = { path = "../sov-sequencer-registry", version = "0.1" }
 sov-chain-state = { path = "../sov-chain-state" }
@@ -48,6 +47,5 @@ native = [
     "serde_json",
     "sov-modules-api/native",
     "sov-state/native",
-    "sov-modules-macros/native",
-    "sov-sequencer-registry/native"
+    "sov-sequencer-registry/native",
 ]
diff --git a/module-system/module-implementations/sov-blob-storage/src/query.rs b/module-system/module-implementations/sov-blob-storage/src/query.rs
@@ -12,7 +12,7 @@ pub struct Response {
     pub address: String,
 }
 
-/// TODO: https://github.com/Sovereign-Labs/sovereign-sdk/issues/626
+/// TODO: <https://github.com/Sovereign-Labs/sovereign-sdk/issues/626>
 #[rpc_gen(client, server, namespace = "blobStorage")]
 impl<C: sov_modules_api::Context, Da: sov_modules_api::DaSpec> BlobStorage<C, Da> {
     /// Queries the address of the module.

diff --git a/module-system/module-implementations/sov-chain-state/Cargo.toml b/module-system/module-implementations/sov-chain-state/Cargo.toml
@@ -19,7 +19,6 @@ serde_json = { workspace = true, optional = true }
 jsonrpsee = { workspace = true, features = ["macros", "client-core", "server"], optional = true }
 
 sov-modules-api = { path = "../../sov-modules-api", version = "0.1" }
-sov-modules-macros = { path = "../../sov-modules-macros", version = "0.1" }
 sov-state = { path = "../../sov-state", version = "0.1" }
 
 
@@ -35,4 +34,4 @@ sov-rollup-interface = { path = "../../../rollup-interface", features = ["mocks"
 
 [features]
 default = []
-native = ["serde", "serde_json", "jsonrpsee", "sov-state/native", "sov-modules-api/native", ]
+native = ["serde", "serde_json", "jsonrpsee", "sov-state/native", "sov-modules-api/native"]
diff --git a/module-system/module-implementations/sov-chain-state/src/lib.rs b/module-system/module-implementations/sov-chain-state/src/lib.rs
@@ -16,8 +16,7 @@ pub mod query;
 use borsh::{BorshDeserialize, BorshSerialize};
 #[cfg(feature = "native")]
 pub use query::{ChainStateRpcImpl, ChainStateRpcServer};
-use sov_modules_api::{Error, ValidityCondition, ValidityConditionChecker};
-use sov_modules_macros::ModuleInfo;
+use sov_modules_api::{Error, ModuleInfo, ValidityCondition, ValidityConditionChecker};
 use sov_state::WorkingSet;
 
 /// Type alias that contains the height of a given transition
-Original file line number
+Diff line change
@@ Expand Up / @@ -47,6 +47,7 @@ impl StateTransitionFunction for CheckHashPreimageStf { @@
         // This represents a proof of misbehavior by the sequencer, but we won't utilize it in this tutorial.
         type MisbehaviorProof = ();
+    }
     ```
     Now that we have defined the necessary types, we need to implement the following functions:
@@ Expand Down @@