rippled
DeleteAccount.h
1 //------------------------------------------------------------------------------
2 /*
3  This file is part of rippled: https://github.com/ripple/rippled
4  Copyright (c) 2019 Ripple Labs Inc.
5 
6  Permission to use, copy, modify, and/or distribute this software for any
7  purpose with or without fee is hereby granted, provided that the above
8  copyright notice and this permission notice appear in all copies.
9 
10  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18 //==============================================================================
19 
20 #ifndef RIPPLE_TX_DELETEACCOUNT_H_INCLUDED
21 #define RIPPLE_TX_DELETEACCOUNT_H_INCLUDED
22 
23 #include <ripple/app/tx/impl/Transactor.h>
24 #include <ripple/basics/Log.h>
25 #include <ripple/protocol/Indexes.h>
26 
27 namespace ripple {
28 
29 class DeleteAccount : public Transactor
30 {
31 public:
33 
34  // Set a reasonable upper limit on the number of deletable directory
35  // entries an account may have before we decide the account can't be
36  // deleted.
37  //
38  // A limit is useful because if we go much past this limit the
39  // transaction will fail anyway due to too much metadata (tecOVERSIZE).
40  static constexpr std::int32_t maxDeletableDirEntries{1000};
41 
42  explicit DeleteAccount(ApplyContext& ctx) : Transactor(ctx)
43  {
44  }
45 
46  static NotTEC
47  preflight(PreflightContext const& ctx);
48 
49  static FeeUnit64
50  calculateBaseFee(ReadView const& view, STTx const& tx);
51 
52  static TER
53  preclaim(PreclaimContext const& ctx);
54 
55  TER
56  doApply() override;
57 };
58 
59 } // namespace ripple
60 
61 #endif
ripple::Transactor::Blocker
@ Blocker
Definition: Transactor.h:102
ripple::Transactor
Definition: Transactor.h:86
ripple::DeleteAccount::preflight
static NotTEC preflight(PreflightContext const &ctx)
Definition: DeleteAccount.cpp:35
ripple::DeleteAccount::doApply
TER doApply() override
Definition: DeleteAccount.cpp:245
ripple::DeleteAccount
Definition: DeleteAccount.h:29
ripple::DeleteAccount::preclaim
static TER preclaim(PreclaimContext const &ctx)
Definition: DeleteAccount.cpp:154
ripple::DeleteAccount::calculateBaseFee
static FeeUnit64 calculateBaseFee(ReadView const &view, STTx const &tx)
Definition: DeleteAccount.cpp:56
ripple::DeleteAccount::ConsequencesFactory
static constexpr ConsequencesFactoryType ConsequencesFactory
Definition: DeleteAccount.h:32
ripple::DeleteAccount::DeleteAccount
DeleteAccount(ApplyContext &ctx)
Definition: DeleteAccount.h:42
ripple::Transactor::ConsequencesFactoryType
ConsequencesFactoryType
Definition: Transactor.h:102
ripple::TERSubset
Definition: TER.h:326
ripple::DeleteAccount::maxDeletableDirEntries
static constexpr std::int32_t maxDeletableDirEntries
Definition: DeleteAccount.h:40
ripple::STTx
Definition: STTx.h:42
ripple::ApplyContext
State information when applying a tx.
Definition: ApplyContext.h:35
std::int32_t
ripple::feeunit::TaggedFee
Definition: FeeUnits.h:70
ripple::PreclaimContext
State information when determining if a tx is likely to claim a fee.
Definition: Transactor.h:53
ripple::ReadView
A view into a ledger.
Definition: ReadView.h:192
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition: RCLCensorshipDetector.h:29
ripple::Transactor::view
ApplyView & view()
Definition: Transactor.h:108
ripple::PreflightContext
State information when preflighting a tx.
Definition: Transactor.h:32