Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add include_deleted param to ledger_entry API #721

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

Kassaking7
Copy link
Contributor

High Level Overview of Change

Based on XRPLF/clio#1306

Context of Change

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (non-breaking change that only restructures code)
  • Tests (You added tests for code that already exists, or your new feature included in this PR)
  • Documentation Updates
  • Release

Did you update CHANGELOG.md?

  • Yes
  • No, this change does not impact library users

Test Plan

@pdp2121 pdp2121 requested a review from ckeshava July 9, 2024 15:20
@@ -264,6 +264,8 @@ class LedgerEntry(Request, LookupByLedgerRequest):
binary: bool = False
nft_page: Optional[str] = None
"""Must be the object ID of the NFToken page, as hexadecimal"""
include_deleted: Optional[bool] = None
"""This parameter is supported only by Clio servers"""
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you also add a link to the documentation reference for this include_deleted parameter?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is still on progress (XRPLF/clio#1306) so it's not in XRPL docs for now. Do I need to add that link to ledger_entry.py?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I see. It would have been helpful to add the docs link, but it's not absolutely essential.

@@ -264,6 +264,8 @@ class LedgerEntry(Request, LookupByLedgerRequest):
binary: bool = False
nft_page: Optional[str] = None
"""Must be the object ID of the NFToken page, as hexadecimal"""
include_deleted: Optional[bool] = None
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why does the xrpl-py client library not contain the deleted_ledger_index parameter? I observed it in the javascript client library

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since there's no response class in ledger_entry.py so I assume we don't need it? For js one there's already a response class(interface) so I just add deleted_ledger_index to that class.

@Kassaking7 Kassaking7 requested a review from ckeshava July 11, 2024 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants