Add test cases

stellar · Jan 22, 2025 · 4db05df · 4db05df
1 parent 5ba5b80
commit 4db05df
Show file tree

Hide file tree

Showing 3 changed files with 65 additions and 5 deletions.
diff --git a/clients/stellarcore/client.go b/clients/stellarcore/client.go
@@ -252,7 +252,7 @@ func (c *Client) GetLedgerEntryRaw(ctx context.Context, ledgerSeq uint32, keys .
 
 func (c *Client) GetLedgerEntries(ctx context.Context, ledgerSeq uint32, keys ...xdr.LedgerKey) (*proto.GetLedgerEntryResponse, error) {
 	var resp *proto.GetLedgerEntryResponse
-	return resp, c.makeLedgerKeyRequest(ctx, resp, "getledgerentry", ledgerSeq, keys...)
+	return resp, c.makeLedgerKeyRequest(ctx, &resp, "getledgerentry", ledgerSeq, keys...)
 }
 
 // SubmitTransaction calls the `tx` command on the connected stellar core with the provided envelope

diff --git a/clients/stellarcore/client_test.go b/clients/stellarcore/client_test.go
@@ -86,7 +86,7 @@ func TestManualClose_NotAvailable(t *testing.T) {
 	assert.EqualError(t, err, "exception in response: Set MANUAL_CLOSE=true")
 }
 
-func TestGetLedgerEntries(t *testing.T) {
+func TestGetRawLedgerEntries(t *testing.T) {
 	hmock := httptest.NewClient()
 	c := &Client{HTTP: hmock, URL: "http://localhost:11626"}
 
@@ -139,6 +139,66 @@ func TestGetLedgerEntries(t *testing.T) {
 	require.Equal(t, "pretend this is another XDR lol", resp.Entries[1].Entry)
 }
 
+func TestGetLedgerEntries(t *testing.T) {
+	hmock := httptest.NewClient()
+	c := &Client{HTTP: hmock, URL: "http://localhost:11626"}
+
+	// build a fake response body
+	mockResp := proto.GetLedgerEntryResponse{
+		Ledger: 1215, // checkpoint align on expected request
+		Entries: []proto.LedgerEntryResponse{{
+			Entry: "pretend this is XDR lol",
+			State: "live",
+			Ttl:   1234,
+		}, {
+			Entry: "pretend this is another XDR lol",
+			State: "archived",
+		}},
+	}
+
+	var key xdr.LedgerKey
+	acc, err := xdr.AddressToAccountId(keypair.MustRandom().Address())
+	require.NoError(t, err)
+	key.SetAccount(acc)
+
+	// happy path - fetch an entry
+	ce := hmock.On("POST", "http://localhost:11626/getledgerentry")
+	hmock.RegisterResponder(
+		"POST",
+		"http://localhost:11626/getledgerentry",
+		func(r *http.Request) (*http.Response, error) {
+			// Ensure the request has the correct POST body
+			requestData, ierr := io.ReadAll(r.Body)
+			require.NoError(t, ierr)
+
+			keyB64, ierr := key.MarshalBinaryBase64()
+			require.NoError(t, ierr)
+			expected := fmt.Sprintf("key=%s&ledgerSeq=1234", url.QueryEscape(keyB64))
+			require.Equal(t, expected, string(requestData))
+
+			resp, ierr := httpmock.NewJsonResponse(http.StatusOK, &mockResp)
+			require.NoError(t, ierr)
+			ce.Return(httpmock.ResponderFromResponse(resp))
+			return resp, nil
+		})
+
+	resp, err := c.GetLedgerEntries(context.Background(), 1234, key)
+	require.NoError(t, err)
+	require.NotNil(t, resp)
+
+	require.EqualValues(t, 1215, resp.Ledger)
+	require.Len(t, resp.Entries, 2)
+	require.Equal(t, "pretend this is XDR lol", resp.Entries[0].Entry)
+	require.Equal(t, "pretend this is another XDR lol", resp.Entries[1].Entry)
+	require.EqualValues(t, 1234, resp.Entries[0].Ttl)
+	require.EqualValues(t, "live", resp.Entries[0].State)
+	require.EqualValues(t, "archived", resp.Entries[1].State)
+
+	key.Type = xdr.LedgerEntryTypeTtl
+	_, err = c.GetLedgerEntries(context.Background(), 1234, key)
+	require.Error(t, err)
+}
+
 func TestGenSorobanConfigUpgradeTxAndKey(t *testing.T) {
 	coreBinary := os.Getenv("STELLAR_CORE_BINARY_PATH")
 	if coreBinary == "" {

diff --git a/protocols/stellarcore/getledgerentry_response.go b/protocols/stellarcore/getledgerentry_response.go
@@ -17,11 +17,11 @@ const (
 
 // GetLedgerEntryResponse is the structure of Stellar Core's /getledgerentry
 type GetLedgerEntryResponse struct {
-	Ledger  uint32                     `json:"ledger"`
-	Entries []RawLedgerEntriesResponse `json:"entries"`
+	Ledger  uint32                `json:"ledger"`
+	Entries []LedgerEntryResponse `json:"entries"`
 }
 
-type RawLedgerEntriesResponse struct {
+type LedgerEntryResponse struct {
 	Entry string `json:"e"`             // base64-encoded xdr.LedgerEntry, or xdr.LedgerKey if state == new
 	State string `json:"state"`         // one of the above states
 	Ttl   uint32 `json:"ttl,omitempty"` // optionally, a Soroban entry's `liveUntilLedgerSeq`