fix: remove index signature from base request

[interc0der]

High Level Overview of Change

• Removed the index signature (e.g., [key: string]: any) from the base request method's TypeScript interface in the XRPL.js library.
• Updated all downstream instances where the index signature was previously used for accessing properties dynamically (e.g., replaced with explicit property definitions or more specific types).
• This change improves type safety and enhances compatibility with TypeScript utility types like Omit<> and Partial<>, making it easier for third-party developers to extend or manipulate the request type in their own projects.

Context of Change

• Previously, the request method likely used an index signature to allow arbitrary key-value pairs, which provided flexibility but sacrificed type safety and discoverability. For example, a definition like interface Request { [key: string]: any } would allow any string key with any value, making it harder for developers to catch errors at compile time and limiting the utility of TypeScript’s tooling (e.g., autocompletion, refactoring).
• This change is a refactor with bug-fix-like benefits: it eliminates the overly permissive index signature, replacing it with a more explicit structure (e.g., specific fields like method: string, params?: object). This aligns with TypeScript best practices, as index signatures should only be used when the keys are truly dynamic and unknown ahead of time.
• The motivation stems from enhancing portability and usability for third-party developers. With a precise interface, developers can now leverage utility types (e.g., Omit<Request, 'params'> or Partial<Request>) to customize the request type without running into issues caused by the loose index signature.
• No specific bug is being fixed (i.e., no prior crash or runtime error), but this prevents potential type-related issues in downstream usage. The change likely emerged from feedback or observed friction in third-party integrations with the library.
• Alternatives considered might have included keeping the index signature with a more constrained value type (e.g., [key: string]: string | number), but removing it entirely was chosen to enforce stricter typing and better align with the library’s intended usage patterns.
• No design document is referenced, but this aligns with broader TypeScript ecosystem trends toward stricter, more explicit type definitions.

Type of Change

• Bug fix (non-breaking change which fixes an issue)
  (Prevents potential type misuse, though not tied to a specific runtime bug.)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
  (Assumed non-breaking since existing valid usage should still work with explicit types.)
• Refactor (non-breaking change that only restructures code)
  (Primary intent is to improve type structure, making this a refactor as well.)
• Tests (You added tests for code that already exists, or your new feature included in this PR)
• Documentation Updates
• Release

Did you update HISTORY.md?

• Yes
• No, this change does not impact library users
  (The change is internal to the type system and transparent to end users interacting with the library’s runtime behavior. It mainly benefits developers working with the typings, so no user-facing HISTORY.md update is needed.)

Test Plan

• No specific unit tests were added for this change, as it is a type-level refactor that does not alter runtime behavior. The TypeScript compiler itself enforces the correctness of the updated typings during the build process.
• Validation was performed by publishing a modified build to npm and testing it in a production-like environment. The updated package is available here: https://www.npmjs.com/package/@interc0der/xrpl.
• Existing tests (if any) should still pass, assuming they were written to align with the request method’s intended usage. If the library has a CI pipeline, it likely caught any downstream type errors introduced by this change.

[coderabbitai]

Walkthrough

This pull request enhances error handling in the Client class's request method by checking for the existence of the account property before verifying its type, reducing the risk of runtime errors. Additionally, the index signature in the BaseRequest interface was removed to enforce a stricter structure. No alterations were made to exported or public entities.

Changes

File(s)	Change Summary
packages/xrpl/src/client/index.ts	Updated the condition in the Client class's request method: now checks for "account" in req before type-checking to prevent runtime errors.
packages/xrpl/src/models/methods/baseMethod.ts	Removed the [x: string]: unknown index signature from the BaseRequest interface, restricting objects to explicitly defined properties only.

Poem

I’m a rabbit hopping through the code night,
Skipping bugs with careful checks so bright.
In client files, I watch each property’s dance,
While strict types in BaseRequest enhance.
Hoppy changes bring a joyful byte,
🐇✨ coding under the moonlight!

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• 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 generate docstrings to generate docstrings for this 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.

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/xrpl/src/client/index.ts (1)

346-346: Good defensive programming improvement.

This change improves code safety by first checking if the account property exists in the request object before checking its type. This pattern prevents potential TypeErrors when the property doesn't exist, especially important after removing the index signature from the BaseRequest interface (as mentioned in the PR objectives).

The code now properly handles the case where a request doesn't include an account property, ensuring more robust error handling.

According to the ESLint configuration, you should use single quotes instead of double quotes:

-        "account" in req && typeof req.account === 'string'
+        'account' in req && typeof req.account === 'string'

🧰 Tools

🪛 ESLint

[error] 346-346: Replace "account" with 'account'

(prettier/prettier)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8995e3d and 1271c37.

📒 Files selected for processing (2)

• packages/xrpl/src/client/index.ts (1 hunks)
• packages/xrpl/src/models/methods/baseMethod.ts (0 hunks)

💤 Files with no reviewable changes (1)

• packages/xrpl/src/models/methods/baseMethod.ts

🧰 Additional context used

🪛 ESLint

packages/xrpl/src/client/index.ts

[error] 346-346: Replace "account" with 'account'

(prettier/prettier)