Added more ledger details output by getLatestLedger endpoint by cjonas9 · Pull Request #544 · stellar/stellar-rpc

cjonas9 · 2025-11-24T21:56:53Z

MIGRATING THIS PR TO protocol 25 branch

What

See issue #79. Included more details to be output by the getLatestLedger endpoint such that it matches the info output by getLedgers. The following fields are output:

id: hash of the lastest ledger
protocolVersion: Stellar Core protocol version
sequence: sequence number of the latest ledger
closeTime: time the latest ledger closed
header: base64 encoded ledger header
headerJson: JSON representation of the latest ledger header (omitted if empty)
metadata: base64 encoded representation of latest ledger metadata
metadataJson: JSON representation of latest ledger metadata (omitted if empty)

Why

The getLatestLedger endpoint should return all information about the ledger, but it previously only output id, protocolVersion, and sequence.

Known limitations

N/A.

cjonas9 · 2025-11-25T17:38:23Z

for the reference/convenience of anyone interested:

curl -X POST http://localhost:8000 \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "getLatestLedger"
  }'

tamirms · 2025-11-25T21:27:11Z

protocol/get_latest_ledger.go

@@ -1,12 +1,24 @@
 package protocol

+import "encoding/json"


we moved the protocol package and the stellar-rpc client to the go sdk:

https://github.com/stellar/go-stellar-sdk/tree/master/protocols/rpc

https://github.com/stellar/go-stellar-sdk/tree/master/clients/rpcclient

I think we forgot to delete the code from the stellar-rpc repo. So, we will need to:

delete the rpc client and protocols packages from the stellar-rpc repo

update rpc codebase to use the client / protocols package from the go sdk

create a PR in the go sdk repo to update the GetLatestLedgerResponse

Great catch, will raise an issue about this!

That's already done on the protocol-25 branch (see #527). This could retarget that branch and be released as part of that, or we can try to merge the branches but that'd probably be more painful.

Shaptic · 2025-11-25T20:58:17Z

protocol/get_latest_ledger.go

+	// LedgerHeader of the latest ledger (base64-encoded XDR)
+	LedgerHeader string `json:"header"`
+	// JSON representation of the latest ledger header
+	LedgerHeaderJSON json.RawMessage `json:"headerJson,omitempty"`
+	// LedgerMetadata of the latest ledger (base64-encoded XDR)
+	LedgerMetadata string `json:"metadata"`
+	// JSON representation of the latest ledger metadata
+	LedgerMetadataJSON json.RawMessage `json:"metadataJson,omitempty"`


I recommend dropping JSON support and just having base64 fields, but still suffixing them appropriately in case we want to introduce json later.

Suggested change

// LedgerHeader of the latest ledger (base64-encoded XDR)

LedgerHeader string `json:"header"`

// JSON representation of the latest ledger header

LedgerHeaderJSON json.RawMessage `json:"headerJson,omitempty"`

// LedgerMetadata of the latest ledger (base64-encoded XDR)

LedgerMetadata string `json:"metadata"`

// JSON representation of the latest ledger metadata

LedgerMetadataJSON json.RawMessage `json:"metadataJson,omitempty"`

// LedgerHeader of the latest ledger (base64-encoded XDR)

LedgerHeader string `json:"headerXdr"`

// LedgerMetadata of the latest ledger (base64-encoded XDR)

LedgerMetadata string `json:"metadataXdr"`

Shaptic · 2025-11-25T20:58:19Z

cmd/stellar-rpc/internal/methods/get_latest_ledger.go

+			LedgerCloseTime: latestLedger.LedgerCloseTime(),
+			LedgerHeader:    base64.StdEncoding.EncodeToString(headerBytes),
+		}
+		if LedgerHeaderJSON, err := json.Marshal(header); err == nil {


Nah you can't just call Marshal on this because it's an XDR structure, you'll almost certainly error out every time; that's what xdr2json is for. I recommend not having JSON-formatted fields in this endpoint at all tbh, because we'd then need to add xdrFormat: "json" | "base64" to the request itself to switch between them like with the other endpoints.

oddly, this never error'd out on my testing of this (curling http://localhost:8000). still a great catch and indeed why xdr2json is there. becomes moot because I'm taking your advice to drop JSON support.

the conditional relies on err == nil 😉 you were hiding the error case

Shaptic · 2025-11-25T20:58:50Z

cmd/stellar-rpc/internal/methods/get_latest_ledger_test.go


 	assert.Equal(t, expectedLatestLedgerProtocolVersion, latestLedgerResp.ProtocolVersion)
 	assert.Equal(t, expectedLatestLedgerSequence, latestLedgerResp.Sequence)
+	assert.Equal(t, int64(expectedLatestLedgerCloseTime), latestLedgerResp.LedgerCloseTime)


No tests for header/metadata equivalence?

fixed in latest commit

cjonas9 added 3 commits November 24, 2025 16:45

Added more ledger details output by getLatestLedger endpoint

fdee7d6

fixed linter error

ba75c35

fixed test to work with new latest ledger requirements

1b229d1

cjonas9 marked this pull request as ready for review November 25, 2025 17:25

cjonas9 linked an issue Nov 25, 2025 that may be closed by this pull request

Add more ledger details to getLedger/getLatestLedger #79

Closed

tamirms reviewed Nov 25, 2025

View reviewed changes

Shaptic reviewed Nov 25, 2025

View reviewed changes

cjonas9 added 2 commits November 26, 2025 16:57

dropped JSON from endpoint, improved testing

e92baba

fixed linter errors

c3f9814

cjonas9 changed the base branch from main to protocol-25 November 26, 2025 22:45

cjonas9 changed the base branch from protocol-25 to main November 26, 2025 23:06

This was referenced Dec 2, 2025

Expanded GetLatestLedgerResponse struct fields stellar/go-stellar-sdk#5870

Merged

Added more ledger details output by getLatestLedger endpoint (P25) #554

Merged

cjonas9 closed this Dec 3, 2025

cjonas9 deleted the add-more-ledger-details-to-getlatestledger branch December 8, 2025 19:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added more ledger details output by getLatestLedger endpoint#544

Added more ledger details output by getLatestLedger endpoint#544
cjonas9 wants to merge 5 commits intomainfrom
add-more-ledger-details-to-getlatestledger

cjonas9 commented Nov 24, 2025 •

edited

Loading

Uh oh!

cjonas9 commented Nov 25, 2025

Uh oh!

tamirms Nov 25, 2025

Uh oh!

cjonas9 Nov 26, 2025

Uh oh!

Shaptic Nov 26, 2025

Uh oh!

Shaptic Nov 25, 2025

Uh oh!

Shaptic Nov 25, 2025

Uh oh!

cjonas9 Nov 26, 2025

Uh oh!

Shaptic Nov 26, 2025

Uh oh!

Shaptic Nov 25, 2025

Uh oh!

cjonas9 Nov 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

cjonas9 commented Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Why

Known limitations

Uh oh!

cjonas9 commented Nov 25, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

cjonas9 commented Nov 24, 2025 •

edited

Loading