You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
ledgerSeq=N&key=base64&key=base64...
Here, ledgerSeq is an optional uint32 number and each key is a base64-encoded xdr.LedgerKey. If the ledgerSeq is not available on the given instance, a 404 will be returned.
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. The best way to do this, in my opinion, is to remove the stellarcore.Client.GetLedgerEntry entirely and add support into a new GetLedgerEntries, so any code referencing the old method will break.
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 these endpoints so they cannot be tested end-to-end (hence the Blocked label). However, we can still implement the schemas in anticipation of these interfaces.
The text was updated successfully, but these errors were encountered:
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. The best way to do this, in my opinion, is to remove the
stellarcore.Client.GetLedgerEntry
entirely and add support into a newGetLedgerEntries
, so any code referencing the old method will break.Protocol 23:
/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 23:
/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 these endpoints so they cannot be tested end-to-end (hence the Blocked label). However, we can still implement the schemas in anticipation of these interfaces.
The text was updated successfully, but these errors were encountered: