RPC Methods: Add getLedgers (#1221)

stellar · Jan 8, 2025 · deae27d · deae27d
1 parent 8f1546e
commit deae27d
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 0 deletions.
diff --git a/src/app/(sidebar)/endpoints/[[...pages]]/page.tsx b/src/app/(sidebar)/endpoints/[[...pages]]/page.tsx
@@ -208,6 +208,20 @@ export default function Endpoints() {
         };
       }
 
+      case Routes.ENDPOINTS_GET_LEDGERS: {
+        return {
+          ...defaultRpcRequestBody,
+          params: {
+            startLedger: Number(params.startLedger) || null,
+            pagination: sanitizeObject({
+              cursor: params.cursor,
+              limit: Number(params.limit) || undefined,
+            }),
+            xdrFormat: params.xdrFormat || "base64",
+          },
+        };
+      }
+
       case Routes.ENDPOINTS_GET_TRANSACTION: {
         return {
           ...defaultRpcRequestBody,
@@ -363,6 +377,15 @@ export default function Endpoints() {
       }
     });
 
+    // RPC Cursor field can be used instead of the required Start Ledger Sequence
+    if (
+      isRpcEndpoint &&
+      requiredFields.includes("startLedger") &&
+      !params.startLedger
+    ) {
+      isValidReqFields = Boolean(params.cursor);
+    }
+
     return (
       isValidReqAssetFields && isValidReqFields && isValid && isAssetMultiValid
     );

diff --git a/src/constants/endpointsPages.ts b/src/constants/endpointsPages.ts
@@ -99,6 +99,20 @@ export const ENDPOINTS_PAGES_RPC: EndpointsPagesProps = {
         isStreaming: false,
       },
     },
+    {
+      route: Routes.ENDPOINTS_GET_LEDGERS,
+      label: "getLedgers",
+      form: {
+        docsUrl:
+          "https://developers.stellar.org/docs/data/rpc/api-reference/methods/getLedgers",
+        docsLabel: "getLedgers",
+        endpointUrlTemplate: "{?startLedger,cursor,limit,xdrFormat}",
+        requestMethod: "POST",
+        requiredParams: "startLedger",
+        rpcMethod: "getLedgers",
+        isStreaming: false,
+      },
+    },
     {
       route: Routes.ENDPOINTS_GET_NETWORK,
       label: "getNetwork",

diff --git a/src/constants/routes.ts b/src/constants/routes.ts
@@ -64,6 +64,7 @@ export enum Routes {
   ENDPOINTS_GET_HEALTH = "/endpoints/rpc/get-health",
   ENDPOINTS_GET_LATEST_LEDGER = "/endpoints/rpc/get-latest-ledger",
   ENDPOINTS_GET_LEDGER_ENTRIES = "/endpoints/rpc/get-ledger-entries",
+  ENDPOINTS_GET_LEDGERS = "/endpoints/rpc/get-ledgers",
   ENDPOINTS_GET_NETWORK = "/endpoints/rpc/get-network",
   ENDPOINTS_GET_TRANSACTION = "/endpoints/rpc/get-transaction",
   ENDPOINTS_GET_TRANSACTIONS = "/endpoints/rpc/get-transactions",