-
Notifications
You must be signed in to change notification settings - Fork 503
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 HTTP endpoints #5426
Labels
Milestone
Comments
This was referenced Aug 13, 2024
7 tasks
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Protocol 23: Core Endpoints
Epics: #5433, stellar/stellar-rpc#267
Stellar Core will have one new high-performance HTTP endpoint as part of their v22 in stellar/stellar-core#4350 which is supported as part of #5428. It will have three more in v23. We need to support them. The endpoint schemas are defined in this document and are replicated here (please check the document to ensure the following schemas are not outdated).
Request format
Each endpoint needs to be implemented into the
stellarcore
client as its described here. The format for every endpoint is the same POST request:Here,
ledgerSeq
is an optionaluint32
number and eachkey
is a base64-encodedxdr.LedgerKey
. If theledgerSeq
is not available on the given instance, a 404 will be returned.Response formats
Protocol 23:
/getledgerentry
JSON response (as a TypeScript interface):
Note that this is REPLACING the existing endpoint, meaning we need to ensure that all code paths that use the current variant of the endpoint are updated correctly.
Protocol 24: Core Endpoints
The details are omitted here so they can be moved to a new issue when appropriate, since the endpoint schemas might change.
Request format
Each endpoint needs to be implemented into the
stellarcore
client as its described here. The format for every endpoint is the same POST request:Here,
ledgerSeq
is an optionaluint32
number and eachkey
is a base64-encodedxdr.LedgerKey
. If theledgerSeq
is not available on the given instance, a 404 will be returned.Protocol 24:
/getinvocationproof
JSON response (as a TypeScript interface):
Note that if a proof is not required for any of the given entries,
proof
will be omitted.Protocol 24:
/getrestorationproof
JSON response (as a TypeScript interface):
Note that if a proof is not required for any of the given entries,
proof
will be omitted.Notes
Core does not have a build ready with the Protocol 24 endpoints so they cannot be tested end-to-end.
The text was updated successfully, but these errors were encountered: