|
| 1 | +--- |
| 2 | +html: feature.html |
| 3 | +parent: server-info-methods.html |
| 4 | +seo: |
| 5 | + description: Get information about protocol amendments. |
| 6 | +labels: |
| 7 | + - Blockchain |
| 8 | + - Core Server |
| 9 | +--- |
| 10 | + |
| 11 | +# feature |
| 12 | + |
| 13 | +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Feature1.cpp "Source")<br/> |
| 14 | + |
| 15 | +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. |
| 16 | + |
| 17 | +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. |
| 18 | + |
| 19 | +{% badge href="https://github.com/XRPLF/rippled/releases/tag/2.2.0" %}New in: rippled 2.2.0{% /badge %} |
| 20 | + |
| 21 | +## Request Format |
| 22 | + |
| 23 | +An example of the request format: |
| 24 | + |
| 25 | +{% tabs %} |
| 26 | + |
| 27 | +{% tab label="WebSocket" %} |
| 28 | +```json |
| 29 | +{ |
| 30 | + "command": "feature", |
| 31 | + "feature": "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373" |
| 32 | +} |
| 33 | +``` |
| 34 | +{% /tab %} |
| 35 | + |
| 36 | +{% tab label="JSON-RPC" %} |
| 37 | +```json |
| 38 | +{ |
| 39 | + "method": "feature", |
| 40 | + "params": [ |
| 41 | + { |
| 42 | + "feature": "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373" |
| 43 | + } |
| 44 | + ] |
| 45 | +} |
| 46 | +``` |
| 47 | +{% /tab %} |
| 48 | + |
| 49 | +{% tab label="Commandline" %} |
| 50 | +```sh |
| 51 | +#Syntax: feature [<feature_id>] |
| 52 | +rippled feature 4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373 |
| 53 | +``` |
| 54 | +{% /tab %} |
| 55 | + |
| 56 | +{% /tabs %} |
| 57 | + |
| 58 | +{% try-it method="feature" /%} |
| 59 | + |
| 60 | +The request includes the following parameters: |
| 61 | + |
| 62 | +| `Field` | Type | Description | |
| 63 | +|:----------|:--------|:-------------------------------------------------------| |
| 64 | +| `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. | |
| 65 | + |
| 66 | +## Response Format |
| 67 | + |
| 68 | +An example of a successful response: |
| 69 | + |
| 70 | +{% tabs %} |
| 71 | + |
| 72 | +{% tab label="WebSocket" %} |
| 73 | +```json |
| 74 | +{ |
| 75 | + "result": { |
| 76 | + "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373": { |
| 77 | + "enabled": false, |
| 78 | + "name": "MultiSign", |
| 79 | + "supported": true |
| 80 | + } |
| 81 | + }, |
| 82 | + "status": "success", |
| 83 | + "type": "response" |
| 84 | +} |
| 85 | +``` |
| 86 | +{% /tab %} |
| 87 | + |
| 88 | +{% tab label="JSON-RPC" %} |
| 89 | +```json |
| 90 | +200 OK |
| 91 | + |
| 92 | +{ |
| 93 | + "result": { |
| 94 | + "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373": { |
| 95 | + "enabled": false, |
| 96 | + "name": "MultiSign", |
| 97 | + "supported": true |
| 98 | + }, |
| 99 | + "status": "success" |
| 100 | + } |
| 101 | +} |
| 102 | +``` |
| 103 | +{% /tab %} |
| 104 | + |
| 105 | +{% tab label="Commandline" %} |
| 106 | +```json |
| 107 | +Loading: "/etc/rippled.cfg" |
| 108 | +Connecting to 127.0.0.1:5005 |
| 109 | + |
| 110 | +{ |
| 111 | + "result": { |
| 112 | + "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373": { |
| 113 | + "enabled": false, |
| 114 | + "name": "MultiSign", |
| 115 | + "supported": true |
| 116 | + }, |
| 117 | + "status": "success" |
| 118 | + } |
| 119 | +} |
| 120 | +``` |
| 121 | +{% /tab %} |
| 122 | + |
| 123 | +{% /tabs %} |
| 124 | + |
| 125 | +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: |
| 126 | + |
| 127 | +| `Field` | Type | Description | |
| 128 | +|:------------|:--------|:-----------------------------------------------------| |
| 129 | +| `enabled` | Boolean | Whether this amendment is currently enabled in the latest ledger. | |
| 130 | +| `name` | String | (May be omitted) The human-readable name for this amendment, if known. | |
| 131 | +| `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). | |
| 132 | + |
| 133 | +{% 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 %} |
| 134 | + |
| 135 | +## Possible Errors |
| 136 | + |
| 137 | +- Any of the [universal error types][]. |
| 138 | +- `badFeature` - The `feature` specified was invalidly formatted, or the server does not know an amendment with that name. |
| 139 | +- `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. |
| 140 | +- `reportingUnsupported` - ([Reporting Mode][] servers only) This method is not available in Reporting Mode. |
| 141 | + |
| 142 | +{% raw-partial file="/docs/_snippets/common-links.md" /%} |
0 commit comments