Remove deprecated `full` parameter from ledger request model

kennyzlei commented 2 weeks ago

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 https://github.com/XRPLF/clio/pull/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

[x] 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?

[x] 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

mvadari commented 2 weeks ago

Please update the changelog.

kennyzlei commented 1 week ago

@mvadari updated the changelog! thanks for the reminder

kennyzlei commented 1 week ago

@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 🙏

arihantkothari commented 1 week ago

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 commented 1 week ago

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 commented 1 week ago

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:

https://github.com/XRPLF/xrpl-py/pull/724

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.

XRPLF / xrpl-py