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

clients/stellarcore: Add support for Core's new /getledgerentryraw #5428

Merged
merged 9 commits into from
Sep 24, 2024

Conversation

Shaptic
Copy link
Contributor

@Shaptic Shaptic commented Aug 15, 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

Adds support for a new endpoint: /getledgerentryraw.

Why

Closes #5455.

Note that this endpoint will have the same request format (see #5426 or the PR itself for details) as a bunch of upcoming future endpoints, so for now there is a generic invocation method that can be shared. I reverted their implementation in cd811da, so you can see that adding this commit back would be all we need to do to support them.

Known limitations

Needs end-to-end testing, though basic unit tests are present.

@Shaptic Shaptic self-assigned this Aug 15, 2024
@Shaptic Shaptic changed the title [Draft] Add support for Core's new state archival endpoints [Draft] Add support for Core's new /getledgerentry endpoint Aug 19, 2024
@Shaptic Shaptic force-pushed the new-core-endpoints branch from 7b62213 to e94e43e Compare August 19, 2024 20:55
@Shaptic Shaptic changed the title [Draft] Add support for Core's new /getledgerentry endpoint clients/stellarcore: Add support for Core's new (breaking) /getledgerentry endpoint Aug 19, 2024
@Shaptic Shaptic marked this pull request as ready for review August 19, 2024 21:10
@Shaptic Shaptic force-pushed the new-core-endpoints branch 4 times, most recently from f7bc63c to b8ddb2e Compare August 19, 2024 21:21
@Shaptic Shaptic changed the title clients/stellarcore: Add support for Core's new (breaking) /getledgerentry endpoint clients/stellarcore: Add support for Core's new /getledgerentryraw Sep 17, 2024
@Shaptic Shaptic requested review from SirTyson and a team September 17, 2024 18:04
@Shaptic Shaptic added this to the platform sprint 51 milestone Sep 17, 2024
// GetLedgerEntryRawResponse is the structure of Stellar Core's /getledgerentryraw
type GetLedgerEntryRawResponse struct {
Ledger uint32 `json:"ledger"`
Entries []RawLedgerEntryResponse `json:"entries"`
Copy link
Contributor

Choose a reason for hiding this comment

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

out of curiosity why is each entry a json blob containing one string field instead of simply being a string?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not my schema, heh 🤷 @SirTyson?

@Shaptic Shaptic requested a review from tamirms September 23, 2024 20:20
@Shaptic Shaptic merged commit 6904ece into protocol-22 Sep 24, 2024
21 checks passed
@Shaptic Shaptic deleted the new-core-endpoints branch September 24, 2024 21:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
4 participants