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

Remove deprecated full parameter from ledger request model #722

Merged
merged 4 commits into from
Jul 9, 2024

Conversation

kennyzlei
Copy link
Contributor

@kennyzlei kennyzlei commented Jul 4, 2024

High Level Overview of Change

Remove deprecated full parameter from ledger request model

Context of Change

In the ledger API, the full request parameter has been deprecated for quite awhile now. As of Clio 2.2.0 with this particular commit XRPLF/clio#1360, this API will return a request error if you provide that parameter. This change removes this parameter from the ledger request model. This change would not impact lib users as this using this parameter or setting it to true instead of default false previously would not have been used by rippled or Clio

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

Existing integration tests should continue to pass and manual testing of ledger API with xrpl-py against Clio 2.2.0 should succeed

@kennyzlei kennyzlei changed the title Remove deprecated full parameter from ledger request model Remove deprecated full parameter from ledger request model Jul 4, 2024
@mvadari
Copy link
Collaborator

mvadari commented Jul 5, 2024

Please update the changelog.

@kennyzlei
Copy link
Contributor Author

@mvadari updated the changelog! thanks for the reminder

@kennyzlei
Copy link
Contributor Author

@pdp2121 @mvadari thanks for the reviews/approvals! I don't have write access to be able to merge, so please feel free to merge this PR when it is the right time 🙏

@mvadari mvadari merged commit 752f1eb into XRPLF:main Jul 9, 2024
21 checks passed
@kennyzlei kennyzlei deleted the patch-1 branch July 9, 2024 15:09
@arihantkothari
Copy link

arihantkothari commented Jul 9, 2024

so, does this mean everyone using xrpl-py needs to upgrade immediately ? (seems like a breaking change by clio)

  • since older version with the full parameter is not supported by clio

@kennyzlei / @mvadari / @pdp2121

@angelmacm
Copy link

I'm not quite sure if this is relevant

I've manually modified the above file on my xrpl-py pip release on my device and even cloned the repository in place of the current xrpl-py release on pip. Both times I got an error that said Request failed, notSupported: Not supported field 'accounts' error occurred.

I modified again the above file to remove the accounts field and it is now working.

@kennyzlei
Copy link
Contributor Author

kennyzlei commented Jul 9, 2024

I'm not quite sure if this is relevant

I've manually modified the above file on my xrpl-py pip release on my device and even cloned the repository in place of the current xrpl-py release on pip. Both times I got an error that said Request failed, notSupported: Not supported field 'accounts' error occurred.

I modified again the above file to remove the accounts field and it is now working.

@angelmacm thanks for flagging, I think it is similar in that the accounts field may have been deprecated for awhile too and Clio is now enforcing it. I have created a PR here:

The deprecated fields are described here https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger/

The ledger field is deprecated and may be removed without further notice. The full, accounts, and type fields (admin-only) are also deprecated; the Clio server does not implement these parameters.

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.

5 participants