xrpl::test::jtx::MPTTester Class Reference

Test helper for creating, mutating, and asserting MPT and confidential MPT ledger state. More...

#include <mpt.h>

Collaboration diagram for xrpl::test::jtx::MPTTester:

Public Types
enum class	EncryptedBalanceType { IssuerEncryptedBalance , HolderEncryptedInbox , HolderEncryptedSpending , AuditorEncryptedBalance }

Public Member Functions
	MPTTester (Env &env, Account issuer, MPTInit const &constr={})
	MPTTester (MPTInitDef const &constr)
	MPTTester (Env &env, Account issuer, MPTID const &id, std::vector< Account > const &holders={}, bool close=true)
	operator MPT () const
void	create (MPTCreate const &arg=MPTCreate{})
void	destroy (MPTDestroy const &arg=MPTDestroy{})
void	authorize (MPTAuthorize const &arg=MPTAuthorize{})
void	authorizeHolders (Holders const &holders)
void	set (MPTSet const &set={})
void	convert (MPTConvert const &arg=MPTConvert{})
json::Value	convertJV (MPTConvert const &arg, std::uint32_t seq)
	Build a confidential convert JV without submitting it.
void	mergeInbox (MPTMergeInbox const &arg=MPTMergeInbox{})
json::Value	mergeInboxJV (MPTMergeInbox const &arg=MPTMergeInbox{}) const
void	send (MPTConfidentialSend const &arg=MPTConfidentialSend{})
json::Value	sendJV (MPTConfidentialSend const &arg, std::uint32_t seq, std::optional< ConfidentialSendChainState > chain=std::nullopt)
	Build a confidential send JV.
ConfidentialSendChainState	chainAfterSend (Account const &sender, std::uint64_t sendAmt, json::Value const &jv) const
	Compute the projected sender state after a confidential send in a batch.
void	convertBack (MPTConvertBack const &arg=MPTConvertBack{})
json::Value	convertBackJV (MPTConvertBack const &arg, std::uint32_t seq)
	Build a confidential convertBack JV without submitting it.
void	confidentialClaw (MPTConfidentialClawback const &arg=MPTConfidentialClawback{})
bool	checkDomainID (std::optional< uint256 > expected) const
bool	checkMPTokenAmount (Account const &holder, std::int64_t expectedAmount) const
bool	checkMPTokenOutstandingAmount (std::int64_t expectedAmount) const
bool	checkIssuanceConfidentialBalance (std::int64_t expectedAmount) const
bool	checkFlags (uint32_t const expectedFlags, std::optional< Account > const &holder=std::nullopt) const
bool	checkMetadata (std::string const &metadata) const
bool	isMetadataPresent () const
bool	checkTransferFee (std::uint16_t transferFee) const
bool	isTransferFeePresent () const
Account const &	issuer () const
Account const &	holder (std::string const &h) const
void	pay (Account const &src, Account const &dest, std::int64_t amount, std::optional< TER > err=std::nullopt, std::optional< std::vector< std::string > > credentials=std::nullopt)
void	claw (Account const &issuer, Account const &holder, std::int64_t amount, std::optional< TER > err=std::nullopt)
PrettyAmount	mpt (std::int64_t amount) const
MPTID const &	issuanceID () const
std::int64_t	getBalance (Account const &account) const
std::int64_t	getIssuanceConfidentialBalance () const
std::optional< Buffer >	getEncryptedBalance (Account const &account, EncryptedBalanceType option=holderEncryptedInbox) const
MPT	operator[] (std::string const &name) const
PrettyAmount	operator() (std::int64_t amount) const
	operator Asset () const
void	generateKeyPair (Account const &account)
std::optional< Buffer >	getPubKey (Account const &account) const
std::optional< Buffer >	getPrivKey (Account const &account) const
Buffer	encryptAmount (Account const &account, uint64_t const amt, Buffer const &blindingFactor) const
std::optional< uint64_t >	decryptAmount (Account const &account, Buffer const &amt) const
std::optional< uint64_t >	getDecryptedBalance (Account const &account, EncryptedBalanceType balanceType) const
std::optional< std::int64_t >	getIssuanceOutstandingBalance () const
std::optional< Buffer >	getClawbackProof (Account const &holder, std::uint64_t amount, Buffer const &privateKey, uint256 const &txHash) const
std::optional< Buffer >	getSchnorrProof (Account const &account, uint256 const &ctxHash) const
std::optional< Buffer >	getConfidentialSendProof (Account const &sender, std::uint64_t const amount, std::vector< ConfidentialRecipient > const &recipients, Slice const &blindingFactor, uint256 const &contextHash, PedersenProofParams const &amountParams, PedersenProofParams const &balanceParams) const
Buffer	getConvertBackProof (Account const &holder, std::uint64_t const amount, uint256 const &contextHash, PedersenProofParams const &pcParams) const
std::uint32_t	getMPTokenVersion (Account const account) const

Static Public Member Functions
static json::Value	createJV (MPTCreate const &arg=MPTCreate{})
static json::Value	destroyJV (MPTDestroy const &arg=MPTDestroy{})
static json::Value	authorizeJV (MPTAuthorize const &arg=MPTAuthorize{})
static json::Value	setJV (MPTSet const &set={})
static Buffer	getPedersenCommitment (std::uint64_t const amount, Buffer const &pedersenBlindingFactor)

Static Public Attributes
static constexpr auto	issuerEncryptedBalance = EncryptedBalanceType::IssuerEncryptedBalance
static constexpr auto	holderEncryptedInbox = EncryptedBalanceType::HolderEncryptedInbox
static constexpr auto	holderEncryptedSpending = EncryptedBalanceType::HolderEncryptedSpending
static constexpr auto	auditorEncryptedBalance = EncryptedBalanceType::AuditorEncryptedBalance

Private Types
using	SLEP = SLE::const_pointer

Private Member Functions
bool	forObject (std::function< bool(SLEP const &sle)> const &cb, std::optional< Account > const &holder=std::nullopt) const
template<typename A>
TER	submit (A const &arg, json::Value jv)
std::uint32_t	getFlags (std::optional< Account > const &holder) const
template<typename T>
void	fillConversionCiphertexts (T const &arg, json::Value &jv, Buffer &holderCiphertext, Buffer &issuerCiphertext, std::optional< Buffer > &auditorCiphertext, Buffer &blindingFactor) const

Static Private Member Functions
static std::unordered_map< std::string, Account >	makeHolders (std::vector< Account > const &holders)

Private Attributes
Env &	env_
Account const	issuer_
std::unordered_map< std::string, Account > const	holders_
std::optional< Account > const	auditor_
std::optional< MPTID >	id_
bool	close_
std::unordered_map< AccountID, Buffer >	pubKeys_
std::unordered_map< AccountID, Buffer >	privKeys_

Friends
BookSpec	operator~ (MPTTester const &mpt)

Detailed Description

Test helper for creating, mutating, and asserting MPT and confidential MPT ledger state.

Definition at line 384 of file mpt.h.

Member Typedef Documentation

SLEP

using xrpl::test::jtx::MPTTester::SLEP = SLE::const_pointer

private

Definition at line 662 of file mpt.h.

Member Enumeration Documentation

EncryptedBalanceType

enum class xrpl::test::jtx::MPTTester::EncryptedBalanceType

strong

Enumerator
IssuerEncryptedBalance
HolderEncryptedInbox
HolderEncryptedSpending
AuditorEncryptedBalance

Definition at line 396 of file mpt.h.

Constructor & Destructor Documentation

MPTTester() [1/3]

xrpl::test::jtx::MPTTester::MPTTester	(	Env &	env,
		Account	issuer,
		MPTInit const &	constr = {} )

Definition at line 143 of file mpt.cpp.

MPTTester() [2/3]

xrpl::test::jtx::MPTTester::MPTTester

(

MPTInitDef const &

constr

)

Definition at line 210 of file mpt.cpp.

MPTTester() [3/3]

xrpl::test::jtx::MPTTester::MPTTester	(	Env &	env,
		Account	issuer,
		MPTID const &	id,
		std::vector< Account > const &	holders = {},
		bool	close = true )

Definition at line 178 of file mpt.cpp.

Member Function Documentation

operator MPT()

xrpl::test::jtx::MPTTester::operator MPT

(

)

const

Definition at line 223 of file mpt.cpp.

create()

void xrpl::test::jtx::MPTTester::create

(

MPTCreate const &

arg = MPTCreate{}

)

Definition at line 256 of file mpt.cpp.

createJV()

json::Value xrpl::test::jtx::MPTTester::createJV ( MPTCreate const & arg = MPTCreate{} )

static

Definition at line 232 of file mpt.cpp.

destroy()

void xrpl::test::jtx::MPTTester::destroy

(

MPTDestroy const &

arg = MPTDestroy{}

)

Definition at line 334 of file mpt.cpp.

destroyJV()

json::Value xrpl::test::jtx::MPTTester::destroyJV ( MPTDestroy const & arg = MPTDestroy{} )

static

Definition at line 321 of file mpt.cpp.

authorize()

void xrpl::test::jtx::MPTTester::authorize

(

MPTAuthorize const &

arg = MPTAuthorize{}

)

Definition at line 368 of file mpt.cpp.

authorizeJV()

json::Value xrpl::test::jtx::MPTTester::authorizeJV ( MPTAuthorize const & arg = MPTAuthorize{} )

static

Definition at line 353 of file mpt.cpp.

authorizeHolders()

void xrpl::test::jtx::MPTTester::authorizeHolders

(

Holders const &

holders

)

Definition at line 430 of file mpt.cpp.

set()

void xrpl::test::jtx::MPTTester::set

(

MPTSet const &

set = {}

)

Definition at line 482 of file mpt.cpp.

setJV()

json::Value xrpl::test::jtx::MPTTester::setJV ( MPTSet const & set = {} )

static

Definition at line 439 of file mpt.cpp.

convert()

void xrpl::test::jtx::MPTTester::convert

(

MPTConvert const &

arg = MPTConvert{}

)

Definition at line 1086 of file mpt.cpp.

convertJV()

json::Value xrpl::test::jtx::MPTTester::convertJV	(	MPTConvert const &	arg,
		std::uint32_t	seq )

Build a confidential convert JV without submitting it.

Parameters

arg	Transaction builder arguments.
seq	Inner transaction sequence used in the Schnorr proof context hash.

Returns

The transaction JSON object.

Definition at line 1259 of file mpt.cpp.

mergeInbox()

void xrpl::test::jtx::MPTTester::mergeInbox

(

MPTMergeInbox const &

arg = MPTMergeInbox{}

)

Definition at line 2164 of file mpt.cpp.

mergeInboxJV()

json::Value xrpl::test::jtx::MPTTester::mergeInboxJV ( MPTMergeInbox const & arg = MPTMergeInbox{} ) const

nodiscard

Definition at line 2138 of file mpt.cpp.

send()

void xrpl::test::jtx::MPTTester::send

(

MPTConfidentialSend const &

arg = MPTConfidentialSend{}

)

Definition at line 1321 of file mpt.cpp.

sendJV()

json::Value xrpl::test::jtx::MPTTester::sendJV	(	MPTConfidentialSend const &	arg,
		std::uint32_t	seq,
		std::optional< ConfidentialSendChainState >	chain = std::nullopt )

Build a confidential send JV.

When chain is provided, the sender's proof parameters are taken from it instead of the ledger, enabling proof generation for a second or later send from the same account inside a single batch.

Parameters

arg	Transaction builder arguments.
seq	Inner transaction sequence used in the proof context hash.
chain	Optional predicted sender state from a previous batched send.

Returns

The transaction JSON object.

Definition at line 1659 of file mpt.cpp.

chainAfterSend()

ConfidentialSendChainState xrpl::test::jtx::MPTTester::chainAfterSend ( Account const & sender, std::uint64_t sendAmt, json::Value const & jv ) const

nodiscard

Compute the projected sender state after a confidential send in a batch.

Each confidential send requires a ZK proof that the sender's spending balance covers the transfer. In a batch, the second and later sends from the same sender need proofs built against the updated spending balance.

Parameters

sender	The sender whose post-send state is being predicted.
sendAmt	The plaintext amount sent by the transaction.
jv	The confidential send transaction JSON object.

Returns

The predicted sender state after applying the send.

Definition at line 1885 of file mpt.cpp.

convertBack()

void xrpl::test::jtx::MPTTester::convertBack

(

MPTConvertBack const &

arg = MPTConvertBack{}

)

Definition at line 2286 of file mpt.cpp.

convertBackJV()

json::Value xrpl::test::jtx::MPTTester::convertBackJV	(	MPTConvertBack const &	arg,
		std::uint32_t	seq )

Build a confidential convertBack JV without submitting it.

Reads the current encrypted spending balance and version from the ledger, so call this before the batch is submitted.

Parameters

arg	Transaction builder arguments.
seq	Inner transaction sequence used in the proof context hash.

Returns

The transaction JSON object.

Definition at line 2453 of file mpt.cpp.

confidentialClaw()

void xrpl::test::jtx::MPTTester::confidentialClaw

(

MPTConfidentialClawback const &

arg = MPTConfidentialClawback{}

)

Definition at line 1925 of file mpt.cpp.

checkDomainID()

bool xrpl::test::jtx::MPTTester::checkDomainID ( std::optional< uint256 > expected ) const

nodiscard

Definition at line 597 of file mpt.cpp.

checkMPTokenAmount()

bool xrpl::test::jtx::MPTTester::checkMPTokenAmount ( Account const & holder, std::int64_t expectedAmount ) const

nodiscard

Definition at line 607 of file mpt.cpp.

checkMPTokenOutstandingAmount()

bool xrpl::test::jtx::MPTTester::checkMPTokenOutstandingAmount ( std::int64_t expectedAmount ) const

nodiscard

Definition at line 614 of file mpt.cpp.

checkIssuanceConfidentialBalance()

bool xrpl::test::jtx::MPTTester::checkIssuanceConfidentialBalance ( std::int64_t expectedAmount ) const

nodiscard

Definition at line 621 of file mpt.cpp.

checkFlags()

bool xrpl::test::jtx::MPTTester::checkFlags ( uint32_t const expectedFlags, std::optional< Account > const & holder = std::nullopt ) const

nodiscard

Definition at line 629 of file mpt.cpp.

checkMetadata()

bool xrpl::test::jtx::MPTTester::checkMetadata ( std::string const & metadata ) const

nodiscard

Definition at line 635 of file mpt.cpp.

isMetadataPresent()

bool xrpl::test::jtx::MPTTester::isMetadataPresent ( ) const

nodiscard

Definition at line 645 of file mpt.cpp.

checkTransferFee()

bool xrpl::test::jtx::MPTTester::checkTransferFee ( std::uint16_t transferFee ) const

nodiscard

Definition at line 652 of file mpt.cpp.

isTransferFeePresent()

bool xrpl::test::jtx::MPTTester::isTransferFeePresent ( ) const

nodiscard

Definition at line 662 of file mpt.cpp.

issuer()

Account const & xrpl::test::jtx::MPTTester::issuer ( ) const

nodiscard

Definition at line 551 of file mpt.h.

holder()

Account const & xrpl::test::jtx::MPTTester::holder ( std::string const & h ) const

nodiscard

Definition at line 344 of file mpt.cpp.

pay()

void xrpl::test::jtx::MPTTester::pay	(	Account const &	src,
		Account const &	dest,
		std::int64_t	amount,
		std::optional< TER >	err = std::nullopt,
		std::optional< std::vector< std::string > >	credentials = std::nullopt )

Definition at line 668 of file mpt.cpp.

claw()

void xrpl::test::jtx::MPTTester::claw	(	Account const &	issuer,
		Account const &	holder,
		std::int64_t	amount,
		std::optional< TER >	err = std::nullopt )

Definition at line 720 of file mpt.cpp.

mpt()

PrettyAmount xrpl::test::jtx::MPTTester::mpt ( std::int64_t amount ) const

nodiscard

Definition at line 741 of file mpt.cpp.

issuanceID()

MPTID const & xrpl::test::jtx::MPTTester::issuanceID ( ) const

nodiscard

Definition at line 576 of file mpt.h.

getBalance()

std::int64_t xrpl::test::jtx::MPTTester::getBalance ( Account const & account ) const

nodiscard

Definition at line 757 of file mpt.cpp.

getIssuanceConfidentialBalance()

std::int64_t xrpl::test::jtx::MPTTester::getIssuanceConfidentialBalance ( ) const

nodiscard

Definition at line 775 of file mpt.cpp.

getEncryptedBalance()

std::optional< Buffer > xrpl::test::jtx::MPTTester::getEncryptedBalance ( Account const & account, EncryptedBalanceType option = holderEncryptedInbox ) const

nodiscard

Definition at line 972 of file mpt.cpp.

operator[]()

MPT xrpl::test::jtx::MPTTester::operator[]

(

std::string const &

name

)

const

Definition at line 1021 of file mpt.cpp.

operator()()

PrettyAmount xrpl::test::jtx::MPTTester::operator()

(

std::int64_t

amount

)

const

Definition at line 1027 of file mpt.cpp.

operator Asset()

xrpl::test::jtx::MPTTester::operator Asset

(

)

const

Definition at line 748 of file mpt.cpp.

generateKeyPair()

void xrpl::test::jtx::MPTTester::generateKeyPair

(

Account const &

account

)

Definition at line 2027 of file mpt.cpp.

getPubKey()

std::optional< Buffer > xrpl::test::jtx::MPTTester::getPubKey ( Account const & account ) const

nodiscard

Definition at line 2049 of file mpt.cpp.

getPrivKey()

std::optional< Buffer > xrpl::test::jtx::MPTTester::getPrivKey ( Account const & account ) const

nodiscard

Definition at line 2058 of file mpt.cpp.

encryptAmount()

Buffer xrpl::test::jtx::MPTTester::encryptAmount ( Account const & account, uint64_t const amt, Buffer const & blindingFactor ) const

nodiscard

Definition at line 2067 of file mpt.cpp.

decryptAmount()

std::optional< uint64_t > xrpl::test::jtx::MPTTester::decryptAmount ( Account const & account, Buffer const & amt ) const

nodiscard

Definition at line 2082 of file mpt.cpp.

getDecryptedBalance()

std::optional< uint64_t > xrpl::test::jtx::MPTTester::getDecryptedBalance ( Account const & account, EncryptedBalanceType balanceType ) const

nodiscard

Definition at line 2112 of file mpt.cpp.

getIssuanceOutstandingBalance()

std::optional< std::int64_t > xrpl::test::jtx::MPTTester::getIssuanceOutstandingBalance ( ) const

nodiscard

Definition at line 2256 of file mpt.cpp.

getClawbackProof()

std::optional< Buffer > xrpl::test::jtx::MPTTester::getClawbackProof ( Account const & holder, std::uint64_t amount, Buffer const & privateKey, uint256 const & txHash ) const

nodiscard

Definition at line 787 of file mpt.cpp.

getSchnorrProof()

std::optional< Buffer > xrpl::test::jtx::MPTTester::getSchnorrProof ( Account const & account, uint256 const & ctxHash ) const

nodiscard

Definition at line 827 of file mpt.cpp.

getConfidentialSendProof()

std::optional< Buffer > xrpl::test::jtx::MPTTester::getConfidentialSendProof ( Account const & sender, std::uint64_t const amount, std::vector< ConfidentialRecipient > const & recipients, Slice const & blindingFactor, uint256 const & contextHash, PedersenProofParams const & amountParams, PedersenProofParams const & balanceParams ) const

nodiscard

Definition at line 850 of file mpt.cpp.

getConvertBackProof()

Buffer xrpl::test::jtx::MPTTester::getConvertBackProof ( Account const & holder, std::uint64_t const amount, uint256 const & contextHash, PedersenProofParams const & pcParams ) const

nodiscard

Definition at line 937 of file mpt.cpp.

getMPTokenVersion()

std::uint32_t xrpl::test::jtx::MPTTester::getMPTokenVersion ( Account const account ) const

nodiscard

Definition at line 2270 of file mpt.cpp.

getPedersenCommitment()

Buffer xrpl::test::jtx::MPTTester::getPedersenCommitment ( std::uint64_t const amount, Buffer const & pedersenBlindingFactor )

static

Definition at line 911 of file mpt.cpp.

forObject()

bool xrpl::test::jtx::MPTTester::forObject ( std::function< bool(SLEP const &sle)> const & cb, std::optional< Account > const & holder = std::nullopt ) const

private

Definition at line 584 of file mpt.cpp.

submit()

template<typename A>

TER xrpl::test::jtx::MPTTester::submit ( A const & arg, json::Value jv )

private

Definition at line 670 of file mpt.h.

makeHolders()

std::unordered_map< std::string, Account > xrpl::test::jtx::MPTTester::makeHolders ( std::vector< Account > const & holders )

staticprivate

Definition at line 131 of file mpt.cpp.

getFlags()

std::uint32_t xrpl::test::jtx::MPTTester::getFlags ( std::optional< Account > const & holder ) const

nodiscardprivate

Definition at line 1007 of file mpt.cpp.

fillConversionCiphertexts()

template<typename T>

void xrpl::test::jtx::MPTTester::fillConversionCiphertexts ( T const & arg, json::Value & jv, Buffer & holderCiphertext, Buffer & issuerCiphertext, std::optional< Buffer > & auditorCiphertext, Buffer & blindingFactor ) const

private

Definition at line 1034 of file mpt.cpp.

Friends And Related Symbol Documentation

operator~

BookSpec operator~ ( MPTTester const & mpt )

friend

Definition at line 656 of file mpt.h.

Member Data Documentation

env_

Env& xrpl::test::jtx::MPTTester::env_

private

Definition at line 386 of file mpt.h.

issuer_

Account const xrpl::test::jtx::MPTTester::issuer_

private

Definition at line 387 of file mpt.h.

holders_

std::unordered_map<std::string, Account> const xrpl::test::jtx::MPTTester::holders_

private

Definition at line 388 of file mpt.h.

auditor_

std::optional<Account> const xrpl::test::jtx::MPTTester::auditor_

private

Definition at line 389 of file mpt.h.

id_

std::optional<MPTID> xrpl::test::jtx::MPTTester::id_

private

Definition at line 390 of file mpt.h.

close_

bool xrpl::test::jtx::MPTTester::close_

private

Definition at line 391 of file mpt.h.

pubKeys_

std::unordered_map<AccountID, Buffer> xrpl::test::jtx::MPTTester::pubKeys_

private

Definition at line 392 of file mpt.h.

privKeys_

std::unordered_map<AccountID, Buffer> xrpl::test::jtx::MPTTester::privKeys_

private

Definition at line 393 of file mpt.h.

issuerEncryptedBalance

auto xrpl::test::jtx::MPTTester::issuerEncryptedBalance = EncryptedBalanceType::IssuerEncryptedBalance

staticconstexpr

Definition at line 403 of file mpt.h.

holderEncryptedInbox

auto xrpl::test::jtx::MPTTester::holderEncryptedInbox = EncryptedBalanceType::HolderEncryptedInbox

staticconstexpr

Definition at line 404 of file mpt.h.

holderEncryptedSpending

auto xrpl::test::jtx::MPTTester::holderEncryptedSpending = EncryptedBalanceType::HolderEncryptedSpending

staticconstexpr

Definition at line 405 of file mpt.h.

auditorEncryptedBalance

auto xrpl::test::jtx::MPTTester::auditorEncryptedBalance = EncryptedBalanceType::AuditorEncryptedBalance

staticconstexpr

Definition at line 406 of file mpt.h.