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

Update docs for XRPFees amendment

Browse Source
This commit is contained in:
Oliver Eggert
2023-02-28 15:55:08 -08:00
parent 2bf9323ffd
commit ffd57e749d
3 changed files with 26 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
content/_snippets/rippled-api-links.md
View File

@@ -237,7 +237,8 @@
"TicketBatch",
"Tickets",
"TickSize",
"TrustSetAuth"
"TrustSetAuth",
"XRPFees"
] %}
{% for amd in amendment_names %}

13
content/references/protocol-reference/ledger-data/ledger-object-types/feesettings.md
View File

@@ -41,6 +41,18 @@ The `FeeSettings` object has the following fields:
**Warning:** The JSON format for this ledger object type is unusual. The `BaseFee`, `ReserveBase`, and `ReserveIncrement` indicate drops of XRP but ***not*** in the usual format for [specifying XRP][Currency Amount].
If the _[XRPFees amendment][]_ is enabled, the `FeeSettings` object has these fields instead:
| Name | JSON Type | [Internal Type][] | Required? | Description |
|:------------------------|:----------|:------------------|:----------|:-----------------------|
| `BaseFeeDrops` | String | UInt64 | Yes | The [transaction cost](transaction-cost.html) of the "reference transaction" in drops of XRP. |
| `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`. |
| `LedgerEntryType` | String | UInt16 | Yes | The value `0x0073`, mapped to the string `FeeSettings`, indicates that this object contains the ledger's fee settings. |
| `ReserveBaseDrops` | String | UInt64 | Yes | The [base reserve](reserves.html#base-reserve-and-owner-reserve) for an account in the XRP Ledger, as drops of XRP. |
| `ReserveIncrementDrops` | String | UInt64 | Yes | The incremental [owner reserve](reserves.html#base-reserve-and-owner-reserve) for owning objects, as drops of XRP. |
## FeeSettings ID Format
The `FeeSettings` object ID is the hash of the `FeeSettings` space key (`0x0065`) only. This means that the ID of the `FeeSettings` object in a ledger is always:
@@ -49,6 +61,7 @@ The `FeeSettings` object ID is the hash of the `FeeSettings` space key (`0x0065`
4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A651
```
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}

11
content/references/protocol-reference/transactions/pseudo-transaction-types/setfee.md
View File

@@ -41,6 +41,17 @@ A `SetFee` [pseudo-transaction](pseudo-transaction-types.html) marks a change in
| `ReserveIncrement` | Unsigned Integer | UInt32 | The incremental reserve, in drops |
| `LedgerSequence` | Number | UInt32 | _(Omitted for some historical `SetFee` pseudo-transactions)_ The index of the ledger version where this pseudo-transaction appears. This distinguishes the pseudo-transaction from other occurrences of the same change. |
If the _[XRPFees amendment][]_ is enabled, `SetFee` pseudo-transactions use these fields instead:
| Field | JSON Type | [Internal Type][] | Description |
|:------------------------|:----------|:------------------|:----------------|
| `BaseFeeDrops` | String | UInt64 | The charge, in drops of XRP, for the reference transaction. (This is the [transaction cost](transaction-cost.html) before scaling for load.) |
| `ReserveBaseDrops` | String | UInt64 | The base reserve, in drops |
| `ReserveIncrementDrops` | String | UInt64 | The incremental reserve, in drops |
| `LedgerSequence` | Number | UInt32 | _(Omitted for some historical `SetFee` pseudo-transactions)_ The index of the ledger version where this pseudo-transaction appears. This distinguishes the pseudo-transaction from other occurrences of the same change. |
{% include '_snippets/setfee_uniqueness_note.md' %}
<!--{# common link defs #}-->