mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-21 12:15:50 +00:00
Migrate old callout syntax
This commit is contained in:
mDuo13
@@ -16,7 +16,7 @@ _The `validation_create` method is an [admin method](../index.md) that cannot be
|
||||
|
||||
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](../../../../infrastructure/configuration/server-modes/run-rippled-as-a-validator.md#3-enable-validation-on-your-rippled-server).
|
||||
{% admonition type="success" name="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).{% /admonition %}
|
||||
|
||||
|
||||
### Request Format
|
||||
@@ -62,7 +62,7 @@ The request includes the following parameters:
|
||||
|:---------|:-------|:---------------------------------------------------------|
|
||||
| `secret` | String | _(Optional)_ Use this value as a seed to generate the credentials. The same secret always generates the same credentials. You can provide the seed in [RFC-1751](https://tools.ietf.org/html/rfc1751) format or the XRP Ledger's [base58][] format. If omitted, generate a random seed. |
|
||||
|
||||
**Note:** The security of your validator depends on the entropy of your seed. Do not use a secret value for real business purposes unless it is generated with a strong source of randomness. Ripple recommends omitting the `secret` when generating new credentials for the first time.
|
||||
{% admonition type="info" name="Note" %}The security of your validator depends on the entropy of your seed. Do not use a secret value for real business purposes unless it is generated with a strong source of randomness. Ripple recommends omitting the `secret` when generating new credentials for the first time.{% /admonition %}
|
||||
|
||||
### Response Format
|
||||
|
||||
|
||||
@@ -88,7 +88,7 @@ The request can contain the following parameters:
|
||||
|
||||
You must provide **at most one** of the following fields: `passphrase`, `seed`, or `seed_hex`. If you omit all three, `rippled` uses a random seed.
|
||||
|
||||
**Note:** The commandline version of this command cannot generate [Ed25519](https://ed25519.cr.yp.to/) keys.
|
||||
{% admonition type="info" name="Note" %}The commandline version of this command cannot generate [Ed25519](https://ed25519.cr.yp.to/) keys.{% /admonition %}
|
||||
|
||||
#### Specifying a Seed
|
||||
|
||||
|
||||
@@ -45,7 +45,7 @@ An example of the request format:
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
**Note:** There is no command-line syntax for this method. Use the [json method][] to access this from the command line.
|
||||
{% admonition type="info" name="Note" %}There is no command-line syntax for this method. Use the [json method][] to access this from the command line.{% /admonition %}
|
||||
|
||||
The request includes the following fields:
|
||||
|
||||
@@ -54,7 +54,7 @@ The request includes the following fields:
|
||||
| `public_key` | Boolean | _(Optional)_ If `true`, the response includes the node public keys (for peer-to-peer communications) of servers that were crawled. The default is `false`. |
|
||||
| `limit` | Number | _(Optional)_ How many hops deep to search. The default is 0, which searches direct peers only. With a limit of `1`, searches peers' peers also. The maximum value is `3`. |
|
||||
|
||||
**Caution:** The number of peers potentially searched grows exponentially as `limit` increases. With a limit of 2 or 3, it can take several seconds for the server to respond to the API request.
|
||||
{% admonition type="warning" name="Caution" %}The number of peers potentially searched grows exponentially as `limit` increases. With a limit of 2 or 3, it can take several seconds for the server to respond to the API request.{% /admonition %}
|
||||
|
||||
|
||||
### Response Format
|
||||
|
||||
@@ -131,7 +131,7 @@ The response follows the [standard format][], with a successful result containin
|
||||
|:----------|:-------|:--------------------------------------------------------|
|
||||
| `message` | String | A message describing the actions taken in response to this request. |
|
||||
|
||||
**Tip:** To see which shards your server has available, use the [crawl_shards method][]. Alternatively, you can look at the subfolders in your configured location for the shard store (the `path` parameter of `[shard_db]` in your `rippled.cfg`). The folders are named to match the numbers of the shards; up to one of those folders may contain a `control.txt` file indicating that the shard is incomplete.
|
||||
{% admonition type="success" name="Tip" %}To see which shards your server has available, use the [crawl_shards method][]. Alternatively, you can look at the subfolders in your configured location for the shard store (the `path` parameter of `[shard_db]` in your `rippled.cfg`). The folders are named to match the numbers of the shards; up to one of those folders may contain a `control.txt` file indicating that the shard is incomplete.{% /admonition %}
|
||||
|
||||
### Possible Errors
|
||||
|
||||
|
||||
@@ -49,7 +49,7 @@ You must provide either `ledger_index` or `ledger_hash` but not both.
|
||||
|
||||
The response follows the [standard format][]. However, the request returns a failure response if it does not have the specified ledger _even if it successfully instructed the `rippled` server to start retrieving the ledger_.
|
||||
|
||||
**Note:** To retrieve a ledger, the rippled server must have a direct peer with that ledger in its history. If none of the peers have the requested ledger, you can use the [connect method][] or the `fixed_ips` section of the config file to add Ripple's full-history server at `s2.ripple.com` and then make the `ledger_request` request again.
|
||||
{% admonition type="info" name="Note" %}To retrieve a ledger, the rippled server must have a direct peer with that ledger in its history. If none of the peers have the requested ledger, you can use the [connect method][] or the `fixed_ips` section of the config file to add Ripple's full-history server at `s2.ripple.com` and then make the `ledger_request` request again.{% /admonition %}
|
||||
|
||||
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][].
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ You can configure parameters such as `minsize` and `rotate` depending on the amo
|
||||
|
||||
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.
|
||||
{% admonition type="info" name="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.{% /admonition %}
|
||||
|
||||
_The `logrotate` method is an [admin method](../index.md) that cannot be run by unprivileged users._
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ The {% code-page-name /%} method removes a specific [peer reservation][], if one
|
||||
|
||||
_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.
|
||||
{% admonition type="info" name="Note" %}Removing a peer reservation does not automatically disconnect the corresponding peer, if that peer is connected.{% /admonition %}
|
||||
|
||||
### Request Format
|
||||
|
||||
@@ -119,7 +119,7 @@ The response follows the [standard format][], with a successful result containin
|
||||
|:--------|:-------|:----------------------------------------------------------|
|
||||
| `previous` | Object | _(May be omitted)_ A **peer reservation object** with the last state of the peer reservation before deleting it. This field is always provided if a peer reservation was successfully deleted. |
|
||||
|
||||
**Note:** If the specified reservation did not exist, this command returns success with an empty result object. In this case, the `previous` field is omitted.
|
||||
{% admonition type="info" name="Note" %}If the specified reservation did not exist, this command returns success with an empty result object. In this case, the `previous` field is omitted.{% /admonition %}
|
||||
|
||||
#### Peer Reservation Object
|
||||
|
||||
|
||||
@@ -412,7 +412,7 @@ The `metrics` object contains the following fields:
|
||||
| `total_bytes_recv` | String | The total number of bytes of data received from this peer. |
|
||||
| `total_bytes_sent` | String | The total number of bytes of data sent to this peer. |
|
||||
|
||||
**Note:** All of the fields in the `metrics` object are 64-bit unsigned integers serialized to string format so that they do not lose precision in JSON encoding/decoding.
|
||||
{% admonition type="info" name="Note" %}All of the fields in the `metrics` object are 64-bit unsigned integers serialized to string format so that they do not lose precision in JSON encoding/decoding.{% /admonition %}
|
||||
|
||||
### Possible Errors
|
||||
|
||||
|
||||
@@ -59,7 +59,7 @@ The response follows the [standard format][], with a successful result containin
|
||||
|:-----------------------|:-----------------|:---------------------------------|
|
||||
| `ledger_current_index` | Unsigned Integer - [Ledger Index][] | Ledger index of the newly created 'current' ledger |
|
||||
|
||||
**Note:** When you close a ledger, `rippled` determines the canonical order of transactions in that ledger and replays them. This can change the outcome of transactions that were provisionally applied to the current ledger.
|
||||
{% admonition type="info" name="Note" %}When you close a ledger, `rippled` determines the canonical order of transactions in that ledger and replays them. This can change the outcome of transactions that were provisionally applied to the current ledger.{% /admonition %}
|
||||
|
||||
### Possible Errors
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ The `sign` method takes a [transaction in JSON format](../../../protocol/transac
|
||||
{% partial file="/docs/_snippets/public-signing-note.md" /%}
|
||||
|
||||
|
||||
**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).
|
||||
{% admonition type="warning" name="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).{% /admonition %}
|
||||
|
||||
## Request Format
|
||||
An example of the request format:
|
||||
@@ -212,7 +212,7 @@ The response follows the [standard format][], with a successful result containin
|
||||
| `tx_blob` | String | Binary representation of the fully-qualified, signed transaction, as hex |
|
||||
| `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.
|
||||
{% admonition type="warning" name="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.{% /admonition %}
|
||||
|
||||
* Do not write this error to a log file that can be seen by multiple people.
|
||||
* Do not paste this error to a public place for debugging.
|
||||
|
||||
@@ -71,7 +71,7 @@ The request includes the following parameters:
|
||||
| `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. {% 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.
|
||||
{% admonition type="info" name="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.{% /admonition %}
|
||||
|
||||
### Response Format
|
||||
|
||||
@@ -191,7 +191,7 @@ The response follows the [standard format][], with a successful result containin
|
||||
| `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.
|
||||
{% admonition type="warning" name="Caution" %}The `name` for an amendment does not strictly indicate what that amendment does. The name is not guaranteed to be unique or consistent across servers.{% /admonition %}
|
||||
|
||||
### Possible Errors
|
||||
|
||||
|
||||
Reference in New Issue
Block a user