PR: #27 (commit 4a9a6d3)
File: crates/charon-core/src/types.rs, lines 24-36 (Position), 62-76 (LiquidationOpportunity)
Fields collateral_amount, debt_amount, chain_id, collateral_token, debt_token, debt_to_repay, expected_collateral_out have no /// doc comments. Project policy (CLAUDE.md) requires docs to ship in rustdoc, not .md files. Missing field docs leave callers to infer whether amounts are in token base units or scaled, and what debt_to_repay ceiling is (50% for Aave-style, 100% for Compound-style).
Per criterion 12, constructors returning LiquidationOpportunity must be annotated #[must_use]. No constructor exists yet, but adding #![warn(clippy::must_use_candidate)] at crate root now enforces this automatically when one is added.
Fix:
- Add
/// field doc comments stating units and valid ranges.
- Add
#![warn(clippy::must_use_candidate)] to crates/charon-core/src/lib.rs.
PR: #27 (commit 4a9a6d3)
File: crates/charon-core/src/types.rs, lines 24-36 (Position), 62-76 (LiquidationOpportunity)
Fields
collateral_amount, debt_amount, chain_id, collateral_token, debt_token, debt_to_repay, expected_collateral_outhave no///doc comments. Project policy (CLAUDE.md) requires docs to ship in rustdoc, not .md files. Missing field docs leave callers to infer whether amounts are in token base units or scaled, and whatdebt_to_repayceiling is (50% for Aave-style, 100% for Compound-style).Per criterion 12, constructors returning
LiquidationOpportunitymust be annotated#[must_use]. No constructor exists yet, but adding#![warn(clippy::must_use_candidate)]at crate root now enforces this automatically when one is added.Fix:
///field doc comments stating units and valid ranges.#![warn(clippy::must_use_candidate)]tocrates/charon-core/src/lib.rs.