ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-21 04:05:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Migrate content syntax via script

Browse Source 
The changes in this commit were auto-generated by running

tool/migrate.sh

Following this commit, the Dactyl build no longer works but the Redocly
build (mostly) should.
This commit is contained in:
mDuo13
2024-01-31 16:09:41 -08:00
parent 96121303b2
commit 554a3732d4
898 changed files with 19879 additions and 18631 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
content/references/http-websocket-apis/admin-api-methods/index.md
View File

@@ -9,69 +9,69 @@ labels:
Administer a `rippled` server using these admin API methods. Admin methods are meant only for trusted personnel in charge of keeping the server operational. Admin methods include commands for managing, monitoring, and debugging the server.
Admin commands are available only if you connect to `rippled` on a host and port that the `rippled.cfg` file identifies as admin. By default, the commandline client uses an admin connection. For more information on connecting to `rippled`, see [Getting Started with the `rippled` API](get-started-using-http-websocket-apis.html).
Admin commands are available only if you connect to `rippled` on a host and port that the `rippled.cfg` file identifies as admin. By default, the commandline client uses an admin connection. For more information on connecting to `rippled`, see [Getting Started with the `rippled` API](../../../tutorials/get-started/get-started-using-http-websocket-apis.md).
## [Key Generation Methods](key-generation-methods.html)
## [Key Generation Methods](key-generation-methods/index.md)
Use these methods to generate and manage keys.
* **[`validation_create`](validation_create.html)** - Generate formatted for `rippled` node key pair. (Validators should use [tokens](run-rippled-as-a-validator.html) instead of keys generated by this method.)
* **[`wallet_propose`](wallet_propose.html)** - Generate keys for a new account.
* **[`validation_create`](key-generation-methods/validation_create.md)** - Generate formatted for `rippled` node key pair. (Validators should use [tokens](../../../infrastructure/configuration/server-modes/run-rippled-as-a-validator.md) instead of keys generated by this method.)
* **[`wallet_propose`](key-generation-methods/wallet_propose.md)** - Generate keys for a new account.
## [Logging and Data Management Methods](logging-and-data-management-methods.html)
## [Logging and Data Management Methods](logging-and-data-management-methods/index.md)
Use these methods to manage log levels and other data, such as ledgers.
* **[`can_delete`](can_delete.html)** - Allow online deletion of ledgers up to a specific ledger.
* **[`download_shard`](download_shard.html)** - Download a specific shard of ledger history.
* **[`ledger_cleaner`](ledger_cleaner.html)** - Configure the ledger cleaner service to check for corrupted data.
* **[`ledger_request`](ledger_request.html)** - Query a peer server for a specific ledger version.
* **[`log_level`](log_level.html)** - Get or modify log verbosity.
* **[`logrotate`](logrotate.html)** - Reopen the log file.
* **[`node_to_shard`](node_to_shard.html)** - Copy data from the ledger store to the shard store.
* **[`can_delete`](logging-and-data-management-methods/can_delete.md)** - Allow online deletion of ledgers up to a specific ledger.
* **[`download_shard`](logging-and-data-management-methods/download_shard.md)** - Download a specific shard of ledger history.
* **[`ledger_cleaner`](logging-and-data-management-methods/ledger_cleaner.md)** - Configure the ledger cleaner service to check for corrupted data.
* **[`ledger_request`](logging-and-data-management-methods/ledger_request.md)** - Query a peer server for a specific ledger version.
* **[`log_level`](logging-and-data-management-methods/log_level.md)** - Get or modify log verbosity.
* **[`logrotate`](logging-and-data-management-methods/logrotate.md)** - Reopen the log file.
* **[`node_to_shard`](logging-and-data-management-methods/node_to_shard.md)** - Copy data from the ledger store to the shard store.
## [Server Control Methods](server-control-methods.html)
## [Server Control Methods](server-control-methods/index.md)
Use these methods to manage the `rippled` server.
* **[`ledger_accept`](ledger_accept.html)** - Close and advance the ledger in stand-alone mode.
* **[`stop`](stop.html)** - Shut down the `rippled` server.
* **[`ledger_accept`](server-control-methods/ledger_accept.md)** - Close and advance the ledger in stand-alone mode.
* **[`stop`](server-control-methods/stop.md)** - Shut down the `rippled` server.
## [Signing Methods](signing-methods.html)
## [Signing Methods](signing-methods/index.md)
Use these methods to sign transactions.
* **[`sign`](sign.html)** - Cryptographically sign a transaction.
* **[`sign_for`](sign_for.html)** - Contribute to a multi-signature.
* **[`sign`](signing-methods/sign.md)** - Cryptographically sign a transaction.
* **[`sign_for`](signing-methods/sign_for.md)** - Contribute to a multi-signature.
By default, these methods are [admin-only](get-started-using-http-websocket-apis.html#admin-access). They can be used as public methods if the server admin has [enabled public signing](enable-public-signing.html).
By default, these methods are [admin-only](../../../tutorials/get-started/get-started-using-http-websocket-apis.md#admin-access). They can be used as public methods if the server admin has [enabled public signing](../../../infrastructure/configuration/enable-public-signing.md).
## [Peer Management Methods](peer-management-methods.html)
## [Peer Management Methods](peer-management-methods/index.md)
Use these methods to manage the server's connections in the peer-to-peer XRP Ledger network.
* **[`connect`](connect.html)** - Force the `rippled` server to connect to a specific peer.
* **[`peer_reservations_add`](peer_reservations_add.html)** - Add or update a reserved slot for a specific peer.
* **[`peer_reservations_del`](peer_reservations_del.html)** - Remove a reserved slot for a specific peer.
* **[`peer_reservations_list`](peer_reservations_list.html)** - List reserved slots for specific peers.
* **[`peers`](peers.html)** - Get information about the peer servers connected.
* **[`connect`](peer-management-methods/connect.md)** - Force the `rippled` server to connect to a specific peer.
* **[`peer_reservations_add`](peer-management-methods/peer_reservations_add.md)** - Add or update a reserved slot for a specific peer.
* **[`peer_reservations_del`](peer-management-methods/peer_reservations_del.md)** - Remove a reserved slot for a specific peer.
* **[`peer_reservations_list`](peer-management-methods/peer_reservations_list.md)** - List reserved slots for specific peers.
* **[`peers`](peer-management-methods/peers.md)** - Get information about the peer servers connected.
## [Status and Debugging Methods](status-and-debugging-methods.html)
## [Status and Debugging Methods](status-and-debugging-methods/index.md)
Use these methods to check the status of the network and server.
* **[`consensus_info`](consensus_info.html)** - Get information about the state of consensus as it happens.
* **[`feature`](feature.html)** - Get information about protocol amendments.
* **[`fetch_info`](fetch_info.html)** - Get information about the server's sync with the network.
* **[`get_counts`](get_counts.html)** - Get statistics about the server's internals and memory usage.
* **[`manifest`](manifest.html)** - Get the latest public key information about a known validator.
* **[`print`](print.html)** - Get information about internal subsystems.
* **[`validator_info`](validator_info.html)** - Get information about the server's validator settings, if configured as a validator.
* **[`validator_list_sites`](validator_list_sites.html)** - Get information about sites that publish validator lists.
* **[`validators`](validators.html)** - Get information about the current validators.
* **[`consensus_info`](status-and-debugging-methods/consensus_info.md)** - Get information about the state of consensus as it happens.
* **[`feature`](status-and-debugging-methods/feature.md)** - Get information about protocol amendments.
* **[`fetch_info`](status-and-debugging-methods/fetch_info.md)** - Get information about the server's sync with the network.
* **[`get_counts`](status-and-debugging-methods/get_counts.md)** - Get statistics about the server's internals and memory usage.
* **[`manifest`](../public-api-methods/server-info-methods/manifest.md)** - Get the latest public key information about a known validator.
* **[`print`](status-and-debugging-methods/print.md)** - Get information about internal subsystems.
* **[`validator_info`](status-and-debugging-methods/validator_info.md)** - Get information about the server's validator settings, if configured as a validator.
* **[`validator_list_sites`](status-and-debugging-methods/validator_list_sites.md)** - Get information about sites that publish validator lists.
* **[`validators`](status-and-debugging-methods/validators.md)** - Get information about the current validators.
## Deprecated Methods
@@ -84,8 +84,4 @@ The following admin commands are deprecated and may be removed without further n
The [validation_seed method][] has been removed since `rippled` v0.29.1.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

8
content/references/http-websocket-apis/admin-api-methods/key-generation-methods/index.md
View File

@@ -1,8 +1,12 @@
---
html: key-generation-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
metadata:
indexPage: true
---
# Key Generation Methods
Use these methods to generate and manage keys.
Use these methods to generate and manage keys.
{% child-pages /%}

41
content/references/http-websocket-apis/admin-api-methods/key-generation-methods/validation_create.md
View File

@@ -9,22 +9,21 @@ labels:
# validation_create
[[Source]](https://github.com/XRPLF/rippled/blob/315a8b6b602798a4cff4d8e1911936011e12abdb/src/ripple/rpc/handlers/ValidationCreate.cpp "Source")
Use the `validation_create` command to generate [cryptographic keys a `rippled` server can use to identify itself to the network](peer-protocol.html#node-key-pair). Similar to the [wallet_propose method][], this method only generates a set of keys in the proper format. It does not any makes changes to the XRP Ledger data or server configuration.
Use the `validation_create` command to generate [cryptographic keys a `rippled` server can use to identify itself to the network](../../../../concepts/networks-and-servers/peer-protocol.md#node-key-pair). Similar to the [wallet_propose method][], this method only generates a set of keys in the proper format. It does not any makes changes to the XRP Ledger data or server configuration.
_The `validation_create` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users._
_The `validation_create` method is an [admin method](../index.md) that cannot be run by unprivileged users._
You can configure your server to use the generated key pair to sign validations (validation key pair) or regular peer-to-peer communications ([node key pair](peer-protocol.html#node-key-pair)).
You can configure your server to use the generated key pair to sign validations (validation key pair) or regular peer-to-peer communications ([node key pair](../../../../concepts/networks-and-servers/peer-protocol.md#node-key-pair)).
**Tip:** For configuring a robust validator, you should use the `validator-keys` tool (included in the `rippled` RPM) to generate validator tokens (which can be rotated) with an offline master key. For more information, see [Validator Setup](run-rippled-as-a-validator.html#3-enable-validation-on-your-rippled-server).
**Tip:** For configuring a robust validator, you should use the `validator-keys` tool (included in the `rippled` RPM) to generate validator tokens (which can be rotated) with an offline master key. For more information, see [Validator Setup](../../../../infrastructure/configuration/server-modes/run-rippled-as-a-validator.md#3-enable-validation-on-your-rippled-server).
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 0,
@@ -32,9 +31,9 @@ An example of the request format:
"secret": "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "validation_create",
@@ -45,15 +44,16 @@ An example of the request format:
]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: validation_create [secret]
rippled validation_create "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE"
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes the following parameters:
@@ -67,10 +67,9 @@ The request includes the following parameters:
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*JSON-RPC*
{% tabs %}
{% tab label="JSON-RPC" %}
```json
{
"result" : {
@@ -81,9 +80,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -97,8 +96,9 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following fields:
@@ -113,7 +113,4 @@ The response follows the [standard format][], with a successful result containin
* Any of the [universal error types][].
* `badSeed` - The request provided an invalid seed value. This usually means that the seed value appears to be a valid string of a different format, such as an account address or validation public key.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

67
content/references/http-websocket-apis/admin-api-methods/key-generation-methods/wallet_propose.md
View File

@@ -9,20 +9,19 @@ labels:
# wallet_propose
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/WalletPropose.cpp "Source")
Use the `wallet_propose` method to generate a key pair and XRP Ledger address. This command only generates key and address values, and does not affect the XRP Ledger itself in any way. To become a funded address stored in the ledger, the address must [receive a Payment transaction](accounts.html#creating-accounts) that provides enough XRP to meet the [reserve requirement](reserves.html).
Use the `wallet_propose` method to generate a key pair and XRP Ledger address. This command only generates key and address values, and does not affect the XRP Ledger itself in any way. To become a funded address stored in the ledger, the address must [receive a Payment transaction](../../../../concepts/accounts/accounts.md#creating-accounts) that provides enough XRP to meet the [reserve requirement](../../../../concepts/accounts/reserves.md).
*The `wallet_propose` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users!* (This command is restricted to protect against people sniffing network traffic for account secrets, since admin commands are not usually transmitted over the outside network.)
*The `wallet_propose` method is an [admin method](../index.md) that cannot be run by unprivileged users!* (This command is restricted to protect against people sniffing network traffic for account secrets, since admin commands are not usually transmitted over the outside network.)
[Updated in: rippled 0.31.0][]
{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.31.0" %}Updated in: rippled 0.31.0{% /badge %}
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket (with key type)*
{% tabs %}
{% tab label="WebSocket (with key type)" %}
```json
{
"command": "wallet_propose",
@@ -30,18 +29,18 @@ An example of the request format:
"key_type": "secp256k1"
}
```
{% /tab %}
*WebSocket (no key type)*
{% tab label="WebSocket (no key type)" %}
```json
{
"command": "wallet_propose",
"passphrase": "masterpassphrase"
}
```
{% /tab %}
*JSON-RPC (with key type)*
{% tab label="JSON-RPC (with key type)" %}
```json
{
"method": "wallet_propose",
@@ -53,9 +52,9 @@ An example of the request format:
]
}
```
{% /tab %}
*JSON-RPC (no key type)*
{% tab label="JSON-RPC (no key type)" %}
```json
{
"method": "wallet_propose",
@@ -66,21 +65,22 @@ An example of the request format:
]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: wallet_propose [passphrase]
rippled wallet_propose masterpassphrase
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request can contain the following parameters:
| `Field` | Type | Description |
|:-------------|:-------|:-----------------------------------------------------|
| `key_type` | String |Which [signing algorithm](cryptographic-keys.html#signing-algorithms) to use to derive this key pair. Valid values are `ed25519` and `secp256k1` (all lower case). The default is `secp256k1`. |
| `key_type` | String |Which [signing algorithm](../../../../concepts/accounts/cryptographic-keys.md#signing-algorithms) to use to derive this key pair. Valid values are `ed25519` and `secp256k1` (all lower case). The default is `secp256k1`. |
| `passphrase` | String | _(Optional)_ Generate a key pair and address from this seed value. This value can be formatted in [hexadecimal][], the XRP Ledger's [base58][] format, [RFC-1751][], or as an arbitrary string. Cannot be used with `seed` or `seed_hex`. |
| `seed` | String | _(Optional)_ Generate the key pair and address from this seed value in the XRP Ledger's [base58][]-encoded format. Cannot be used with `passphrase` or `seed_hex`. |
| `seed_hex` | String | _(Optional)_ Generate the key pair and address from this seed value in [hexadecimal][] format. Cannot be used with `passphrase` or `seed`. |
@@ -91,7 +91,7 @@ You must provide **at most one** of the following fields: `passphrase`, `seed`,
#### Specifying a Seed
For most cases, you should use a seed value generated from a strong source of randomness. Anyone who knows the seed value for an address has full power to [send transactions signed by that address](transactions.html#authorizing-transactions). Generally, running this command with no parameters is a good way to generate a random seed.
For most cases, you should use a seed value generated from a strong source of randomness. Anyone who knows the seed value for an address has full power to [send transactions signed by that address](../../../../concepts/transactions/index.md#authorizing-transactions). Generally, running this command with no parameters is a good way to generate a random seed.
Cases where you would specify a known seed include:
@@ -112,10 +112,9 @@ If you do specify a seed, you can specify it in any of the following formats:
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 2,
@@ -132,9 +131,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"result": {
@@ -149,9 +148,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -169,29 +168,30 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing various important information about the new (potential) account, including the following fields:
| `Field` | Type | Description |
|:------------------|:-------|:------------------------------------------------|
| `key_type` | String | Which [signing algorithm](cryptographic-keys.html#signing-algorithms) was used to derive this key pair. Valid values are `ed25519` and `secp256k1` (all lower case). |
| `master_seed` | String | The [master seed](cryptographic-keys.html#key-components), in the XRP Ledger's [base58][] encoded string format. Typically, you use the key in this format to sign transactions. |
| `key_type` | String | Which [signing algorithm](../../../../concepts/accounts/cryptographic-keys.md#signing-algorithms) was used to derive this key pair. Valid values are `ed25519` and `secp256k1` (all lower case). |
| `master_seed` | String | The [master seed](../../../../concepts/accounts/cryptographic-keys.md#key-components), in the XRP Ledger's [base58][] encoded string format. Typically, you use the key in this format to sign transactions. |
| `master_seed_hex` | String | The master seed, in hex format. |
| `master_key` | String | **DEPRECATED** The master seed, in [RFC-1751][] format. **Note:** The `rippled` implementation reverses the byte order of the key after decoding from RFC-1751 and before encoding to RFC-1751; if you read or write keys for use with the XRP Ledger using a different RFC-1751 implementation, you must do the same to be compatible with `rippled`'s RFC-1751 encoding. |
| `account_id` | String | The [Address][] of the account in the XRP Ledger's [base58][] format. This is not the public key, but a hash-of-a-hash of it. It also has a checksum so a typo almost certainly results in an invalid address rather than a valid, but different address. This is the primary identifier of an account in the XRP Ledger. You tell people this to get paid, and use it in transactions to indicate who you are and who you're paying, trusting, and so forth. [Multi-signing lists](multi-signing.html) also use these to identify other signers. |
| `account_id` | String | The [Address][] of the account in the XRP Ledger's [base58][] format. This is not the public key, but a hash-of-a-hash of it. It also has a checksum so a typo almost certainly results in an invalid address rather than a valid, but different address. This is the primary identifier of an account in the XRP Ledger. You tell people this to get paid, and use it in transactions to indicate who you are and who you're paying, trusting, and so forth. [Multi-signing lists](../../../../concepts/accounts/multi-signing.md) also use these to identify other signers. |
| `public_key` | String | The public key of the key pair, in the XRP Ledger's [base58][] encoded string format. Derived from the `master_seed`. |
| `public_key_hex` | String | This is the public key of the key pair, in hexadecimal. Derived from the `master_seed`. To validate the signature on a transaction, `rippled` needs this public key. That's why the format for a signed transaction includes the public key in the `SigningPubKey` field. |
| `warning` | String | (May be omitted) If the request specified a seed value, this field provides a warning that it may be insecure. [New in: rippled 0.32.0][] |
| `warning` | String | (May be omitted) If the request specified a seed value, this field provides a warning that it may be insecure. {% badge href="https://github.com/XRPLF/rippled/releases/tag/0.32.0" %}New in: rippled 0.32.0{% /badge %} |
You can also use this method to generate a key pair to use as a regular key pair for an account. You assign a regular key pair to an account to be able to sign most transactions with it, while keeping your master key pair offline whenever possible.
In addition to using it as a regular key pair, you can also use it as a member of a multi-signing list (SignerList).
For more information about master and regular key pairs, see [Cryptographic Keys](cryptographic-keys.html)
For more information about master and regular key pairs, see [Cryptographic Keys](../../../../concepts/accounts/cryptographic-keys.md)
For more information about multi-signing and signer lists, see [Multi-Signing](multi-signing.html).
For more information about multi-signing and signer lists, see [Multi-Signing](../../../../concepts/accounts/multi-signing.md).
### Possible Errors
@@ -200,7 +200,4 @@ For more information about multi-signing and signer lists, see [Multi-Signing](m
* `invalidParams` - One or more fields are specified incorrectly.
* `badSeed` - The request specified a disallowed seed value (in the `passphrase`, `seed`, or `seed_hex` fields), such as an empty string, or a string resembling a XRP Ledger address.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

29
content/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/can_delete.md
View File

@@ -8,18 +8,17 @@ labels:
# can_delete
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/CanDelete.cpp "Source")
The `can_delete` method informs the `rippled` server of the latest ledger version which may be deleted when using [online deletion with advisory deletion enabled](online-deletion.html#advisory-deletion). If advisory deletion is not enabled, this method does nothing.
The `can_delete` method informs the `rippled` server of the latest ledger version which may be deleted when using [online deletion with advisory deletion enabled](../../../../infrastructure/configuration/data-retention/online-deletion.md#advisory-deletion). If advisory deletion is not enabled, this method does nothing.
_The `can_delete` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users._
_The `can_delete` method is an [admin method](../index.md) that cannot be run by unprivileged users._
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 2,
@@ -27,9 +26,9 @@ An example of the request format:
"can_delete": 11320417
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "can_delete",
@@ -40,15 +39,16 @@ An example of the request format:
]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: can_delete [<ledger_index>|<ledger_hash>|now|always|never]
rippled can_delete 11320417
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request accepts the following parameter:
@@ -77,10 +77,7 @@ Use this command with no parameter to query the existing `can_delete` setting.
## See Also
- [Online Deletion](online-deletion.html)
- [Configure Advisory Deletion](configure-advisory-deletion.html)
- [Online Deletion](../../../../infrastructure/configuration/data-retention/online-deletion.md)
- [Configure Advisory Deletion](../../../../infrastructure/configuration/data-retention/configure-advisory-deletion.md)
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

46
content/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/crawl_shards.md
View File

@@ -8,18 +8,17 @@ labels:
# crawl_shards
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/CrawlShards.cpp "Source")
Requests information from peer servers about which [shards of historical ledger data](history-sharding.html) they have available. [New in: rippled 1.2.0][]
Requests information from peer servers about which [shards of historical ledger data](../../../../infrastructure/configuration/data-retention/history-sharding.md) they have available. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.2.0" %}New in: rippled 1.2.0{% /badge %}
_The `crawl_shards` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users._
_The `crawl_shards` method is an [admin method](../index.md) that cannot be run by unprivileged users._
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"command": "crawl_shards",
@@ -27,9 +26,9 @@ An example of the request format:
"limit": 0
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "crawl_shards",
@@ -41,8 +40,9 @@ An example of the request format:
]
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
**Note:** There is no command-line syntax for this method. Use the [json method][] to access this from the command line.
@@ -60,10 +60,9 @@ The request includes the following fields:
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"result": {
@@ -84,10 +83,9 @@ An example of a successful response:
"type": "response"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
200 OK
@@ -109,28 +107,28 @@ An example of a successful response:
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following fields:
| `Field` | Type | Description |
|:------------------|:-------|:------------------------------------------------|
| `complete_shards` | String | _(May be omitted)_ The range of [history shards](history-sharding.html) that are available on the local server. This may be an empty string, or a disjointed range. For example, `1-2,5,7-9` indicates that shards 1, 2, 5, 7, 8, and 9 are available. Omitted if this server does not have history sharding enabled. |
| `complete_shards` | String | _(May be omitted)_ The range of [history shards](../../../../infrastructure/configuration/data-retention/history-sharding.md) that are available on the local server. This may be an empty string, or a disjointed range. For example, `1-2,5,7-9` indicates that shards 1, 2, 5, 7, 8, and 9 are available. Omitted if this server does not have history sharding enabled. |
| `peers` | Array | _(May be omitted)_ List of **Peer Shard Objects** (see below) describing which history shards each peer has available. The response omits this field if no peers within the number of hops specified by `limit` have any shards. |
#### Peer Shard Objects
Each member of the `peers` array of the response is an object that describes one server in the peer-to-peer network. The list only includes peers that have at least one complete [history shard](history-sharding.html) available. Each object in the array has the following fields:
Each member of the `peers` array of the response is an object that describes one server in the peer-to-peer network. The list only includes peers that have at least one complete [history shard](../../../../infrastructure/configuration/data-retention/history-sharding.md) available. Each object in the array has the following fields:
| `Field` | Type | Description |
|:----------|:-------|:--------------------------------------------------------|
| `complete_shards` | String | The range of complete history shards this peer has available. This may be disjointed. For example, `1-2,5,7-9` indicates that shards 1, 2, 5, 7, 8, and 9 are available. |
| `incomplete_shards` | String | _(May be omitted)_ A comma-separated list of history shards this peer has partially downloaded, and percent completion for each. For example, `1:50,2:25` indicates that shard 1 is 50% downloaded and shard 2 is 25% downloaded. [New in: rippled 1.8.1][] |
| `public_key` | String | _(Omitted unless the request specified `"public_key": true`)_ The public key this peer uses for peer-to-peer communications, in the XRP Ledger's [base58 format](base58-encodings.html). |
| `incomplete_shards` | String | _(May be omitted)_ A comma-separated list of history shards this peer has partially downloaded, and percent completion for each. For example, `1:50,2:25` indicates that shard 1 is 50% downloaded and shard 2 is 25% downloaded. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.8.1" %}New in: rippled 1.8.1{% /badge %} |
| `public_key` | String | _(Omitted unless the request specified `"public_key": true`)_ The public key this peer uses for peer-to-peer communications, in the XRP Ledger's [base58 format](../../../protocol/data-types/base58-encodings.md). |
The `ip` field is no longer provided. [Removed in: rippled 1.8.1][]
The `ip` field is no longer provided. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.8.1" %}Removed in: rippled 1.8.1{% /badge %}
### Possible Errors
@@ -139,8 +137,4 @@ The `ip` field is no longer provided. [Removed in: rippled 1.8.1][]
- `invalidParams` - One or more required fields were omitted from the request, or a provided field was specified as the wrong data type.
- `reportingUnsupported` - ([Reporting Mode][] servers only) This method is not available in Reporting Mode.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

48
content/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/download_shard.md
View File

@@ -8,9 +8,9 @@ labels:
# download_shard
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/DownloadShard.cpp "Source")
Instructs the server to download a specific [shard of historical ledger data](history-sharding.html) from an external source. Your `rippled` server must be [configured to store history shards](configure-history-sharding.html). [Updated in: rippled 1.6.0][]
Instructs the server to download a specific [shard of historical ledger data](../../../../infrastructure/configuration/data-retention/history-sharding.md) from an external source. Your `rippled` server must be [configured to store history shards](../../../../infrastructure/configuration/data-retention/configure-history-sharding.md). {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.6.0" %}Updated in: rippled 1.6.0{% /badge %}
_The `download_shard` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users._
_The `download_shard` method is an [admin method](../index.md) that cannot be run by unprivileged users._
The external source must provide the shard as an [lz4-compressed](https://lz4.github.io/lz4/) [tar archive](https://en.wikipedia.org/wiki/Tar_(computing)) served via HTTPS. The archive must contain the shard directory and data files in NuDB format.
@@ -20,10 +20,9 @@ Downloading and importing shards using this method is usually faster than acquir
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"command": "download_shard",
@@ -34,9 +33,9 @@ An example of the request format:
]
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "download_shard",
@@ -51,15 +50,16 @@ An example of the request format:
]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
# Syntax: download_shard [[<index> <url>]]
rippled download_shard 1 https://example.com/1.tar.lz4 2 https://example.com/2.tar.lz4 5 https://example.com/5.tar.lz4
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes the following field:
@@ -68,23 +68,22 @@ The request includes the following field:
|:-----------|:--------|:------------------------------------------------------|
| `shards` | Array | List of Shard Descriptor objects (see below) describing shards to download and where to download them from. |
The `validate` field is deprecated and may be removed in a future version. (The server always checks the integrity of shards when it imports them.) [Updated in: rippled 1.6.0][]
The `validate` field is deprecated and may be removed in a future version. (The server always checks the integrity of shards when it imports them.) {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.6.0" %}Updated in: rippled 1.6.0{% /badge %}
Each **Shard Descriptor object** in the `shards` array has the following fields:
| `Field` | Type | Description |
|:--------|:-------|:----------------------------------------------------------|
| `index` | Number | The index of the shard to retrieve. In the production XRP Ledger, the oldest shard has index 1 and contains ledgers 32750-32768. The next shard has index 2 and contains ledgers 32769-49152, and so on. |
| `url` | String | The URL where this shard can be downloaded. The URL must start with `http://` or `https://` and must end with `.tar.lz4` (not case-sensitive). The web server providing this download must use a valid TLS certificate signed by a trusted Certificate Authority (CA). (`rippled` uses the operating system's CA store.) [Updated in: rippled 1.7.0][] |
| `url` | String | The URL where this shard can be downloaded. The URL must start with `http://` or `https://` and must end with `.tar.lz4` (not case-sensitive). The web server providing this download must use a valid TLS certificate signed by a trusted Certificate Authority (CA). (`rippled` uses the operating system's CA store.) {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.7.0" %}Updated in: rippled 1.7.0{% /badge %} |
### Response Format
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"result": {
@@ -94,10 +93,9 @@ An example of a successful response:
"type": "response"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
200 OK
@@ -108,9 +106,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -122,8 +120,9 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following fields:
@@ -141,9 +140,4 @@ The response follows the [standard format][], with a successful result containin
- `invalidParams` - One or more required fields were omitted from the request, or a provided field was specified as the wrong data type.
- `reportingUnsupported` - ([Reporting Mode][] servers only) This method is not available in Reporting Mode.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

8
content/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/index.md
View File

@@ -1,8 +1,12 @@
---
html: logging-and-data-management-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
metadata:
indexPage: true
---
# Logging and Data Management Methods
Use these methods to manage log levels and other data, such as ledgers.
Use these methods to manage log levels and other data, such as ledgers.
{% child-pages /%}

23
content/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/ledger_cleaner.md
View File

@@ -10,15 +10,14 @@ labels:
The `ledger_cleaner` command controls the [Ledger Cleaner](https://github.com/XRPLF/rippled/blob/f313caaa73b0ac89e793195dcc2a5001786f916f/src/ripple/app/ledger/README.md#the-ledger-cleaner), an asynchronous maintenance process that can find and repair corruption in `rippled`'s database of ledgers.
_The `ledger_cleaner` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users._
_The `ledger_cleaner` method is an [admin method](../index.md) that cannot be run by unprivileged users._
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"command": "ledger_cleaner",
@@ -27,8 +26,9 @@ An example of the request format:
"stop": false
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes the following parameters:
@@ -46,10 +46,9 @@ The request includes the following parameters:
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*JSON-RPC*
{% tabs %}
{% tab label="JSON-RPC" %}
```json
200 OK
@@ -61,8 +60,9 @@ An example of a successful response:
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following fields:
@@ -75,7 +75,4 @@ The response follows the [standard format][], with a successful result containin
* Any of the [universal error types][].
* `internal` if one the parameters is specified incorrectly. (This is a bug; the intended error code is `invalidParams`.)
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

39
content/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/ledger_request.md
View File

@@ -10,15 +10,14 @@ labels:
The `ledger_request` command tells server to fetch a specific ledger version from its connected peers. This only works if one of the server's immediately-connected peers has that ledger. You may need to run the command several times to completely fetch a ledger.
*The `ledger_request` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users!*
*The `ledger_request` method is an [admin method](../index.md) that cannot be run by unprivileged users!*
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 102,
@@ -26,14 +25,15 @@ An example of the request format:
"ledger_index": 13800000
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```
rippled ledger_request 13800000
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes the following parameters:
@@ -52,10 +52,9 @@ The response follows the [standard format][]. However, the request returns a fai
A failure response indicates the status of fetching the ledger. A successful response contains the information for the ledger in a similar format to the [ledger method][].
<!-- MULTICODE_BLOCK_START -->
*Commandline (failure)*
{% tabs %}
{% tab label="Commandline (failure)" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -79,9 +78,9 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
*Commandline (in-progress)*
{% tab label="Commandline (in-progress)" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -126,9 +125,9 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
*Commandline (success)*
{% tab label="Commandline (success)" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -157,14 +156,15 @@ Connecting to 127.0.0.1:5005
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The three possible response formats are as follows:
1. When returning a `lgrNotFound` error, the response has a field, `acquiring` with a [Ledger Request Object](#ledger-request-object) indicating the progress of fetching the ledger from the peer-to-peer network.
2. When the response shows the server is currently fetching the ledger, the body of the result is a [Ledger Request Object](#ledger-request-object) indicating the progress of fetching the ledger from the peer-to-peer network.
3. When the ledger is fully available, the response is a representation of the [ledger header](ledger-header.html).
3. When the ledger is fully available, the response is a representation of the [ledger header](../../../protocol/ledger-data/ledger-header.md).
### Ledger Request Object
@@ -185,10 +185,7 @@ When the server is in the progress of fetching a ledger, but has not yet finishe
- Any of the [universal error types][].
- `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. This error can also occur if you specify a ledger index equal or higher than the current in-progress ledger.
- `lgrNotFound` - If the ledger is not yet available. This indicates that the server has started fetching the ledger, although it may fail if none of its connected peers have the requested ledger. (Previously, this error used the code `ledgerNotFound` instead.) [Updated in: rippled 0.30.1][]
- `lgrNotFound` - If the ledger is not yet available. This indicates that the server has started fetching the ledger, although it may fail if none of its connected peers have the requested ledger. (Previously, this error used the code `ledgerNotFound` instead.) {% badge href="https://github.com/XRPLF/rippled/releases/tag/0.30.1" %}Updated in: rippled 0.30.1{% /badge %}
- `reportingUnsupported` - ([Reporting Mode][] servers only) This method is not available in Reporting Mode.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

31
content/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/log_level.md
View File

@@ -10,15 +10,14 @@ labels:
The `log_level` command changes the `rippled` server's logging verbosity, or returns the current logging level for each category (called a _partition_) of log messages.
_The `log_level` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users._
_The `log_level` method is an [admin method](../index.md) that cannot be run by unprivileged users._
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": "ll1",
@@ -27,15 +26,16 @@ An example of the request format:
"partition": "PathRequest"
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: log_level [[partition] severity]
rippled log_level PathRequest debug
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes the following parameters:
@@ -48,10 +48,9 @@ The request includes the following parameters:
Examples of successful responses:
<!-- MULTICODE_BLOCK_START -->
*Commandline (set log level)*
{% tabs %}
{% tab label="Commandline (set log level)" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -62,9 +61,9 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
*Commandline (check log levels)*
{% tab label="Commandline (check log levels)" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -127,8 +126,9 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][]. The response format depends on whether the request specified a `severity`. If it did, the log level is changed and a successful result contains no additional fields.
@@ -143,7 +143,4 @@ Otherwise, the response contains the following field:
* Any of the [universal error types][].
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

33
content/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/logrotate.md
View File

@@ -34,34 +34,34 @@ The following script is a sample that can be created as `/etc/logrotate.d/ripple
You can configure parameters such as `minsize` and `rotate` depending on the amount of logs you keep. Use the `log_level` setting in your `rippled.cfg` file to configure how verbose your server's logs are. This sample script is based on standard `log_level` and stores approximately 2 weeks worth of logs in a compressed format.
The official packages [for CentOS/Red Hat](install-rippled-on-centos-rhel-with-yum.html) and [Ubuntu or Debian](install-rippled-on-ubuntu.html) provide the script `/etc/logrotate.d/rippled` by default. You can make modifications to this as required. Your modifications will not be overwritten on package upgrades. <!-- STYLE_OVERRIDE: will -->
The official packages [for CentOS/Red Hat](../../../../infrastructure/installation/install-rippled-on-centos-rhel-with-yum.md) and [Ubuntu or Debian](../../../../infrastructure/installation/install-rippled-on-ubuntu.md) provide the script `/etc/logrotate.d/rippled` by default. You can make modifications to this as required. Your modifications will not be overwritten on package upgrades. <!-- STYLE_OVERRIDE: will -->
**Note:** You should have only one system log rotation script per application. Please ensure that you do not have any other log rotation that handles the same directory.
_The `logrotate` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users._
_The `logrotate` method is an [admin method](../index.md) that cannot be run by unprivileged users._
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": "lr1",
"command": "logrotate"
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: logrotate
rippled logrotate
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes no parameters.
@@ -69,10 +69,9 @@ The request includes no parameters.
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*JSON-RPC*
{% tabs %}
{% tab label="JSON-RPC" %}
```json
200 OK
@@ -84,9 +83,9 @@ An example of a successful response:
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -99,8 +98,9 @@ Connecting to 127.0.0.1:5005
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following fields:
@@ -112,7 +112,4 @@ The response follows the [standard format][], with a successful result containin
* Any of the [universal error types][].
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

51
content/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/node_to_shard.md
View File

@@ -8,45 +8,45 @@ labels:
# node_to_shard
[[Source]](https://github.com/XRPLF/rippled/blob/develop/src/ripple/rpc/handlers/NodeToShard.cpp "Source")
The `{{currentpage.name}}` method manages copying data from the ledger store to the [shard store](history-sharding.html). It can start, stop, or check the status of copying the data.
The {% code-page-name /%} method manages copying data from the ledger store to the [shard store](../../../../infrastructure/configuration/data-retention/history-sharding.md). It can start, stop, or check the status of copying the data.
_The `{{currentpage.name}}` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users._
_The {% code-page-name /%} method is an [admin method](../index.md) that cannot be run by unprivileged users._
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"command": "{{currentpage.name}}",
"command": "{% $frontmatter.seo.title %}",
"action": "start"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "{{currentpage.name}}",
"method": "{% $frontmatter.seo.title %}",
"params": [{
"action": "start"
}]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: {{currentpage.name}} start|stop|status
rippled {{currentpage.name}} start
#Syntax: {% $frontmatter.seo.title %} start|stop|status
rippled {% $frontmatter.seo.title %} start
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes the following parameters:
@@ -59,10 +59,9 @@ The request includes the following parameters:
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"result": {
@@ -72,9 +71,9 @@ An example of a successful response:
"type": "response"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"result" : {
@@ -84,9 +83,9 @@ An example of a successful response:
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -99,8 +98,9 @@ Connecting to 127.0.0.1:5005
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following fields:
@@ -113,10 +113,7 @@ The response follows the [standard format][], with a successful result containin
- Any of the [universal error types][].
- `internal` - If you attempt an invalid operation like checking the status of a copy when one isn't running.
- `notEnabled` - If the server is not configured to store [history shards](history-sharding.html).
- `notEnabled` - If the server is not configured to store [history shards](../../../../infrastructure/configuration/data-retention/history-sharding.md).
- `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

38
content/references/http-websocket-apis/admin-api-methods/peer-management-methods/connect.md
View File

@@ -10,15 +10,14 @@ labels:
The `connect` command forces the `rippled` server to connect to a specific peer `rippled` server.
*The `connect` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users!*
*The `connect` method is an [admin method](../index.md) that cannot be run by unprivileged users!*
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"command": "connect",
@@ -26,9 +25,9 @@ An example of the request format:
"port": 51235
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "connect",
@@ -40,32 +39,31 @@ An example of the request format:
]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: connect ip [port]
rippled connect 192.170.145.88 51235
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes the following parameters:
| `Field` | Type | Description |
|:--------|:-------|:----------------------------------------------------------|
| `ip` | String | IP address of the server to connect to |
| `port` | Number | _(Optional)_ Port number to use when connecting. The default is **2459**. [Updated in: rippled 1.6.0][] |
| `port` | Number | _(Optional)_ Port number to use when connecting. The default is **2459**. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.6.0" %}Updated in: rippled 1.6.0{% /badge %} |
### Response Format
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*JSON-RPC*
{% tabs %}
{% tab label="JSON-RPC" %}
```json
{
"result" : {
@@ -74,9 +72,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -88,8 +86,9 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following fields:
@@ -104,7 +103,4 @@ The response follows the [standard format][], with a successful result containin
- Cannot connect in stand-alone mode - Network-related commands are disabled in stand-alone mode.
- `reportingUnsupported` - ([Reporting Mode][] servers only) This method is not available in Reporting Mode.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

8
content/references/http-websocket-apis/admin-api-methods/peer-management-methods/index.md
View File

@@ -1,8 +1,12 @@
---
html: peer-management-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
metadata:
indexPage: true
---
# Peer Management Methods
Use these methods to manage your server's peer-to-peer connections.
Use these methods to manage your server's peer-to-peer connections.
{% child-pages /%}

53
content/references/http-websocket-apis/admin-api-methods/peer-management-methods/peer_reservations_add.md
View File

@@ -8,48 +8,48 @@ labels:
# peer_reservations_add
[[Source]](https://github.com/XRPLF/rippled/blob/4a1148eb2849513dd1e7ae080288fd47ab57a376/src/ripple/rpc/handlers/Reservations.cpp#L36 "Source")
The `{{currentpage.name}}` method adds or updates a reserved slot for a specific peer server in the XRP Ledger [peer-to-peer network](peer-protocol.html). [New in: rippled 1.4.0][]
The {% code-page-name /%} method adds or updates a reserved slot for a specific peer server in the XRP Ledger [peer-to-peer network](../../../../concepts/networks-and-servers/peer-protocol.md). {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.4.0" %}New in: rippled 1.4.0{% /badge %}
_The `{{currentpage.name}}` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users._
_The {% code-page-name /%} method is an [admin method](../index.md) that cannot be run by unprivileged users._
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": "peer_reservations_add_example_1",
"command": "{{currentpage.name}}",
"command": "{% $frontmatter.seo.title %}",
"public_key": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99",
"description": "Ripple s1 server 'WOOL'"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "{{currentpage.name}}",
"method": "{% $frontmatter.seo.title %}",
"params": [{
"public_key": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99",
"description": "Ripple s1 server 'WOOL'"
}]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: {{currentpage.name}} <public_key> [<description>]
rippled {{currentpage.name}} n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99 "Ripple s1 server 'WOOL'"
#Syntax: {% $frontmatter.seo.title %} <public_key> [<description>]
rippled {% $frontmatter.seo.title %} n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99 "Ripple s1 server 'WOOL'"
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes the following parameters:
@@ -64,10 +64,9 @@ The request includes the following parameters:
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": "peer_reservations_add_example_1",
@@ -81,9 +80,9 @@ An example of a successful response:
"type": "response"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"result": {
@@ -95,9 +94,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -112,8 +111,9 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following fields:
@@ -127,8 +127,8 @@ If there was not a previous entry for the same [node public key][], the `result`
If the `previous` field is provided, it shows the previous status of this peer reservation, with the following fields:
{% include '_snippets/peer_reservation_object.md' %}
<!--_ -->
{% partial file="/_snippets/peer_reservation_object.md" /%}
### Possible Errors
@@ -138,7 +138,4 @@ If the `previous` field is provided, it shows the previous status of this peer r
- `publicMalformed` - The `public_key` field of the request is not valid. It must be a valid node public key in [base58][] format.
- `reportingUnsupported` - ([Reporting Mode][] servers only) This method is not available in Reporting Mode.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

53
content/references/http-websocket-apis/admin-api-methods/peer-management-methods/peer_reservations_del.md
View File

@@ -8,9 +8,9 @@ labels:
# peer_reservations_del
[[Source]](https://github.com/XRPLF/rippled/blob/4a1148eb2849513dd1e7ae080288fd47ab57a376/src/ripple/rpc/handlers/Reservations.cpp#L89 "Source")
The `{{currentpage.name}}` method removes a specific [peer reservation][], if one exists. [New in: rippled 1.4.0][]
The {% code-page-name /%} method removes a specific [peer reservation][], if one exists. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.4.0" %}New in: rippled 1.4.0{% /badge %}
_The `{{currentpage.name}}` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users._
_The {% code-page-name /%} method is an [admin method](../index.md) that cannot be run by unprivileged users._
**Note:** Removing a peer reservation does not automatically disconnect the corresponding peer, if that peer is connected.
@@ -18,37 +18,37 @@ _The `{{currentpage.name}}` method is an [admin method](admin-api-methods.html)
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": "peer_reservations_del_example_1",
"command": "{{currentpage.name}}",
"command": "{% $frontmatter.seo.title %}",
"public_key": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "{{currentpage.name}}",
"method": "{% $frontmatter.seo.title %}",
"params": [{
"public_key": "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99"
}]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: {{currentpage.name}} <public_key>
rippled {{currentpage.name}} n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99
#Syntax: {% $frontmatter.seo.title %} <public_key>
rippled {% $frontmatter.seo.title %} n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes the following parameter:
@@ -61,10 +61,9 @@ The request includes the following parameter:
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": "peer_reservations_del_example_1",
@@ -78,9 +77,9 @@ An example of a successful response:
"type": "response"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"result" : {
@@ -92,9 +91,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -109,8 +108,9 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following fields:
@@ -124,8 +124,8 @@ The response follows the [standard format][], with a successful result containin
If the `previous` field is provided, it shows the previous status of this peer reservation, with the following fields:
{% include '_snippets/peer_reservation_object.md' %}
<!--_ -->
{% partial file="/_snippets/peer_reservation_object.md" /%}
### Possible Errors
@@ -134,7 +134,4 @@ If the `previous` field is provided, it shows the previous status of this peer r
- `publicMalformed` - The `public_key` field of the request is not valid. It must be a valid node public key in [base58][] format.
- `reportingUnsupported` - ([Reporting Mode][] servers only) This method is not available in Reporting Mode.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

53
content/references/http-websocket-apis/admin-api-methods/peer-management-methods/peer_reservations_list.md
View File

@@ -8,42 +8,42 @@ labels:
# peer_reservations_list
[[Source]](https://github.com/XRPLF/rippled/blob/4a1148eb2849513dd1e7ae080288fd47ab57a376/src/ripple/rpc/handlers/Reservations.cpp#L116 "Source")
The `{{currentpage.name}}` method lists [peer reservations][]. [New in: rippled 1.4.0][]
The {% code-page-name /%} method lists [peer reservations][]. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.4.0" %}New in: rippled 1.4.0{% /badge %}
_The `{{currentpage.name}}` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users._
_The {% code-page-name /%} method is an [admin method](../index.md) that cannot be run by unprivileged users._
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": "peer_reservations_list_example_1",
"command": "{{currentpage.name}}"
"command": "{% $frontmatter.seo.title %}"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "{{currentpage.name}}"
"method": "{% $frontmatter.seo.title %}"
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: {{currentpage.name}}
rippled {{currentpage.name}}
#Syntax: {% $frontmatter.seo.title %}
rippled {% $frontmatter.seo.title %}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
This request does not take any parameters.
@@ -52,10 +52,9 @@ This request does not take any parameters.
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": "peer_reservations_list_example_1",
@@ -74,9 +73,9 @@ An example of a successful response:
"type": "response"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"result" : {
@@ -93,9 +92,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
2019-Dec-27 21:56:07.253260422 HTTPClient:NFO Connecting to 127.0.0.1:5005
@@ -115,8 +114,9 @@ Loading: "/etc/rippled.cfg"
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following fields:
@@ -128,15 +128,12 @@ The response follows the [standard format][], with a successful result containin
Each member of the `reservations` array is a JSON object describing one [peer reservation][]. This object has the following fields:
{% include '_snippets/peer_reservation_object.md' %}
<!--_ -->
{% partial file="/_snippets/peer_reservation_object.md" /%}
### Possible Errors
- Any of the [universal error types][].
- `reportingUnsupported` - ([Reporting Mode][] servers only) This method is not available in Reporting Mode.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

47
content/references/http-websocket-apis/admin-api-methods/peer-management-methods/peers.md
View File

@@ -8,31 +8,31 @@ labels:
# peers
[[Source]](https://github.com/XRPLF/rippled/blob/52f298f150fc1530d201d3140c80d3eaf781cb5f/src/ripple/rpc/handlers/Peers.cpp "Source")
The `peers` command returns a list of all other `rippled` servers currently connected to this one over the [Peer Protocol](peer-protocol.html), including information on their connection and sync status.
The `peers` command returns a list of all other `rippled` servers currently connected to this one over the [Peer Protocol](../../../../concepts/networks-and-servers/peer-protocol.md), including information on their connection and sync status.
*The `peers` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users!*
*The `peers` method is an [admin method](../index.md) that cannot be run by unprivileged users!*
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 2,
"command": "peers"
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```
rippled peers
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes no additional parameters.
@@ -40,10 +40,9 @@ The request includes no additional parameters.
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": "peers_example",
@@ -178,9 +177,9 @@ An example of a successful response:
"type": "response"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"result" : {
@@ -270,9 +269,9 @@ An example of a successful response:
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -364,14 +363,15 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing a JSON object with the following fields:
| `Field` | Type | Description |
|:----------|:-------|:--------------------------------------------------------|
| `cluster` | Object | Summary of other `rippled` servers in the same cluster, if [configured as a cluster](clustering.html). [New in: rippled 0.30.1][] |
| `cluster` | Object | Summary of other `rippled` servers in the same cluster, if [configured as a cluster](../../../../concepts/networks-and-servers/clustering.md). {% badge href="https://github.com/XRPLF/rippled/releases/tag/0.30.1" %}New in: rippled 0.30.1{% /badge %} |
| `peers` | Array | Array of peer objects. |
Each field of the `cluster` object is the public key of that `rippled` server's identifying key pair. (This is the same value that that server returns as `pubkey_node` in the [server_info method][].) The contents of that field are an object with the following fields:
@@ -379,7 +379,7 @@ Each field of the `cluster` object is the public key of that `rippled` server's
| `Field` | Type | Description |
|:--------|:-------|:----------------------------------------------------------|
| `tag` | String | The display name for this cluster member as defined in the config file. |
| `fee` | Number | _(May be omitted)_ The load multiplier this cluster member is applying to the [transaction cost](transaction-cost.html) |
| `fee` | Number | _(May be omitted)_ The load multiplier this cluster member is applying to the [transaction cost](../../../../concepts/transactions/transaction-cost.md) |
| `age` | Number | The number of seconds since the last cluster report from this cluster member. |
Each member of the `peers` array is a peer object with the following fields:
@@ -395,11 +395,11 @@ Each member of the `peers` array is a peer object with the following fields:
| `ledger` | String | The identifying [hash][Hash] of the peer's most recently closed ledger |
| `load` | Number | A measure of the amount of load the peer server is putting on the local server. Larger numbers indicate more load. (The units by which load is measured are not formally defined.) |
| `protocol` | String | _(May be omitted)_ The protocol version that the peer is using, if not the same as the local server. |
| `metrics` | Object | Details on the amount of data sent to and received from this peer. See the description of the `metrics` object below for details. [New in: rippled 1.4.0][] |
| `metrics` | Object | Details on the amount of data sent to and received from this peer. See the description of the `metrics` object below for details. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.4.0" %}New in: rippled 1.4.0{% /badge %} |
| `public_key` | String | _(May be omitted)_ A public key that can be used to verify the integrity of the peer's messages. This is not the same key that is used for validations, but it follows the same format. |
| `sanity` | String | _(May be omitted)_ Whether this peer is following the same rules and ledger history as the current server. A value of `insane` probably indicates that the peer is part of a [parallel network](parallel-networks.html). The value `unknown` indicates that the current server is unsure whether the peer is compatible. <!-- STYLE_OVERRIDE: insane --> |
| `sanity` | String | _(May be omitted)_ Whether this peer is following the same rules and ledger history as the current server. A value of `insane` probably indicates that the peer is part of a [parallel network](../../../../concepts/networks-and-servers/parallel-networks.md). The value `unknown` indicates that the current server is unsure whether the peer is compatible. <!-- STYLE_OVERRIDE: insane --> |
| `status` | String | _(May be omitted)_ The most recent status message from the peer. Could be `connecting`, `connected`, `monitoring`, `validating`, or `shutting`. |
| `uptime` | Number | The number of seconds that your `rippled` server has been continuously connected to this peer. [New in: rippled 0.30.1][] |
| `uptime` | Number | The number of seconds that your `rippled` server has been continuously connected to this peer. {% badge href="https://github.com/XRPLF/rippled/releases/tag/0.30.1" %}New in: rippled 0.30.1{% /badge %} |
| `version` | string | _(May be omitted)_ The `rippled` version number of the peer server |
The `metrics` object contains the following fields:
@@ -418,7 +418,4 @@ The `metrics` object contains the following fields:
- Any of the [universal error types][].
- `reportingUnsupported` - ([Reporting Mode][] servers only) This method is not available in Reporting Mode.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

8
content/references/http-websocket-apis/admin-api-methods/server-control-methods/index.md
View File

@@ -1,8 +1,12 @@
---
html: server-control-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
metadata:
indexPage: true
---
# Server Control Methods
Use these methods to manage the rippled server.
Use these methods to manage the rippled server.
{% child-pages /%}

19
content/references/http-websocket-apis/admin-api-methods/server-control-methods/ledger_accept.md
View File

@@ -10,31 +10,31 @@ labels:
The `ledger_accept` method forces the server to close the current-working ledger and move to the next ledger number. This method is intended for testing purposes only, and is only available when the `rippled` server is running stand-alone mode.
*The `ledger_accept` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users!*
*The `ledger_accept` method is an [admin method](../index.md) that cannot be run by unprivileged users!*
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": "Accept my ledger!",
"command": "ledger_accept"
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: ledger_accept
rippled ledger_accept
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request accepts no parameters.
@@ -65,7 +65,4 @@ The response follows the [standard format][], with a successful result containin
* Any of the [universal error types][].
* `notStandAlone` - If the `rippled` server is not currently running in stand-alone mode.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

35
content/references/http-websocket-apis/admin-api-methods/server-control-methods/stop.md
View File

@@ -10,24 +10,23 @@ labels:
Gracefully shuts down the server.
*The `stop` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users!*
*The `stop` method is an [admin method](../index.md) that cannot be run by unprivileged users!*
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 0,
"command": "stop"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "stop",
@@ -36,15 +35,16 @@ An example of the request format:
]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: stop
rippled stop
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes no parameters.
@@ -52,10 +52,9 @@ The request includes no parameters.
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*JSON-RPC*
{% tabs %}
{% tab label="JSON-RPC" %}
```json
{
"result" : {
@@ -64,9 +63,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -78,8 +77,9 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following fields:
@@ -91,7 +91,4 @@ The response follows the [standard format][], with a successful result containin
* Any of the [universal error types][].
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

33
content/references/http-websocket-apis/admin-api-methods/server-control-methods/validation_seed.md
View File

@@ -10,17 +10,16 @@ labels:
[[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. [Disabled since: rippled 0.29.1](https://github.com/XRPLF/rippled/releases/tag/0.29.1-rc1 "BADGE_RED")
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](admin-api-methods.html) that cannot be run by unprivileged users!*
*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:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": "set_seed_1",
@@ -28,15 +27,16 @@ An example of the request format:
"secret": "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE"
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: validation_seed [secret]
rippled validation_seed 'BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE'
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes the following parameters:
@@ -48,10 +48,9 @@ The request includes the following parameters:
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*JSON-RPC*
{% tabs %}
{% tab label="JSON-RPC" %}
```json
200 OK
@@ -64,9 +63,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -80,8 +79,9 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following fields:
@@ -96,7 +96,4 @@ The response follows the [standard format][], with a successful result containin
* 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.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

8
content/references/http-websocket-apis/admin-api-methods/signing-methods/index.md
View File

@@ -1,8 +1,12 @@
---
html: signing-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
metadata:
indexPage: true
---
# Signing Methods
Use these methods to work with transactions.
Use these methods to work with transactions.
{% child-pages /%}

64
content/references/http-websocket-apis/admin-api-methods/signing-methods/sign.md
View File

@@ -8,20 +8,19 @@ labels:
# sign
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/SignHandler.cpp "Source")
The `sign` method takes a [transaction in JSON format](transaction-formats.html) and a [seed value](cryptographic-keys.html), and returns a signed binary representation of the transaction. To contribute one signature to a [multi-signed transaction](multi-signing.html), use the [sign_for method][] instead.
The `sign` method takes a [transaction in JSON format](../../../protocol/transactions/index.md) and a [seed value](../../../../concepts/accounts/cryptographic-keys.md), and returns a signed binary representation of the transaction. To contribute one signature to a [multi-signed transaction](../../../../concepts/accounts/multi-signing.md), use the [sign_for method][] instead.
{% include '_snippets/public-signing-note.md' %}
<!--_ -->
{% partial file="/_snippets/public-signing-note.md" /%}
**Caution:** Unless you run the `rippled` server yourself, you should do local signing using a [client library](client-libraries.html) instead of using this command. For more information, see [Set Up Secure Signing](secure-signing.html).
**Caution:** Unless you run the `rippled` server yourself, you should do local signing using a [client library](../../../client-libraries.md) instead of using this command. For more information, see [Set Up Secure Signing](../../../../concepts/transactions/secure-signing.md).
## Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 2,
@@ -41,9 +40,9 @@ An example of the request format:
"fee_mult_max": 1000
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "sign",
@@ -66,17 +65,18 @@ An example of the request format:
]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: sign secret tx_json [offline]
rippled sign s████████████████████████████ '{"TransactionType": "Payment", "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", "Amount": { "currency": "USD", "value": "1", "issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn" }, "Sequence": 360, "Fee": "10000"}' offline
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
To sign a transaction, you must provide a secret key that can [authorize the transaction](transactions.html#authorizing-transactions). Typically you provide a seed value that the server derives the secret key from. You can do this in a few ways:
To sign a transaction, you must provide a secret key that can [authorize the transaction](../../../../concepts/transactions/index.md#authorizing-transactions). Typically you provide a seed value that the server derives the secret key from. You can do this in a few ways:
* Provide the seed in the `secret` field and omit the `key_type` field. This value can be formatted as an XRP Ledger [base58][] seed, RFC-1751, hexadecimal, or as a string passphrase. (secp256k1 keys only)
* Provide a `key_type` value and exactly one of `seed`, `seed_hex`, or `passphrase`. Omit the `secret` field. (Not supported by the commandline syntax.)
@@ -85,25 +85,25 @@ The request includes the following parameters:
| `Field` | Type | Description |
|:---------------|:--------|:--------------------------------------------------|
| `tx_json` | Object | [Transaction definition](transaction-formats.html) in JSON format |
| `tx_json` | Object | [Transaction definition](../../../protocol/transactions/index.md) in JSON format |
| `secret` | String | _(Optional)_ The secret seed of the account supplying the transaction, used to sign it. Do not send your secret to untrusted servers or through unsecured network connections. Cannot be used with `key_type`, `seed`, `seed_hex`, or `passphrase`. |
| `seed` | String | _(Optional)_ The secret seed of the account supplying the transaction, used to sign it. Must be in the XRP Ledger's [base58][] format. If provided, you must also specify the `key_type`. Cannot be used with `secret`, `seed_hex`, or `passphrase`. |
| `seed_hex` | String | _(Optional)_ The secret seed of the account supplying the transaction, used to sign it. Must be in hexadecimal format. If provided, you must also specify the `key_type`. Cannot be used with `secret`, `seed`, or `passphrase`. |
| `passphrase` | String | _(Optional)_ The secret seed of the account supplying the transaction, used to sign it, as a string passphrase. If provided, you must also specify the `key_type`. Cannot be used with `secret`, `seed`, or `seed_hex`. |
| `key_type` | String | _(Optional)_ The [signing algorithm](cryptographic-keys.html#signing-algorithms) of the cryptographic key pair provided. Valid types are `secp256k1` or `ed25519`. Defaults to `secp256k1`. Cannot be used with `secret`. |
| `key_type` | String | _(Optional)_ The [signing algorithm](../../../../concepts/accounts/cryptographic-keys.md#signing-algorithms) of the cryptographic key pair provided. Valid types are `secp256k1` or `ed25519`. Defaults to `secp256k1`. Cannot be used with `secret`. |
| `offline` | Boolean | _(Optional)_ If `true`, when constructing the transaction, do not try to [automatically fill](#auto-fillable-fields) any transaction details. The default is `false`. |
| `build_path` | Boolean | _(Optional)_ If this field is provided, the server [auto-fills](transaction-common-fields.html#auto-fillable-fields) the `Paths` field of a [Payment transaction][] before signing. You must omit this field if the transaction is a [direct XRP payment](direct-xrp-payments.html) or if it is not a Payment-type transaction. **Caution:** The server looks for the presence or absence of this field, not its value. This behavior may change. ([Issue #3272](https://github.com/XRPLF/rippled/issues/3272)) |
| `fee_mult_max` | Integer | _(Optional)_ Signing fails with the error `rpcHIGH_FEE` if the [auto-filled `Fee` value](transaction-common-fields.html#auto-fillable-fields) would be greater than the [reference transaction cost](transaction-cost.html#special-transaction-costs) × `fee_mult_max` ÷ `fee_div_max`. This field has no effect if you explicitly specify the `Fee` field of the transaction. The default is `10`. |
| `fee_div_max` | Integer | _(Optional)_ Signing fails with the error `rpcHIGH_FEE` if the [auto-filled `Fee` value](transaction-common-fields.html#auto-fillable-fields) would be greater than the [reference transaction cost](transaction-cost.html#special-transaction-costs) × `fee_mult_max` ÷ `fee_div_max`. This field has no effect if you explicitly specify the `Fee` field of the transaction. The default is `1`. [New in: rippled 0.30.1][] |
| `build_path` | Boolean | _(Optional)_ If this field is provided, the server [auto-fills](../../../protocol/transactions/common-fields.md#auto-fillable-fields) the `Paths` field of a [Payment transaction][] before signing. You must omit this field if the transaction is a [direct XRP payment](../../../../concepts/payment-types/direct-xrp-payments.md) or if it is not a Payment-type transaction. **Caution:** The server looks for the presence or absence of this field, not its value. This behavior may change. ([Issue #3272](https://github.com/XRPLF/rippled/issues/3272)) |
| `fee_mult_max` | Integer | _(Optional)_ Signing fails with the error `rpcHIGH_FEE` if the [auto-filled `Fee` value](../../../protocol/transactions/common-fields.md#auto-fillable-fields) would be greater than the [reference transaction cost](../../../../concepts/transactions/transaction-cost.md#special-transaction-costs) × `fee_mult_max` ÷ `fee_div_max`. This field has no effect if you explicitly specify the `Fee` field of the transaction. The default is `10`. |
| `fee_div_max` | Integer | _(Optional)_ Signing fails with the error `rpcHIGH_FEE` if the [auto-filled `Fee` value](../../../protocol/transactions/common-fields.md#auto-fillable-fields) would be greater than the [reference transaction cost](../../../../concepts/transactions/transaction-cost.md#special-transaction-costs) × `fee_mult_max` ÷ `fee_div_max`. This field has no effect if you explicitly specify the `Fee` field of the transaction. The default is `1`. {% badge href="https://github.com/XRPLF/rippled/releases/tag/0.30.1" %}New in: rippled 0.30.1{% /badge %} |
### Auto-Fillable Fields
The server automatically tries to fill in certain fields in `tx_json` (the [Transaction object](transaction-formats.html)) automatically if you omit them. The server provides the following fields before signing, unless the request specified `offline` as `true`:
The server automatically tries to fill in certain fields in `tx_json` (the [Transaction object](../../../protocol/transactions/index.md)) automatically if you omit them. The server provides the following fields before signing, unless the request specified `offline` as `true`:
* `Sequence` - The server automatically uses the next Sequence number from the sender's account information.
* **Caution:** The next sequence number for the account is not incremented until this transaction is applied. If you sign multiple transactions without submitting and waiting for the response to each one, you must manually provide the correct sequence numbers for each transaction after the first.
* `Fee` - If you omit the `Fee` parameter, the server tries to fill in an appropriate transaction cost automatically. On the production XRP Ledger, this fails with `rpcHIGH_FEE` unless you provide an appropriate `fee_mult_max` value.
* The `fee_mult_max` and `fee_div_max` parameters limit how high the automatically-provided transaction cost can be, in terms of the load-scaling multiplier that gets applied to the [reference transaction cost](transaction-cost.html#reference-transaction-cost). The default settings return an error if the automatically-provided value would use greater than a 10× multiplier. However, the production XRP Ledger [typically has a 1000× load multiplier](transaction-cost.html#current-transaction-cost).
* The `fee_mult_max` and `fee_div_max` parameters limit how high the automatically-provided transaction cost can be, in terms of the load-scaling multiplier that gets applied to the [reference transaction cost](../../../../concepts/transactions/transaction-cost.md#reference-transaction-cost). The default settings return an error if the automatically-provided value would use greater than a 10× multiplier. However, the production XRP Ledger [typically has a 1000× load multiplier](../../../../concepts/transactions/transaction-cost.md#current-transaction-cost).
* The commandline syntax does not support `fee_mult_max` and `fee_div_max`. For the production XRP Ledger, you must provide a `Fee` value.
* **Caution:** A malicious server can specify an excessively high transaction cost, ignoring the values of `fee_mult_max` and `fee_div_max`.
* `Paths` - For Payment-type transactions (excluding XRP-to-XRP transfers), the Paths field can be automatically filled, as if you used the [ripple_path_find method][]. Only filled if `build_path` is provided.
@@ -112,10 +112,9 @@ The server automatically tries to fill in certain fields in `tx_json` (the [Tran
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 2,
@@ -142,9 +141,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
200 OK
@@ -171,9 +170,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -201,15 +200,16 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following fields:
| `Field` | Type | Description |
|:----------|:-------|:--------------------------------------------------------|
| `tx_blob` | String | Binary representation of the fully-qualified, signed transaction, as hex |
| `tx_json` | Object | JSON specification of the [complete transaction](transaction-formats.html) as signed, including any fields that were automatically filled in |
| `tx_json` | Object | JSON specification of the [complete transaction](../../../protocol/transactions/index.md) as signed, including any fields that were automatically filled in |
**Caution:** If this command results in an error messages, the message can contain a secret value provided in the request. Make sure that these errors are not visible to others.
@@ -225,8 +225,4 @@ The response follows the [standard format][], with a successful result containin
* `tooBusy` - The transaction did not include paths, but the server is too busy to do pathfinding right now. Does not occur if you are connected as an admin.
* `noPath` - The transaction did not include paths, and the server was unable to find a path by which this payment can occur.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

50
content/references/http-websocket-apis/admin-api-methods/signing-methods/sign_for.md
View File

@@ -8,20 +8,19 @@ labels:
# sign_for
[[Source]](https://github.com/XRPLF/rippled/blob/release/src/ripple/rpc/handlers/SignFor.cpp "Source")
The `sign_for` command provides one signature for a [multi-signed transaction](multi-signing.html).
The `sign_for` command provides one signature for a [multi-signed transaction](../../../../concepts/accounts/multi-signing.md).
{% include '_snippets/public-signing-note.md' %}
<!--_ -->
{% partial file="/_snippets/public-signing-note.md" /%}
This command requires the [MultiSign amendment][] to be enabled. [New in: rippled 0.31.0][]
This command requires the [MultiSign amendment][] to be enabled. {% badge href="https://github.com/XRPLF/rippled/releases/tag/0.31.0" %}New in: rippled 0.31.0{% /badge %}
## Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": "sign_for_example",
@@ -44,9 +43,9 @@ An example of the request format:
}
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "sign_for",
@@ -70,9 +69,9 @@ An example of the request format:
}]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: rippled sign_for <signer_address> <signer_secret> [offline]
rippled sign_for rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW s████████████████████████████ '{
@@ -89,15 +88,16 @@ rippled sign_for rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW s█████████
"Fee": "30000"
}'
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes the following parameters:
| `Field` | Type | Description |
|:-------------|:---------------------|:---------------------------------------|
| `account` | String - [Address][] | The address which is providing the signature. |
| `tx_json` | Object | The [Transaction](transaction-formats.html) to sign. Unlike using the [sign method][], all fields of the transaction must be provided, including `Fee` and `Sequence`. The transaction must include the field `SigningPubKey` with an empty string as the value. The object may optionally contain a `Signers` array with previously-collected signatures. |
| `tx_json` | Object | The [Transaction](../../../protocol/transactions/index.md) to sign. Unlike using the [sign method][], all fields of the transaction must be provided, including `Fee` and `Sequence`. The transaction must include the field `SigningPubKey` with an empty string as the value. The object may optionally contain a `Signers` array with previously-collected signatures. |
| `secret` | String | _(Optional)_ Secret key of the account supplying the transaction, used to sign it. Do not send your secret to untrusted servers or through unsecured network connections. Cannot be used with `key_type`, `seed`, `seed_hex`, or `passphrase`. |
| `seed` | String | _(Optional)_ Secret key of the account supplying the transaction, used to sign it. Must be in the XRP Ledger's [base58][] format. If provided, you must also specify the `key_type`. Cannot be used with `secret`, `seed_hex`, or `passphrase`. |
| `seed_hex` | String | _(Optional)_ Secret key of the account supplying the transaction, used to sign it. Must be in hexadecimal format. If provided, you must also specify the `key_type`. Cannot be used with `secret`, `seed`, or `passphrase`. |
@@ -113,10 +113,9 @@ You must provide **exactly 1 field** with the secret key, which can be either of
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": "sign_for_example",
@@ -150,9 +149,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
200 OK
@@ -186,9 +185,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -223,15 +222,16 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following fields:
| `Field` | Type | Description |
|:----------|:-------|:--------------------------------------------------------|
| `tx_blob` | String | Hexadecimal representation of the signed transaction, including the newly-added signature. If it has enough signatures, you can [submit this string using the `submit` method](submit.html#submit-only-mode). |
| `tx_json` | Object | The [transaction specification](transaction-formats.html) in JSON format, with the newly-added signature in the `Signers` array. If it has enough signatures, you can submit this object using the [submit_multisigned method][]. |
| `tx_blob` | String | Hexadecimal representation of the signed transaction, including the newly-added signature. If it has enough signatures, you can [submit this string using the `submit` method](../../public-api-methods/transaction-methods/submit.md#submit-only-mode). |
| `tx_json` | Object | The [transaction specification](../../../protocol/transactions/index.md) in JSON format, with the newly-added signature in the `Signers` array. If it has enough signatures, you can submit this object using the [submit_multisigned method][]. |
## Possible Errors
@@ -242,6 +242,4 @@ The response follows the [standard format][], with a successful result containin
* `badSeed` - The seed value supplied was invalidly-formatted.
* `badSecret` - The secret value supplied was invalidly-formatted.
{% include '_snippets/rippled_versions.md' %}
{% include '_snippets/rippled-api-links.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

39
content/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/consensus_info.md
View File

@@ -9,26 +9,25 @@ labels:
# consensus_info
[[Source]](https://github.com/XRPLF/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/ConsensusInfo.cpp "Source")
The `consensus_info` command provides information about the [consensus process](consensus.html) for debugging purposes.
The `consensus_info` command provides information about the [consensus process](../../../../concepts/consensus-protocol/index.md) for debugging purposes.
_The `consensus_info` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users._
_The `consensus_info` method is an [admin method](../index.md) that cannot be run by unprivileged users._
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 99,
"command": "consensus_info"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "consensus_info",
@@ -37,15 +36,16 @@ An example of the request format:
]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: consensus_info
rippled consensus_info
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request has no parameters.
@@ -53,10 +53,9 @@ The request has no parameters.
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*JSON-RPC*
{% tabs %}
{% tab label="JSON-RPC" %}
```json
{
"result" : {
@@ -129,9 +128,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -207,8 +206,9 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following fields:
@@ -220,7 +220,7 @@ The following is an incomplete summary of fields that may be contained in the `i
| `Field` | Type | Description |
|:-----------------|:--------|:------------------------------------------------|
| `ledger_seq` | Number | The [ledger index][Ledger Index] of the [ledger](ledgers.html) currently in the consensus process |
| `ledger_seq` | Number | The [ledger index][Ledger Index] of the [ledger](../../../../concepts/ledgers/index.md) currently in the consensus process |
| `our_position` | Object | This server's expectation for the ledger in the consensus process. |
| `peer_positions` | Object | Map of peers and their proposed versions of the ledger in the consensus process. |
| `proposers` | Number | The number of trusted validators participating in this consensus process. Which validators are trusted depends on this server's configuration. |
@@ -237,7 +237,4 @@ The results of the `consensus_info` command can vary dramatically if you run it
- Any of the [universal error types][].
- `reportingUnsupported` - ([Reporting Mode][] servers only) This method is not available in Reporting Mode.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

57
content/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/feature.md
View File

@@ -9,28 +9,27 @@ labels:
# feature
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Feature1.cpp "Source")
The `feature` command returns information about [amendments](amendments.html) this server knows about, including whether they are enabled and whether the server is voting in favor of those amendments in the [amendment process](amendments.html#amendment-process). [New in: rippled 0.31.0][]
The `feature` command returns information about [amendments](../../../../concepts/networks-and-servers/amendments.md) this server knows about, including whether they are enabled and whether the server is voting in favor of those amendments in the [amendment process](../../../../concepts/networks-and-servers/amendments.md#amendment-process). {% badge href="https://github.com/XRPLF/rippled/releases/tag/0.31.0" %}New in: rippled 0.31.0{% /badge %}
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. [Updated in: rippled 1.7.0][]
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](admin-api-methods.html) that cannot be run by unprivileged users._
_The `feature` method is an [admin method](../index.md) that cannot be run by unprivileged users._
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket - list all*
{% tabs %}
{% tab label="WebSocket - list all" %}
```json
{
"id": "list_all_features",
"command": "feature"
}
```
{% /tab %}
*WebSocket - reject*
{% tab label="WebSocket - reject" %}
```json
{
"id": "reject_multi_sign",
@@ -39,9 +38,9 @@ An example of the request format:
"vetoed": true
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "feature",
@@ -53,22 +52,23 @@ An example of the request format:
]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: feature [<feature_id> [accept|reject]]
rippled feature 4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373 accept
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
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. |
| `vetoed` | Boolean | _(Optional; ignored unless `feature` also specified)_ If `true`, instructs the server to vote against the amendment specified by `feature`. If false, instructs the server to vote in favor of the amendment. On the commandline, use 'accept' or 'reject rather than 'true' or 'false'. You cannot vote in favor of an amendment that is marked as _obsolete_ in the server's source code. [Updated in: rippled 1.11.0][] |
| `vetoed` | Boolean | _(Optional; ignored unless `feature` also specified)_ If `true`, instructs the server to vote against the amendment specified by `feature`. If false, instructs the server to vote in favor of the amendment. On the commandline, use 'accept' or 'reject rather than 'true' or 'false'. You cannot vote in favor of an amendment that is marked as _obsolete_ in the server's source code. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.11.0" %}Updated in: rippled 1.11.0{% /badge %} |
**Note:** You can configure your server to vote in favor of a new amendment, even if the server does not currently know how to apply that amendment, by specifying the amendment ID in the `feature` field. For example, you might want to do this if you plan to upgrade soon to a new `rippled` version that _does_ support the amendment.
@@ -76,10 +76,9 @@ The request includes the following parameters:
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket - list all*
{% tabs %}
{% tab label="WebSocket - list all" %}
```json
{
"id": "list_all_features",
@@ -121,9 +120,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*WebSocket - reject*
{% tab label="WebSocket - reject" %}
```json
{
"id": "reject_multi_sign",
@@ -141,9 +140,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
200 OK
@@ -159,9 +158,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -178,8 +177,9 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /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:
@@ -187,8 +187,8 @@ The response follows the [standard format][], with a successful result containin
|:------------|:--------|:-----------------------------------------------------|
| `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](amendments.html#amendment-blocked-servers). |
| `vetoed` | Boolean or String | For most amendments, this is a boolean value indicating whether the server has been instructed to vote against this amendment. For amendments that are marked as obsolete in the code, this is the string `Obsolete` instead. [Updated in: rippled 1.11.0][] |
| `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). |
| `vetoed` | Boolean or String | For most amendments, this is a boolean value indicating whether the server has been instructed to vote against this amendment. For amendments that are marked as obsolete in the code, this is the string `Obsolete` instead. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.11.0" %}Updated in: rippled 1.11.0{% /badge %} |
**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.
@@ -198,7 +198,4 @@ The response follows the [standard format][], with a successful result containin
- `badFeature` - The `feature` specified was invalidly formatted, or the server does not know an amendment with that name.
- `reportingUnsupported` - ([Reporting Mode][] servers only) This method is not available in Reporting Mode.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

35
content/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/fetch_info.md
View File

@@ -10,15 +10,14 @@ labels:
The `fetch_info` command returns information about objects that this server is currently fetching from the network, and how many peers have that information. It can also be used to reset current fetches.
_The `fetch_info` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users._
_The `fetch_info` method is an [admin method](../index.md) that cannot be run by unprivileged users._
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 91,
@@ -26,9 +25,9 @@ An example of the request format:
"clear": false
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "fetch_info",
@@ -39,15 +38,16 @@ An example of the request format:
]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: fetch_info [clear]
rippled fetch_info
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes the following parameters:
@@ -59,10 +59,9 @@ The request includes the following parameters:
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*JSON-RPC*
{% tabs %}
{% tab label="JSON-RPC" %}
```json
{
"result" : {
@@ -98,9 +97,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -139,8 +138,9 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following fields:
@@ -164,7 +164,4 @@ The fields describing a fetch in progress are subject to change without notice.
- Any of the [universal error types][].
- `reportingUnsupported` - ([Reporting Mode][] servers only) This method is not available in Reporting Mode.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

35
content/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/get_counts.md
View File

@@ -10,15 +10,14 @@ labels:
The `get_counts` command provides various stats about the health of the server, mostly the number of objects of different types that it currently holds in memory.
_The `get_counts` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users._
_The `get_counts` method is an [admin method](../index.md) that cannot be run by unprivileged users._
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 90,
@@ -26,9 +25,9 @@ An example of the request format:
"min_count": 100
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "get_counts",
@@ -39,15 +38,16 @@ An example of the request format:
]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: get_counts [min_count]
rippled get_counts 100
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes the following parameters:
@@ -59,10 +59,9 @@ The request includes the following parameters:
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*JSON-RPC*
{% tabs %}
{% tab label="JSON-RPC" %}
```json
{
"result" : {
@@ -97,9 +96,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -137,8 +136,9 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][]. The list of fields contained in the result is subject to change without notice, but it may contain any of the following (among others):
@@ -155,7 +155,4 @@ For most other entries, the value indicates the number of objects of that type c
* Any of the [universal error types][].
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

8
content/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/index.md
View File

@@ -1,8 +1,12 @@
---
html: status-and-debugging-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
metadata:
indexPage: true
---
# Status and Debugging Methods
Use these methods to check the status of the network and server.
Use these methods to check the status of the network and server.
{% child-pages /%}

27
content/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/print.md
View File

@@ -10,29 +10,29 @@ labels:
The `print` command returns the current status of various internal subsystems, including peers, the ledger cleaner, and the resource manager.
*The `print` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users!*
*The `print` method is an [admin method](../index.md) that cannot be run by unprivileged users!*
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": "print_req_1",
"command": "print"
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```
rippled print
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes no parameters.
@@ -40,10 +40,9 @@ The request includes no parameters.
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*Commandline*
{% tabs %}
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -229,8 +228,9 @@ Connecting to 127.0.0.1:5005
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][]. Additional fields in the result depend on the internal state of the `rippled` server. The results of this command are subject to change without notice.
@@ -238,7 +238,4 @@ The response follows the [standard format][]. Additional fields in the result de
* Any of the [universal error types][].
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

53
content/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/validator_info.md
View File

@@ -9,41 +9,41 @@ labels:
# validator_info
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/ValidatorInfo.cpp "Source")
The `{{currentpage.name}}` method returns the current validator settings of the server, if it is configured as a validator.
The {% code-page-name /%} method returns the current validator settings of the server, if it is configured as a validator.
_The `{{currentpage.name}}` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users._
_The {% code-page-name /%} method is an [admin method](../index.md) that cannot be run by unprivileged users._
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"command": "{{currentpage.name}}"
"command": "{% $frontmatter.seo.title %}"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "{{currentpage.name}}"
"method": "{% $frontmatter.seo.title %}"
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: {{currentpage.name}}
rippled {{currentpage.name}}
#Syntax: {% $frontmatter.seo.title %}
rippled {% $frontmatter.seo.title %}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request does not accept any parameters.
@@ -52,10 +52,9 @@ The request does not accept any parameters.
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"result": {
@@ -69,9 +68,9 @@ An example of a successful response:
"type": "response"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
200 OK
@@ -86,9 +85,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -104,8 +103,9 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following fields:
@@ -113,7 +113,7 @@ The response follows the [standard format][], with a successful result containin
|:--------|:-------|:----------------------------------------------------------|
| `domain` | String | _(May be omitted)_ The domain name associated with this validator, if one has been configured.
| `ephemeral_key` | String | _(May be omitted)_ The public key of the ephemeral key pair this server uses to sign validation messages, in [base58][]. This key changes if the validator's configured token changes. |
| `manifest` | String | _(May be omitted)_ The public "manifest" corresponding to this validator's configured token, [serialized to binary](serialization.html) and then encoded in base64. This field does not contain any private information. |
| `manifest` | String | _(May be omitted)_ The public "manifest" corresponding to this validator's configured token, [serialized to binary](../../../protocol/binary-format.md) and then encoded in base64. This field does not contain any private information. |
| `master_key` | String | The public key of this validator's master key pair, in [base58][]. This key uniquely identifies the validator and remains the same if the validator rotates ephemeral keys. If the server is configured using a `[validation_seed]` instead of a `[validator_token]`, this is the only field in the response. |
| `seq` | Number | _(May be omitted)_ A sequence number for this validator's configured validation token and settings. This number increases whenever the validator operator updates the validator's token to rotate ephemeral keys or change settings. |
@@ -123,9 +123,6 @@ For more information on validator tokens and key rotation, see the [validator-ke
### Possible Errors
- Any of the [universal error types][].
- `invalidParams` - The server returns this error with `"error_message" : "not a validator"` if the server is not [configured as a validator](run-rippled-as-a-validator.html).
- `invalidParams` - The server returns this error with `"error_message" : "not a validator"` if the server is not [configured as a validator](../../../../infrastructure/configuration/server-modes/run-rippled-as-a-validator.md).
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

43
content/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/validator_list_sites.md
View File

@@ -9,26 +9,25 @@ labels:
# validator_list_sites
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/ValidatorListSites.cpp "Source")
The `validator_list_sites` command returns status information of sites serving validator lists. [New in: rippled 0.80.1][]
The `validator_list_sites` command returns status information of sites serving validator lists. {% badge href="https://github.com/XRPLF/rippled/releases/tag/0.80.1" %}New in: rippled 0.80.1{% /badge %}
*The `validator_list_sites` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users!*
*The `validator_list_sites` method is an [admin method](../index.md) that cannot be run by unprivileged users!*
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 1,
"command": "validator_list_sites"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "validator_list_sites",
@@ -37,15 +36,16 @@ An example of the request format:
]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: validator_list_sites
rippled validator_list_sites
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes no parameters.
@@ -53,10 +53,9 @@ The request includes no parameters.
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id":5,
@@ -75,9 +74,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
200 OK
@@ -95,9 +94,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -116,8 +115,9 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following field:
@@ -142,7 +142,7 @@ The `last_refresh_status` field can have the following values:
|:----------------------|:-----------------------------------------------------|
| `accepted` | The site provided a valid list, which your server is now using. |
| `same_sequence` | The site provided a list with the same sequence number as your existing list, so your server continued using its existing list. |
| `unsupported_version` | The site provided a list, but your server does not support the list format version number in the list. You might need to [update `rippled`](install-rippled.html) to a newer software version. |
| `unsupported_version` | The site provided a list, but your server does not support the list format version number in the list. You might need to [update `rippled`](../../../../infrastructure/installation/index.md) to a newer software version. |
| `untrusted` | The site provided a list from the site that is signed by a cryptographic key pair your server is not configured to trust. You may want to check for typos in your `validators.txt` file and check to see if the list publisher changed their cryptographic keys. |
| `stale` | The site provided a list with a lower sequence number than the list your server is already using. |
| `invalid` | The site provided a list or signature that was not validly formed. |
@@ -152,7 +152,4 @@ The `last_refresh_status` field can have the following values:
- Any of the [universal error types][].
- `reportingUnsupported` - ([Reporting Mode][] servers only) This method is not available in Reporting Mode.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

41
content/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/validators.md
View File

@@ -9,26 +9,25 @@ labels:
# validators
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Validators.cpp "Source")
The `validators` command returns human readable information about the current list of published and [trusted validators](consensus.html#trust-based-validation) used by the server.
The `validators` command returns human readable information about the current list of published and [trusted validators](../../../../concepts/consensus-protocol/index.md#trust-based-validation) used by the server.
*The `validators` method is an [admin method](admin-api-methods.html) that cannot be run by unprivileged users!*
*The `validators` method is an [admin method](../index.md) that cannot be run by unprivileged users!*
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": "validators_example",
"command": "validators"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "validators",
@@ -37,15 +36,16 @@ An example of the request format:
]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: validators
rippled validators
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes no parameters.
@@ -53,10 +53,9 @@ The request includes no parameters.
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": "validators_example",
@@ -193,9 +192,9 @@ An example of a successful response:
"type": "response"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
200 OK
@@ -332,9 +331,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
@@ -472,8 +471,9 @@ Connecting to 127.0.0.1:5005
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following fields:
@@ -502,7 +502,4 @@ Each member of the `publisher_lists` array is a **Publisher List** object with t
- Any of the [universal error types][].
- `reportingUnsupported` - ([Reporting Mode][] servers only) This method is not available in Reporting Mode.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}