mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
2d5ddbf1bf
Introduce a new ledger type: ltCHECK Introduce three new transactions that operate on checks: - "CheckCreate" which adds the check entry to the ledger. The check is a promise from the source of the check that the destination of the check may cash the check and receive up to the SendMax specified on the check. The check may have an expiration, after which the check may no longer be cashed. - "CheckCash" is a request by the destination of the check to transfer a requested amount of funds, up to the check's SendMax, from the source to the destination. The destination may receive less than the SendMax due to transfer fees. When cashing a check, the destination specifies the smallest amount of funds that will be acceptable. If the transfer completes and delivers the requested amount, then the check is considered cashed and removed from the ledger. If enough funds cannot be delivered, then the transaction fails and the check remains in the ledger. Attempting to cash the check after its expiration will fail. - "CheckCancel" removes the check from the ledger without transferring funds. Either the check's source or destination can cancel the check at any time. After a check has expired, any account can cancel the check. Facilities related to checks are on the "Checks" amendment.
355 lines
12 KiB
C++
355 lines
12 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of rippled: https://github.com/ripple/rippled
|
|
Copyright (c) 2012, 2013 Ripple Labs Inc.
|
|
|
|
Permission to use, copy, modify, and/or distribute this software for any
|
|
purpose with or without fee is hereby granted, provided that the above
|
|
copyright notice and this permission notice appear in all copies.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
//==============================================================================
|
|
|
|
#ifndef RIPPLE_LEDGER_VIEW_H_INCLUDED
|
|
#define RIPPLE_LEDGER_VIEW_H_INCLUDED
|
|
|
|
#include <ripple/ledger/ApplyView.h>
|
|
#include <ripple/ledger/OpenView.h>
|
|
#include <ripple/ledger/RawView.h>
|
|
#include <ripple/ledger/ReadView.h>
|
|
#include <ripple/protocol/Protocol.h>
|
|
#include <ripple/protocol/Rate.h>
|
|
#include <ripple/protocol/Serializer.h>
|
|
#include <ripple/protocol/STLedgerEntry.h>
|
|
#include <ripple/protocol/STObject.h>
|
|
#include <ripple/protocol/STTx.h>
|
|
#include <ripple/protocol/TER.h>
|
|
#include <ripple/core/Config.h>
|
|
#include <ripple/beast/utility/Journal.h>
|
|
#include <boost/optional.hpp>
|
|
#include <functional>
|
|
#include <map>
|
|
#include <memory>
|
|
#include <utility>
|
|
|
|
#include <vector>
|
|
|
|
namespace ripple {
|
|
|
|
//------------------------------------------------------------------------------
|
|
//
|
|
// Observers
|
|
//
|
|
//------------------------------------------------------------------------------
|
|
|
|
/** Controls the treatment of frozen account balances */
|
|
enum FreezeHandling
|
|
{
|
|
fhIGNORE_FREEZE,
|
|
fhZERO_IF_FROZEN
|
|
};
|
|
|
|
bool
|
|
isGlobalFrozen (ReadView const& view,
|
|
AccountID const& issuer);
|
|
|
|
bool
|
|
isFrozen (ReadView const& view, AccountID const& account,
|
|
Currency const& currency, AccountID const& issuer);
|
|
|
|
// Returns the amount an account can spend without going into debt.
|
|
//
|
|
// <-- saAmount: amount of currency held by account. May be negative.
|
|
STAmount
|
|
accountHolds (ReadView const& view,
|
|
AccountID const& account, Currency const& currency,
|
|
AccountID const& issuer, FreezeHandling zeroIfFrozen,
|
|
beast::Journal j);
|
|
|
|
STAmount
|
|
accountFunds (ReadView const& view, AccountID const& id,
|
|
STAmount const& saDefault, FreezeHandling freezeHandling,
|
|
beast::Journal j);
|
|
|
|
// Return the account's liquid (not reserved) XRP. Generally prefer
|
|
// calling accountHolds() over this interface. However this interface
|
|
// allows the caller to temporarily adjust the owner count should that be
|
|
// necessary.
|
|
//
|
|
// @param ownerCountAdj positive to add to count, negative to reduce count.
|
|
XRPAmount
|
|
xrpLiquid (ReadView const& view, AccountID const& id,
|
|
std::int32_t ownerCountAdj, beast::Journal j);
|
|
|
|
/** Iterate all items in an account's owner directory. */
|
|
void
|
|
forEachItem (ReadView const& view, AccountID const& id,
|
|
std::function<void (std::shared_ptr<SLE const> const&)> f);
|
|
|
|
/** Iterate all items after an item in an owner directory.
|
|
@param after The key of the item to start after
|
|
@param hint The directory page containing `after`
|
|
@param limit The maximum number of items to return
|
|
@return `false` if the iteration failed
|
|
*/
|
|
bool
|
|
forEachItemAfter (ReadView const& view, AccountID const& id,
|
|
uint256 const& after, std::uint64_t const hint,
|
|
unsigned int limit, std::function<
|
|
bool (std::shared_ptr<SLE const> const&)> f);
|
|
|
|
Rate
|
|
transferRate (ReadView const& view,
|
|
AccountID const& issuer);
|
|
|
|
/** Returns `true` if the directory is empty
|
|
@param key The key of the directory
|
|
*/
|
|
bool
|
|
dirIsEmpty (ReadView const& view,
|
|
Keylet const& k);
|
|
|
|
// Return the first entry and advance uDirEntry.
|
|
// <-- true, if had a next entry.
|
|
// VFALCO Fix these clumsy routines with an iterator
|
|
bool
|
|
cdirFirst (ReadView const& view,
|
|
uint256 const& uRootIndex, // --> Root of directory.
|
|
std::shared_ptr<SLE const>& sleNode, // <-> current node
|
|
unsigned int& uDirEntry, // <-- next entry
|
|
uint256& uEntryIndex, // <-- The entry, if available. Otherwise, zero.
|
|
beast::Journal j);
|
|
|
|
// Return the current entry and advance uDirEntry.
|
|
// <-- true, if had a next entry.
|
|
// VFALCO Fix these clumsy routines with an iterator
|
|
bool
|
|
cdirNext (ReadView const& view,
|
|
uint256 const& uRootIndex, // --> Root of directory
|
|
std::shared_ptr<SLE const>& sleNode, // <-> current node
|
|
unsigned int& uDirEntry, // <-> next entry
|
|
uint256& uEntryIndex, // <-- The entry, if available. Otherwise, zero.
|
|
beast::Journal j);
|
|
|
|
// Return the list of enabled amendments
|
|
std::set <uint256>
|
|
getEnabledAmendments (ReadView const& view);
|
|
|
|
// Return a map of amendments that have achieved majority
|
|
using majorityAmendments_t = std::map <uint256, NetClock::time_point>;
|
|
majorityAmendments_t
|
|
getMajorityAmendments (ReadView const& view);
|
|
|
|
/** Return the hash of a ledger by sequence.
|
|
The hash is retrieved by looking up the "skip list"
|
|
in the passed ledger. As the skip list is limited
|
|
in size, if the requested ledger sequence number is
|
|
out of the range of ledgers represented in the skip
|
|
list, then boost::none is returned.
|
|
@return The hash of the ledger with the
|
|
given sequence number or boost::none.
|
|
*/
|
|
boost::optional<uint256>
|
|
hashOfSeq (ReadView const& ledger, LedgerIndex seq,
|
|
beast::Journal journal);
|
|
|
|
/** Find a ledger index from which we could easily get the requested ledger
|
|
|
|
The index that we return should meet two requirements:
|
|
1) It must be the index of a ledger that has the hash of the ledger
|
|
we are looking for. This means that its sequence must be equal to
|
|
greater than the sequence that we want but not more than 256 greater
|
|
since each ledger contains the hashes of the 256 previous ledgers.
|
|
|
|
2) Its hash must be easy for us to find. This means it must be 0 mod 256
|
|
because every such ledger is permanently enshrined in a LedgerHashes
|
|
page which we can easily retrieve via the skip list.
|
|
*/
|
|
inline
|
|
LedgerIndex
|
|
getCandidateLedger (LedgerIndex requested)
|
|
{
|
|
return (requested + 255) & (~255);
|
|
}
|
|
|
|
/** Return false if the test ledger is provably incompatible
|
|
with the valid ledger, that is, they could not possibly
|
|
both be valid. Use the first form if you have both ledgers,
|
|
use the second form if you have not acquired the valid ledger yet
|
|
*/
|
|
bool areCompatible (ReadView const& validLedger, ReadView const& testLedger,
|
|
beast::Journal::Stream& s, const char* reason);
|
|
|
|
bool areCompatible (uint256 const& validHash, LedgerIndex validIndex,
|
|
ReadView const& testLedger, beast::Journal::Stream& s, const char* reason);
|
|
|
|
//------------------------------------------------------------------------------
|
|
//
|
|
// Modifiers
|
|
//
|
|
//------------------------------------------------------------------------------
|
|
|
|
/** Adjust the owner count up or down. */
|
|
void
|
|
adjustOwnerCount (ApplyView& view,
|
|
std::shared_ptr<SLE> const& sle,
|
|
std::int32_t amount, beast::Journal j);
|
|
|
|
// Return the first entry and advance uDirEntry.
|
|
// <-- true, if had a next entry.
|
|
// VFALCO Fix these clumsy routines with an iterator
|
|
bool
|
|
dirFirst (ApplyView& view,
|
|
uint256 const& uRootIndex, // --> Root of directory.
|
|
std::shared_ptr<SLE>& sleNode, // <-> current node
|
|
unsigned int& uDirEntry, // <-- next entry
|
|
uint256& uEntryIndex, // <-- The entry, if available. Otherwise, zero.
|
|
beast::Journal j);
|
|
|
|
// Return the current entry and advance uDirEntry.
|
|
// <-- true, if had a next entry.
|
|
// VFALCO Fix these clumsy routines with an iterator
|
|
bool
|
|
dirNext (ApplyView& view,
|
|
uint256 const& uRootIndex, // --> Root of directory
|
|
std::shared_ptr<SLE>& sleNode, // <-> current node
|
|
unsigned int& uDirEntry, // <-> next entry
|
|
uint256& uEntryIndex, // <-- The entry, if available. Otherwise, zero.
|
|
beast::Journal j);
|
|
|
|
std::function<void (SLE::ref)>
|
|
describeOwnerDir(AccountID const& account);
|
|
|
|
// deprecated
|
|
boost::optional<std::uint64_t>
|
|
dirAdd (ApplyView& view,
|
|
Keylet const& uRootIndex,
|
|
uint256 const& uLedgerIndex,
|
|
bool strictOrder,
|
|
std::function<void (SLE::ref)> fDescriber,
|
|
beast::Journal j);
|
|
|
|
// deprecated
|
|
TER
|
|
dirDelete (ApplyView& view,
|
|
const bool bKeepRoot,
|
|
std::uint64_t uNodeDir, // Node item is mentioned in.
|
|
Keylet const& uRootIndex,
|
|
uint256 const& uLedgerIndex, // Item being deleted
|
|
const bool bStable,
|
|
const bool bSoft,
|
|
beast::Journal j);
|
|
|
|
// VFALCO NOTE Both STAmount parameters should just
|
|
// be "Amount", a unit-less number.
|
|
//
|
|
/** Create a trust line
|
|
|
|
This can set an initial balance.
|
|
*/
|
|
TER
|
|
trustCreate (ApplyView& view,
|
|
const bool bSrcHigh,
|
|
AccountID const& uSrcAccountID,
|
|
AccountID const& uDstAccountID,
|
|
uint256 const& uIndex, // --> ripple state entry
|
|
SLE::ref sleAccount, // --> the account being set.
|
|
const bool bAuth, // --> authorize account.
|
|
const bool bNoRipple, // --> others cannot ripple through
|
|
const bool bFreeze, // --> funds cannot leave
|
|
STAmount const& saBalance, // --> balance of account being set.
|
|
// Issuer should be noAccount()
|
|
STAmount const& saLimit, // --> limit for account being set.
|
|
// Issuer should be the account being set.
|
|
std::uint32_t uSrcQualityIn,
|
|
std::uint32_t uSrcQualityOut,
|
|
beast::Journal j);
|
|
|
|
TER
|
|
trustDelete (ApplyView& view,
|
|
std::shared_ptr<SLE> const& sleRippleState,
|
|
AccountID const& uLowAccountID,
|
|
AccountID const& uHighAccountID,
|
|
beast::Journal j);
|
|
|
|
/** Delete an offer.
|
|
|
|
Requirements:
|
|
The passed `sle` be obtained from a prior
|
|
call to view.peek()
|
|
*/
|
|
TER
|
|
offerDelete (ApplyView& view,
|
|
std::shared_ptr<SLE> const& sle,
|
|
beast::Journal j);
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
//
|
|
// Money Transfers
|
|
//
|
|
|
|
// Direct send w/o fees:
|
|
// - Redeeming IOUs and/or sending sender's own IOUs.
|
|
// - Create trust line of needed.
|
|
// --> bCheckIssuer : normally require issuer to be involved.
|
|
TER
|
|
rippleCredit (ApplyView& view,
|
|
AccountID const& uSenderID, AccountID const& uReceiverID,
|
|
const STAmount & saAmount, bool bCheckIssuer,
|
|
beast::Journal j);
|
|
|
|
TER
|
|
accountSend (ApplyView& view,
|
|
AccountID const& from,
|
|
AccountID const& to,
|
|
const STAmount & saAmount,
|
|
beast::Journal j);
|
|
|
|
TER
|
|
issueIOU (ApplyView& view,
|
|
AccountID const& account,
|
|
STAmount const& amount,
|
|
Issue const& issue,
|
|
beast::Journal j);
|
|
|
|
TER
|
|
redeemIOU (ApplyView& view,
|
|
AccountID const& account,
|
|
STAmount const& amount,
|
|
Issue const& issue,
|
|
beast::Journal j);
|
|
|
|
TER
|
|
transferXRP (ApplyView& view,
|
|
AccountID const& from,
|
|
AccountID const& to,
|
|
STAmount const& amount,
|
|
beast::Journal j);
|
|
|
|
NetClock::time_point const& fix1141Time ();
|
|
bool fix1141 (NetClock::time_point const closeTime);
|
|
|
|
NetClock::time_point const& fix1274Time ();
|
|
bool fix1274 (NetClock::time_point const closeTime);
|
|
|
|
NetClock::time_point const& fix1298Time ();
|
|
bool fix1298 (NetClock::time_point const closeTime);
|
|
|
|
NetClock::time_point const& fix1443Time ();
|
|
bool fix1443 (NetClock::time_point const closeTime);
|
|
|
|
NetClock::time_point const& fix1449Time ();
|
|
bool fix1449 (NetClock::time_point const closeTime);
|
|
|
|
} // ripple
|
|
|
|
#endif
|