-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
67cfbf5
commit c1e4bfb
Showing
60 changed files
with
8,790 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| //------------------------------------------------------------------------------ | ||
| /* | ||
| This file is part of rippled: https://github.com/ripple/rippled | ||
| Copyright (c) 2022 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_APP_MISC_AMM_H_INLCUDED | ||
| #define RIPPLE_APP_MISC_AMM_H_INLCUDED | ||
|
|
||
| #include <ripple/beast/utility/Journal.h> | ||
| #include <ripple/protocol/Quality.h> | ||
| #include <ripple/protocol/STAmount.h> | ||
| #include <ripple/protocol/STArray.h> | ||
| #include <ripple/protocol/STLedgerEntry.h> | ||
| #include <ripple/protocol/TER.h> | ||
| #include <ripple/protocol/TxFlags.h> | ||
| #include <ripple/protocol/digest.h> | ||
|
|
||
| namespace ripple { | ||
|
|
||
| class ReadView; | ||
| class ApplyView; | ||
| class Sandbox; | ||
| class STLedgerEntry; | ||
| class NetClock; | ||
| class STObject; | ||
| class Rules; | ||
|
|
||
| /** Calculate AMM account ID. | ||
| */ | ||
| template <typename... Args> | ||
| AccountID | ||
| calcAccountID(Args const&... args) | ||
| { | ||
| ripesha_hasher rsh; | ||
| auto hash = sha512Half(args...); | ||
| rsh(hash.data(), hash.size()); | ||
| return AccountID{static_cast<ripesha_hasher::result_type>(rsh)}; | ||
| } | ||
|
|
||
| /** Calculate AMM group hash. The ltAMM object | ||
| * contains all AMM's for the same issues. | ||
| */ | ||
| uint256 | ||
| calcAMMGroupHash(Issue const& issue1, Issue const& issue2); | ||
|
|
||
| /** Calculate Liquidity Provider Token (LPT) Currency. | ||
| */ | ||
| Currency | ||
| calcLPTCurrency(AccountID const& ammAccountID); | ||
|
|
||
| /** Calculate LPT Issue. | ||
| */ | ||
| Issue | ||
| calcLPTIssue(AccountID const& ammAccountID); | ||
|
|
||
| /** Get AMM pool balances. | ||
| */ | ||
| std::pair<STAmount, STAmount> | ||
| ammPoolHolds( | ||
| ReadView const& view, | ||
| AccountID const& ammAccountID, | ||
| Issue const& issue1, | ||
| Issue const& issue2, | ||
| beast::Journal const j); | ||
|
|
||
| /** Get AMM pool and LP token balances. If both optIssue are | ||
| * provided then they are used as the AMM token pair issues. | ||
| * Otherwise the missing issues are fetched from ammSle. | ||
| */ | ||
| std::tuple<STAmount, STAmount, STAmount> | ||
| ammHolds( | ||
| ReadView const& view, | ||
| SLE const& ammSle, | ||
| std::optional<Issue> const& optIssue1, | ||
| std::optional<Issue> const& optIssue2, | ||
| beast::Journal const j); | ||
|
|
||
| /** Get the balance of LP tokens. | ||
| */ | ||
| STAmount | ||
| lpHolds( | ||
| ReadView const& view, | ||
| AccountID const& ammAccountID, | ||
| AccountID const& lpAccount, | ||
| beast::Journal const j); | ||
|
|
||
| /** Validate the amount. | ||
| * If zero is false and amount is beast::zero then invalid amount. | ||
| * Return error code if invalid amount. | ||
| */ | ||
| std::optional<TEMcodes> | ||
| invalidAmount(std::optional<STAmount> const& a, bool zero = false); | ||
|
|
||
| /** Check if the line is frozen from the issuer. | ||
| */ | ||
| bool | ||
| isFrozen(ReadView const& view, std::optional<STAmount> const& a); | ||
|
|
||
| /** Get AMM SLE and verify that the AMM account exists. | ||
| * Return null if SLE not found or AMM account doesn't exist. | ||
| */ | ||
| std::shared_ptr<STLedgerEntry const> | ||
| getAMMSle(ReadView const& view, uint256 ammID); | ||
|
|
||
| std::shared_ptr<STLedgerEntry> | ||
| getAMMSle(Sandbox& view, uint256 ammID); | ||
|
|
||
| /** Check if the account requires authorization. | ||
| * Return true if issuer's account, account, and trust line exist | ||
| * and the account requires authorization. | ||
| */ | ||
| bool | ||
| requireAuth(ReadView const& view, Issue const& issue, AccountID const& account); | ||
|
|
||
| /** Get AMM trading fee for the given account. The fee is discounted | ||
| * if the account is the auction slot owner or one of the slot's authorized | ||
| * accounts. | ||
| */ | ||
| std::uint16_t | ||
| getTradingFee(SLE const& ammSle, AccountID const& account); | ||
|
|
||
| /** Get Issue from sfToken1/sfToken2 fields. | ||
| */ | ||
| std::pair<Issue, Issue> | ||
| getTokensIssue(SLE const& ammSle); | ||
|
|
||
| /** Send w/o fees. Either from or to must be AMM account. | ||
| */ | ||
| TER | ||
| ammSend( | ||
| ApplyView& view, | ||
| AccountID const& from, | ||
| AccountID const& to, | ||
| STAmount const& amount, | ||
| beast::Journal j); | ||
|
|
||
| /** Get time slot of the auction slot. | ||
| */ | ||
| std::uint16_t | ||
| timeSlot(NetClock::time_point const& clock, STObject const& auctionSlot); | ||
|
|
||
| bool | ||
| ammRequiredAmendments(Rules const&); | ||
|
|
||
| } // namespace ripple | ||
|
|
||
| #endif // RIPPLE_APP_MISC_AMM_H_INLCUDED |
Oops, something went wrong.