rippled
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
ripple::test::jtx Namespace Reference

Namespaces

 amm
 
 check
 Check operations.
 
 deposit
 Deposit preauthorize operations.
 
 detail
 
 ticket
 Ticket operations.
 
 token
 

Classes

class  Account
 Immutable cryptographic account descriptor. More...
 
struct  account_txn_id
 
class  AMM
 Convenience class to test AMM functionality. More...
 
class  AMMTest
 
class  AMMTestBase
 
struct  any_t
 
struct  AnyAmount
 Amount specifier with an option for any issuer. More...
 
struct  autofill_t
 
class  balance
 A balance matches. More...
 
struct  basic_prop
 
struct  BookSpec
 
struct  cancel_time
 Set the "CancelAfter" time tag on a JTx. More...
 
struct  condition
 
class  delivermin
 Sets the DeliverMin on a JTx. More...
 
class  dest_tag
 Set DestinationTag on a JTx. More...
 
struct  disabled_t
 
struct  dtag
 Set the destination tag on a JTx. More...
 
class  Env
 A transaction testing environment. More...
 
class  Env_ss
 A transaction testing environment wrapper. More...
 
struct  epsilon_t
 
class  expiration
 Set Expiration on a JTx. More...
 
class  fee
 Set the fee on a JTx. More...
 
struct  finish_time
 Set the "FinishAfter" time tag on a JTx. More...
 
class  flags
 Match set account flags. More...
 
struct  fulfillment
 
struct  invoice_id
 
class  IOU
 Converts to IOU Issue or STAmount. More...
 
class  json
 Inject raw JSON. More...
 
struct  JTx
 Execution context for applying a JSON transaction. More...
 
struct  last_ledger_seq
 
class  LPToken
 
class  memo
 Add a memo to a JTx. More...
 
class  memodata
 
class  memoformat
 
class  memondata
 
class  memonformat
 
class  memontype
 
class  memotype
 
class  msig
 Set a multisignature on a JTx. More...
 
class  nflags
 Match clear account flags. More...
 
struct  None
 
struct  none_t
 
class  owner_count
 
class  owners
 Match the number of items in the account's owner directory. More...
 
struct  parse_error
 Thrown when parse fails. More...
 
class  path
 Add a path. More...
 
class  paths
 Set Paths, SendMax on a JTx. More...
 
struct  PrettyAmount
 Represents an XRP or IOU quantity This customizes the string conversion and supports XRP conversions from integer and floating point. More...
 
struct  prop
 Set a property on a JTx. More...
 
struct  prop_type
 
class  qualityIn
 Sets the literal QualityIn on a trust JTx. More...
 
class  qualityInPercent
 Sets the QualityIn on a trust JTx. More...
 
class  qualityOut
 Sets the literal QualityOut on a trust JTx. More...
 
class  qualityOutPercent
 Sets the QualityOut on a trust JTx as a percentage. More...
 
class  require
 Check a set of conditions. More...
 
class  sendmax
 Sets the SendMax on a JTx. More...
 
struct  seq
 Set the sequence number on a JTx. More...
 
class  sig
 Set the regular signature on a JTx. More...
 
struct  signer
 A signer in a SignerList. More...
 
class  source_tag
 Set SourceTag on a JTx. More...
 
struct  stag
 Set the source tag on a JTx. More...
 
class  SuiteLogs
 
class  ter
 Set the expected result code for a JTx The test will fail if the code doesn't match. More...
 
class  txflags
 Set the flags on a JTx. More...
 
struct  XChainBridgeObjects
 
struct  XRP_t
 

Typedefs

using checks = owner_count< ltCHECK >
 Match the number of checks on the account. More...
 
using siglists = owner_count< ltSIGNER_LIST >
 The number of signer lists matches. More...
 
using lines = owner_count< ltRIPPLE_STATE >
 Match the number of trust lines in the account's owner directory. More...
 
using offers = owner_count< ltOFFER >
 Match the number of offers in the account's owner directory. More...
 
using require_t = std::function< void(Env &)>
 
using requires_t = std::vector< require_t >
 
using tickets = owner_count< ltTICKET >
 Match the number of tickets on the account. More...
 
using JValueVec = std::vector< Json::Value >
 

Enumerations

enum  Fund { Fund::All, Fund::Acct, Fund::Gw, Fund::IOUOnly }
 

Functions

bool operator== (Account const &lhs, Account const &rhs) noexcept
 
template<class Hasher >
void hash_append (Hasher &h, Account const &v) noexcept
 
bool operator< (Account const &lhs, Account const &rhs) noexcept
 
Json::Value acctdelete (Account const &account, Account const &dest)
 Delete account. More...
 
void fund (jtx::Env &env, jtx::Account const &gw, std::vector< jtx::Account > const &accounts, std::vector< STAmount > const &amts, Fund how)
 
void fund (jtx::Env &env, jtx::Account const &gw, std::vector< jtx::Account > const &accounts, STAmount const &xrp, std::vector< STAmount > const &amts={}, Fund how=Fund::All)
 
void fund (jtx::Env &env, std::vector< jtx::Account > const &accounts, STAmount const &xrp, std::vector< STAmount > const &amts={}, Fund how=Fund::All)
 
bool operator== (PrettyAmount const &lhs, PrettyAmount const &rhs)
 
bool operator!= (PrettyAmount const &lhs, PrettyAmount const &rhs)
 
std::ostreamoperator<< (std::ostream &os, PrettyAmount const &amount)
 
template<class Integer , class = std::enable_if_t<std::is_integral_v<Integer>>>
PrettyAmount drops (Integer i)
 Returns an XRP PrettyAmount, which is trivially convertible to STAmount. More...
 
PrettyAmount drops (XRPAmount i)
 Returns an XRP PrettyAmount, which is trivially convertible to STAmount. More...
 
std::ostreamoperator<< (std::ostream &os, IOU const &iou)
 
Buffer sign_claim_attestation (PublicKey const &pk, SecretKey const &sk, STXChainBridge const &bridge, AccountID const &sendingAccount, STAmount const &sendingAmount, AccountID const &rewardAccount, bool wasLockingChainSend, std::uint64_t claimID, std::optional< AccountID > const &dst)
 
Buffer sign_create_account_attestation (PublicKey const &pk, SecretKey const &sk, STXChainBridge const &bridge, AccountID const &sendingAccount, STAmount const &sendingAmount, STAmount const &rewardAmount, AccountID const &rewardAccount, bool wasLockingChainSend, std::uint64_t createCount, AccountID const &dst)
 
template<class... Args>
std::array< Account, 1+sizeof...(Args)> noripple (Account const &account, Args const &... args)
 Designate accounts as no-ripple in Env::fund. More...
 
FeatureBitset supported_amendments ()
 
void forAllApiVersions (VersionedTestCallable auto... testCallable)
 
std::unique_ptr< Configenvconfig ()
 creates and initializes a default configuration for jtx::Env More...
 
template<class F , class... Args>
std::unique_ptr< Configenvconfig (F &&modfunc, Args &&... args)
 creates and initializes a default configuration for jtx::Env and invokes the provided function/lambda with the configuration object. More...
 
std::unique_ptr< Configno_admin (std::unique_ptr< Config >)
 adjust config so no admin ports are enabled More...
 
std::unique_ptr< Configsecure_gateway (std::unique_ptr< Config >)
 
std::unique_ptr< Configadmin_localnet (std::unique_ptr< Config >)
 
std::unique_ptr< Configsecure_gateway_localnet (std::unique_ptr< Config >)
 
std::unique_ptr< Configvalidator (std::unique_ptr< Config >, std::string const &)
 adjust configuration with params needed to be a validator More...
 
std::unique_ptr< Configport_increment (std::unique_ptr< Config >, int)
 adjust the default configured server ports by a specified value More...
 
std::unique_ptr< ConfigaddGrpcConfig (std::unique_ptr< Config >)
 add a grpc address and port to config More...
 
std::unique_ptr< ConfigaddGrpcConfigWithSecureGateway (std::unique_ptr< Config >, std::string const &secureGateway)
 add a grpc address, port and secure_gateway to config More...
 
Json::Value fset (Account const &account, std::uint32_t on, std::uint32_t off=0)
 Add and/or remove flag. More...
 
Json::Value fclear (Account const &account, std::uint32_t off)
 Remove account flag. More...
 
static Number number (STAmount const &a)
 
static IOUAmount initialTokens (STAmount const &asset1, STAmount const &asset2)
 
template<typename T >
static std::string to_places (const T d, std::uint8_t places)
 
Json::Value signers (Account const &account, std::uint32_t quorum, std::vector< signer > const &v)
 
Json::Value signers (Account const &account, none_t)
 Remove a signer list. More...
 
Json::Value offer (Account const &account, STAmount const &takerPays, STAmount const &takerGets, std::uint32_t flags=0)
 Create an offer. More...
 
Json::Value offer_cancel (Account const &account, std::uint32_t offerSeq)
 Cancel an offer. More...
 
Json::Value pay (AccountID const &account, AccountID const &to, AnyAmount amount)
 Create a payment. More...
 
Json::Value pay (Account const &account, Account const &to, AnyAmount amount)
 
static void insertQualityIntoJtx (SField const &field, std::uint32_t value, JTx &jt)
 
Json::Value rate (Account const &account, double multiplier)
 Set a transfer rate. More...
 
Json::Value regkey (Account const &account, disabled_t)
 Disable the regular key. More...
 
Json::Value regkey (Account const &account, Account const &signer)
 Set a regular key. More...
 
Json::Value getAccountOffers (Env &env, AccountID const &acct, bool current)
 
Json::Value getAccountLines (Env &env, AccountID const &acctId)
 
bool checkArraySize (Json::Value const &val, unsigned int size)
 
void stpath_append_one (STPath &st, Account const &account)
 
void stpath_append_one (STPath &st, STPathElement const &pe)
 
bool equal (STAmount const &sa1, STAmount const &sa2)
 
STPathElement IPE (Issue const &iss)
 
XRPAmount txfee (Env const &env, std::uint16_t n)
 
PrettyAmount xrpMinusFee (Env const &env, std::int64_t xrpAmount)
 
bool expectLine (Env &env, AccountID const &account, STAmount const &value, bool defaultLimits)
 
bool expectLine (Env &env, AccountID const &account, None const &value)
 
bool expectOffers (Env &env, AccountID const &account, std::uint16_t size, std::vector< Amounts > const &toMatch)
 
Json::Value ledgerEntryRoot (Env &env, Account const &acct)
 
Json::Value ledgerEntryState (Env &env, Account const &acct_a, Account const &acct_b, std::string const &currency)
 
Json::Value accountBalance (Env &env, Account const &acct)
 
bool expectLedgerEntryRoot (Env &env, Account const &acct, STAmount const &expectedValue)
 
Json::Value escrow (AccountID const &account, AccountID const &to, STAmount const &amount)
 
Json::Value finish (AccountID const &account, AccountID const &from, std::uint32_t seq)
 
Json::Value cancel (AccountID const &account, Account const &from, std::uint32_t seq)
 
Json::Value create (AccountID const &account, AccountID const &to, STAmount const &amount, NetClock::duration const &settleDelay, PublicKey const &pk, std::optional< NetClock::time_point > const &cancelAfter, std::optional< std::uint32_t > const &dstTag)
 
Json::Value fund (AccountID const &account, uint256 const &channel, STAmount const &amount, std::optional< NetClock::time_point > const &expiration)
 
Json::Value claim (AccountID const &account, uint256 const &channel, std::optional< STAmount > const &balance, std::optional< STAmount > const &amount, std::optional< Slice > const &signature, std::optional< PublicKey > const &pk)
 
uint256 channel (AccountID const &account, AccountID const &dst, std::uint32_t seqProxyValue)
 
STAmount channelBalance (ReadView const &view, uint256 const &chan)
 
bool channelExists (ReadView const &view, uint256 const &chan)
 
void n_offers (Env &env, std::size_t n, Account const &account, STAmount const &in, STAmount const &out)
 
STPathElement cpe (Currency const &c)
 
STPathElement allpe (AccountID const &a, Issue const &iss)
 
Json::Value trust (Account const &account, STAmount const &amount, std::uint32_t flags=0)
 Modify a trust line. More...
 
Json::Value trust (Account const &account, STAmount const &amount, Account const &peer, std::uint32_t flags)
 Change flags on a trust line. More...
 
Json::Value claw (Account const &account, STAmount const &amount)
 
STObject parse (Json::Value const &jv)
 Convert JSON to STObject. More...
 
void sign (Json::Value &jv, Account const &account)
 Sign automatically. More...
 
void fill_fee (Json::Value &jv, ReadView const &view)
 Set the fee automatically. More...
 
void fill_seq (Json::Value &jv, ReadView const &view)
 Set the sequence number automatically. More...
 
Json::Value bridge (Account const &lockingChainDoor, Issue const &lockingChainIssue, Account const &issuingChainDoor, Issue const &issuingChainIssue)
 
Json::Value bridge_rpc (Account const &lockingChainDoor, Issue const &lockingChainIssue, Account const &issuingChainDoor, Issue const &issuingChainIssue)
 
Json::Value bridge_create (Account const &acc, Json::Value const &bridge, STAmount const &reward, std::optional< STAmount > const &minAccountCreate)
 
Json::Value bridge_modify (Account const &acc, Json::Value const &bridge, std::optional< STAmount > const &reward, std::optional< STAmount > const &minAccountCreate)
 
Json::Value xchain_create_claim_id (Account const &acc, Json::Value const &bridge, STAmount const &reward, Account const &otherChainSource)
 
Json::Value xchain_commit (Account const &acc, Json::Value const &bridge, std::uint32_t claimID, AnyAmount const &amt, std::optional< Account > const &dst)
 
Json::Value xchain_claim (Account const &acc, Json::Value const &bridge, std::uint32_t claimID, AnyAmount const &amt, Account const &dst)
 
Json::Value sidechain_xchain_account_create (Account const &acc, Json::Value const &bridge, Account const &dst, AnyAmount const &amt, AnyAmount const &reward)
 
Json::Value claim_attestation (jtx::Account const &submittingAccount, Json::Value const &jvBridge, jtx::Account const &sendingAccount, jtx::AnyAmount const &sendingAmount, jtx::Account const &rewardAccount, bool wasLockingChainSend, std::uint64_t claimID, std::optional< jtx::Account > const &dst, jtx::signer const &signer)
 
Json::Value create_account_attestation (jtx::Account const &submittingAccount, Json::Value const &jvBridge, jtx::Account const &sendingAccount, jtx::AnyAmount const &sendingAmount, jtx::AnyAmount const &rewardAmount, jtx::Account const &rewardAccount, bool wasLockingChainSend, std::uint64_t createCount, jtx::Account const &dst, jtx::signer const &signer)
 
JValueVec claim_attestations (jtx::Account const &submittingAccount, Json::Value const &jvBridge, jtx::Account const &sendingAccount, jtx::AnyAmount const &sendingAmount, std::vector< jtx::Account > const &rewardAccounts, bool wasLockingChainSend, std::uint64_t claimID, std::optional< jtx::Account > const &dst, std::vector< jtx::signer > const &signers, std::size_t const numAtts, std::size_t const fromIdx)
 
JValueVec create_account_attestations (jtx::Account const &submittingAccount, Json::Value const &jvBridge, jtx::Account const &sendingAccount, jtx::AnyAmount const &sendingAmount, jtx::AnyAmount const &rewardAmount, std::vector< jtx::Account > const &rewardAccounts, bool wasLockingChainSend, std::uint64_t createCount, jtx::Account const &dst, std::vector< jtx::signer > const &signers, std::size_t const numAtts, std::size_t const fromIdx)
 
Json::Value noop (Account const &account)
 The null transaction. More...
 
template<class... Args>
require_t required (Args const &... args)
 Compose many condition functors into one. More...
 
Json::Value getAccountOffers (Env &env, Account const &acct, bool current=false)
 
Json::Value getAccountLines (Env &env, Account const &acct)
 
template<typename... IOU>
Json::Value getAccountLines (Env &env, AccountID const &acctId, IOU... ious)
 
template<class T >
std::enable_if_t< std::is_constructible< Account, T >::value > stpath_append_one (STPath &st, T const &t)
 
template<class T , class... Args>
void stpath_append (STPath &st, T const &t, Args const &... args)
 
template<class... Args>
void stpathset_append (STPathSet &st, STPath const &p, Args const &... args)
 
template<class... Args>
STPath stpath (Args const &... args)
 
template<class... Args>
bool same (STPathSet const &st1, Args const &... args)
 
template<typename... Amts>
bool expectLine (Env &env, AccountID const &account, STAmount const &value, Amts const &... amts)
 
Json::Value escrow (Account const &account, Account const &to, STAmount const &amount)
 
Json::Value finish (Account const &account, Account const &from, std::uint32_t seq)
 
Json::Value cancel (Account const &account, Account const &from, std::uint32_t seq)
 
Json::Value create (Account const &account, Account const &to, STAmount const &amount, NetClock::duration const &settleDelay, PublicKey const &pk, std::optional< NetClock::time_point > const &cancelAfter=std::nullopt, std::optional< std::uint32_t > const &dstTag=std::nullopt)
 
uint256 channel (Account const &account, Account const &dst, std::uint32_t seqProxyValue)
 
Json::Value sidechain_xchain_account_claim (Account const &acc, Json::Value const &bridge, Account const &dst, AnyAmount const &amt)
 

Variables

constexpr XRPAmount dropsPerXRP {1'000'000}
 
const XRP_t XRP {}
 Converts to XRP Issue or STAmount. More...
 
static const epsilon_t epsilon
 
const any_t any {}
 Returns an amount representing "any issuer". More...
 
template<class T >
concept SingleVersionedTestCallable
 The SingleVersionedTestCallable concept checks for a callable that takes an unsigned integer as its argument and returns void. More...
 
template<class... T>
concept VersionedTestCallable = (... && SingleVersionedTestCallable<T>)
 The VersionedTestCallable concept checks if a set of callables all satisfy the SingleVersionedTestCallable concept. More...
 
constexpr auto defaultseed = "shUwVw52ofnCUX5m7kPTKzJdr4HEH"
 
static const none_t none
 
static const autofill_t autofill
 
static const disabled_t disabled
 
constexpr std::array< std::uint8_t, 39 > cb1
 
const std::array< std::uint8_t, 4 > fb1 = {{0xA0, 0x02, 0x80, 0x00}}
 
constexpr std::size_t UT_XCHAIN_DEFAULT_NUM_SIGNERS = 5
 
constexpr std::size_t UT_XCHAIN_DEFAULT_QUORUM = 4
 

Typedef Documentation

◆ checks

Match the number of checks on the account.

Definition at line 61 of file check.h.

◆ siglists

The number of signer lists matches.

Definition at line 116 of file multisign.h.

◆ lines

Match the number of trust lines in the account's owner directory.

Definition at line 86 of file owners.h.

◆ offers

Match the number of offers in the account's owner directory.

Definition at line 89 of file owners.h.

◆ require_t

Definition at line 32 of file requires.h.

◆ requires_t

Definition at line 33 of file requires.h.

◆ tickets

Match the number of tickets on the account.

Definition at line 64 of file ticket.h.

◆ JValueVec

Definition at line 34 of file xchain_bridge.h.

Enumeration Type Documentation

◆ Fund

Enumerator
All 
Acct 
Gw 
IOUOnly 

Definition at line 34 of file AMMTest.h.

Function Documentation

◆ operator==() [1/2]

bool ripple::test::jtx::operator== ( Account const &  lhs,
Account const &  rhs 
)
noexcept

Definition at line 149 of file Account.h.

◆ hash_append()

template<class Hasher >
void ripple::test::jtx::hash_append ( Hasher &  h,
Account const &  v 
)
noexcept

Definition at line 156 of file Account.h.

◆ operator<()

bool ripple::test::jtx::operator< ( Account const &  lhs,
Account const &  rhs 
)
noexcept

Definition at line 162 of file Account.h.

◆ acctdelete()

Json::Value ripple::test::jtx::acctdelete ( jtx::Account const &  account,
jtx::Account const &  dest 
)

Delete account.

If successful transfer remaining XRP to dest.

Definition at line 29 of file acctdelete.cpp.

◆ fund() [1/4]

void ripple::test::jtx::fund ( jtx::Env env,
jtx::Account const &  gw,
std::vector< jtx::Account > const &  accounts,
std::vector< STAmount > const &  amts,
Fund  how 
)

Definition at line 35 of file AMMTest.cpp.

◆ fund() [2/4]

void ripple::test::jtx::fund ( jtx::Env env,
jtx::Account const &  gw,
std::vector< jtx::Account > const &  accounts,
STAmount const &  xrp,
std::vector< STAmount > const &  amts = {},
Fund  how = Fund::All 
)

Definition at line 73 of file AMMTest.cpp.

◆ fund() [3/4]

void ripple::test::jtx::fund ( jtx::Env env,
std::vector< jtx::Account > const &  accounts,
STAmount const &  xrp,
std::vector< STAmount > const &  amts = {},
Fund  how = Fund::All 
)

Definition at line 46 of file AMMTest.cpp.

◆ operator==() [2/2]

bool ripple::test::jtx::operator== ( PrettyAmount const &  lhs,
PrettyAmount const &  rhs 
)

Definition at line 138 of file amount.h.

◆ operator!=()

bool ripple::test::jtx::operator!= ( PrettyAmount const &  lhs,
PrettyAmount const &  rhs 
)

Definition at line 144 of file amount.h.

◆ operator<<() [1/2]

std::ostream & ripple::test::jtx::operator<< ( std::ostream os,
PrettyAmount const &  amount 
)

Definition at line 73 of file amount.cpp.

◆ drops() [1/2]

template<class Integer , class = std::enable_if_t<std::is_integral_v<Integer>>>
PrettyAmount ripple::test::jtx::drops ( Integer  i)

Returns an XRP PrettyAmount, which is trivially convertible to STAmount.

Example: drops(10) Returns PrettyAmount of 10 drops

Definition at line 241 of file amount.h.

◆ drops() [2/2]

PrettyAmount ripple::test::jtx::drops ( XRPAmount  i)

Returns an XRP PrettyAmount, which is trivially convertible to STAmount.

Example: drops(view->fee().basefee) Returns PrettyAmount of 10 drops

Definition at line 252 of file amount.h.

◆ operator<<() [2/2]

std::ostream & ripple::test::jtx::operator<< ( std::ostream os,
IOU const &  iou 
)

Definition at line 120 of file amount.cpp.

◆ sign_claim_attestation()

Buffer ripple::test::jtx::sign_claim_attestation ( PublicKey const &  pk,
SecretKey const &  sk,
STXChainBridge const &  bridge,
AccountID const &  sendingAccount,
STAmount const &  sendingAmount,
AccountID const &  rewardAccount,
bool  wasLockingChainSend,
std::uint64_t  claimID,
std::optional< AccountID > const &  dst 
)

Definition at line 33 of file attester.cpp.

◆ sign_create_account_attestation()

Buffer ripple::test::jtx::sign_create_account_attestation ( PublicKey const &  pk,
SecretKey const &  sk,
STXChainBridge const &  bridge,
AccountID const &  sendingAccount,
STAmount const &  sendingAmount,
STAmount const &  rewardAmount,
AccountID const &  rewardAccount,
bool  wasLockingChainSend,
std::uint64_t  createCount,
AccountID const &  dst 
)

Definition at line 56 of file attester.cpp.

◆ noripple()

template<class... Args>
std::array<Account, 1 + sizeof...(Args)> ripple::test::jtx::noripple ( Account const &  account,
Args const &...  args 
)

Designate accounts as no-ripple in Env::fund.

Definition at line 65 of file Env.h.

◆ supported_amendments()

FeatureBitset ripple::test::jtx::supported_amendments ( )

Definition at line 71 of file Env.h.

◆ forAllApiVersions()

void ripple::test::jtx::forAllApiVersions ( VersionedTestCallable auto...  testCallable)

Definition at line 743 of file Env.h.

◆ envconfig() [1/2]

std::unique_ptr<Config> ripple::test::jtx::envconfig ( )

creates and initializes a default configuration for jtx::Env

Returns
unique_ptr to Config instance

Definition at line 49 of file envconfig.h.

◆ envconfig() [2/2]

template<class F , class... Args>
std::unique_ptr<Config> ripple::test::jtx::envconfig ( F &&  modfunc,
Args &&...  args 
)

creates and initializes a default configuration for jtx::Env and invokes the provided function/lambda with the configuration object.

Parameters
modfunccallable function or lambda to modify the default config. The first argument to the function must be std::unique_ptr to ripple::Config. The function takes ownership of the unique_ptr and relinquishes ownership by returning a unique_ptr.
argsadditional arguments that will be passed to the config modifier function (optional)
Returns
unique_ptr to Config instance

Definition at line 70 of file envconfig.h.

◆ no_admin()

std::unique_ptr< Config > ripple::test::jtx::no_admin ( std::unique_ptr< Config cfg)

adjust config so no admin ports are enabled

this is intended for use with envconfig, as in envconfig(no_admin)

Parameters
cfgconfig instance to be modified
Returns
unique_ptr to Config instance

Definition at line 82 of file envconfig.cpp.

◆ secure_gateway()

std::unique_ptr< Config > ripple::test::jtx::secure_gateway ( std::unique_ptr< Config cfg)

Definition at line 90 of file envconfig.cpp.

◆ admin_localnet()

std::unique_ptr< Config > ripple::test::jtx::admin_localnet ( std::unique_ptr< Config cfg)

Definition at line 99 of file envconfig.cpp.

◆ secure_gateway_localnet()

std::unique_ptr< Config > ripple::test::jtx::secure_gateway_localnet ( std::unique_ptr< Config cfg)

Definition at line 107 of file envconfig.cpp.

◆ validator()

std::unique_ptr< Config > ripple::test::jtx::validator ( std::unique_ptr< Config cfg,
std::string const &  seed 
)

adjust configuration with params needed to be a validator

this is intended for use with envconfig, as in envconfig(validator, myseed)

Parameters
cfgconfig instance to be modified
seedseed string for use in secret key generation. A fixed default value will be used if this string is empty
Returns
unique_ptr to Config instance

Definition at line 119 of file envconfig.cpp.

◆ port_increment()

std::unique_ptr< Config > ripple::test::jtx::port_increment ( std::unique_ptr< Config cfg,
int  increment 
)

adjust the default configured server ports by a specified value

This is intended for use with envconfig, as in envconfig(port_increment, 5)

Parameters
cfgconfig instance to be modified
intamount by which to increment the existing server port values in the config
Returns
unique_ptr to Config instance

Definition at line 128 of file envconfig.cpp.

◆ addGrpcConfig()

std::unique_ptr< Config > ripple::test::jtx::addGrpcConfig ( std::unique_ptr< Config cfg)

add a grpc address and port to config

This is intended for use with envconfig, for tests that require a grpc server. If this function is not called, grpc server will not start

Parameters
cfgconfig instance to be modified

Definition at line 143 of file envconfig.cpp.

◆ addGrpcConfigWithSecureGateway()

std::unique_ptr< Config > ripple::test::jtx::addGrpcConfigWithSecureGateway ( std::unique_ptr< Config cfg,
std::string const &  secureGateway 
)

add a grpc address, port and secure_gateway to config

This is intended for use with envconfig, for tests that require a grpc server. If this function is not called, grpc server will not start

Parameters
cfgconfig instance to be modified

Definition at line 152 of file envconfig.cpp.

◆ fset()

Json::Value ripple::test::jtx::fset ( Account const &  account,
std::uint32_t  on,
std::uint32_t  off = 0 
)

Add and/or remove flag.

Definition at line 28 of file flags.cpp.

◆ fclear()

Json::Value ripple::test::jtx::fclear ( Account const &  account,
std::uint32_t  off 
)

Remove account flag.

Definition at line 40 of file flags.h.

◆ number()

static Number ripple::test::jtx::number ( STAmount const &  a)
static

Definition at line 34 of file AMM.cpp.

◆ initialTokens()

static IOUAmount ripple::test::jtx::initialTokens ( STAmount const &  asset1,
STAmount const &  asset2 
)
static

Definition at line 42 of file AMM.cpp.

◆ to_places()

template<typename T >
static std::string ripple::test::jtx::to_places ( const T  d,
std::uint8_t  places 
)
static

Definition at line 57 of file amount.cpp.

◆ signers() [1/2]

Json::Value ripple::test::jtx::signers ( Account const &  account,
std::uint32_t  quorum,
std::vector< signer > const &  v 
)

Definition at line 35 of file multisign.cpp.

◆ signers() [2/2]

Json::Value ripple::test::jtx::signers ( Account const &  account,
none_t   
)

Remove a signer list.

Definition at line 58 of file multisign.cpp.

◆ offer()

Json::Value ripple::test::jtx::offer ( Account const &  account,
STAmount const &  takerPays,
STAmount const &  takerGets,
std::uint32_t  flags 
)

Create an offer.

Definition at line 28 of file offer.cpp.

◆ offer_cancel()

Json::Value ripple::test::jtx::offer_cancel ( Account const &  account,
std::uint32_t  offerSeq 
)

Cancel an offer.

Definition at line 45 of file offer.cpp.

◆ pay() [1/2]

Json::Value ripple::test::jtx::pay ( AccountID const &  account,
AccountID const &  to,
AnyAmount  amount 
)

Create a payment.

Definition at line 29 of file pay.cpp.

◆ pay() [2/2]

Json::Value ripple::test::jtx::pay ( Account const &  account,
Account const &  to,
AnyAmount  amount 
)

Definition at line 41 of file pay.cpp.

◆ insertQualityIntoJtx()

static void ripple::test::jtx::insertQualityIntoJtx ( SField const &  field,
std::uint32_t  value,
JTx jt 
)
static

Definition at line 41 of file quality2.cpp.

◆ rate()

Json::Value ripple::test::jtx::rate ( Account const &  account,
double  multiplier 
)

Set a transfer rate.

Definition at line 30 of file rate.cpp.

◆ regkey() [1/2]

Json::Value ripple::test::jtx::regkey ( Account const &  account,
disabled_t   
)

Disable the regular key.

Definition at line 28 of file regkey.cpp.

◆ regkey() [2/2]

Json::Value ripple::test::jtx::regkey ( Account const &  account,
Account const &  signer 
)

Set a regular key.

Definition at line 37 of file regkey.cpp.

◆ getAccountOffers() [1/2]

Json::Value ripple::test::jtx::getAccountOffers ( Env env,
AccountID const &  acct,
bool  current 
)

Definition at line 32 of file TestHelpers.cpp.

◆ getAccountLines() [1/3]

Json::Value ripple::test::jtx::getAccountLines ( Env env,
AccountID const &  acctId 
)

Definition at line 40 of file TestHelpers.cpp.

◆ checkArraySize()

bool ripple::test::jtx::checkArraySize ( Json::Value const &  val,
unsigned int  size 
)

Definition at line 48 of file TestHelpers.cpp.

◆ stpath_append_one() [1/3]

void ripple::test::jtx::stpath_append_one ( STPath st,
Account const &  account 
)

Definition at line 56 of file TestHelpers.cpp.

◆ stpath_append_one() [2/3]

void ripple::test::jtx::stpath_append_one ( STPath st,
STPathElement const &  pe 
)

Definition at line 62 of file TestHelpers.cpp.

◆ equal()

bool ripple::test::jtx::equal ( STAmount const &  sa1,
STAmount const &  sa2 
)

Definition at line 68 of file TestHelpers.cpp.

◆ IPE()

STPathElement ripple::test::jtx::IPE ( Issue const &  iss)

Definition at line 75 of file TestHelpers.cpp.

◆ txfee()

XRPAmount ripple::test::jtx::txfee ( Env const &  env,
std::uint16_t  n 
)

Definition at line 87 of file TestHelpers.cpp.

◆ xrpMinusFee()

PrettyAmount ripple::test::jtx::xrpMinusFee ( Env const &  env,
std::int64_t  xrpAmount 
)

Definition at line 93 of file TestHelpers.cpp.

◆ expectLine() [1/3]

bool ripple::test::jtx::expectLine ( Env env,
AccountID const &  account,
STAmount const &  value,
bool  defaultLimits 
)

Definition at line 100 of file TestHelpers.cpp.

◆ expectLine() [2/3]

bool ripple::test::jtx::expectLine ( Env env,
AccountID const &  account,
None const &  value 
)

Definition at line 134 of file TestHelpers.cpp.

◆ expectOffers()

bool ripple::test::jtx::expectOffers ( Env env,
AccountID const &  account,
std::uint16_t  size,
std::vector< Amounts > const &  toMatch 
)

Definition at line 140 of file TestHelpers.cpp.

◆ ledgerEntryRoot()

Json::Value ripple::test::jtx::ledgerEntryRoot ( Env env,
Account const &  acct 
)

Definition at line 168 of file TestHelpers.cpp.

◆ ledgerEntryState()

Json::Value ripple::test::jtx::ledgerEntryState ( Env env,
Account const &  acct_a,
Account const &  acct_b,
std::string const &  currency 
)

Definition at line 177 of file TestHelpers.cpp.

◆ accountBalance()

Json::Value ripple::test::jtx::accountBalance ( Env env,
Account const &  acct 
)

Definition at line 193 of file TestHelpers.cpp.

◆ expectLedgerEntryRoot()

bool ripple::test::jtx::expectLedgerEntryRoot ( Env env,
Account const &  acct,
STAmount const &  expectedValue 
)

Definition at line 200 of file TestHelpers.cpp.

◆ escrow() [1/2]

Json::Value ripple::test::jtx::escrow ( AccountID const &  account,
AccountID const &  to,
STAmount const &  amount 
)

Definition at line 212 of file TestHelpers.cpp.

◆ finish() [1/2]

Json::Value ripple::test::jtx::finish ( AccountID const &  account,
AccountID const &  from,
std::uint32_t  seq 
)

Definition at line 224 of file TestHelpers.cpp.

◆ cancel() [1/2]

Json::Value ripple::test::jtx::cancel ( AccountID const &  account,
Account const &  from,
std::uint32_t  seq 
)

Definition at line 236 of file TestHelpers.cpp.

◆ create() [1/2]

Json::Value ripple::test::jtx::create ( AccountID const &  account,
AccountID const &  to,
STAmount const &  amount,
NetClock::duration const &  settleDelay,
PublicKey const &  pk,
std::optional< NetClock::time_point > const &  cancelAfter,
std::optional< std::uint32_t > const &  dstTag 
)

Definition at line 250 of file TestHelpers.cpp.

◆ fund() [4/4]

Json::Value ripple::test::jtx::fund ( AccountID const &  account,
uint256 const &  channel,
STAmount const &  amount,
std::optional< NetClock::time_point > const &  expiration 
)

Definition at line 275 of file TestHelpers.cpp.

◆ claim()

Json::Value ripple::test::jtx::claim ( AccountID const &  account,
uint256 const &  channel,
std::optional< STAmount > const &  balance,
std::optional< STAmount > const &  amount,
std::optional< Slice > const &  signature,
std::optional< PublicKey > const &  pk 
)

Definition at line 293 of file TestHelpers.cpp.

◆ channel() [1/2]

uint256 ripple::test::jtx::channel ( AccountID const &  account,
AccountID const &  dst,
std::uint32_t  seqProxyValue 
)

Definition at line 318 of file TestHelpers.cpp.

◆ channelBalance()

STAmount ripple::test::jtx::channelBalance ( ReadView const &  view,
uint256 const &  chan 
)

Definition at line 328 of file TestHelpers.cpp.

◆ channelExists()

bool ripple::test::jtx::channelExists ( ReadView const &  view,
uint256 const &  chan 
)

Definition at line 337 of file TestHelpers.cpp.

◆ n_offers()

void ripple::test::jtx::n_offers ( Env env,
std::size_t  n,
Account const &  account,
STAmount const &  in,
STAmount const &  out 
)

Definition at line 347 of file TestHelpers.cpp.

◆ cpe()

STPathElement ripple::test::jtx::cpe ( Currency const &  c)

Definition at line 368 of file TestHelpers.cpp.

◆ allpe()

STPathElement ripple::test::jtx::allpe ( AccountID const &  a,
Issue const &  iss 
)

Definition at line 376 of file TestHelpers.cpp.

◆ trust() [1/2]

Json::Value ripple::test::jtx::trust ( Account const &  account,
STAmount const &  amount,
std::uint32_t  flags 
)

Modify a trust line.

Definition at line 30 of file trust.cpp.

◆ trust() [2/2]

Json::Value ripple::test::jtx::trust ( Account const &  account,
STAmount const &  amount,
Account const &  peer,
std::uint32_t  flags 
)

Change flags on a trust line.

Definition at line 43 of file trust.cpp.

◆ claw()

Json::Value ripple::test::jtx::claw ( Account const &  account,
STAmount const &  amount 
)

Definition at line 63 of file trust.cpp.

◆ parse()

STObject ripple::test::jtx::parse ( Json::Value const &  jv)

Convert JSON to STObject.

This throws on failure, the JSON must be correct.

Note
Testing malformed JSON is beyond the scope of this set of unit test routines.

Definition at line 35 of file utility.cpp.

◆ sign()

void ripple::test::jtx::sign ( Json::Value jv,
Account const &  account 
)

Sign automatically.

Note
This only works on accounts with multi-signing off.

Definition at line 44 of file utility.cpp.

◆ fill_fee()

void ripple::test::jtx::fill_fee ( Json::Value jv,
ReadView const &  view 
)

Set the fee automatically.

Definition at line 55 of file utility.cpp.

◆ fill_seq()

void ripple::test::jtx::fill_seq ( Json::Value jv,
ReadView const &  view 
)

Set the sequence number automatically.

Definition at line 63 of file utility.cpp.

◆ bridge()

Json::Value ripple::test::jtx::bridge ( Account const &  lockingChainDoor,
Issue const &  lockingChainIssue,
Account const &  issuingChainDoor,
Issue const &  issuingChainIssue 
)

Definition at line 40 of file xchain_bridge.cpp.

◆ bridge_rpc()

Json::Value ripple::test::jtx::bridge_rpc ( Account const &  lockingChainDoor,
Issue const &  lockingChainIssue,
Account const &  issuingChainDoor,
Issue const &  issuingChainIssue 
)

Definition at line 56 of file xchain_bridge.cpp.

◆ bridge_create()

Json::Value ripple::test::jtx::bridge_create ( Account const &  acc,
Json::Value const &  bridge,
STAmount const &  reward,
std::optional< STAmount > const &  minAccountCreate 
)

Definition at line 71 of file xchain_bridge.cpp.

◆ bridge_modify()

Json::Value ripple::test::jtx::bridge_modify ( Account const &  acc,
Json::Value const &  bridge,
std::optional< STAmount > const &  reward,
std::optional< STAmount > const &  minAccountCreate 
)

Definition at line 92 of file xchain_bridge.cpp.

◆ xchain_create_claim_id()

Json::Value ripple::test::jtx::xchain_create_claim_id ( Account const &  acc,
Json::Value const &  bridge,
STAmount const &  reward,
Account const &  otherChainSource 
)

Definition at line 115 of file xchain_bridge.cpp.

◆ xchain_commit()

Json::Value ripple::test::jtx::xchain_commit ( Account const &  acc,
Json::Value const &  bridge,
std::uint32_t  claimID,
AnyAmount const &  amt,
std::optional< Account > const &  dst 
)

Definition at line 134 of file xchain_bridge.cpp.

◆ xchain_claim()

Json::Value ripple::test::jtx::xchain_claim ( Account const &  acc,
Json::Value const &  bridge,
std::uint32_t  claimID,
AnyAmount const &  amt,
Account const &  dst 
)

Definition at line 156 of file xchain_bridge.cpp.

◆ sidechain_xchain_account_create()

Json::Value ripple::test::jtx::sidechain_xchain_account_create ( Account const &  acc,
Json::Value const &  bridge,
Account const &  dst,
AnyAmount const &  amt,
AnyAmount const &  reward 
)

Definition at line 177 of file xchain_bridge.cpp.

◆ claim_attestation()

Json::Value ripple::test::jtx::claim_attestation ( jtx::Account const &  submittingAccount,
Json::Value const &  jvBridge,
jtx::Account const &  sendingAccount,
jtx::AnyAmount const &  sendingAmount,
jtx::Account const &  rewardAccount,
bool  wasLockingChainSend,
std::uint64_t  claimID,
std::optional< jtx::Account > const &  dst,
jtx::signer const &  signer 
)

Definition at line 199 of file xchain_bridge.cpp.

◆ create_account_attestation()

Json::Value ripple::test::jtx::create_account_attestation ( jtx::Account const &  submittingAccount,
Json::Value const &  jvBridge,
jtx::Account const &  sendingAccount,
jtx::AnyAmount const &  sendingAmount,
jtx::AnyAmount const &  rewardAmount,
jtx::Account const &  rewardAccount,
bool  wasLockingChainSend,
std::uint64_t  createCount,
jtx::Account const &  dst,
jtx::signer const &  signer 
)

Definition at line 251 of file xchain_bridge.cpp.

◆ claim_attestations()

JValueVec ripple::test::jtx::claim_attestations ( jtx::Account const &  submittingAccount,
Json::Value const &  jvBridge,
jtx::Account const &  sendingAccount,
jtx::AnyAmount const &  sendingAmount,
std::vector< jtx::Account > const &  rewardAccounts,
bool  wasLockingChainSend,
std::uint64_t  claimID,
std::optional< jtx::Account > const &  dst,
std::vector< jtx::signer > const &  signers,
std::size_t const  numAtts,
std::size_t const  fromIdx 
)

Definition at line 306 of file xchain_bridge.cpp.

◆ create_account_attestations()

JValueVec ripple::test::jtx::create_account_attestations ( jtx::Account const &  submittingAccount,
Json::Value const &  jvBridge,
jtx::Account const &  sendingAccount,
jtx::AnyAmount const &  sendingAmount,
jtx::AnyAmount const &  rewardAmount,
std::vector< jtx::Account > const &  rewardAccounts,
bool  wasLockingChainSend,
std::uint64_t  createCount,
jtx::Account const &  dst,
std::vector< jtx::signer > const &  signers,
std::size_t const  numAtts,
std::size_t const  fromIdx 
)

Definition at line 338 of file xchain_bridge.cpp.

◆ noop()

Json::Value ripple::test::jtx::noop ( Account const &  account)

The null transaction.

Definition at line 31 of file noop.h.

◆ required()

template<class... Args>
require_t ripple::test::jtx::required ( Args const &...  args)

Compose many condition functors into one.

Definition at line 47 of file require.h.

◆ getAccountOffers() [2/2]

Json::Value ripple::test::jtx::getAccountOffers ( Env env,
Account const &  acct,
bool  current = false 
)

Definition at line 39 of file TestHelpers.h.

◆ getAccountLines() [2/3]

Json::Value ripple::test::jtx::getAccountLines ( Env env,
Account const &  acct 
)

Definition at line 48 of file TestHelpers.h.

◆ getAccountLines() [3/3]

template<typename... IOU>
Json::Value ripple::test::jtx::getAccountLines ( Env env,
AccountID const &  acctId,
IOU...  ious 
)

Definition at line 55 of file TestHelpers.h.

◆ stpath_append_one() [3/3]

template<class T >
std::enable_if_t<std::is_constructible<Account, T>::value> ripple::test::jtx::stpath_append_one ( STPath st,
T const &  t 
)

Definition at line 89 of file TestHelpers.h.

◆ stpath_append()

template<class T , class... Args>
void ripple::test::jtx::stpath_append ( STPath st,
T const &  t,
Args const &...  args 
)

Definition at line 99 of file TestHelpers.h.

◆ stpathset_append()

template<class... Args>
void ripple::test::jtx::stpathset_append ( STPathSet st,
STPath const &  p,
Args const &...  args 
)

Definition at line 108 of file TestHelpers.h.

◆ stpath()

template<class... Args>
STPath ripple::test::jtx::stpath ( Args const &...  args)

Definition at line 124 of file TestHelpers.h.

◆ same()

template<class... Args>
bool ripple::test::jtx::same ( STPathSet const &  st1,
Args const &...  args 
)

Definition at line 133 of file TestHelpers.h.

◆ expectLine() [3/3]

template<typename... Amts>
bool ripple::test::jtx::expectLine ( Env env,
AccountID const &  account,
STAmount const &  value,
Amts const &...  amts 
)

Definition at line 165 of file TestHelpers.h.

◆ escrow() [2/2]

Json::Value ripple::test::jtx::escrow ( Account const &  account,
Account const &  to,
STAmount const &  amount 
)

Definition at line 211 of file TestHelpers.h.

◆ finish() [2/2]

Json::Value ripple::test::jtx::finish ( Account const &  account,
Account const &  from,
std::uint32_t  seq 
)

Definition at line 220 of file TestHelpers.h.

◆ cancel() [2/2]

Json::Value ripple::test::jtx::cancel ( Account const &  account,
Account const &  from,
std::uint32_t  seq 
)

Definition at line 229 of file TestHelpers.h.

◆ create() [2/2]

Json::Value ripple::test::jtx::create ( Account const &  account,
Account const &  to,
STAmount const &  amount,
NetClock::duration const &  settleDelay,
PublicKey const &  pk,
std::optional< NetClock::time_point > const &  cancelAfter = std::nullopt,
std::optional< std::uint32_t > const &  dstTag = std::nullopt 
)

Definition at line 339 of file TestHelpers.h.

◆ channel() [2/2]

uint256 ripple::test::jtx::channel ( Account const &  account,
Account const &  dst,
std::uint32_t  seqProxyValue 
)

Definition at line 375 of file TestHelpers.h.

◆ sidechain_xchain_account_claim()

Json::Value ripple::test::jtx::sidechain_xchain_account_claim ( Account const &  acc,
Json::Value const &  bridge,
Account const &  dst,
AnyAmount const &  amt 
)

Variable Documentation

◆ dropsPerXRP

constexpr XRPAmount ripple::test::jtx::dropsPerXRP {1'000'000}
constexpr

Definition at line 67 of file amount.h.

◆ XRP

const XRP_t ripple::test::jtx::XRP {}

Converts to XRP Issue or STAmount.

Examples: XRP Converts to the XRP Issue XRP(10) Returns STAmount of 10 XRP

Definition at line 105 of file amount.cpp.

◆ epsilon

const epsilon_t ripple::test::jtx::epsilon
static

Definition at line 282 of file amount.h.

◆ any

const any_t ripple::test::jtx::any {}

Returns an amount representing "any issuer".

Note
With respect to what the recipient will accept

Definition at line 126 of file amount.cpp.

◆ SingleVersionedTestCallable

template<class T >
concept ripple::test::jtx::SingleVersionedTestCallable
Initial value:
= requires(T callable, unsigned int version)
{
{
callable(version)
}
->std::same_as<void>;
}

The SingleVersionedTestCallable concept checks for a callable that takes an unsigned integer as its argument and returns void.

Definition at line 724 of file Env.h.

◆ VersionedTestCallable

template<class... T>
concept ripple::test::jtx::VersionedTestCallable = (... && SingleVersionedTestCallable<T>)

The VersionedTestCallable concept checks if a set of callables all satisfy the SingleVersionedTestCallable concept.

This allows forAllApiVersions to accept any number of functions. It executes a set of provided functions over a range of versions from RPC::apiMinimumSupportedVersion to RPC::apiBetaVersion. This is useful for running a series of tests or operations that need to be performed on multiple versions of an API.

Definition at line 741 of file Env.h.

◆ defaultseed

constexpr auto ripple::test::jtx::defaultseed = "shUwVw52ofnCUX5m7kPTKzJdr4HEH"
constexpr

Definition at line 116 of file envconfig.cpp.

◆ none

const none_t ripple::test::jtx::none
static

Definition at line 34 of file tags.h.

◆ autofill

const autofill_t ripple::test::jtx::autofill
static

Definition at line 42 of file tags.h.

◆ disabled

const disabled_t ripple::test::jtx::disabled
static

Definition at line 50 of file tags.h.

◆ cb1

constexpr std::array<std::uint8_t, 39> ripple::test::jtx::cb1
constexpr
Initial value:
= {
{0xA0, 0x25, 0x80, 0x20, 0xE3, 0xB0, 0xC4, 0x42, 0x98, 0xFC,
0x1C, 0x14, 0x9A, 0xFB, 0xF4, 0xC8, 0x99, 0x6F, 0xB9, 0x24,
0x27, 0xAE, 0x41, 0xE4, 0x64, 0x9B, 0x93, 0x4C, 0xA4, 0x95,
0x99, 0x1B, 0x78, 0x52, 0xB8, 0x55, 0x81, 0x01, 0x00}}

Definition at line 234 of file TestHelpers.h.

◆ fb1

const std::array<std::uint8_t, 4> ripple::test::jtx::fb1 = {{0xA0, 0x02, 0x80, 0x00}}

Definition at line 241 of file TestHelpers.h.

◆ UT_XCHAIN_DEFAULT_NUM_SIGNERS

constexpr std::size_t ripple::test::jtx::UT_XCHAIN_DEFAULT_NUM_SIGNERS = 5
constexpr

Definition at line 36 of file xchain_bridge.h.

◆ UT_XCHAIN_DEFAULT_QUORUM

constexpr std::size_t ripple::test::jtx::UT_XCHAIN_DEFAULT_QUORUM = 4
constexpr

Definition at line 37 of file xchain_bridge.h.