fix(sdk): AddressListError is private

[shumkov]

Issue being fixed or feature implemented

#2264

What was done?

• Re-exported AddressListError type

How Has This Been Tested?

None

Breaking Changes

None

Checklist:

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have added or updated relevant unit/integration/functional/e2e tests
• I have added "!" to the title and described breaking changes in the corresponding section if my code contains any
• I have made corresponding changes to the documentation if needed

For repository code-owners and collaborators only

• I have assigned this pull request to a milestone

Summary by CodeRabbit

• New Features

  • Introduced AddressListError for improved error handling in address list operations within the DAPI client.
  • Added AddressNotFound error variant to indicate when a specified address is not present in the list.

• Bug Fixes

  • Enhanced error management without altering existing functionalities.

[coderabbitai]

Walkthrough

The pull request introduces a new public export called AddressListError from the address_list module in the packages/rs-dapi-client/src/lib.rs file. It also adds a new error variant, AddressNotFound, to the AddressListError enum in the packages/rs-dapi-client/src/address_list.rs file. This variant is used to indicate when a specified address is not found in the list and includes an associated Uri parameter. The overall structure and functionality of the modules remain unchanged.

Changes

File Path	Change Summary
packages/rs-dapi-client/src/lib.rs	Added public export AddressListError from address_list module.
packages/rs-dapi-client/src/address_list.rs	Added enum variant AddressNotFound to AddressListError and updated ban_address and unban_address methods to utilize this new error variant.

Possibly related issues

• Rust DAPI client does not export AddressListError #2264: The change addresses the issue where the Rust DAPI client does not export AddressListError, allowing external projects to match on DAPI errors.

Possibly related PRs

• feat(sdk): fix client tls connections #2223: The changes in this PR involve modifications to the dapi_client.rs file, specifically enhancing error handling in the execute method, which is related to the error handling improvements introduced in the main PR with the new AddressListError export.
• fix(sdk): opposite retry trigger #2265: This PR also modifies the error handling logic within the DapiClient implementation in dapi_client.rs, which aligns with the main PR's focus on enhancing error reporting related to address management.

Suggested labels

enhancement, js-sdk

Suggested reviewers

• lklimek
• QuantumExplorer

🐇 In the code, a new error we see,
AddressListError, as clear as can be.
Handling mistakes, it hops into play,
Making our DAPI work better each day!
With exports now shining, like stars in the night,
Our code's now more robust, and everything's right! 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c31c455 and e28a344.

📒 Files selected for processing (1)

• packages/rs-dapi-client/src/address_list.rs (1 hunks)

🔇 Additional comments (3)

packages/rs-dapi-client/src/address_list.rs (3)

82-84: LGTM! Well-structured error variant addition.

The new AddressNotFound variant is well-documented and properly implements error handling best practices:

• Clear error message format
• Appropriate use of thiserror
• Proper conditional serialization for mocks

---

81-84: Consider adjusting visibility to align with PR objective.

The PR objective mentions making AddressListError private and re-exporting it, but the enum is still marked as pub in this file. Consider:

1. Making the enum private (remove pub) in this module
2. Re-exporting it through lib.rs for better encapsulation

#!/bin/bash
# Check current exports in lib.rs
rg "pub use.*AddressListError" packages/rs-dapi-client/src/lib.rs

# Verify other potential direct usages that might break
rg "use super::AddressListError|use crate::address_list::AddressListError" packages/rs-dapi-client/src/

---

82-84: Verify consistent error handling across the codebase.

Let's ensure the new error variant is used consistently across all address-related operations.

✅ Verification successful

Let me gather more information about the usage of this error variant by searching for its implementation and usage patterns.

---

Error handling is consistent and properly implemented

The error variant AddressNotFound is used consistently in both ban_address and unban_address methods, following the same error handling pattern. The error includes the URI as intended and is properly propagated. No inconsistencies or missing error handling were found in address-related operations.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any other potential places where address not found errors should be handled
rg -l "AddressListError" | xargs rg "address.*not.*found" -i

Length of output: 299

---

Script:

#!/bin/bash
# Search for the implementation and usage of AddressListError
ast-grep --pattern 'enum AddressListError { $$$ }'

# Search for functions that return AddressListError
ast-grep --pattern 'fn $_($$$) -> Result<$_, AddressListError> { $$$ }'

# Search for actual usage of AddressNotFound variant
rg "AddressNotFound\(" -A 2 -B 2

Length of output: 1484

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.