|
xrpld
|
Holds a ledger. More...
#include <Ledger.h>


Classes | |
| class | SlesIterImpl |
| class | TxsIterImpl |
Public Types | |
| using | digest_type = uint256 |
| using | tx_type = std::pair<std::shared_ptr<STTx const>, std::shared_ptr<STObject const>> |
| using | key_type = uint256 |
| using | mapped_type = SLE::const_pointer |
Public Member Functions | |
| Ledger (Ledger const &)=delete | |
| Ledger & | operator= (Ledger const &)=delete |
| Ledger (Ledger &&)=delete | |
| Ledger & | operator= (Ledger &&)=delete |
| Ledger (CreateGenesisT, Rules rules, Fees const &fees, std::vector< uint256 > const &amendments, Family &family) | |
| Create the Genesis ledger. | |
| Ledger (LedgerHeader const &info, Rules rules, Family &family) | |
| Ledger (LedgerHeader const &info, bool &loaded, bool acquire, Rules rules, Fees const &fees, Family &family, beast::Journal j) | |
| Used for ledgers loaded from JSON files. | |
| Ledger (Ledger const &previous, NetClock::time_point closeTime) | |
| Create a new ledger following a previous ledger. | |
| Ledger (std::uint32_t ledgerSeq, NetClock::time_point closeTime, Rules rules, Fees const &fees, Family &family) | |
| ~Ledger () override=default | |
| bool | open () const override |
| Returns true if this reflects an open ledger. | |
| LedgerHeader const & | header () const override |
| Returns information about the ledger. | |
| void | setLedgerInfo (LedgerHeader const &info) |
| Fees const & | fees () const override |
| Returns the fees for the base ledger. | |
| Rules const & | rules () const override |
| Returns the tx processing rules. | |
| bool | exists (Keylet const &k) const override |
| Determine if a state item exists. | |
| bool | exists (uint256 const &key) const |
| std::optional< uint256 > | succ (uint256 const &key, std::optional< uint256 > const &last=std::nullopt) const override |
| SLE::const_pointer | read (Keylet const &k) const override |
| Return the state item associated with a key. | |
| std::unique_ptr< SlesType::iter_base > | slesBegin () const override |
| std::unique_ptr< SlesType::iter_base > | slesEnd () const override |
| std::unique_ptr< SlesType::iter_base > | slesUpperBound (uint256 const &key) const override |
| std::unique_ptr< TxsType::iter_base > | txsBegin () const override |
| std::unique_ptr< TxsType::iter_base > | txsEnd () const override |
| bool | txExists (uint256 const &key) const override |
| tx_type | txRead (key_type const &key) const override |
| Read a transaction from the tx map. | |
| std::optional< digest_type > | digest (key_type const &key) const override |
| Return the digest associated with the key. | |
| void | rawErase (SLE::ref sle) override |
| Delete an existing state item. | |
| void | rawInsert (SLE::ref sle) override |
| Unconditionally insert a state item. | |
| void | rawErase (uint256 const &key) |
| void | rawReplace (SLE::ref sle) override |
| Unconditionally replace a state item. | |
| void | rawDestroyXRP (XRPAmount const &fee) override |
| Destroy XRP. | |
| void | rawTxInsert (uint256 const &key, std::shared_ptr< Serializer const > const &txn, std::shared_ptr< Serializer const > const &metaData) override |
| void | setValidated () const |
| void | setAccepted (NetClock::time_point closeTime, NetClock::duration closeResolution, bool correctCloseTime) |
| void | setImmutable (bool rehash=true) |
| bool | isImmutable () const |
| void | setFull () const |
| void | setTotalDrops (std::uint64_t totDrops) |
| SHAMap const & | stateMap () const |
| SHAMap & | stateMap () |
| SHAMap const & | txMap () const |
| SHAMap & | txMap () |
| bool | addSLE (SLE const &sle) |
| void | updateSkipList () |
| bool | walkLedger (beast::Journal j, bool parallel=false) const |
| bool | isSensible () const |
| void | invariants () const |
| void | unshare () const |
| hash_set< PublicKey > | negativeUNL () const |
| get Negative UNL validators' master public keys | |
| std::optional< PublicKey > | validatorToDisable () const |
| get the to be disabled validator's master public key if any | |
| std::optional< PublicKey > | validatorToReEnable () const |
| get the to be re-enabled validator's master public key if any | |
| void | updateNegativeUNL () |
| update the Negative UNL ledger component. | |
| bool | isFlagLedger () const |
| Returns true if the ledger is a flag ledger. | |
| bool | isVotingLedger () const |
| Returns true if the ledger directly precedes a flag ledger. | |
| SLE::pointer | peek (Keylet const &k) const |
| T | shared_from_this (T... args) |
| T | weak_from_this (T... args) |
| NetClock::time_point | parentCloseTime () const |
| Returns the close time of the previous ledger. | |
| LedgerIndex | seq () const |
| Returns the sequence number of the base ledger. | |
| virtual std::optional< key_type > | succ (key_type const &key, std::optional< key_type > const &last=std::nullopt) const =0 |
| Return the key of the next state item. | |
| virtual STAmount | balanceHookIOU (AccountID const &account, AccountID const &issuer, STAmount const &amount) const |
| virtual STAmount | balanceHookMPT (AccountID const &account, MPTIssue const &issue, std::int64_t amount) const |
| virtual STAmount | balanceHookSelfIssueMPT (MPTIssue const &issue, std::int64_t amount) const |
| virtual std::uint32_t | ownerCountHook (AccountID const &account, std::uint32_t count) const |
| virtual std::unique_ptr< SlesType::iter_base > | slesUpperBound (key_type const &key) const =0 |
| virtual bool | txExists (key_type const &key) const =0 |
| Returns true if a tx exists in the tx map. | |
| virtual void | rawTxInsert (ReadView::key_type const &key, std::shared_ptr< Serializer const > const &txn, std::shared_ptr< Serializer const > const &metaData)=0 |
| Add a transaction to the tx map. | |
Public Attributes | |
| SlesType | sles |
| Iterable range of ledger state items. | |
| TxsType | txs |
| friend | Object |
Private Member Functions | |
| bool | setup () |
Static Private Member Functions | |
| static std::shared_ptr< STTx const > | deserializeTx (SHAMapItem const &item) |
| Deserialize a SHAMapItem containing a single STTx. | |
| static std::pair< std::shared_ptr< STTx const >, std::shared_ptr< STObject const > > | deserializeTxPlusMeta (SHAMapItem const &item) |
| Deserialize a SHAMapItem containing STTx + STObject metadata. | |
| static auto & | getCounter () noexcept |
Private Attributes | |
| bool | immutable_ |
| SHAMap | txMap_ |
| SHAMap | stateMap_ |
| std::mutex | mutex_ |
| Fees | fees_ |
| Rules | rules_ |
| LedgerHeader | header_ |
| beast::Journal | j_ |
Holds a ledger.
The ledger is composed of two SHAMaps. The state map holds all of the ledger entries such as account roots and order books. The tx map holds all of the transactions and associated metadata that made it into that particular ledger. Most of the operations on a ledger are concerned with the state map.
This can hold just the header, a partial set of data, or the entire set of data. It all depends on what is in the corresponding SHAMap entry. Various functions are provided to populate or depopulate the caches that the object holds references to.
Ledgers are constructed as either mutable or immutable.
1) If you are the sole owner of a mutable ledger, you can do whatever you want with no need for locks.
2) If you have an immutable ledger, you cannot ever change it, so no need for locks.
3) Mutable ledgers cannot be shared.
Definition at line 55 of file include/xrpl/ledger/Ledger.h.
|
inherited |
Definition at line 251 of file ReadView.h.
|
inherited |
Definition at line 33 of file ReadView.h.
|
inherited |
Definition at line 35 of file ReadView.h.
|
inherited |
Definition at line 37 of file ReadView.h.
|
delete |
|
delete |
| xrpl::Ledger::Ledger | ( | CreateGenesisT | , |
| Rules | rules, | ||
| Fees const & | fees, | ||
| std::vector< uint256 > const & | amendments, | ||
| Family & | family ) |
Create the Genesis ledger.
The Genesis ledger contains a single account whose AccountID is generated with a Generator using the seed computed from the string "masterpassphrase" and ordinal zero.
The account has an XRP balance equal to the total amount of XRP in the system. No more XRP than the amount which starts in this account can ever exist, with amounts used to pay fees being destroyed.
Amendments specified are enabled in the genesis ledger
Definition at line 148 of file libxrpl/ledger/Ledger.cpp.
| xrpl::Ledger::Ledger | ( | LedgerHeader const & | info, |
| Rules | rules, | ||
| Family & | family ) |
Definition at line 281 of file libxrpl/ledger/Ledger.cpp.
| xrpl::Ledger::Ledger | ( | LedgerHeader const & | info, |
| bool & | loaded, | ||
| bool | acquire, | ||
| Rules | rules, | ||
| Fees const & | fees, | ||
| Family & | family, | ||
| beast::Journal | j ) |
Used for ledgers loaded from JSON files.
| acquire | If true, acquires the ledger if not found locally |
Definition at line 208 of file libxrpl/ledger/Ledger.cpp.
| xrpl::Ledger::Ledger | ( | Ledger const & | previous, |
| NetClock::time_point | closeTime ) |
Create a new ledger following a previous ledger.
The ledger will have the sequence number that follows previous, and have parentCloseTime == previous.closeTime.
Definition at line 254 of file libxrpl/ledger/Ledger.cpp.
| xrpl::Ledger::Ledger | ( | std::uint32_t | ledgerSeq, |
| NetClock::time_point | closeTime, | ||
| Rules | rules, | ||
| Fees const & | fees, | ||
| Family & | family ) |
Definition at line 292 of file libxrpl/ledger/Ledger.cpp.
|
overridedefault |
|
overridevirtual |
Returns true if this reflects an open ledger.
Implements xrpl::ReadView.
Definition at line 131 of file include/xrpl/ledger/Ledger.h.
|
overridevirtual |
Returns information about the ledger.
Implements xrpl::ReadView.
Definition at line 137 of file include/xrpl/ledger/Ledger.h.
| void xrpl::Ledger::setLedgerInfo | ( | LedgerHeader const & | info | ) |
Definition at line 143 of file include/xrpl/ledger/Ledger.h.
|
overridevirtual |
Returns the fees for the base ledger.
Implements xrpl::ReadView.
Definition at line 149 of file include/xrpl/ledger/Ledger.h.
|
overridevirtual |
Returns the tx processing rules.
Implements xrpl::ReadView.
Definition at line 155 of file include/xrpl/ledger/Ledger.h.
|
overridevirtual |
Determine if a state item exists.
Implements xrpl::ReadView.
Definition at line 381 of file libxrpl/ledger/Ledger.cpp.
| bool xrpl::Ledger::exists | ( | uint256 const & | key | ) | const |
Definition at line 388 of file libxrpl/ledger/Ledger.cpp.
|
override |
Definition at line 394 of file libxrpl/ledger/Ledger.cpp.
|
overridevirtual |
Return the state item associated with a key.
Effects: If the key exists, gives the caller ownership of the non-modifiable corresponding SLE.
Implements xrpl::ReadView.
Definition at line 405 of file libxrpl/ledger/Ledger.cpp.
|
overridevirtual |
Implements xrpl::ReadView.
Definition at line 426 of file libxrpl/ledger/Ledger.cpp.
|
overridevirtual |
Implements xrpl::ReadView.
Definition at line 432 of file libxrpl/ledger/Ledger.cpp.
|
override |
Definition at line 438 of file libxrpl/ledger/Ledger.cpp.
|
overridevirtual |
Implements xrpl::ReadView.
Definition at line 444 of file libxrpl/ledger/Ledger.cpp.
|
overridevirtual |
Implements xrpl::ReadView.
Definition at line 450 of file libxrpl/ledger/Ledger.cpp.
|
override |
Definition at line 456 of file libxrpl/ledger/Ledger.cpp.
|
overridevirtual |
Read a transaction from the tx map.
If the view represents an open ledger, the metadata object will be empty.
Implements xrpl::ReadView.
Definition at line 462 of file libxrpl/ledger/Ledger.cpp.
|
overridevirtual |
Return the digest associated with the key.
Implements xrpl::DigestAwareReadView.
Definition at line 476 of file libxrpl/ledger/Ledger.cpp.
|
overridevirtual |
Delete an existing state item.
The SLE is provided so the implementation can calculate metadata.
Implements xrpl::RawView.
Definition at line 489 of file libxrpl/ledger/Ledger.cpp.
|
overridevirtual |
Unconditionally insert a state item.
Requirements: The key must not already exist.
Effects:
The key is associated with the SLE.
Implements xrpl::RawView.
Definition at line 503 of file libxrpl/ledger/Ledger.cpp.
| void xrpl::Ledger::rawErase | ( | uint256 const & | key | ) |
Definition at line 496 of file libxrpl/ledger/Ledger.cpp.
|
overridevirtual |
Unconditionally replace a state item.
Requirements:
The key must exist.
Effects:
The key is associated with the SLE.
Implements xrpl::RawView.
Definition at line 515 of file libxrpl/ledger/Ledger.cpp.
|
overridevirtual |
Destroy XRP.
This is used to pay for transaction fees.
Implements xrpl::RawView.
Definition at line 217 of file include/xrpl/ledger/Ledger.h.
|
override |
Definition at line 527 of file libxrpl/ledger/Ledger.cpp.
| void xrpl::Ledger::setValidated | ( | ) | const |
Definition at line 235 of file include/xrpl/ledger/Ledger.h.
| void xrpl::Ledger::setAccepted | ( | NetClock::time_point | closeTime, |
| NetClock::duration | closeResolution, | ||
| bool | correctCloseTime ) |
Definition at line 332 of file libxrpl/ledger/Ledger.cpp.
| void xrpl::Ledger::setImmutable | ( | bool | rehash = true | ) |
Definition at line 312 of file libxrpl/ledger/Ledger.cpp.
| bool xrpl::Ledger::isImmutable | ( | ) | const |
Definition at line 250 of file include/xrpl/ledger/Ledger.h.
| void xrpl::Ledger::setFull | ( | ) | const |
Definition at line 266 of file include/xrpl/ledger/Ledger.h.
| void xrpl::Ledger::setTotalDrops | ( | std::uint64_t | totDrops | ) |
Definition at line 275 of file include/xrpl/ledger/Ledger.h.
| SHAMap const & xrpl::Ledger::stateMap | ( | ) | const |
Definition at line 281 of file include/xrpl/ledger/Ledger.h.
| SHAMap & xrpl::Ledger::stateMap | ( | ) |
Definition at line 287 of file include/xrpl/ledger/Ledger.h.
| SHAMap const & xrpl::Ledger::txMap | ( | ) | const |
Definition at line 293 of file include/xrpl/ledger/Ledger.h.
| SHAMap & xrpl::Ledger::txMap | ( | ) |
Definition at line 299 of file include/xrpl/ledger/Ledger.h.
| bool xrpl::Ledger::addSLE | ( | SLE const & | sle | ) |
Definition at line 347 of file libxrpl/ledger/Ledger.cpp.
| void xrpl::Ledger::updateSkipList | ( | ) |
Definition at line 808 of file libxrpl/ledger/Ledger.cpp.
| bool xrpl::Ledger::walkLedger | ( | beast::Journal | j, |
| bool | parallel = false ) const |
Definition at line 741 of file libxrpl/ledger/Ledger.cpp.
| bool xrpl::Ledger::isSensible | ( | ) | const |
Definition at line 792 of file libxrpl/ledger/Ledger.cpp.
| void xrpl::Ledger::invariants | ( | ) | const |
Definition at line 899 of file libxrpl/ledger/Ledger.cpp.
| void xrpl::Ledger::unshare | ( | ) | const |
Definition at line 892 of file libxrpl/ledger/Ledger.cpp.
get Negative UNL validators' master public keys
Definition at line 639 of file libxrpl/ledger/Ledger.cpp.
| std::optional< PublicKey > xrpl::Ledger::validatorToDisable | ( | ) | const |
get the to be disabled validator's master public key if any
Definition at line 664 of file libxrpl/ledger/Ledger.cpp.
| std::optional< PublicKey > xrpl::Ledger::validatorToReEnable | ( | ) | const |
get the to be re-enabled validator's master public key if any
Definition at line 678 of file libxrpl/ledger/Ledger.cpp.
| void xrpl::Ledger::updateNegativeUNL | ( | ) |
update the Negative UNL ledger component.
Definition at line 692 of file libxrpl/ledger/Ledger.cpp.
| bool xrpl::Ledger::isFlagLedger | ( | ) | const |
Returns true if the ledger is a flag ledger.
Definition at line 881 of file libxrpl/ledger/Ledger.cpp.
| bool xrpl::Ledger::isVotingLedger | ( | ) | const |
Returns true if the ledger directly precedes a flag ledger.
Definition at line 886 of file libxrpl/ledger/Ledger.cpp.
| SLE::pointer xrpl::Ledger::peek | ( | Keylet const & | k | ) | const |
Definition at line 627 of file libxrpl/ledger/Ledger.cpp.
|
private |
Definition at line 543 of file libxrpl/ledger/Ledger.cpp.
|
staticprivate |
Deserialize a SHAMapItem containing a single STTx.
| item | The SHAMapItem to deserialize. |
| May | throw on deserialization error. |
Definition at line 356 of file libxrpl/ledger/Ledger.cpp.
|
staticprivate |
Deserialize a SHAMapItem containing STTx + STObject metadata.
The SHAMapItem must contain two variable length serialization objects.
| item | The SHAMapItem to deserialize. |
| May | throw on deserialization error. |
Definition at line 363 of file libxrpl/ledger/Ledger.cpp.
|
nodiscardinherited |
Returns the close time of the previous ledger.
Definition at line 90 of file ReadView.h.
|
nodiscardinherited |
Returns the sequence number of the base ledger.
Definition at line 97 of file ReadView.h.
|
nodiscardpure virtualinherited |
Return the key of the next state item.
This returns the key of the first state item whose key is greater than the specified key. If no such key is present, std::nullopt is returned.
If last is engaged, returns std::nullopt when the key returned would be outside the open interval (key, last).
Implemented in xrpl::detail::ApplyViewBase, xrpl::detail::CachedViewImpl, and xrpl::OpenView.
|
nodiscardvirtualinherited |
Reimplemented in xrpl::PaymentSandbox.
Definition at line 155 of file ReadView.h.
|
nodiscardvirtualinherited |
Reimplemented in xrpl::PaymentSandbox.
Definition at line 165 of file ReadView.h.
|
nodiscardvirtualinherited |
Reimplemented in xrpl::PaymentSandbox.
Definition at line 175 of file ReadView.h.
|
nodiscardvirtualinherited |
Reimplemented in xrpl::PaymentSandbox.
Definition at line 186 of file ReadView.h.
|
nodiscardpure virtualinherited |
|
nodiscardpure virtualinherited |
Returns true if a tx exists in the tx map.
A tx exists in the map if it is part of the base ledger, or if it is a newly inserted tx.
Implemented in xrpl::detail::ApplyViewBase, xrpl::detail::CachedViewImpl, and xrpl::OpenView.
|
pure virtualinherited |
Add a transaction to the tx map.
Closed ledgers must have metadata, while open ledgers omit metadata.
Implemented in xrpl::OpenView.
|
staticprivatenoexceptinherited |
Definition at line 109 of file CountedObject.h.
|
private |
Definition at line 395 of file include/xrpl/ledger/Ledger.h.
|
mutableprivate |
Definition at line 398 of file include/xrpl/ledger/Ledger.h.
|
mutableprivate |
Definition at line 401 of file include/xrpl/ledger/Ledger.h.
|
mutableprivate |
Definition at line 404 of file include/xrpl/ledger/Ledger.h.
|
private |
Definition at line 406 of file include/xrpl/ledger/Ledger.h.
|
private |
Definition at line 407 of file include/xrpl/ledger/Ledger.h.
|
private |
Definition at line 408 of file include/xrpl/ledger/Ledger.h.
|
private |
Definition at line 409 of file include/xrpl/ledger/Ledger.h.
|
inherited |
Iterable range of ledger state items.
Definition at line 239 of file ReadView.h.
|
inherited |
Definition at line 242 of file ReadView.h.
|
inherited |
Definition at line 134 of file CountedObject.h.