rippled
check.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_TEST_JTX_CHECK_H_INCLUDED
21 #define RIPPLE_TEST_JTX_CHECK_H_INCLUDED
22 
23 #include <test/jtx/Account.h>
24 #include <test/jtx/Env.h>
25 #include <test/jtx/owners.h>
26 
27 namespace ripple {
28 namespace test {
29 namespace jtx {
30 
32 namespace check {
33 
36 create(
37  jtx::Account const& account,
38  jtx::Account const& dest,
39  STAmount const& sendMax);
40 
43 cash(jtx::Account const& dest, uint256 const& checkId, STAmount const& amount);
44 
46 struct DeliverMin
47 {
49  explicit DeliverMin(STAmount const& deliverMin) : value(deliverMin)
50  {
51  }
52 };
53 
56 cash(
57  jtx::Account const& dest,
58  uint256 const& checkId,
59  DeliverMin const& atLeast);
60 
63 cancel(jtx::Account const& dest, uint256 const& checkId);
64 
65 } // namespace check
66 
69 
70 } // namespace jtx
71 
72 } // namespace test
73 } // namespace ripple
74 
75 #endif
ripple::test::jtx::check::create
Json::Value create(jtx::Account const &account, jtx::Account const &dest, STAmount const &sendMax)
Create a check.
Definition: check.cpp:32
ripple::test::jtx::check::DeliverMin::DeliverMin
DeliverMin(STAmount const &deliverMin)
Definition: check.h:49
ripple::test::jtx::check::cancel
Json::Value cancel(jtx::Account const &dest, uint256 const &checkId)
Cancel a check.
Definition: check.cpp:77
ripple::base_uint< 256 >
ripple::test::jtx::check::DeliverMin
Type used to specify DeliverMin for cashing a check.
Definition: check.h:46
ripple::STAmount
Definition: STAmount.h:45
ripple::test::jtx::check::DeliverMin::value
STAmount value
Definition: check.h:48
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition: RCLCensorshipDetector.h:29
ripple::test::jtx::check::cash
Json::Value cash(jtx::Account const &dest, uint256 const &checkId, STAmount const &amount)
Cash a check requiring that a specific amount be delivered.
Definition: check.cpp:48
ripple::test::jtx::Account
Immutable cryptographic account descriptor.
Definition: Account.h:37
Json::Value
Represents a JSON value.
Definition: json_value.h:145
ripple::test::jtx::owner_count
Definition: owners.h:49