mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-06 04:45:49 +00:00
7645140477
For better URLs, the content folder has been renamed 'docs' and all other files have been moved up a level. Also, non-docs images have been moved to the static folder at the top level where they belong. Many relative paths had to be fixed to make this work.
171 lines
6.1 KiB
Markdown
171 lines
6.1 KiB
Markdown
---
|
|
html: fee.html
|
|
parent: server-info-methods.html
|
|
seo:
|
|
description: Get information about transaction cost.
|
|
labels:
|
|
- Fees
|
|
---
|
|
# fee
|
|
[[Source]](https://github.com/XRPLF/rippled/blob/release/src/ripple/rpc/handlers/Fee1.cpp "Source")
|
|
|
|
The `fee` command reports the current state of the open-ledger requirements for the [transaction cost](../../../../concepts/transactions/transaction-cost.md). This requires the [FeeEscalation amendment][] to be enabled.
|
|
|
|
This is a public command available to unprivileged users. {% badge href="https://github.com/XRPLF/rippled/releases/tag/0.32.0" %}Updated in: rippled 0.32.0{% /badge %}
|
|
|
|
## Request Format
|
|
An example of the request format:
|
|
|
|
{% tabs %}
|
|
|
|
{% tab label="WebSocket" %}
|
|
```json
|
|
{
|
|
"id": "fee_websocket_example",
|
|
"command": "fee"
|
|
}
|
|
```
|
|
{% /tab %}
|
|
|
|
{% tab label="JSON-RPC" %}
|
|
```json
|
|
{
|
|
"method": "fee",
|
|
"params": [{}]
|
|
}
|
|
```
|
|
{% /tab %}
|
|
|
|
{% tab label="Commandline" %}
|
|
```sh
|
|
#Syntax: fee
|
|
rippled fee
|
|
```
|
|
{% /tab %}
|
|
|
|
{% /tabs %}
|
|
|
|
The request does not include any parameters.
|
|
|
|
## Response Format
|
|
|
|
An example of a successful response:
|
|
|
|
{% tabs %}
|
|
|
|
{% tab label="WebSocket" %}
|
|
```json
|
|
{
|
|
"id": "fee_websocket_example",
|
|
"status": "success",
|
|
"type": "response",
|
|
"result": {
|
|
"current_ledger_size": "14",
|
|
"current_queue_size": "0",
|
|
"drops": {
|
|
"base_fee": "10",
|
|
"median_fee": "11000",
|
|
"minimum_fee": "10",
|
|
"open_ledger_fee": "10"
|
|
},
|
|
"expected_ledger_size": "24",
|
|
"ledger_current_index": 26575101,
|
|
"levels": {
|
|
"median_level": "281600",
|
|
"minimum_level": "256",
|
|
"open_ledger_level": "256",
|
|
"reference_level": "256"
|
|
},
|
|
"max_queue_size": "480"
|
|
}
|
|
}
|
|
```
|
|
{% /tab %}
|
|
|
|
{% tab label="JSON-RPC" %}
|
|
```json
|
|
200 OK
|
|
|
|
{
|
|
"result": {
|
|
"current_ledger_size": "56",
|
|
"current_queue_size": "11",
|
|
"drops": {
|
|
"base_fee": "10",
|
|
"median_fee": "10000",
|
|
"minimum_fee": "10",
|
|
"open_ledger_fee": "2653937"
|
|
},
|
|
"expected_ledger_size": "55",
|
|
"ledger_current_index": 26575101,
|
|
"levels": {
|
|
"median_level": "256000",
|
|
"minimum_level": "256",
|
|
"open_ledger_level": "67940792",
|
|
"reference_level": "256"
|
|
},
|
|
"max_queue_size": "1100",
|
|
"status": "success"
|
|
}
|
|
}
|
|
```
|
|
{% /tab %}
|
|
|
|
{% tab label="Commandline" %}
|
|
```json
|
|
Loading: "/etc/rippled.cfg"
|
|
Connecting to 127.0.0.1:5005
|
|
|
|
{
|
|
"result" : {
|
|
"current_ledger_size" : "16",
|
|
"current_queue_size" : "2",
|
|
"drops" : {
|
|
"base_fee" : "10",
|
|
"median_fee" : "11000",
|
|
"minimum_fee" : "10",
|
|
"open_ledger_fee" : "3203982"
|
|
},
|
|
"expected_ledger_size" : "15",
|
|
"ledger_current_index": 26575101,
|
|
"levels" : {
|
|
"median_level" : "281600",
|
|
"minimum_level" : "256",
|
|
"open_ledger_level" : "82021944",
|
|
"reference_level" : "256"
|
|
},
|
|
"max_queue_size" : "300",
|
|
"status" : "success"
|
|
}
|
|
}
|
|
```
|
|
{% /tab %}
|
|
|
|
{% /tabs %}
|
|
|
|
The response follows the [standard format][], with a successful result containing the following fields:
|
|
|
|
| `Field` | Type | Description |
|
|
|:---------------------------|:-----------------|:-----------------------------|
|
|
| `current_ledger_size` | String (Integer) | Number of transactions provisionally included in the in-progress ledger. |
|
|
| `current_queue_size` | String (Integer) | Number of transactions currently queued for the next ledger. |
|
|
| `drops` | Object | Various information about the transaction cost (the `Fee` field of a transaction), in [drops of XRP][]. |
|
|
| `drops.base_fee` | String (Integer) | The transaction cost required for a [reference transaction](../../../../concepts/transactions/transaction-cost.md#reference-transaction-cost) to be included in a ledger under minimum load, represented in drops of XRP. |
|
|
| `drops.median_fee` | String (Integer) | An approximation of the median transaction cost among transactions included in the previous validated ledger, represented in drops of XRP. |
|
|
| `drops.minimum_fee` | String (Integer) | The minimum transaction cost for a [reference transaction](../../../../concepts/transactions/transaction-cost.md#reference-transaction-cost) to be queued for a later ledger, represented in drops of XRP. If greater than `base_fee`, the transaction queue is full. |
|
|
| `drops.open_ledger_fee` | String (Integer) | The minimum transaction cost that a [reference transaction](../../../../concepts/transactions/transaction-cost.md#reference-transaction-cost) must pay to be included in the current open ledger, represented in drops of XRP. |
|
|
| `expected_ledger_size` | String (Integer) | The approximate number of transactions expected to be included in the current ledger. This is based on the number of transactions in the previous ledger. |
|
|
| `ledger_current_index` | Number | The [Ledger Index][] of the current open ledger these stats describe. |
|
|
| `levels` | Object | Various information about the transaction cost, in [fee levels][]. The ratio in fee levels applies to any transaction relative to the minimum cost of that particular transaction. |
|
|
| `levels.median_level` | String (Integer) | The median transaction cost among transactions in the previous validated ledger, represented in [fee levels][]. |
|
|
| `levels.minimum_level` | String (Integer) | The minimum transaction cost required to be queued for a future ledger, represented in [fee levels][]. |
|
|
| `levels.open_ledger_level` | String (Integer) | The minimum transaction cost required to be included in the current open ledger, represented in [fee levels][]. |
|
|
| `levels.reference_level` | String (Integer) | The equivalent of the minimum transaction cost, represented in [fee levels][]. |
|
|
| `max_queue_size` | String (Integer) | The maximum number of transactions that the [transaction queue](../../../../concepts/transactions/transaction-cost.md#queued-transactions) can currently hold. |
|
|
|
|
## Possible Errors
|
|
|
|
- Any of the [universal error types][].
|
|
|
|
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|