Fix links w/ ledger entry changes

This commit is contained in:
mDuo13
2023-09-19 16:36:54 -07:00
parent 52b100b004
commit 0f3f2f8d3e
8 changed files with 15 additions and 14 deletions

View File

@@ -85,6 +85,7 @@
{% if ledger_entry in ["amendments", "depositpreauth", "escrow"] %}
{# objects where the naive URL is already taken #}
[{{ledger_entry}} object]: {{ledger_entry|lower}}-object.html
[{{ledger_entry}} entry]: {{ledger_entry|lower}}-object.html
{% if target.lang == "ja" %}
[{{ledger_entry}}オブジェクト]: {{ledger_entry|lower}}-object.html
[{{ledger_entry}} オブジェクト]: {{ledger_entry|lower}}-object.html

View File

@@ -37,7 +37,7 @@ Objects that count towards their owner's reserve requirement include: [Checks](c
Some special cases:
- Non-Fungible Tokens (NFTs) are grouped into pages containing up to 32 NFTs each, and the owner reserve applies per page rather than per NFT. Due to the mechanism for splitting and combining pages, the number of NFTs actually stored per page varies. See also: [Reserve for NFTokenPage objects](nftokenpage.html#reserve-for-nftokenpage-objects).
- Non-Fungible Tokens (NFTs) are grouped into pages containing up to 32 NFTs each, and the owner reserve applies per page rather than per NFT. Due to the mechanism for splitting and combining pages, the number of NFTs actually stored per page varies. See also: [Reserve for NFTokenPage objects](nftokenpage.html#nftokenpage-reserve).
- Trust lines (`RippleState` entries) are shared between two accounts. The owner reserve can apply to one or both of them. Most often, the token holder owes a reserve and the issuer does not. See also: [RippleState: Contributing to the Owner Reserve](ripplestate.html#contributing-to-the-owner-reserve).
- Signer lists created before the [MultiSignReserve amendment][] activated in April 2019 count as multiple objects. See also: [Signer Lists and Reserves](signerlist.html#signer-lists-and-reserves).
- An [Owner Directory](directorynode.html) is a ledger entry that lists all objects related to an account, including all objects the account owns. However, the owner directory itself does not count towards the reserve.
@@ -51,7 +51,7 @@ Applications can look up the current base and incremental reserve values using t
| [server_info method][] | Decimal XRP | `validated_ledger.reserve_base_xrp` | `validated_ledger.reserve_inc_xrp` |
| [server_state method][] | Integer drops of XRP | `validated_ledger.reserve_base` | `validated_ledger.reserve_inc` |
To determine the owner reserve of an account, multiply the incremental reserve by the number of objects the account owns. To look up the number of objects an account owns, call the [account_info method][] and take `account_data.OwnerCount`.
To determine the owner reserve of an account, multiply the incremental reserve by the number of objects the account owns. To look up the number of objects an account owns, call the [account_info method][] and take `account_data.OwnerCount`.
To calculate an address's total reserve requirement, multiply `OwnerCount` by `reserve_inc_xrp`, then add `reserve_base_xrp`. [Here is a demonstration](build-a-desktop-wallet-in-python.html#codeblock-17) of this calculation in Python.

View File

@@ -9,7 +9,7 @@ Each [ledger version](ledgers.html) in the XRP Ledger is made up of three parts:
- **[Ledger Header](ledger-header.html)**: Data about this ledger version itself.
- **[Transaction Set](transaction-formats.html)**: The transactions that were executed to create this ledger version.
- **[State Data](ledger-entries.html)**: A list of ledger entries, representing all accounts, settings, and balances as of this ledger version. (This is also called the "account state".)
- **[State Data](ledger-entry-types.html)**: A list of ledger entries, representing all accounts, settings, and balances as of this ledger version. (This is also called the "account state".)
## State Data

View File

@@ -61,7 +61,7 @@ In addition to the [common fields](ledger-entry-common-fields.html), `{{currentp
| `WalletLocator` | String | Hash256 | No | An arbitrary 256-bit value that users can set. |
| `WalletSize` | Number | UInt32 | No | Unused. (The code supports this field but there is no way to set it.) |
## Special AMM AccountRoot Objects
## Special AMM AccountRoot Entries
_(Requires the [AMM amendment][] :not_enabled:)_

View File

@@ -11,7 +11,7 @@ status: not_enabled
_(Requires the [AMM amendment][] :not_enabled:)_
An `AMM` ledger entry describes a single [Automated Market Maker](automated-market-makers.html) (AMM) instance. This is always paired with a [special AccountRoot entry](#special-amm-accountroot-objects).
An `AMM` ledger entry describes a single [Automated Market Maker](automated-market-makers.html) (AMM) instance. This is always paired with a [special AccountRoot entry](accountroot.html#special-amm-accountroot-entries).
## Example AMM JSON
@@ -75,7 +75,7 @@ In addition to the [common fields](ledger-entry-common-fields.html), `{{currentp
|:-----------------|:--------------------|:------------------|:----------|--------------|
| `Asset` | Object | STIssue | Yes | The definition for one of the two assets this AMM holds. In JSON, this is an object with `currency` and `issuer` fields. |
| `Asset2` | Object | STIssue | Yes | The definition for the other asset this AMM holds. In JSON, this is an object with `currency` and `issuer` fields. |
| `AMMAccount` | String | AccountID | Yes | The address of the [special account](accountroot.html#special-amm-accountroot-objects) that holds this AMM's assets. |
| `AMMAccount` | String | AccountID | Yes | The address of the [special account](accountroot.html#special-amm-accountroot-entries) that holds this AMM's assets. |
| `AuctionSlot` | Object | STObject | No | Details of the current owner of the auction slot, as an [Auction Slot object](#auction-slot-object). |
| `LPTokenBalance` | [Currency Amount][] | Amount | Yes | The total outstanding balance of liquidity provider tokens from this AMM instance. The holders of these tokens can vote on the AMM's trading fee in proportion to their holdings, or redeem the tokens for a share of the AMM's assets which grows with the trading fees collected. |
| `TradingFee` | Number | UInt16 | Yes | The percentage fee to be charged for trades against this AMM instance, in units of 1/100,000. The maximum value is 1000, for a 1% fee. |

View File

@@ -3,6 +3,6 @@ html: ledger-entry-types.html
parent: ledger-data-formats.html
template: pagetype-category.html.jinja
---
# Ledger Object Types
# Ledger Entry Types
{% include '_snippets/ledger-objects-intro.md' %}

View File

@@ -13,7 +13,7 @@ _(Requires the [AMM amendment][] :not_enabled:)_
Create a new [Automated Market Maker](automated-market-makers.html) (AMM) instance for trading a pair of assets ([fungible tokens](tokens.html) or [XRP](xrp.html)).
Creates both an [AMM object][] and a [special AccountRoot object](accountroot.html#special-amm-accountroot-objects) to represent the AMM. Also transfers ownership of the starting balance of both assets from the sender to the created `AccountRoot` and issues an initial balance of liquidity provider tokens (LP Tokens) from the AMM account to the sender.
Creates both an [AMM entry][] and a [special AccountRoot entry](accountroot.html#special-amm-accountroot-entries) to represent the AMM. Also transfers ownership of the starting balance of both assets from the sender to the created `AccountRoot` and issues an initial balance of liquidity provider tokens (LP Tokens) from the AMM account to the sender.
**Caution:** When you create the AMM, you should fund it with (approximately) equal-value amounts of each asset. Otherwise, other users can profit at your expense by trading with this AMM ([performing arbitrage](https://www.machow.ski/posts/an_introduction_to_automated_market_makers/#price-arbitrage)). The currency risk that liquidity providers take on increases with the volatility (potential for imbalance) of the asset pair. The higher the trading fee, the more it offsets this risk, so it's best to set the trading fee based on the volatility of the asset pair.

View File

@@ -2434,6 +2434,12 @@ pages:
targets:
- ja
# TODO: translate
- md: references/protocol-reference/ledger-data/ledger-entry-common-fields.md
targets:
- en
- ja
- md: references/protocol-reference/ledger-data/ledger-entry-types/ledger-entry-types.md
targets:
- en
@@ -2442,12 +2448,6 @@ pages:
targets:
- ja
# TODO: translate
- md: references/protocol-reference/ledger-data/ledger-entry-types/ledger-entry-types.md
targets:
- en
- ja
# redirect from old "ledger object types" URL
- name: Ledger Entry Types
html: ledger-object-types.html