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

protocols/horizon: Reinstate errorResultXdr with deprecation warning #5496

Merged
merged 2 commits into from
Oct 25, 2024

Conversation

tamirms
Copy link
Contributor

@tamirms tamirms commented Oct 24, 2024

PR Checklist

PR Structure

  • This PR has reasonably narrow scope (if not, break it down into smaller PRs).
  • This PR avoids mixing refactoring changes with feature changes (split into two PRs
    otherwise).
  • This PR's title starts with name of package that is most changed in the PR, ex.
    services/friendbot, or all or doc if the changes are broad or impact many
    packages.

Thoroughness

  • This PR adds tests for the most critical parts of the new functionality or fixes.
  • I've updated any docs (developer docs, .md
    files, etc... affected by this change). Take a look in the docs folder for a given service,
    like this one.

Release planning

  • I've reviewed the changes in this PR and if I consider them worthwhile for being mentioned on release notes then I have updated the relevant CHANGELOG.md within the component folder structure. For example, if I changed horizon, then I updated (services/horizon/CHANGELOG.md. I add a new line item describing the change and reference to this PR. If I don't update a CHANGELOG, I acknowledge this PR's change may not be mentioned in future release notes.
  • I've decided if this PR requires a new major/minor version according to
    semver, or if it's mainly a patch change. The PR is targeted at the next
    release branch if it's not a patch change.

What

In #5445 , errorResultXdr was renamed to error_result_xdr. Although the v22 is a major release, we should provide a pathway for horizon clients to upgrade without incurring any downtime. So, will still include the field in the async txsub response and in the v23 release we can remove errorResultXdr entirely.

This commit also includes deprecation warnings in the changelog for num_archived_contracts and archived_contracts_amount from the /assets response. From protocol 23 onwards it will be difficult to track archived contract balances because archived balances will eventually be evicted and horizon will not be able to determine how many archived balances live outside the bucketlist.

@tamirms tamirms requested a review from a team October 24, 2024 13:25
Copy link
Contributor

@aditya1702 aditya1702 left a comment

Choose a reason for hiding this comment

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

We also need to update txsub_async_oapi.yml file. Otherwise the changes look good to me.

@karthikiyer56
Copy link
Contributor

We also need to update txsub_async_oapi.yml file. Otherwise the changes look good to me.

I am guessing corresponding changes must have gone in the stellar-dics repo as well?
Do they need to be reverted as well?

@tamirms tamirms merged commit 364ca19 into stellar:protocol-22 Oct 25, 2024
29 checks passed
@tamirms tamirms deleted the deprecate branch October 25, 2024 08:51
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