mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-22 04:35:49 +00:00
Remove badges > ~2yrs old
Version 1.8.0 of rippled was released in late 2021, so any changes prior to that are historical and no longer need badges. Fixes #1978
This commit is contained in:
mDuo13
@@ -183,7 +183,7 @@ The response follows the [standard format][], with a successful result containin
|
||||
| `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. {% badge href="https://github.com/XRPLF/rippled/releases/tag/0.32.0" %}New in: rippled 0.32.0{% /badge %} |
|
||||
| `warning` | String | (May be omitted) If the request specified a seed value, this field provides a warning that it may be insecure. |
|
||||
|
||||
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.
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ 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](../../../../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 %}
|
||||
Requests information from peer servers about which [shards of historical ledger data](../../../../infrastructure/configuration/data-retention/history-sharding.md) they have available.
|
||||
|
||||
_The `crawl_shards` method is an [admin method](../index.md) that cannot be run by unprivileged users._
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ labels:
|
||||
# peer_reservations_add
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/4a1148eb2849513dd1e7ae080288fd47ab57a376/src/ripple/rpc/handlers/Reservations.cpp#L36 "Source")
|
||||
|
||||
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 {% 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).
|
||||
|
||||
_The {% code-page-name /%} method is an [admin method](../index.md) that cannot be run by unprivileged users._
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ labels:
|
||||
# peer_reservations_del
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/4a1148eb2849513dd1e7ae080288fd47ab57a376/src/ripple/rpc/handlers/Reservations.cpp#L89 "Source")
|
||||
|
||||
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 {% code-page-name /%} method removes a specific [peer reservation][], if one exists.
|
||||
|
||||
_The {% code-page-name /%} method is an [admin method](../index.md) that cannot be run by unprivileged users._
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ labels:
|
||||
# peer_reservations_list
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/4a1148eb2849513dd1e7ae080288fd47ab57a376/src/ripple/rpc/handlers/Reservations.cpp#L116 "Source")
|
||||
|
||||
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 {% code-page-name /%} method lists [peer reservations][].
|
||||
|
||||
_The {% code-page-name /%} method is an [admin method](../index.md) that cannot be run by unprivileged users._
|
||||
|
||||
|
||||
@@ -371,7 +371,7 @@ The response follows the [standard format][], with a successful result containin
|
||||
|
||||
| `Field` | Type | Description |
|
||||
|:----------|:-------|:--------------------------------------------------------|
|
||||
| `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 %} |
|
||||
| `cluster` | Object | Summary of other `rippled` servers in the same cluster, if [configured as a cluster](../../../../concepts/networks-and-servers/clustering.md). |
|
||||
| `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:
|
||||
@@ -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. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.4.0" %}New in: rippled 1.4.0{% /badge %} |
|
||||
| `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. |
|
||||
| `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](../../../../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. {% badge href="https://github.com/XRPLF/rippled/releases/tag/0.30.1" %}New in: rippled 0.30.1{% /badge %} |
|
||||
| `uptime` | Number | The number of seconds that your `rippled` server has been continuously connected to this peer. |
|
||||
| `version` | string | _(May be omitted)_ The `rippled` version number of the peer server |
|
||||
|
||||
The `metrics` object contains the following fields:
|
||||
|
||||
@@ -94,7 +94,7 @@ The request includes the following parameters:
|
||||
| `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](../../../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 %} |
|
||||
| `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`. |
|
||||
|
||||
### Auto-Fillable Fields
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ The `sign_for` command provides one signature for a [multi-signed transaction](.
|
||||
{% partial file="/_snippets/public-signing-note.md" /%}
|
||||
|
||||
|
||||
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 %}
|
||||
This command requires the [MultiSign amendment][] to be enabled.
|
||||
|
||||
## Request Format
|
||||
An example of the request format:
|
||||
|
||||
@@ -9,7 +9,7 @@ labels:
|
||||
# feature
|
||||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Feature1.cpp "Source")
|
||||
|
||||
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 %}
|
||||
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).
|
||||
|
||||
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 %}
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ 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. {% badge href="https://github.com/XRPLF/rippled/releases/tag/0.80.1" %}New in: rippled 0.80.1{% /badge %}
|
||||
The `validator_list_sites` command returns status information of sites serving validator lists.
|
||||
|
||||
*The `validator_list_sites` method is an [admin method](../index.md) that cannot be run by unprivileged users!*
|
||||
|
||||
|
||||
Reference in New Issue
Block a user