Skip to content

Commit 207e50c

Browse files
authored
Merge pull request #3226 from XRPLF/mvadari-patch-1
Update feesettings.md
2 parents bab45a1 + 985a47a commit 207e50c

File tree

1 file changed

+36
-13
lines changed

1 file changed

+36
-13
lines changed

docs/references/protocol/ledger-data/ledger-entry-types/feesettings.md

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,25 @@ The `FeeSettings` entry contains the current base [transaction cost](../../../..
1111

1212
## Example {% $frontmatter.seo.title %} JSON
1313

14+
This ledger entry has two formats, depending on whether the [XRPFees amendment][] was enabled at the time:
15+
16+
{% tabs %}
17+
{% tab label="Current Format" %}
18+
```json
19+
{
20+
"BaseFeeDrops": "10",
21+
"Flags": 0,
22+
"LedgerEntryType": "FeeSettings",
23+
"PreviousTxnID": "4EEDB01BB943CE32E97BB468AC179ABF933B272D6FF990E76B6721FB48E069FC",
24+
"PreviousTxnLgrSeq": 92508417,
25+
"ReserveBaseDrops": "1000000",
26+
"ReserveIncrementDrops": "200000",
27+
"index": "4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A651"
28+
}
29+
```
30+
{% /tab %}
31+
32+
{% tab label="Legacy Format" %}
1433
```json
1534
{
1635
"BaseFee": "000000000000000A",
@@ -22,16 +41,28 @@ The `FeeSettings` entry contains the current base [transaction cost](../../../..
2241
"index": "4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A651"
2342
}
2443
```
44+
{% /tab %}
45+
{% /tabs %}
2546

2647
## {% $frontmatter.seo.title %} Fields
2748

28-
In addition to the [common fields](../common-fields.md), the {% code-page-name /%} ledger entry has the following fields:
49+
The fields of the `FeeSettings` ledger entry depend on whether the [XRPFees amendment][] was enabled the last time it was modified. If the last update was before the amendment became enabled, the entry uses the **legacy format**. If it has been updated after the amendment, it uses the **current format**. The fields it can have, in addition to the [common fields](../common-fields.md), are as follows:
2950

51+
{% tabs %}
52+
{% tab label="Current Format" %}
53+
| Name | JSON Type | [Internal Type][] | Required? | Description |
54+
|:------------------------|:----------|:------------------|:----------|:-----------------------|
55+
| `BaseFeeDrops` | String | Amount | Yes | The [transaction cost](../../../../concepts/transactions/transaction-cost.md) of the "reference transaction" in drops of XRP. |
56+
| `ReserveBaseDrops` | String | Amount | Yes | The [base reserve](../../../../concepts/accounts/reserves.md#base-reserve-and-owner-reserve) for an account in the XRP Ledger, as drops of XRP. |
57+
| `ReserveIncrementDrops` | String | Amount | Yes | The incremental [owner reserve](../../../../concepts/accounts/reserves.md#base-reserve-and-owner-reserve) for owning objects, as drops of XRP. |
58+
| `PreviousTxnID` | String | UInt256 | No | The identifying hash of the transaction that most recently modified this entry. _(Added by the [fixPreviousTxnID amendment][].)_ |
59+
| `PreviousTxnLgrSeq` | Number | UInt32 | No | The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this entry. _(Added by the [fixPreviousTxnID amendment][].)_ |
60+
{% /tab %}
61+
62+
{% tab label="Legacy Format" %}
3063
| Name | JSON Type | [Internal Type][] | Required? | Description |
3164
|:--------------------|:----------|:------------------|:----------|:-----------------------|
3265
| `BaseFee` | String | UInt64 | Yes | The [transaction cost](../../../../concepts/transactions/transaction-cost.md) of the "reference transaction" in drops of XRP as hexadecimal. |
33-
| `Flags` | Number | UInt32 | Yes | A bit-map of boolean flags enabled for this object. Currently, the protocol defines no flags for `FeeSettings` objects. The value is always `0`. |
34-
| `LedgerEntryType` | String | UInt16 | Yes | The value `0x0073`, mapped to the string `FeeSettings`, indicates that this object contains the ledger's fee settings. |
3566
| `ReferenceFeeUnits` | Number | UInt32 | Yes | The `BaseFee` translated into "fee units". |
3667
| `ReserveBase` | Number | UInt32 | Yes | The [base reserve](../../../../concepts/accounts/reserves.md#base-reserve-and-owner-reserve) for an account in the XRP Ledger, as drops of XRP. |
3768
| `ReserveIncrement` | Number | UInt32 | Yes | The incremental [owner reserve](../../../../concepts/accounts/reserves.md#base-reserve-and-owner-reserve) for owning objects, as drops of XRP. |
@@ -40,16 +71,8 @@ In addition to the [common fields](../common-fields.md), the {% code-page-name /
4071

4172
{% admonition type="danger" name="Warning" %}The JSON format for this ledger entry type is unusual. The `BaseFee`, `ReserveBase`, and `ReserveIncrement` indicate drops of XRP but ***not*** in the usual format for [specifying XRP][Currency Amount].{% /admonition %}
4273

43-
44-
If the _[XRPFees amendment][]_ is enabled, the `FeeSettings` object has these fields instead:
45-
46-
| Name | JSON Type | [Internal Type][] | Required? | Description |
47-
|:------------------------|:----------|:------------------|:----------|:-----------------------|
48-
| `BaseFeeDrops` | String | Amount | Yes | The [transaction cost](../../../../concepts/transactions/transaction-cost.md) of the "reference transaction" in drops of XRP. |
49-
| `Flags` | Number | UInt32 | Yes | A bitmap of boolean flags enabled for this object. Currently, the protocol defines no flags for `FeeSettings` objects. The value is always `0`. |
50-
| `LedgerEntryType` | String | UInt16 | Yes | The value `0x0073`, mapped to the string `FeeSettings`, indicates that this object contains the ledger's fee settings. |
51-
| `ReserveBaseDrops` | String | Amount | Yes | The [base reserve](../../../../concepts/accounts/reserves.md#base-reserve-and-owner-reserve) for an account in the XRP Ledger, as drops of XRP. |
52-
| `ReserveIncrementDrops` | String | Amount | Yes | The incremental [owner reserve](../../../../concepts/accounts/reserves.md#base-reserve-and-owner-reserve) for owning objects, as drops of XRP. |
74+
{% /tab %}
75+
{% /tabs %}
5376

5477

5578
## {% $frontmatter.seo.title %} Flags

0 commit comments

Comments
 (0)