Merge pull request #3040 from XRPLF/add-non-admin-feature-rpc

Add non-admin feature RPC
2025-11-04 11:55:50 +00:00 · 2025-03-28 10:16:21 -07:00
parent 7d39cb3058 d905b9c68d
commit f31c504b88
5 changed files with 154 additions and 1 deletions
--- a/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/feature.md
+++ b/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/feature.md
@@ -14,7 +14,7 @@ The `feature` command returns information about [amendments](../../../../concept

 You can use the `feature` command to configure the server to vote against or in favor of an amendment. This change persists even if you restart the server. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.7.0" %}Updated in: rippled 1.7.0{% /badge %}

-_The `feature` method is an [admin method](../index.md) that cannot be run by unprivileged users._
+_The `feature` method documented on this page is an [admin method](../index.md). For the non-admin version, see the [`feature` public API method](../../public-api-methods/server-info-methods/feature.md)._

 ### Request Format
 An example of the request format:
--- a/docs/references/http-websocket-apis/public-api-methods/index.md
+++ b/docs/references/http-websocket-apis/public-api-methods/index.md
@@ -89,6 +89,7 @@ Use these methods to enable the server to push updates to your client when vario
 Use these methods to retrieve information about the current state of the `rippled` server.

 * **[`fee`](server-info-methods/fee.md)** - Get information about transaction cost.
+* **[`feature`](server-info-methods/feature.md)** - Returns information about amendments this server knows about.
 * **[`server_info`](server-info-methods/server_info.md)** - Retrieve status of the server in human-readable format.
 * **[`server_state`](server-info-methods/server_state.md)** - Retrieve status of the server in machine-readable format.
 * **[`server_definitions`](server-info-methods/server_definitions.md)** - Retrieve a list of types and fields used for the XRPL's canonical binary format.
--- a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/feature.md
+++ b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/feature.md
@@ -0,0 +1,142 @@
+---
+html: feature.html
+parent: server-info-methods.html
+seo:
+    description: Get information about protocol amendments.
+labels:
+  - Blockchain
+  - Core Server
+---
+
+# feature
+
+[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Feature1.cpp "Source")<br/>
+
+The `feature` command returns information about [amendments](../../../../concepts/networks-and-servers/amendments.md) this server knows about, including whether they are enabled and if the server knows how to apply the amendments.
+
+This is the non-admin version of the [`feature` admin command](../../admin-api-methods/status-and-debugging-methods/feature.md). It follows the same formatting as the _admin_ command, but hides potentially sensitive data.
+
+{% badge href="https://github.com/XRPLF/rippled/releases/tag/2.2.0" %}New in: rippled 2.2.0{% /badge %}
+
+## Request Format
+
+An example of the request format:
+
+{% tabs %}
+
+{% tab label="WebSocket" %}
+```json
+{
+  "command": "feature",
+  "feature": "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373"
+}
+```
+{% /tab %}
+
+{% tab label="JSON-RPC" %}
+```json
+{
+    "method": "feature",
+    "params": [
+        {
+            "feature": "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373"
+        }
+    ]
+}
+```
+{% /tab %}
+
+{% tab label="Commandline" %}
+```sh
+#Syntax: feature [<feature_id>]
+rippled feature 4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373
+```
+{% /tab %}
+
+{% /tabs %}
+
+{% try-it method="feature" /%}
+
+The request includes the following parameters:
+
+| `Field`   | Type    | Description                                            |
+|:----------|:--------|:-------------------------------------------------------|
+| `feature` | String  | _(Optional)_ The unique ID of an amendment, as hexadecimal; or the short name of the amendment. If provided, limits the response to one amendment. Otherwise, the response lists all amendments. |
+
+## Response Format
+
+An example of a successful response:
+
+{% tabs %}
+
+{% tab label="WebSocket" %}
+```json
+{
+  "result": {
+    "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373": {
+      "enabled": false,
+      "name": "MultiSign",
+      "supported": true
+    }
+  },
+  "status": "success",
+  "type": "response"
+}
+```
+{% /tab %}
+
+{% tab label="JSON-RPC" %}
+```json
+200 OK
+
+{
+    "result": {
+        "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373": {
+            "enabled": false,
+            "name": "MultiSign",
+            "supported": true
+        },
+        "status": "success"
+    }
+}
+```
+{% /tab %}
+
+{% tab label="Commandline" %}
+```json
+Loading: "/etc/rippled.cfg"
+Connecting to 127.0.0.1:5005
+
+{
+    "result": {
+        "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373": {
+            "enabled": false,
+            "name": "MultiSign",
+            "supported": true
+        },
+        "status": "success"
+    }
+}
+```
+{% /tab %}
+
+{% /tabs %}
+
+The response follows the [standard format][], with a successful result containing **a map of amendments** as a JSON object. The keys of the object are amendment IDs. The values for each key are _amendment objects_ that describe the status of the amendment with that ID. If the request specified a `feature`, the map contains only the requested amendment object, after applying any changes from the request. Each amendment object has the following fields:
+
+| `Field`     | Type    | Description                                          |
+|:------------|:--------|:-----------------------------------------------------|
+| `enabled`   | Boolean | Whether this amendment is currently enabled in the latest ledger. |
+| `name`      | String  | (May be omitted) The human-readable name for this amendment, if known. |
+| `supported` | Boolean | Whether the server knows how to apply this amendment. If this field is set to `false` (the server does not know how to apply this amendment) and `enabled` is set to `true` (this amendment is enabled in the latest ledger), this amendment may cause your server to be [amendment blocked](../../../../concepts/networks-and-servers/amendments.md#amendment-blocked-servers). |
+
+{% admonition type="warning" name="Caution" %}The `name` for an amendment does not strictly indicate what that amendment does. The name is not guaranteed to be unique or consistent across servers.{% /admonition %}
+
+## Possible Errors
+
+- Any of the [universal error types][].
+- `badFeature` - The `feature` specified was invalidly formatted, or the server does not know an amendment with that name.
+- `noPermission` - The server does not have permission to run the specified command. For example, this can occur if the request includes admin-only fields that are not allowed, such as the `vetoed` request parameter.
+- `reportingUnsupported` - ([Reporting Mode][] servers only) This method is not available in Reporting Mode.
+
+{% raw-partial file="/docs/_snippets/common-links.md" /%}
--- a/resources/dev-tools/components/websocket-api/data/command-list.json
+++ b/resources/dev-tools/components/websocket-api/data/command-list.json
@@ -565,6 +565,15 @@
        "body": {
          "command": "version"
        }
+      },
+      {
+        "name": "feature",
+        "description": "Returns information about amendments this server knows about. When you connect to a cluster that includes a Clio server, the Clio method is used.",
+        "link": "/docs/references/http-websocket-apis/public-api-methods/server-info-methods/feature",
+        "body": {
+          "command": "feature",
+          "feature": "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373"
+        }
      }
    ]
  },
--- a/sidebars.yaml
+++ b/sidebars.yaml
@@ -525,6 +525,7 @@
                  expanded: false
                  items:
                    - page: docs/references/http-websocket-apis/public-api-methods/server-info-methods/fee.md
+                    - page: docs/references/http-websocket-apis/public-api-methods/server-info-methods/feature.md
                    - page: docs/references/http-websocket-apis/public-api-methods/server-info-methods/manifest.md
                    - page: docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_definitions.md
                    - page: docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md