Add missing fields to rpc Server.getLatestLedger response by Ryang-21 · Pull Request #1389 · stellar/js-stellar-sdk

Ryang-21 · 2026-04-16T20:39:48Z

What

rpc.Server.getLatestLedger() now includes closeTime, headerXdr, and metadataXdr in the typed response, with headerXdr/metadataXdr parsed into XDR objects instead of raw base64 strings.

Copilot

Pull request overview

Updates rpc.Server.getLatestLedger() to return a richer, parsed response object (including additional fields and decoded XDR) instead of the raw RPC payload.

Changes:

Added parsing logic for getLatestLedger to decode headerXdr/metadataXdr into XDR objects.
Introduced a raw response type and a raw _getLatestLedger() method.
Updated unit tests to validate the new parsed response shape and adjust mocks used by other tests.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
test/unit/server/soroban/get_latest_ledger.test.ts	Updates expectations to match parsed `getLatestLedger` response, including XDR decoding.
test/unit/server/soroban/get_classic_entries.test.ts	Adjusts HTTP mocks to handle `getLatestLedger` being called (e.g., via `getAssetBalance`).
src/rpc/server.ts	Routes `getLatestLedger()` through a new parser and adds `_getLatestLedger()` for raw access.
src/rpc/parsers.ts	Adds `parseRawLatestLedger` to decode XDR and shape the typed response.
src/rpc/api.ts	Extends `GetLatestLedgerResponse` and adds `RawGetLatestLedgerResponse` typing.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-16T20:44:43Z

+    /** a base-64 encoded {@link xdr.LedgerHeaderHistoryEntry} instance */
+    headerXdr: xdr.LedgerHeader;
+    /** a base-64 encoded {@link xdr.LedgerCloseMeta} instance */


GetLatestLedgerResponse JSDoc/typing is internally inconsistent: the comments say headerXdr/metadataXdr are base64-encoded XDR strings (and even reference xdr.LedgerHeaderHistoryEntry), but the types are parsed XDR objects (xdr.LedgerHeader / xdr.LedgerCloseMeta). Please update the docs to match the actual types (and ensure the referenced XDR type matches what parseRawLatestLedger returns).

Suggested change

/** a base-64 encoded {@link xdr.LedgerHeaderHistoryEntry} instance */

headerXdr: xdr.LedgerHeader;

/** a base-64 encoded {@link xdr.LedgerCloseMeta} instance */

/** a parsed {@link xdr.LedgerHeader} instance */

headerXdr: xdr.LedgerHeader;

/** a parsed {@link xdr.LedgerCloseMeta} instance */

Copilot · 2026-04-16T20:44:44Z

+  raw: Api.RawGetLatestLedgerResponse,
+): Api.GetLatestLedgerResponse {
+  if (!raw.headerXdr || !raw.metadataXdr) {
+    throw new TypeError(`invalid response missing fields`);


parseRawLatestLedger throws a generic invalid response missing fields error when headerXdr/metadataXdr are absent. For debugging, please include which field(s) are missing (similar to parseRawLedger) and ideally mention the RPC method/response type in the message.

Suggested change

throw new TypeError(`invalid response missing fields`);

let missingFields: string;

if (!raw.metadataXdr && !raw.headerXdr) {

missingFields = "metadataXdr and headerXdr";

} else if (!raw.metadataXdr) {

missingFields = "metadataXdr";

} else {

missingFields = "headerXdr";

}

throw new TypeError(

`invalid getLatestLedger response missing fields: ${missingFields}`,

);

This suggestion returns a better error for the user

Copilot · 2026-04-16T20:44:44Z

@@ -23,12 +24,25 @@ describe("Server#getLatestLedger", () => {
      id: "hashed_id",
      sequence: 123,
      protocolVersion: 20,


Type mismatch: Api.RawGetLatestLedgerResponse.protocolVersion is declared as a string, but this mock response uses a number (20). This makes it easy for runtime/type drift to slip through—either update the mock to a string value or adjust the API types/parsing if the RPC actually returns a number.

Suggested change

protocolVersion: 20,

protocolVersion: "20",

Copilot · 2026-04-16T20:44:44Z

+          result: {
+            id: "hashed_id",
+            sequence: 123,
+            protocolVersion: 20,


Type mismatch: Api.RawGetLatestLedgerResponse.protocolVersion is declared as a string, but this getLatestLedger mock returns a number (20). Consider using a string here (or updating the API types/parsing if the RPC response is numeric) so tests validate the intended schema.

Suggested change

protocolVersion: 20,

protocolVersion: "20",

We define protocolVersion as a string in GetLatestLedgerResponse. Is this using a different type?

github-actions · 2026-04-16T20:48:12Z

Size Change: +75.7 kB (+0.17%)

Total Size: 45.7 MB

📦 View Changed

Filename	Size	Change
`dist/stellar-sdk-minimal.js`	6.05 MB	+12.5 kB (+0.21%)
`dist/stellar-sdk-minimal.min.js`	5.14 MB	+6.4 kB (+0.12%)
`dist/stellar-sdk-no-axios.js`	6.05 MB	+12.5 kB (+0.21%)
`dist/stellar-sdk-no-axios.min.js`	5.14 MB	+6.4 kB (+0.12%)
`dist/stellar-sdk-no-eventsource.js`	6.32 MB	+12.5 kB (+0.2%)
`dist/stellar-sdk-no-eventsource.min.js`	5.36 MB	+6.4 kB (+0.12%)
`dist/stellar-sdk.js`	6.32 MB	+12.5 kB (+0.2%)
`dist/stellar-sdk.min.js`	5.36 MB	+6.4 kB (+0.12%)

_{compressed-size-action}

Shaptic · 2026-04-17T02:00:20Z

 ## Unreleased

+### Added
+* Added


Nit: finish adding added 😉

quietbits · 2026-04-17T12:50:13Z

+  raw: Api.RawGetLatestLedgerResponse,
+): Api.GetLatestLedgerResponse {
+  if (!raw.headerXdr || !raw.metadataXdr) {
+    throw new TypeError(`invalid response missing fields`);


This suggestion returns a better error for the user

quietbits · 2026-04-17T12:54:06Z

+          result: {
+            id: "hashed_id",
+            sequence: 123,
+            protocolVersion: 20,


We define protocolVersion as a string in GetLatestLedgerResponse. Is this using a different type?

add missing fields to rpc Server.getLatestLedger response and fix tests

522565b

Copilot AI review requested due to automatic review settings April 16, 2026 20:39

github-project-automation Bot added this to DevX Apr 16, 2026

github-project-automation Bot moved this to Backlog (Not Ready) in DevX Apr 16, 2026

Copilot started reviewing on behalf of Ryang-21 April 16, 2026 20:40 View session

add getLatestLedger change entry

8710e78

Ryang-21 requested a review from quietbits April 16, 2026 20:41

Copilot AI reviewed Apr 16, 2026

View reviewed changes

Shaptic reviewed Apr 17, 2026

View reviewed changes

Comment thread CHANGELOG.md Outdated

## Unreleased

### Added

* Added

Copy link
Copy Markdown

Contributor

Shaptic Apr 17, 2026

Choose a reason for hiding this comment

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

Nit: finish adding added 😉

quietbits approved these changes Apr 17, 2026

View reviewed changes

Ryang-21 added 5 commits April 17, 2026 09:41

remove duplicated added section

72519de

fix: update protocolVersion type in getLatestLedger test

3eb26d3

fix: update protocolVersion type in getClassicEntries test

67de0fd

fix type discrepancy in js-doc for RawGetLatestLedgerResponse

56efee3

improve error message in parser to output method name and missing fields

2a95724

Ryang-21 merged commit 8db146e into master Apr 17, 2026
10 checks passed

Ryang-21 deleted the add-missing-fields-get-latest-ledger branch April 17, 2026 17:29

github-project-automation Bot moved this from Backlog (Not Ready) to Done in DevX Apr 17, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add missing fields to rpc Server.getLatestLedger response#1389

Add missing fields to rpc Server.getLatestLedger response#1389
Ryang-21 merged 7 commits intomasterfrom
add-missing-fields-get-latest-ledger

Ryang-21 commented Apr 16, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 16, 2026

Uh oh!

Copilot AI Apr 16, 2026

Uh oh!

quietbits Apr 17, 2026

Uh oh!

Copilot AI Apr 16, 2026

Uh oh!

Copilot AI Apr 16, 2026

Uh oh!

quietbits Apr 17, 2026

Uh oh!

github-actions Bot commented Apr 16, 2026 •

edited

Loading

Uh oh!

Shaptic Apr 17, 2026

Uh oh!

quietbits Apr 17, 2026

Uh oh!

quietbits Apr 17, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

-    throw new TypeError(`invalid response missing fields`);
+    let missingFields: string;
+    if (!raw.metadataXdr && !raw.headerXdr) {
+      missingFields = "metadataXdr and headerXdr";
+    } else if (!raw.metadataXdr) {
+      missingFields = "metadataXdr";
+    } else {
+      missingFields = "headerXdr";
+    }
+    throw new TypeError(
+      `invalid getLatestLedger response missing fields: ${missingFields}`,
+    );

Conversation

Ryang-21 commented Apr 16, 2026

What

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

Uh oh!

quietbits Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

Uh oh!

quietbits Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Apr 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Shaptic Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

quietbits Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

quietbits Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions Bot commented Apr 16, 2026 •

edited

Loading