Skip to content

fix: view mutability, return names, meta description, and eval-order comments#186

Open
thedavidmeister wants to merge 2 commits into
mainfrom
issue-95-100-101-103-104-fixes
Open

fix: view mutability, return names, meta description, and eval-order comments#186
thedavidmeister wants to merge 2 commits into
mainfrom
issue-95-100-101-103-104-fixes

Conversation

@thedavidmeister

@thedavidmeister thedavidmeister commented Jun 29, 2026

Copy link
Copy Markdown
Collaborator

Summary

Five related interface/documentation fixes:

Closes #95
Closes #100
Closes #101
Closes #103
Closes #104

Test plan

  • forge test --no-match-test fork — 60 tests passed, 0 failed
  • Interface/docs-only changes; no logic altered

Co-Authored-By: Claude noreply@anthropic.com

Summary by CodeRabbit

  • Documentation

    • Improved exchange-rate documentation to clearly describe the sFLR-to-FLR rate, including an example and conversion guidance.
    • Updated internal comments for price-pair handling to better explain how values are prepared and reused.
  • Bug Fixes

    • Adjusted contract interfaces for clearer return naming and read-only access, helping integrations interpret values more consistently.

… and eval-order comments

- IGoverned.governanceSettings(): add missing `view` mutability (#101)
- IDineroFlrEth: rename ethAmount/tokenAmount returns to
  ethPerFlreth18/flrethPerEth18 to reflect ratio semantics (#100)
- LibFlareFtsoSubParser sflr-exchange-rate meta: specify 0 inputs and
  clarify sFLR-per-FLR direction with example value (#95, #104)
- LibOpFtsoCurrentPricePair.run: add inline comments explaining the
  index-shuffle evaluation order (symbolB fetched first, then symbolA)
  to prevent future inversion during maintenance (#103)

Closes #95
Closes #100
Closes #101
Closes #103
Closes #104

Co-Authored-By: Claude <noreply@anthropic.com>
@thedavidmeister thedavidmeister self-assigned this Jun 29, 2026
@coderabbitai

coderabbitai Bot commented Jun 29, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 5a58c862-f635-4183-bb44-c3967b05ff62

📥 Commits

Reviewing files that changed from the base of the PR and between cb20d03 and 8833fca.

📒 Files selected for processing (4)
  • src/interface/IDineroFlrEth.sol
  • src/interface/IGoverned.sol
  • src/lib/op/LibOpFtsoCurrentPricePair.sol
  • src/lib/parse/LibFlareFtsoSubParser.sol

Walkthrough

Four audit fixes: IDineroFlrEth return parameter names updated to unit-explicit ethPerFlreth18/flrethPerEth18; IGoverned.governanceSettings() gains view mutability; LibOpFtsoCurrentPricePair assembly comments clarified; sflr-exchange-rate authoring metadata expanded with direction, arity, example, and inversion guidance.

Changes

Audit Fixes

Layer / File(s) Summary
IDineroFlrEth return param rename and IGoverned view fix
src/interface/IDineroFlrEth.sol, src/interface/IGoverned.sol
LSTPerToken() return renamed to ethPerFlreth18 and tokensPerLST() return renamed to flrethPerEth18. governanceSettings() mutability changed from external to external view.
Assembly comments and authoring metadata
src/lib/op/LibOpFtsoCurrentPricePair.sol, src/lib/parse/LibFlareFtsoSubParser.sol
Inline comments in the assembly block of LibOpFtsoCurrentPricePair.run now explicitly name which symbol each fetch resolves. sflr-exchange-rate authoring metadata updated to state sFLR-per-FLR direction, 0 inputs, an example, and inversion guidance.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title is concise and accurately summarizes the main interface and documentation changes.
Linked Issues check ✅ Passed The PR addresses the linked issues by fixing the metadata, return names, view mutability, and eval-order comments.
Out of Scope Changes check ✅ Passed No clear out-of-scope changes are present; the edits stay within the linked documentation and interface fixes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch issue-95-100-101-103-104-fixes

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment