feat: default requests to use rippled API v2 - Githubissues

XRPLF / xrpl.js

A JavaScript/TypeScript API for interacting with the XRP Ledger in Node.js and the browser

https://xrpl.org/

1.19k stars 507 forks source link

feat: default requests to use rippled API v2 #2687

Closed khancode closed 2 months ago

khancode commented 2 months ago

High Level Overview of Change

Default requests to use rippled API version 2.

Context of Change

api_version 2 is supported by 100% of rippled servers now that numerous v2 amendments have activated. (as of April 8, 2024.)
Requests such as account_info have a different response data format in rippled API v2.
Therefore, we should default to using v2 and no longer support response types of v1.
This feature will be released as a major bump version since it's a significant breaking change.

Type of Change

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[x] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] Refactor (non-breaking change that only restructures code)
[x] 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?

[x] Yes
[ ] No, this change does not impact library users

Test Plan

Update existing tests for account_info to match rippled API v2 response data format

khancode commented 2 months ago

This PR is no longer applicable since we need to continue TS types support for api_version 1.