From c8e09ccb7a5c4f37b7e04aa39fa99cb2dcb958fe Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Mon, 1 Mar 2021 15:47:03 -0800 Subject: [PATCH] Amendment voting: move configure to tutorial --- .../amendments/amendments.md | 51 +------------ .../configure-amendment-voting.md | 74 +++++++++++++++++++ .../understanding-log-messages.md | 11 +++ dactyl-config.yml | 5 ++ 4 files changed, 91 insertions(+), 50 deletions(-) create mode 100644 content/tutorials/manage-the-rippled-server/configuration/configure-amendment-voting.md diff --git a/content/concepts/consensus-network/amendments/amendments.md b/content/concepts/consensus-network/amendments/amendments.md index fb13164e35..d805a47923 100644 --- a/content/concepts/consensus-network/amendments/amendments.md +++ b/content/concepts/consensus-network/amendments/amendments.md @@ -56,56 +56,7 @@ To become enabled, an amendment must be supported by at least 80% of trusted val As with all aspects of the consensus process, amendment votes are only taken into account by servers that trust the validators sending those votes. At this time, Ripple (the company) recommends only trusting the validators on the validator list that Ripple publishes at . For now, trusting only those validators is enough to coordinate with Ripple on releasing new features. -### Configuring Amendment Voting - -[Updated in: rippled 1.7.0][] - -You can set your server's vote on an amendment using the [feature method][]. For example, to vote against the "SHAMapV2" amendment, you could run the following command: - - - -*WebSocket* - -```json -{ - "id": "any_id_here", - "command": "feature", - "feature": "SHAMapV2", - "vetoed": true -} -``` - -*JSON-RPC* - -```json -{ - "method": "feature", - "params": [ - { - "feature": "SHAMapV2", - "vetoed": true - } - ] -} -``` - -*Commandline* - -```sh -rippled feature SHAMapV2 reject -``` - - - -**Note:** The short name of the amendment is case-sensitive. You can also use an amendment's ID as hexadecimal, which is not case sensitive. - -The `[veto_amendments]` and `[amendments]` stanzas of the config file are deprecated. If you have such a stanza in your config file, the server loads the results one time. On later server restarts, the server ignores the contents of these stanzas and prints a warning to the log. - -> **Tip:** If you still want to use the config file to configure amendment voting, you can add a line to the `[rpc_startup]` stanza for each explicit vote. For example: -> -> [rpc_startup] -> { "command": "feature", "feature": "SHAMapV2", "vetoed": true } - +For information on how to configure your server's amendment votes, see [Configure Amendment Voting](configure-amendment-voting.html). [Updated in: rippled 1.7.0][] ### Amendment Blocked diff --git a/content/tutorials/manage-the-rippled-server/configuration/configure-amendment-voting.md b/content/tutorials/manage-the-rippled-server/configuration/configure-amendment-voting.md new file mode 100644 index 0000000000..70e4dc72f3 --- /dev/null +++ b/content/tutorials/manage-the-rippled-server/configuration/configure-amendment-voting.md @@ -0,0 +1,74 @@ +--- +html: configure-amendment-voting.html +funnel: Build +doc_type: Tutorials +category: Manage the rippled Server +subcategory: Configuration +blurb: Set your server's votes on protocol amendments. +--- +# Configure Amendment Voting + +Servers configured as validators can vote on [amendments](amendments.html) to the XRP Ledger protocol using the [feature method][]. (This method requires [admin access](get-started-with-the-rippled-api.html#admin-access).) + +For example, to vote against the "SHAMapV2" amendment, run the following command: + + + +*WebSocket* + +```json +{ + "id": "any_id_here", + "command": "feature", + "feature": "SHAMapV2", + "vetoed": true +} +``` + +*JSON-RPC* + +```json +{ + "method": "feature", + "params": [ + { + "feature": "SHAMapV2", + "vetoed": true + } + ] +} +``` + +*Commandline* + +```sh +rippled feature SHAMapV2 reject +``` + + + +**Note:** The short name of the amendment is case-sensitive. You can also use an amendment's ID as hexadecimal, which is not case sensitive. + +## Using the Config File + +If you prefer to use the config file to configure amendment voting, you can add a line to the `[rpc_startup]` stanza to run the command automatically on startup for each explicit vote. For example: + +``` +[rpc_startup] +{ "command": "feature", "feature": "SHAMapV2", "vetoed": true } +``` + +Be sure to restart your server for changes to take effect. + +**Caution:** Any commands in the `[rpc_startup]` stanza run each time the server starts up, which can override voting settings you configured while the server was running. + +## See Also + +- [Amendments](amendments.html) + - [Known Amendments](known-amendments.html) +- [feature method][] + + +{% include '_snippets/rippled-api-links.md' %} +{% include '_snippets/tx-type-links.md' %} +{% include '_snippets/rippled_versions.md' %} diff --git a/content/tutorials/manage-the-rippled-server/troubleshooting/understanding-log-messages.md b/content/tutorials/manage-the-rippled-server/troubleshooting/understanding-log-messages.md index a5bd66ccc0..e99ed7a43b 100644 --- a/content/tutorials/manage-the-rippled-server/troubleshooting/understanding-log-messages.md +++ b/content/tutorials/manage-the-rippled-server/troubleshooting/understanding-log-messages.md @@ -292,6 +292,17 @@ Validations:WRN Unable to determine hash of ancestor seq=3 from ledger hash=00B1 +## [veto_amendments] section in config file ignored + +Log messages such as the following occur when your `rippled.cfg` file contains a legacy `[veto_amendments]` stanza. The first time the server starts on version 1.7.0 or higher, it reads the stanza to set amendment votes; on later restarts, it ignores the `[amendments]` and `[veto_amendments]` stanzas and prints this message instead. + +```text +Amendments:WRN [veto_amendments] section in config file ignored in favor of data in db/wallet.db. +``` + +To resolve this error, remove the `[amendments]` and `[veto_amendments]` stanzas from your config file. For more information, see [Amendment Voting](amendments.html#amendment-voting). + + ## View of consensus changed during open Log messages such as the following occur when a server is not in sync with the rest of the network: diff --git a/dactyl-config.yml b/dactyl-config.yml index 3fce4fb0a3..bbdc12f0c9 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -2569,6 +2569,11 @@ pages: - en - ja + # TODO: translate this page & blurb + - md: tutorials/manage-the-rippled-server/configuration/configure-amendment-voting.md + targets: + - en + # TODO: translate this page & blurb - md: tutorials/manage-the-rippled-server/configuration/configure-statsd.md html: configure-statsd.html