Add xdrFormat parameter to all applicable RPC endpoint inputs (#1367)

stellar · Mar 7, 2025 · 7b940f3 · 7b940f3
1 parent 87feb33
commit 7b940f3
Show file tree

Hide file tree

Showing 7 changed files with 72 additions and 16 deletions.
diff --git a/openrpc/src/stellar-rpc/methods/getLedgerEntries.json b/openrpc/src/stellar-rpc/methods/getLedgerEntries.json
@@ -9,6 +9,9 @@
     "params": [
         {
             "$ref": "#/components/contentDescriptors/LedgerKeys"
+        },
+        {
+            "$ref": "#/components/contentDescriptors/Format"
         }
     ],
     "result": {

diff --git a/openrpc/src/stellar-rpc/methods/getLedgers.json b/openrpc/src/stellar-rpc/methods/getLedgers.json
@@ -12,6 +12,9 @@
     },
     {
       "$ref": "#/components/contentDescriptors/TransactionsPagination"
+    },
+    {
+      "$ref": "#/components/contentDescriptors/Format"
     }
   ],
   "result": {

diff --git a/openrpc/src/stellar-rpc/methods/getTransaction.json b/openrpc/src/stellar-rpc/methods/getTransaction.json
@@ -9,6 +9,9 @@
     "params": [
         {
             "$ref": "#/components/contentDescriptors/TransactionHash"
+        },
+        {
+            "$ref": "#/components/contentDescriptors/Format"
         }
     ],
     "result": {

diff --git a/openrpc/src/stellar-rpc/methods/getTransactions.json b/openrpc/src/stellar-rpc/methods/getTransactions.json
@@ -12,6 +12,9 @@
     },
     {
       "$ref": "#/components/contentDescriptors/TransactionsPagination"
+    },
+    {
+      "$ref": "#/components/contentDescriptors/Format"
     }
   ],
   "result": {

diff --git a/openrpc/src/stellar-rpc/methods/simulateTransaction.json b/openrpc/src/stellar-rpc/methods/simulateTransaction.json
@@ -12,6 +12,9 @@
         },
         {
             "$ref": "#/components/contentDescriptors/ResourceConfig"
+        },
+        {
+            "$ref": "#/components/contentDescriptors/Format"
         }
     ],
     "result": {

diff --git a/openrpc/src/stellar-rpc/schemas/Format.json b/openrpc/src/stellar-rpc/schemas/Format.json
@@ -2,10 +2,6 @@
   "Format": {
     "title": "xdrFormat",
     "type": "string",
-    "oneOf": [
-      { "name": "json", "type": "string"},
-      { "name": "base64", "type": "string"}
-    ],
-    "description": "A string which indicates whether the response should be decoded to json or return the base64 encoded xdr strings."
+    "description": "Specifies whether XDR should be encoded as Base64 (default or 'base64') or JSON ('json')."
   }
 }
diff --git a/static/stellar-rpc.openrpc.json b/static/stellar-rpc.openrpc.json
@@ -138,17 +138,7 @@
           "schema": {
             "title": "xdrFormat",
             "type": "string",
-            "oneOf": [
-              {
-                "name": "json",
-                "type": "string"
-              },
-              {
-                "name": "base64",
-                "type": "string"
-              }
-            ],
-            "description": "A string which indicates whether the response should be decoded to json or return the base64 encoded xdr strings."
+            "description": "Specifies whether XDR should be encoded as Base64 (default or 'base64') or JSON ('json')."
           }
         }
       ],
@@ -707,6 +697,17 @@
               "description": "Ledger key, serialized as a base64 string, corresponding to an existing ledger entry you wish to retrieve."
             }
           }
+        },
+        {
+          "name": "xdrFormat",
+          "summary": "chooses a response format for XDR fields: 'json' or 'base64'",
+          "required": false,
+          "description": "Lets the user choose the format in which the response should be returned - either as unpacked JSON or as base64-encoded XDR strings. Note that you should not rely on any schema for the JSON, as it will change when the underlying XDR changes.",
+          "schema": {
+            "title": "xdrFormat",
+            "type": "string",
+            "description": "Specifies whether XDR should be encoded as Base64 (default or 'base64') or JSON ('json')."
+          }
         }
       ],
       "result": {
@@ -883,6 +884,17 @@
               }
             }
           }
+        },
+        {
+          "name": "xdrFormat",
+          "summary": "chooses a response format for XDR fields: 'json' or 'base64'",
+          "required": false,
+          "description": "Lets the user choose the format in which the response should be returned - either as unpacked JSON or as base64-encoded XDR strings. Note that you should not rely on any schema for the JSON, as it will change when the underlying XDR changes.",
+          "schema": {
+            "title": "xdrFormat",
+            "type": "string",
+            "description": "Specifies whether XDR should be encoded as Base64 (default or 'base64') or JSON ('json')."
+          }
         }
       ],
       "result": {
@@ -1074,6 +1086,17 @@
             "pattern": "^[a-f\\d]{64}$",
             "description": "Transaction hash (as a hex-encoded string)"
           }
+        },
+        {
+          "name": "xdrFormat",
+          "summary": "chooses a response format for XDR fields: 'json' or 'base64'",
+          "required": false,
+          "description": "Lets the user choose the format in which the response should be returned - either as unpacked JSON or as base64-encoded XDR strings. Note that you should not rely on any schema for the JSON, as it will change when the underlying XDR changes.",
+          "schema": {
+            "title": "xdrFormat",
+            "type": "string",
+            "description": "Specifies whether XDR should be encoded as Base64 (default or 'base64') or JSON ('json')."
+          }
         }
       ],
       "result": {
@@ -1271,6 +1294,17 @@
               }
             }
           }
+        },
+        {
+          "name": "xdrFormat",
+          "summary": "chooses a response format for XDR fields: 'json' or 'base64'",
+          "required": false,
+          "description": "Lets the user choose the format in which the response should be returned - either as unpacked JSON or as base64-encoded XDR strings. Note that you should not rely on any schema for the JSON, as it will change when the underlying XDR changes.",
+          "schema": {
+            "title": "xdrFormat",
+            "type": "string",
+            "description": "Specifies whether XDR should be encoded as Base64 (default or 'base64') or JSON ('json')."
+          }
         }
       ],
       "result": {
@@ -1797,6 +1831,17 @@
               }
             }
           }
+        },
+        {
+          "name": "xdrFormat",
+          "summary": "chooses a response format for XDR fields: 'json' or 'base64'",
+          "required": false,
+          "description": "Lets the user choose the format in which the response should be returned - either as unpacked JSON or as base64-encoded XDR strings. Note that you should not rely on any schema for the JSON, as it will change when the underlying XDR changes.",
+          "schema": {
+            "title": "xdrFormat",
+            "type": "string",
+            "description": "Specifies whether XDR should be encoded as Base64 (default or 'base64') or JSON ('json')."
+          }
         }
       ],
       "result": {
-Original file line number
+Diff line change
@@ Expand Up / @@ -12,6 +12,9 @@ @@
         },
         {
           "$ref": "#/components/contentDescriptors/TransactionsPagination"
+        },
+        {
+          "$ref": "#/components/contentDescriptors/Format"
         }
       ],
       "result": {
@@ Expand Down @@