From 20c7f5d0b12945edbd2ad7273cec28db5ffa92ee Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Tue, 23 Jan 2024 13:01:58 -0800 Subject: [PATCH] Remove obsolete validation_seed method page --- content/_snippets/common-links.md | 4 - content/redirects.yaml | 2 +- .../admin-api-methods/index.md | 5 +- .../server-control-methods/validation_seed.md | 99 ------------------- content/sidebars.yaml | 1 - 5 files changed, 3 insertions(+), 108 deletions(-) delete mode 100644 content/references/http-websocket-apis/admin-api-methods/server-control-methods/validation_seed.md diff --git a/content/_snippets/common-links.md b/content/_snippets/common-links.md index 2e5d1195220..49eb0e9c857 100644 --- a/content/_snippets/common-links.md +++ b/content/_snippets/common-links.md @@ -848,10 +848,6 @@ [validation_create method]: /references/http-websocket-apis/admin-api-methods/key-generation-methods/validation_create.md [validation_create メソッド]: /references/http-websocket-apis/admin-api-methods/key-generation-methods/validation_create.md [validation_createメソッド]: /references/http-websocket-apis/admin-api-methods/key-generation-methods/validation_create.md -[validation_seed command]: /references/http-websocket-apis/admin-api-methods/server-control-methods/validation_seed.md -[validation_seed method]: /references/http-websocket-apis/admin-api-methods/server-control-methods/validation_seed.md -[validation_seed メソッド]: /references/http-websocket-apis/admin-api-methods/server-control-methods/validation_seed.md -[validation_seedメソッド]: /references/http-websocket-apis/admin-api-methods/server-control-methods/validation_seed.md [validator_info command]: /references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/validator_info.md [validator_info method]: /references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/validator_info.md [validator_info メソッド]: /references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/validator_info.md diff --git a/content/redirects.yaml b/content/redirects.yaml index 180725c7f1f..c0cde5e1149 100644 --- a/content/redirects.yaml +++ b/content/redirects.yaml @@ -1259,7 +1259,7 @@ stop.html: to: /references/http-websocket-apis/admin-api-methods/server-control-methods/stop type: 301 validation_seed.html: - to: /references/http-websocket-apis/admin-api-methods/server-control-methods/validation_seed + to: /references/http-websocket-apis/public-api-methods/ type: 301 signing-methods.html: to: /references/http-websocket-apis/admin-api-methods/signing-methods/ diff --git a/content/references/http-websocket-apis/admin-api-methods/index.md b/content/references/http-websocket-apis/admin-api-methods/index.md index f12f1da1b12..571e34e3b3b 100644 --- a/content/references/http-websocket-apis/admin-api-methods/index.md +++ b/content/references/http-websocket-apis/admin-api-methods/index.md @@ -76,12 +76,11 @@ Use these methods to check the status of the network and server. ## Deprecated Methods -The following admin commands are deprecated and may be removed without further notice: +The following admin commands are deprecated and either have been removed, or may be removed without further notice: * `ledger_header` - Use the [ledger method][] instead. * `unl_add`, `unl_delete`, `unl_list`, `unl_load`, `unl_network`, `unl_reset`, `unl_score` - Use the `validators.txt` config file for UNL management instead. * `wallet_seed` - Use the [wallet_propose method][] instead. - -The [validation_seed method][] has been removed since `rippled` v0.29.1. +* `validation_seed` - Use the config file and `validator-keys-tool` for managing your seed instead. {% raw-partial file="/_snippets/common-links.md" /%} diff --git a/content/references/http-websocket-apis/admin-api-methods/server-control-methods/validation_seed.md b/content/references/http-websocket-apis/admin-api-methods/server-control-methods/validation_seed.md deleted file mode 100644 index 6a9639f9ca0..00000000000 --- a/content/references/http-websocket-apis/admin-api-methods/server-control-methods/validation_seed.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -html: validation_seed.html -parent: server-control-methods.html -blurb: (Obsolete) Temporarily set key to be used for validating. -status: removed -labels: - - Core Server ---- -# validation_seed - -[[Source]](https://github.com/XRPLF/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/ValidationSeed.cpp "Source") - -The `validation_seed` command temporarily sets the secret value that rippled uses to sign validations. This value resets based on the config file when you restart the server. {% badge href="https://github.com/XRPLF/rippled/releases/tag/0.29.1-rc1" %}Disabled since: rippled 0.29.1{% /badge %} - -*The `validation_seed` method is an [admin method](../index.md) that cannot be run by unprivileged users!* - -### Request Format -An example of the request format: - -{% tabs %} - -{% tab label="WebSocket" %} -```json -{ - "id": "set_seed_1", - "command": "validation_seed", - "secret": "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE" -} -``` -{% /tab %} - -{% tab label="Commandline" %} -```sh -#Syntax: validation_seed [secret] -rippled validation_seed 'BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE' -``` -{% /tab %} - -{% /tabs %} - -The request includes the following parameters: - -| `Field` | Type | Description | -|:---------|:-------|:---------------------------------------------------------| -| `secret` | String | _(Optional)_ If present, use this value as the secret value for the validating key pair. Valid formats include the XRP Ledger's [base58][] format, [RFC-1751](https://tools.ietf.org/html/rfc1751), or as a passphrase. If omitted, disables proposing validations to the network. | - -### Response Format - -An example of a successful response: - -{% tabs %} - -{% tab label="JSON-RPC" %} -```json -200 OK - -{ - "result" : { - "status" : "success", - "validation_key" : "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE", - "validation_public_key" : "n9Jx6RS6zSgqsgnuWJifNA9EqgjTKAywqYNReK5NRd1yLBbfC3ng", - "validation_seed" : "snjJkyBGogTem5dFGbcRaThKq2Rt3" - } -} -``` -{% /tab %} - -{% tab label="Commandline" %} -```json -Loading: "/etc/rippled.cfg" -Connecting to 127.0.0.1:5005 - -{ - "result" : { - "status" : "success", - "validation_key" : "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE", - "validation_public_key" : "n9Jx6RS6zSgqsgnuWJifNA9EqgjTKAywqYNReK5NRd1yLBbfC3ng", - "validation_seed" : "snjJkyBGogTem5dFGbcRaThKq2Rt3" - } -} -``` -{% /tab %} - -{% /tabs %} - -The response follows the [standard format][], with a successful result containing the following fields: - -| `Field` | Type | Description | -|:------------------------|:-------|:------------------------------------------| -| `validation_key` | String | (Omitted if proposing disabled) The secret key for these validation credentials, in [RFC-1751](https://tools.ietf.org/html/rfc1751) format. | -| `validation_public_key` | String | (Omitted if proposing disabled) The public key for these validation credentials, in the XRP Ledger's [base58][] encoded string format. | -| `validation_seed` | String | (Omitted if proposing disabled) The secret key for these validation credentials, in the XRP Ledger's [base58][] encoded string format. | - -### Possible Errors - -* Any of the [universal error types][]. -* `badSeed` - The request provided an invalid secret value. This usually means that the secret value appears to be a valid string of a different format, such as an account address or validation public key. - -{% raw-partial file="/_snippets/common-links.md" /%} diff --git a/content/sidebars.yaml b/content/sidebars.yaml index 8d9243c0e02..b72acc19aff 100644 --- a/content/sidebars.yaml +++ b/content/sidebars.yaml @@ -501,7 +501,6 @@ items: - page: references/http-websocket-apis/admin-api-methods/server-control-methods/ledger_accept.md - page: references/http-websocket-apis/admin-api-methods/server-control-methods/stop.md - - page: references/http-websocket-apis/admin-api-methods/server-control-methods/validation_seed.md - page: references/http-websocket-apis/admin-api-methods/signing-methods/index.md expanded: false items: