fix ledger data format landing

This commit is contained in:
Jennifer Hasegawa
2018-05-16 18:26:21 -07:00
parent bd4d55a36c
commit 529cd1f13c
3 changed files with 68 additions and 29 deletions

View File

@@ -1,4 +1,4 @@
# Ledger Data Formats
# Ledgers
The XRP Ledger is a shared, global ledger that is open to all. Individual participants can trust the integrity of the ledger without having to trust any single institution to manage it. The `rippled` server software accomplishes this by managing a ledger database that can only be updated according to very specific rules. Each instance of `rippled` keeps a full copy of the ledger, and the peer-to-peer network of `rippled` servers distributes candidate transactions among themselves. The consensus process determines which transactions get applied to each new version of the ledger. See also: [The Consensus Process](consensus.html).
@@ -31,6 +31,6 @@ All objects in a ledger' state tree have a unique ID. This field is returned as
![Diagram: rippled uses SHA-512Half to generate IDs for ledger objects. The space key prevents IDs for different object types from colliding.](img/ledger-indexes.png)
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -1,17 +1,47 @@
# Ledger Object Types
There are several different kinds of objects that can appear in the ledger's state tree:
Following are the different kinds of objects that can appear in the ledger's state tree. Each ledger object consists of several fields. In the peer protocol that `rippled` servers use to communicate with each other, ledger objects are represented in their raw binary format. In the [`rippled` API](rippled-api.html), ledger objects are represented as JSON objects.
* [**AccountRoot** - The settings, XRP balance, and other metadata for one account.](accountroot.html)
* [**Amendments** - Singleton object with status of enabled and pending amendments.](amendments.html)
* [**Check** - A check that can be redeemed for money by its destination.](check.html)
* [**DirectoryNode** - Contains links to other objects.](directorynode.html)
* [**Escrow** - Contains XRP held for a conditional payment.](escrow.html)
* [**FeeSettings** - Singleton object with consensus-approved base transaction cost and reserve requirements.](feesettings.html)
* [**LedgerHashes** - Lists of prior ledger versions' hashes for history lookup.](ledgerhashes.html)
* [**Offer** - An offer to exchange currencies, known in finance as an _order_.](offer.html)
* [**PayChannel** - A channel for asynchronous XRP payments.](paychannel.html)
* [**RippleState** - Links two accounts, tracking the balance of one currency between them. The concept of a _trust line_ is really an abstraction of this object type.](ripplestate.html)
* [**SignerList** - A list of addresses for multi-signing transactions.](signerlist.html)
* [**AccountRoot**](accountroot.html)
Each ledger object consists of several fields. In the peer protocol that `rippled` servers use to communicate with each other, ledger objects are represented in their raw binary format. In the [`rippled` API](rippled-api.html), ledger objects are represented as JSON objects.
The settings, XRP balance, and other metadata for one account.
* [**Amendments**](amendments.html)
Singleton object with status of enabled and pending amendments.
* [**Check**](check.html)
A check that can be redeemed for money by its destination.
* [**DirectoryNode**](directorynode.html)
Contains links to other objects.
* [**Escrow**](escrow.html)
Contains XRP held for a conditional payment.
* [**FeeSettings**](feesettings.html)
Singleton object with consensus-approved base transaction cost and reserve requirements.
* [**LedgerHashes**](ledgerhashes.html)
Lists of prior ledger versions' hashes for history lookup.
* [**Offer**](offer.html)
An offer to exchange currencies, known in finance as an _order_.
* [**PayChannel**](paychannel.html)
A channel for asynchronous XRP payments.
* [**RippleState**](ripplestate.html)
Links two accounts, tracking the balance of one currency between them. The concept of a _trust line_ is really an abstraction of this object type.
* [**SignerList**](signerlist.html)
A list of addresses for multi-signing transactions.

View File

@@ -189,6 +189,15 @@ pages:
targets:
- local
- md: concepts/payment-system-basics/ledgers.md
html: ledgers.html
funnel: Docs
doc_type: Concepts
category: Payment System Basics
blurb: The XRP Ledger is composed of a series of individual ledgers, or ledger versions, which rippled keeps in its internal database. Learn about the structure and contents of these ledgers.
targets:
- local
- md: concepts/payment-system-basics/transaction-basics/transaction-basics.md
html: transaction-basics.html
funnel: Docs
@@ -1769,7 +1778,7 @@ pages:
targets:
- local
- md: references/rippled-api/ledger-data-formats/ledger-data-formats.md
- name: Ledger Data Formats
html: ledger-data-formats.html
funnel: Docs
doc_type: References
@@ -1797,7 +1806,7 @@ pages:
supercategory: rippled API
category: Ledger Data Formats
subcategory: Ledger Object Types
template: template-landing-children.html #TODO: consider dropping the md since the page children handles this OK
# template: template-landing-children.html #TODO: consider dropping the md since the page children handles this OK
blurb: Specifications for the types of objects that can be stored in a ledger's state tree.
targets:
- local
@@ -1809,7 +1818,7 @@ pages:
supercategory: rippled API
category: Ledger Data Formats
subcategory: Ledger Object Types
blurb: The settings, XRP balance, and other metadata for one account.
# blurb: The settings, XRP balance, and other metadata for one account.
targets:
- local
@@ -1820,7 +1829,7 @@ pages:
supercategory: rippled API
category: Ledger Data Formats
subcategory: Ledger Object Types
blurb: Singleton object with status of enabled and pending amendments.
# blurb: Singleton object with status of enabled and pending amendments.
targets:
- local
@@ -1831,7 +1840,7 @@ pages:
supercategory: rippled API
category: Ledger Data Formats
subcategory: Ledger Object Types
blurb: A check that can be redeemed for money by its destination.
# blurb: A check that can be redeemed for money by its destination.
targets:
- local
@@ -1842,7 +1851,7 @@ pages:
supercategory: rippled API
category: Ledger Data Formats
subcategory: Ledger Object Types
blurb: Contains links to other objects.
# blurb: Contains links to other objects.
targets:
- local
@@ -1853,7 +1862,7 @@ pages:
supercategory: rippled API
category: Ledger Data Formats
subcategory: Ledger Object Types
blurb: Contains XRP held for a conditional payment.
# blurb: Contains XRP held for a conditional payment.
targets:
- local
@@ -1864,7 +1873,7 @@ pages:
supercategory: rippled API
category: Ledger Data Formats
subcategory: Ledger Object Types
blurb: Singleton object with consensus-approved base transaction cost and reserve requirements.
# blurb: Singleton object with consensus-approved base transaction cost and reserve requirements.
targets:
- local
@@ -1875,7 +1884,7 @@ pages:
supercategory: rippled API
category: Ledger Data Formats
subcategory: Ledger Object Types
blurb: Lists of prior ledger versions' hashes for history lookup.
# blurb: Lists of prior ledger versions' hashes for history lookup.
targets:
- local
@@ -1886,7 +1895,7 @@ pages:
supercategory: rippled API
category: Ledger Data Formats
subcategory: Ledger Object Types
blurb: An order to make a currency trade.
# blurb: An order to make a currency trade.
targets:
- local
@@ -1897,7 +1906,7 @@ pages:
supercategory: rippled API
category: Ledger Data Formats
subcategory: Ledger Object Types
blurb: A channel for asynchronous XRP payments.
# blurb: A channel for asynchronous XRP payments.
targets:
- local
@@ -1908,7 +1917,7 @@ pages:
supercategory: rippled API
category: Ledger Data Formats
subcategory: Ledger Object Types
blurb: Links two accounts, tracking the balance of one currency between them. The concept of a trust line is an abstraction of this object type.
# blurb: Links two accounts, tracking the balance of one currency between them. The concept of a trust line is an abstraction of this object type.
targets:
- local
@@ -1919,7 +1928,7 @@ pages:
supercategory: rippled API
category: Ledger Data Formats
subcategory: Ledger Object Types
blurb: A list of addresses for multi-signing transactions.
# blurb: A list of addresses for multi-signing transactions.
targets:
- local