[TA-5164] Add PermissionedDomain ledger entry type

[banasa44]

[TA-5164] Add PermissionedDomain ledger entry type

Description

This PR aims to add the PermissionedDomain ledger entry type (XLS-80d)

Type of change

• Bug fix
• New feature
• Breaking change
• Documentation update
• Refactoring

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code where needed
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective
• New and existing unit tests pass locally with my changes

Changes

• Add PermissionedDomain ledger entry type.
• Add tests for it

Notes (optional)

• Removed unused types SubmitBatchOptions.

Summary by CodeRabbit

• New Features

  • Added support for the new PermissionedDomain ledger entry type, enabling management of permissioned domains in the XRP Ledger.

• Bug Fixes

  • Improved serialization and deserialization for PermissionedDomain ledger entries to ensure correct data handling.

• Chores

  • Removed the unused SubmitBatchOptions struct from client options in both RPC and WebSocket modules.
  • Updated documentation to reflect the new PermissionedDomain ledger entry type.

[notion-workspace]

[xrpl] Add PermissionedDomain ledger entry type

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

A new PermissionedDomain ledger entry type is introduced, including its struct definition, factory integration, and tests. The changelog is updated to reflect this addition. Additionally, the SubmitBatchOptions struct is removed from both RPC and WebSocket client options files, with no other code changes.

Changes

Files/Groups	Change Summary
CHANGELOG.md	Added "Unreleased" section documenting the new PermissionedDomain ledger entry type referencing XLS-80d.
xrpl/ledger-entry-types/ledger_object.go	Added PermissionedDomainEntry to entry types; updated factory and unmarshal logic for the new type.
xrpl/ledger-entry-types/permissioned_domain.go	Introduced PermissionedDomain struct and its method; includes field definitions and JSON annotations.
xrpl/ledger-entry-types/permissioned_domain_test.go	Added unit tests for the PermissionedDomain type, covering type and JSON serialization/deserialization.
xrpl/rpc/types/client_options.go xrpl/websocket/types/client_options.go	Removed the SubmitBatchOptions struct from both RPC and WebSocket client options files.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant LedgerFactory
    participant PermissionedDomain

    Client->>LedgerFactory: Request EmptyLedgerObject("PermissionedDomain")
    LedgerFactory->>PermissionedDomain: Instantiate PermissionedDomain{}
    LedgerFactory-->>Client: Return PermissionedDomain object

    Client->>LedgerFactory: UnmarshalLedgerObject(data with type "PermissionedDomain")
    LedgerFactory->>PermissionedDomain: Unmarshal JSON into PermissionedDomain{}
    LedgerFactory-->>Client: Return PermissionedDomain object

Loading

Suggested labels

xrpl

---

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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

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.

[banasa44]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.