From e444d7248fe77975acffef1dd2c43afc76a3ae31 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Mon, 2 Nov 2015 17:45:44 -0800 Subject: [PATCH] reserves - first draft --- charts-api-tool.html | 3 + charts_api.html | 3 + content/reserves.md | 35 +++++++ data-api-v2-tool.html | 3 + data_api_v2.html | 3 + fees.html | 3 + gateway_guide.html | 3 + historical_data.html | 3 + historicaldb-api-tool.html | 3 + index.html | 3 + paths.html | 3 + reliable_tx.html | 3 + reserves.html | 197 +++++++++++++++++++++++++++++++++++++ rest-api-tool.html | 3 + ripple-api-tool.html | 3 + ripple-ledger.html | 3 + ripple-rest.html | 3 + rippled-apis.html | 3 + rippled-setup.html | 3 + tool/pages.json | 9 +- transactions.html | 3 + transfer_fees.html | 3 + tx-cost.html | 3 + 23 files changed, 300 insertions(+), 1 deletion(-) create mode 100644 content/reserves.md create mode 100644 reserves.html diff --git a/charts-api-tool.html b/charts-api-tool.html index 14eddc39f5..9e5fbf4a89 100644 --- a/charts-api-tool.html +++ b/charts-api-tool.html @@ -58,6 +58,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -71,6 +72,7 @@
  • API Tools
    diff --git a/charts_api.html b/charts_api.html index ddf5825766..945a93a9c3 100644 --- a/charts_api.html +++ b/charts_api.html @@ -85,6 +85,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -98,6 +99,7 @@
  • API Tools
    diff --git a/content/reserves.md b/content/reserves.md new file mode 100644 index 0000000000..8ff7bc82ec --- /dev/null +++ b/content/reserves.md @@ -0,0 +1,35 @@ +# Reserves # + +The Ripple Consensus Ledger applies _reserve requirements_, in XRP, to protect the shared global ledger from growing too large to handle efficiently as the result of spam or malicious usage. The goal is to constrain the growth of the ledger to match [Moore's Law](https://en.wikipedia.org/wiki/Moore's_law) so that a current commodity-level machinec an always fit the current ledger in RAM and the full ledger history on disk. + +Each account in the shared global ledger must hold a minimum of XRP in order to submit transactions, and it cannot send this XRP to other accounts. You cannot create a new account unless you send enough XRP to meet the minimum reserve requirement. + + +## Base Reserve and Owner Reserve ## + +The reserve requirement is divided into two parts: + +* The **Base Reserve** is a static minimum amount of XRP that is required for every account in the ledger. Currently, this is 20 XRP (`20000000` drops). +* The **Owner Reserve** is an additional requirement that scales with the number of objects that the account owns in the ledger. Currently, this is 5 XRP (`5000000` drops) per item. + + +### Owner Reserves ### + +Many objects in the ledger are owned by a particular account, and therefore count toward the reserve requirement of that account. When objects are removed from the ledger, they no longer count against their owner's account reserve. + +* [Offers](ripple-ledger.html#offer) are owned by the account that placed them. An Offer can be automatically removed from the ledger if it is fully consumed or if it is found unfunded during transaction processing. Alternatively, the owner can cancel an offer by sending an [OfferCancel transaction](transactions.html#offercancel), or by sending an [OfferCreate transaction](transactions.html#offercreate) that contains an `OfferSequence` parameter. +* [Trust lines](ripple-ledger.html#ripplestate) are shared between two accounts. The owner reserve can apply to one or both of the accounts, depending on whether the fields that account controls are in their default state. See [Contributing to the Owner Reserve](ripple-ledger.html#contributing-to-the-owner-reserve) for details. +* [Owner directories](ripple-ledger.html#directorynode) list all the ledger nodes that contribute to an account's owner reserve. However, the owner directory itself does not count towards the reserve. + +#### Owner Reserve Edge Cases #### + +The Ripple Consensus Ledger considers an [OfferCreate transaction](transactions.html#offercreate) to be an explicit statement of willingness to hold an asset. Consuming the offer automatically creates a trust line (with limit 0, and a balance above that limit) for the `taker_pays` currency if such a trust line does not exist. However, if the offer's owner does not possess enough XRP to meet the additional reserve requirement of the new trust line, the offer is considered unfunded. See also: [Lifecycle of an Offer](transactions.html#lifecycle-of-an-offer). + + + +## Going Below the Reserve Requirement ## + +During transaction processing, a transaction can only be successful if the sending account possesses at least the reserve requirement in XRP. In the process, the [transaction cost](tx-cost.html) destroys some of the sending account's XRP balance. This can cause an account to go below the reserve requirement. + +When an account has less XRP than its current reserve requirement, it continues to exist in the ledger, but it cannot send new transactions. Unless the reserve requirements decrease, the only way for the account to become able to send transactions again is for it to receive enough XRP that it meets the reserve requirement. + diff --git a/data-api-v2-tool.html b/data-api-v2-tool.html index 9402df7abe..1863f70b81 100644 --- a/data-api-v2-tool.html +++ b/data-api-v2-tool.html @@ -58,6 +58,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -71,6 +72,7 @@
  • API Tools
    diff --git a/data_api_v2.html b/data_api_v2.html index 1eba07ac84..7ad41d86d6 100644 --- a/data_api_v2.html +++ b/data_api_v2.html @@ -85,6 +85,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -98,6 +99,7 @@
  • API Tools
    diff --git a/fees.html b/fees.html index b29d3672e6..024bc1f05a 100644 --- a/fees.html +++ b/fees.html @@ -85,6 +85,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -98,6 +99,7 @@
  • API Tools
    diff --git a/gateway_guide.html b/gateway_guide.html index 722fda164f..a1ebef96bb 100644 --- a/gateway_guide.html +++ b/gateway_guide.html @@ -85,6 +85,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -98,6 +99,7 @@
  • API Tools
    diff --git a/historical_data.html b/historical_data.html index 489e26ef2b..626dbe097d 100644 --- a/historical_data.html +++ b/historical_data.html @@ -85,6 +85,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -98,6 +99,7 @@
  • API Tools
    diff --git a/historicaldb-api-tool.html b/historicaldb-api-tool.html index 336181db50..fa7efa5726 100644 --- a/historicaldb-api-tool.html +++ b/historicaldb-api-tool.html @@ -58,6 +58,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -71,6 +72,7 @@
  • API Tools
    diff --git a/index.html b/index.html index 5b8bbd57ea..80f4714886 100644 --- a/index.html +++ b/index.html @@ -71,6 +71,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -84,6 +85,7 @@
  • API Tools
    diff --git a/paths.html b/paths.html index 19ca7b63cf..fabd879b7c 100644 --- a/paths.html +++ b/paths.html @@ -85,6 +85,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -98,6 +99,7 @@
  • API Tools
    diff --git a/reliable_tx.html b/reliable_tx.html index e7a8d91f9b..ae0adb12a2 100644 --- a/reliable_tx.html +++ b/reliable_tx.html @@ -85,6 +85,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -98,6 +99,7 @@
  • API Tools
    diff --git a/reserves.html b/reserves.html new file mode 100644 index 0000000000..a72accb18f --- /dev/null +++ b/reserves.html @@ -0,0 +1,197 @@ + + + + + + + + Reserves - Ripple Developer Portal + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + + + diff --git a/rest-api-tool.html b/rest-api-tool.html index 3a6e6a863f..e4c3b7daa5 100644 --- a/rest-api-tool.html +++ b/rest-api-tool.html @@ -58,6 +58,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -71,6 +72,7 @@
  • API Tools
    diff --git a/ripple-api-tool.html b/ripple-api-tool.html index ede5866d46..b47339c916 100644 --- a/ripple-api-tool.html +++ b/ripple-api-tool.html @@ -58,6 +58,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -71,6 +72,7 @@
  • API Tools
    diff --git a/ripple-ledger.html b/ripple-ledger.html index 19a0e461bf..3ba5c0e185 100644 --- a/ripple-ledger.html +++ b/ripple-ledger.html @@ -85,6 +85,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -98,6 +99,7 @@
  • API Tools
    diff --git a/ripple-rest.html b/ripple-rest.html index f815048cc9..6d195d925e 100644 --- a/ripple-rest.html +++ b/ripple-rest.html @@ -85,6 +85,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -98,6 +99,7 @@
  • API Tools
    diff --git a/rippled-apis.html b/rippled-apis.html index 3f3fa37063..c81d8e3303 100644 --- a/rippled-apis.html +++ b/rippled-apis.html @@ -85,6 +85,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -98,6 +99,7 @@
  • API Tools
    diff --git a/rippled-setup.html b/rippled-setup.html index 3a1a07927d..84501d665e 100644 --- a/rippled-setup.html +++ b/rippled-setup.html @@ -85,6 +85,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -98,6 +99,7 @@
  • API Tools
    diff --git a/tool/pages.json b/tool/pages.json index f7c5ab59a2..4121cc9a5f 100644 --- a/tool/pages.json +++ b/tool/pages.json @@ -92,6 +92,7 @@ "name": "Fees (Disambiguation)", "md": "fees.md", "html": "fees.html", + "ripple.com": "https://ripple.com/knowledge_center/fees-disambiguation/", "category": "References" }, { @@ -107,11 +108,17 @@ "html": "tx-cost.html", "category": "References" }, + { + "name": "Reserves", + "md": "reserves.md", + "html": "reserves.html", + "category": "References" + }, { "name": "Ripple-REST API Tool", "template":"template-rest-api-tool.html", "methods_js": "js/apitool-methods-ripplerest.js", - "is_apitool": true, + "category": "API Tools", "rest_host": "https://api.ripple.com", "ripple.com": "https://ripple.com/build/rest-tool/", "html": "rest-api-tool.html", diff --git a/transactions.html b/transactions.html index 5c33d885a9..3de9abcde3 100644 --- a/transactions.html +++ b/transactions.html @@ -85,6 +85,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -98,6 +99,7 @@
  • API Tools
    diff --git a/transfer_fees.html b/transfer_fees.html index c8df1c7b4e..f54ccf415d 100644 --- a/transfer_fees.html +++ b/transfer_fees.html @@ -85,6 +85,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -98,6 +99,7 @@
  • API Tools
    diff --git a/tx-cost.html b/tx-cost.html index 99da6ee27b..4be4423104 100644 --- a/tx-cost.html +++ b/tx-cost.html @@ -85,6 +85,7 @@
  • Fees (Disambiguation)
  • Transfer Fees
  • Transaction Cost
    • +
  • Reserves
  • @@ -98,6 +99,7 @@
  • API Tools