chore: revert "feat(ffi): add dash_spv_ffi_config_clear_peers (#591)"#593
chore: revert "feat(ffi): add dash_spv_ffi_config_clear_peers (#591)"#593xdustinface wants to merge 1 commit intov0.42-devfrom
Conversation
This reverts commit 472131a.
📝 WalkthroughWalkthroughRemoved the exported FFI function Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
dash-spv-ffi/FFI_API.md (1)
1-7:⚠️ Potential issue | 🟡 MinorConsider documenting the rationale for this breaking change.
While "chore:" is technically valid for reverts, removing a public FFI function (
dash_spv_ffi_config_clear_peers) is a breaking API change. The PR description provides no rationale for why this function is being removed.Consider adding context about:
- Why the function is being reverted (bug, design issue, not needed?)
- Whether any clients are currently using this function
- Migration guidance if this impacts existing users
As per coding guidelines: PRs are validated for title semantics, and "chore:" should accurately describe the changes. While reverting is typically a chore, the breaking nature of this change might warrant additional visibility in the PR description.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@dash-spv-ffi/FFI_API.md` around lines 1 - 7, Add a short rationale about the breaking change: in the autogenerated FFI_API.md update the header or a "Breaking changes" section to note that the public function dash_spv_ffi_config_clear_peers was removed, why it was reverted (bug, design decision, deprecated/unused), whether customers/clients are known to use it, and provide migration guidance or alternatives (how clients should achieve the same behavior or the planned replacement). Also update the PR title/description to reflect this is a breaking revert (not just "chore:") and include the same rationale and any compatibility notes so reviewers and users can assess impact.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@dash-spv-ffi/FFI_API.md`:
- Around line 1-7: Add a short rationale about the breaking change: in the
autogenerated FFI_API.md update the header or a "Breaking changes" section to
note that the public function dash_spv_ffi_config_clear_peers was removed, why
it was reverted (bug, design decision, deprecated/unused), whether
customers/clients are known to use it, and provide migration guidance or
alternatives (how clients should achieve the same behavior or the planned
replacement). Also update the PR title/description to reflect this is a breaking
revert (not just "chore:") and include the same rationale and any compatibility
notes so reviewers and users can assess impact.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 3a03e661-22cc-4ec2-b77e-40fd4e7dc048
📒 Files selected for processing (3)
dash-spv-ffi/FFI_API.mddash-spv-ffi/src/config.rsdash-spv-ffi/tests/test_config.rs
💤 Files with no reviewable changes (2)
- dash-spv-ffi/src/config.rs
- dash-spv-ffi/tests/test_config.rs
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## v0.42-dev #593 +/- ##
=============================================
- Coverage 67.06% 67.02% -0.04%
=============================================
Files 318 318
Lines 67026 67020 -6
=============================================
- Hits 44950 44921 -29
- Misses 22076 22099 +23
|
This reverts commit 472131a.
Summary by CodeRabbit