Classes
struct	TaxonTag

struct	TokenAndPage
	Finds the token in the owner's token directory. More...

Typedefs
using	Taxon = tagged_integer< std::uint32_t, TaxonTag >

Functions
Taxon	toTaxon (std::uint32_t i)

std::uint32_t	toUInt32 (Taxon t)

std::uint16_t	getFlags (uint256 const &id)

std::uint16_t	getTransferFee (uint256 const &id)

std::uint32_t	getSerial (uint256 const &id)

Taxon	cipheredTaxon (std::uint32_t tokenSeq, Taxon taxon)

Taxon	getTaxon (uint256 const &id)

AccountID	getIssuer (uint256 const &id)

uint256 constexpr	pageMask (std::string_view("0000000000000000000000000000000000000000ffffffffffffffffffffffff"))

Rate	transferFeeAsRate (std::uint16_t fee)
	Given a transfer fee (in basis points) convert it to a transfer rate.

std::size_t	removeTokenOffersWithLimit (ApplyView &view, Keylet const &directory, std::size_t maxDeletableOffers)
	Delete up to a specified number of offers from the specified token offer directory.

TER	notTooManyOffers (ReadView const &view, uint256 const &nftokenID)
	Returns tesSUCCESS if NFToken has few enough offers that it can be burned.

std::optional< STObject >	findToken (ReadView const &view, AccountID const &owner, uint256 const &nftokenID)
	Finds the specified token in the owner's token directory.

std::optional< TokenAndPage >	findTokenAndPage (ApplyView &view, AccountID const &owner, uint256 const &nftokenID)

TER	insertToken (ApplyView &view, AccountID owner, STObject &&nft)
	Insert the token in the owner's token directory.

TER	removeToken (ApplyView &view, AccountID const &owner, uint256 const &nftokenID)
	Remove the token from the owner's token directory.

TER	removeToken (ApplyView &view, AccountID const &owner, uint256 const &nftokenID, std::shared_ptr< SLE > const &curr)
	Remove the token from the owner's token directory.

bool	deleteTokenOffer (ApplyView &view, std::shared_ptr< SLE > const &offer)
	Deletes the given token offer.

bool	repairNFTokenDirectoryLinks (ApplyView &view, AccountID const &owner)
	Repairs the links in an NFTokenPage directory.

bool	compareTokens (uint256 const &a, uint256 const &b)

TER	changeTokenURI (ApplyView &view, AccountID const &owner, uint256 const &nftokenID, std::optional< xrpl::Slice > const &uri)

NotTEC	tokenOfferCreatePreflight (AccountID const &acctID, STAmount const &amount, std::optional< AccountID > const &dest, std::optional< std::uint32_t > const &expiration, std::uint16_t nftFlags, Rules const &rules, std::optional< AccountID > const &owner=std::nullopt, std::uint32_t txFlags=tfSellNFToken)
	Preflight checks shared by NFTokenCreateOffer and NFTokenMint.

TER	tokenOfferCreatePreclaim (ReadView const &view, AccountID const &acctID, AccountID const &nftIssuer, STAmount const &amount, std::optional< AccountID > const &dest, std::uint16_t nftFlags, std::uint16_t xferFee, beast::Journal j, std::optional< AccountID > const &owner=std::nullopt, std::uint32_t txFlags=tfSellNFToken)
	Preclaim checks shared by NFTokenCreateOffer and NFTokenMint.

TER	tokenOfferCreateApply (ApplyView &view, AccountID const &acctID, STAmount const &amount, std::optional< AccountID > const &dest, std::optional< std::uint32_t > const &expiration, SeqProxy seqProxy, uint256 const &nftokenID, XRPAmount const &priorBalance, beast::Journal j, std::uint32_t txFlags=tfSellNFToken)
	doApply implementation shared by NFTokenCreateOffer and NFTokenMint

TER	checkTrustlineAuthorized (ReadView const &view, AccountID const id, beast::Journal const j, Issue const &issue)

TER	checkTrustlineDeepFrozen (ReadView const &view, AccountID const id, beast::Journal const j, Issue const &issue)

static std::shared_ptr< SLE const >	locatePage (ReadView const &view, AccountID const &owner, uint256 const &id)

static std::shared_ptr< SLE >	locatePage (ApplyView &view, AccountID const &owner, uint256 const &id)

static std::shared_ptr< SLE >	getPageForToken (ApplyView &view, AccountID const &owner, uint256 const &id, std::function< void(ApplyView &, AccountID const &)> const &createCallback)

static bool	mergePages (ApplyView &view, std::shared_ptr< SLE > const &p1, std::shared_ptr< SLE > const &p2)

Variables
constexpr std::uint16_t const	flagBurnable = 0x0001

constexpr std::uint16_t const	flagOnlyXRP = 0x0002

constexpr std::uint16_t const	flagCreateTrustLines = 0x0004

constexpr std::uint16_t const	flagTransferable = 0x0008

constexpr std::uint16_t const	flagMutable = 0x0010

Typedef Documentation

◆ Taxon

using xrpl::nft::Taxon = typedef tagged_integer<std::uint32_t, TaxonTag>

Definition at line 19 of file nft.h.

Function Documentation

◆ toTaxon()

Taxon xrpl::nft::toTaxon ( std::uint32_t i )

Definition at line 22 of file nft.h.

◆ toUInt32()

std::uint32_t xrpl::nft::toUInt32 ( Taxon t )

Definition at line 28 of file nft.h.

◆ getFlags()

std::uint16_t xrpl::nft::getFlags ( uint256 const & id )

Definition at line 40 of file nft.h.

◆ getTransferFee()

std::uint16_t xrpl::nft::getTransferFee ( uint256 const & id )

Definition at line 48 of file nft.h.

◆ getSerial()

std::uint32_t xrpl::nft::getSerial ( uint256 const & id )

Definition at line 56 of file nft.h.

◆ cipheredTaxon()

Taxon xrpl::nft::cipheredTaxon	(	std::uint32_t	tokenSeq,
		Taxon	taxon
	)

Definition at line 64 of file nft.h.

◆ getTaxon()

Taxon xrpl::nft::getTaxon ( uint256 const & id )

Definition at line 88 of file nft.h.

◆ getIssuer()

AccountID xrpl::nft::getIssuer ( uint256 const & id )

Definition at line 100 of file nft.h.

◆ pageMask()

uint256 constexpr xrpl::nft::pageMask ( std::string_view("0000000000000000000000000000000000000000ffffffffffffffffffffffff") )

constexpr

◆ transferFeeAsRate()

Rate xrpl::nft::transferFeeAsRate ( std::uint16_t fee )

Given a transfer fee (in basis points) convert it to a transfer rate.

Definition at line 26 of file Rate2.cpp.

◆ removeTokenOffersWithLimit()

std::size_t xrpl::nft::removeTokenOffersWithLimit	(	ApplyView &	view,
		Keylet const &	directory,
		std::size_t	maxDeletableOffers
	)

Delete up to a specified number of offers from the specified token offer directory.

Definition at line 560 of file NFTokenUtils.cpp.

◆ notTooManyOffers()

TER xrpl::nft::notTooManyOffers	(	ReadView const &	view,
		uint256 const &	nftokenID
	)

Returns tesSUCCESS if NFToken has few enough offers that it can be burned.

Definition at line 610 of file NFTokenUtils.cpp.

◆ findToken()

std::optional< STObject > xrpl::nft::findToken	(	ReadView const &	view,
		AccountID const &	owner,
		uint256 const &	nftokenID
	)

Finds the specified token in the owner's token directory.

Definition at line 520 of file NFTokenUtils.cpp.

◆ findTokenAndPage()

std::optional< TokenAndPage > xrpl::nft::findTokenAndPage	(	ApplyView &	view,
		AccountID const &	owner,
		uint256 const &	nftokenID
	)

Definition at line 539 of file NFTokenUtils.cpp.

◆ insertToken()

TER xrpl::nft::insertToken	(	ApplyView &	view,
		AccountID	owner,
		STObject &&	nft
	)

Insert the token in the owner's token directory.

Definition at line 241 of file NFTokenUtils.cpp.

◆ removeToken() [1/2]

TER xrpl::nft::removeToken	(	ApplyView &	view,
		AccountID const &	owner,
		uint256 const &	nftokenID
	)

Remove the token from the owner's token directory.

Definition at line 339 of file NFTokenUtils.cpp.

◆ removeToken() [2/2]

TER xrpl::nft::removeToken	(	ApplyView &	view,
		AccountID const &	owner,
		uint256 const &	nftokenID,
		std::shared_ptr< SLE > const &	page
	)

Remove the token from the owner's token directory.

Definition at line 352 of file NFTokenUtils.cpp.

◆ deleteTokenOffer()

bool xrpl::nft::deleteTokenOffer	(	ApplyView &	view,
		std::shared_ptr< SLE > const &	offer
	)

Deletes the given token offer.

An offer is tracked in two separate places:

The token's 'buy' directory, if it's a buy offer; or
The token's 'sell' directory, if it's a sell offer; and
The owner directory of the account that placed the offer.

The offer also consumes one incremental reserve.

Definition at line 637 of file NFTokenUtils.cpp.

◆ repairNFTokenDirectoryLinks()

bool xrpl::nft::repairNFTokenDirectoryLinks	(	ApplyView &	view,
		AccountID const &	owner
	)

Repairs the links in an NFTokenPage directory.

Returns true if a repair took place, otherwise false.

Definition at line 665 of file NFTokenUtils.cpp.

◆ compareTokens()

bool xrpl::nft::compareTokens	(	uint256 const &	a,
		uint256 const &	b
	)

Definition at line 190 of file NFTokenUtils.cpp.

◆ changeTokenURI()

TER xrpl::nft::changeTokenURI	(	ApplyView &	view,
		AccountID const &	owner,
		uint256 const &	nftokenID,
		std::optional< xrpl::Slice > const &	uri
	)

Definition at line 204 of file NFTokenUtils.cpp.

◆ tokenOfferCreatePreflight()

NotTEC xrpl::nft::tokenOfferCreatePreflight	(	AccountID const &	acctID,
		STAmount const &	amount,
		std::optional< AccountID > const &	dest,
		std::optional< std::uint32_t > const &	expiration,
		std::uint16_t	nftFlags,
		Rules const &	rules,
		std::optional< AccountID > const &	owner = `std::nullopt`,
		std::uint32_t	txFlags = `tfSellNFToken`
	)

Preflight checks shared by NFTokenCreateOffer and NFTokenMint.

Definition at line 784 of file NFTokenUtils.cpp.

◆ tokenOfferCreatePreclaim()

TER xrpl::nft::tokenOfferCreatePreclaim	(	ReadView const &	view,
		AccountID const &	acctID,
		AccountID const &	nftIssuer,
		STAmount const &	amount,
		std::optional< AccountID > const &	dest,
		std::uint16_t	nftFlags,
		std::uint16_t	xferFee,
		beast::Journal	j,
		std::optional< AccountID > const &	owner = `std::nullopt`,
		std::uint32_t	txFlags = `tfSellNFToken`
	)

Preclaim checks shared by NFTokenCreateOffer and NFTokenMint.

Definition at line 835 of file NFTokenUtils.cpp.

◆ tokenOfferCreateApply()

TER xrpl::nft::tokenOfferCreateApply	(	ApplyView &	view,
		AccountID const &	acctID,
		STAmount const &	amount,
		std::optional< AccountID > const &	dest,
		std::optional< std::uint32_t > const &	expiration,
		SeqProxy	seqProxy,
		uint256 const &	nftokenID,
		XRPAmount const &	priorBalance,
		beast::Journal	j,
		std::uint32_t	txFlags = `tfSellNFToken`
	)

doApply implementation shared by NFTokenCreateOffer and NFTokenMint

Definition at line 935 of file NFTokenUtils.cpp.

◆ checkTrustlineAuthorized()

TER xrpl::nft::checkTrustlineAuthorized	(	ReadView const &	view,
		AccountID const	id,
		beast::Journal const	j,
		Issue const &	issue
	)

Definition at line 1007 of file NFTokenUtils.cpp.

◆ checkTrustlineDeepFrozen()

TER xrpl::nft::checkTrustlineDeepFrozen	(	ReadView const &	view,
		AccountID const	id,
		beast::Journal const	j,
		Issue const &	issue
	)

Definition at line 1059 of file NFTokenUtils.cpp.

◆ locatePage() [1/2]

static std::shared_ptr< SLE const > xrpl::nft::locatePage	(	ReadView const &	view,
		AccountID const &	owner,
		uint256 const &	id
	)

static

Definition at line 22 of file NFTokenUtils.cpp.

◆ locatePage() [2/2]

static std::shared_ptr< SLE > xrpl::nft::locatePage	(	ApplyView &	view,
		AccountID const &	owner,
		uint256 const &	id
	)

static

Definition at line 35 of file NFTokenUtils.cpp.

◆ getPageForToken()

static std::shared_ptr< SLE > xrpl::nft::getPageForToken	(	ApplyView &	view,
		AccountID const &	owner,
		uint256 const &	id,
		std::function< void(ApplyView &, AccountID const &)> const &	createCallback
	)

static

Definition at line 48 of file NFTokenUtils.cpp.

◆ mergePages()

static bool xrpl::nft::mergePages	(	ApplyView &	view,
		std::shared_ptr< SLE > const &	p1,
		std::shared_ptr< SLE > const &	p2
	)

static

Definition at line 277 of file NFTokenUtils.cpp.

Variable Documentation

◆ flagBurnable

constexpr std::uint16_t const xrpl::nft::flagBurnable = 0x0001

constexpr

Definition at line 33 of file nft.h.

◆ flagOnlyXRP

constexpr std::uint16_t const xrpl::nft::flagOnlyXRP = 0x0002

constexpr

Definition at line 34 of file nft.h.

◆ flagCreateTrustLines

constexpr std::uint16_t const xrpl::nft::flagCreateTrustLines = 0x0004

constexpr

Definition at line 35 of file nft.h.

◆ flagTransferable

constexpr std::uint16_t const xrpl::nft::flagTransferable = 0x0008

constexpr

Definition at line 36 of file nft.h.

◆ flagMutable

constexpr std::uint16_t const xrpl::nft::flagMutable = 0x0010

constexpr

Definition at line 37 of file nft.h.

Classes

Typedefs

Functions

Variables

Typedef Documentation

◆ Taxon

Function Documentation

◆ toTaxon()

◆ toUInt32()

◆ getFlags()

◆ getTransferFee()

◆ getSerial()

◆ cipheredTaxon()

◆ getTaxon()

◆ getIssuer()

◆ pageMask()

◆ transferFeeAsRate()

◆ removeTokenOffersWithLimit()

◆ notTooManyOffers()

◆ findToken()

◆ findTokenAndPage()

◆ insertToken()

◆ removeToken() [1/2]

◆ removeToken() [2/2]

◆ deleteTokenOffer()

◆ repairNFTokenDirectoryLinks()

◆ compareTokens()

◆ changeTokenURI()

◆ tokenOfferCreatePreflight()

◆ tokenOfferCreatePreclaim()

◆ tokenOfferCreateApply()

◆ checkTrustlineAuthorized()

◆ checkTrustlineDeepFrozen()

◆ locatePage() [1/2]

◆ locatePage() [2/2]

◆ getPageForToken()

◆ mergePages()

Variable Documentation

◆ flagBurnable

◆ flagOnlyXRP

◆ flagCreateTrustLines

◆ flagTransferable

◆ flagMutable