#include <ValidatorList.h>

Collaboration diagram for xrpl::ValidatorList:

[legend]

Classes
struct	MessageWithHash

struct	PublisherList

struct	PublisherListCollection

struct	PublisherListStats
	Describes the result of processing a Validator List (UNL), including some of the information from the list which can be used by the caller to know which list publisher is involved. More...

Public Types
using	QuorumKeys = std::pair< std::size_t const, hash_set< PublicKey > >

Public Member Functions
	ValidatorList (ManifestCache &validatorManifests, ManifestCache &publisherManifests, TimeKeeper &timeKeeper, std::string const &databasePath, beast::Journal j, std::optional< std::size_t > minimumQuorum=std::nullopt)

	~ValidatorList ()=default

bool	load (std::optional< PublicKey > const &localSigningKey, std::vector< std::string > const &configKeys, std::vector< std::string > const &publisherKeys, std::optional< std::size_t > listThreshold={})
	Load configured trusted keys.

PublisherListStats	applyListsAndBroadcast (std::string const &manifest, std::uint32_t version, std::vector< ValidatorBlobInfo > const &blobs, std::string siteUri, uint256 const &hash, Overlay &overlay, HashRouter &hashRouter, NetworkOPs &networkOPs)
	Apply multiple published lists of public keys, then broadcast it to all peers that have not seen it or sent it.

PublisherListStats	applyLists (std::string const &manifest, std::uint32_t version, std::vector< ValidatorBlobInfo > const &blobs, std::string siteUri, std::optional< uint256 > const &hash={})
	Apply multiple published lists of public keys.

std::vector< std::string >	loadLists ()

TrustChanges	updateTrusted (hash_set< NodeID > const &seenValidators, NetClock::time_point closeTime, NetworkOPs &ops, Overlay &overlay, HashRouter &hashRouter)
	Update trusted nodes.

std::size_t	quorum () const
	Get quorum value for current trusted key set.

bool	trusted (PublicKey const &identity) const
	Returns `true` if public key is trusted.

bool	listed (PublicKey const &identity) const
	Returns `true` if public key is included on any lists.

std::optional< PublicKey >	getTrustedKey (PublicKey const &identity) const
	Returns master public key if public key is trusted.

std::optional< PublicKey >	getListedKey (PublicKey const &identity) const
	Returns listed master public if public key is included on any lists.

bool	trustedPublisher (PublicKey const &identity) const
	Returns `true` if public key is a trusted publisher.

std::optional< PublicKey >	localPublicKey () const
	This function returns the local validator public key or a std::nullopt.

void	for_each_listed (std::function< void(PublicKey const &, bool)> func) const
	Invokes the callback once for every listed validation public key.

void	for_each_available (std::function< void(std::string const &manifest, std::uint32_t version, std::map< std::size_t, ValidatorBlobInfo > const &blobInfos, PublicKey const &pubKey, std::size_t maxSequence, uint256 const &hash)> func) const
	Invokes the callback once for every available publisher list's raw data members.

std::optional< Json::Value >	getAvailable (std::string_view pubKey, std::optional< std::uint32_t > forceVersion={})
	Returns the current valid list for the given publisher key, if available, as a Json object.

std::size_t	count () const
	Return the number of configured validator list sites.

std::optional< TimeKeeper::time_point >	expires () const
	Return the time when the validator list will expire.

Json::Value	getJson () const
	Return a JSON representation of the state of the validator list.

QuorumKeys	getQuorumKeys () const
	Get the quorum and all of the trusted keys.

hash_set< PublicKey >	getTrustedMasterKeys () const
	get the trusted master public keys

std::size_t	getListThreshold () const
	get the validator list threshold

hash_set< PublicKey >	getNegativeUNL () const
	get the master public keys of Negative UNL validators

void	setNegativeUNL (hash_set< PublicKey > const &negUnl)
	set the Negative UNL with validators' master public keys

std::vector< std::shared_ptr< STValidation > >	negativeUNLFilter (std::vector< std::shared_ptr< STValidation > > &&validations) const
	Remove validations that are from validators on the negative UNL.

Static Public Member Functions
static std::vector< ValidatorBlobInfo >	parseBlobs (std::uint32_t version, Json::Value const &body)
	Pull the blob/signature/manifest information out of the appropriate Json body fields depending on the version.

static std::vector< ValidatorBlobInfo >	parseBlobs (protocol::TMValidatorList const &body)

static std::vector< ValidatorBlobInfo >	parseBlobs (protocol::TMValidatorListCollection const &body)

static void	sendValidatorList (Peer &peer, std::uint64_t peerSequence, PublicKey const &publisherKey, std::size_t maxSequence, std::uint32_t rawVersion, std::string const &rawManifest, std::map< std::size_t, ValidatorBlobInfo > const &blobInfos, HashRouter &hashRouter, beast::Journal j)

static std::pair< std::size_t, std::size_t >	buildValidatorListMessages (std::size_t messageVersion, std::uint64_t peerSequence, std::size_t maxSequence, std::uint32_t rawVersion, std::string const &rawManifest, std::map< std::size_t, ValidatorBlobInfo > const &blobInfos, std::vector< MessageWithHash > &messages, std::size_t maxSize=maximumMessageSize)

Private Types
using	lock_guard = std::lock_guard< decltype(mutex_)>

using	shared_lock = std::shared_lock< decltype(mutex_)>

Private Member Functions
std::size_t	count (shared_lock const &) const
	Return the number of configured validator list sites.

bool	trusted (shared_lock const &, PublicKey const &identity) const
	Returns `true` if public key is trusted.

std::optional< PublicKey >	getTrustedKey (shared_lock const &, PublicKey const &identity) const
	Returns master public key if public key is trusted.

std::optional< TimeKeeper::time_point >	expires (shared_lock const &) const
	Return the time when the validator list will expire.

PublisherListStats	applyList (std::string const &globalManifest, std::optional< std::string > const &localManifest, std::string const &blob, std::string const &signature, std::uint32_t version, std::string siteUri, std::optional< uint256 > const &hash, lock_guard const &)
	Apply published list of public keys.

void	updatePublisherList (PublicKey const &pubKey, PublisherList const &current, std::vector< PublicKey > const &oldList, lock_guard const &)

boost::filesystem::path	getCacheFileName (lock_guard const &, PublicKey const &pubKey) const
	Get the filename used for caching UNLs.

void	cacheValidatorFile (lock_guard const &lock, PublicKey const &pubKey) const
	Write a JSON UNL to a cache file.

std::pair< ListDisposition, std::optional< PublicKey > >	verify (lock_guard const &, Json::Value &list, Manifest manifest, std::string const &blob, std::string const &signature)
	Check response for trusted valid published list.

bool	removePublisherList (lock_guard const &, PublicKey const &publisherKey, PublisherStatus reason)
	Stop trusting publisher's list of keys.

std::size_t	calculateQuorum (std::size_t unlSize, std::size_t effectiveUnlSize, std::size_t seenSize)
	Return quorum for trusted validator set.

Static Private Member Functions
static void	buildBlobInfos (std::map< std::size_t, ValidatorBlobInfo > &blobInfos, PublisherListCollection const &lists)

static std::map< std::size_t, ValidatorBlobInfo >	buildBlobInfos (PublisherListCollection const &lists)

static void	broadcastBlobs (PublicKey const &publisherKey, PublisherListCollection const &lists, std::size_t maxSequence, uint256 const &hash, Overlay &overlay, HashRouter &hashRouter, beast::Journal j)

static void	sendValidatorList (Peer &peer, std::uint64_t peerSequence, PublicKey const &publisherKey, std::size_t maxSequence, std::uint32_t rawVersion, std::string const &rawManifest, std::map< std::size_t, ValidatorBlobInfo > const &blobInfos, std::vector< MessageWithHash > &messages, HashRouter &hashRouter, beast::Journal j)

static Json::Value	buildFileData (std::string const &pubKey, PublisherListCollection const &pubCollection, beast::Journal j)
	Build a Json representation of the collection, suitable for writing to a cache file, or serving to a /vl/ query.

static Json::Value	buildFileData (std::string const &pubKey, PublisherListCollection const &pubCollection, std::optional< std::uint32_t > forceVersion, beast::Journal j)
	Build a Json representation of the collection, suitable for writing to a cache file, or serving to a /vl/ query.

Private Attributes
ManifestCache &	validatorManifests_

ManifestCache &	publisherManifests_

TimeKeeper &	timeKeeper_

boost::filesystem::path const	dataPath_

beast::Journal const	j_

std::shared_mutex	mutex_

std::atomic< std::size_t >	quorum_

std::optional< std::size_t >	minimumQuorum_

hash_map< PublicKey, PublisherListCollection >	publisherLists_

hash_map< PublicKey, std::size_t >	keyListings_

hash_set< PublicKey >	trustedMasterKeys_

std::size_t	listThreshold_

hash_set< PublicKey >	trustedSigningKeys_

std::optional< PublicKey >	localPubKey_

PublisherList	localPublisherList

hash_set< PublicKey >	negativeUNL_

Static Private Attributes
static constexpr std::uint32_t	supportedListVersions [] {1, 2}

static constexpr std::size_t	maxSupportedBlobs = 5

static std::string const	filePrefix_ = "cache."

Friends
template<class Hasher >
void	hash_append (Hasher &h, PublisherListCollection pl)

Detailed Description

Trusted Validators List

Rippled accepts ledger proposals and validations from trusted validator nodes. A ledger is considered fully-validated once the number of received trusted validations for a ledger meets or exceeds a quorum value.

This class manages the set of validation public keys the local rippled node trusts. The list of trusted keys is populated using the keys listed in the configuration file as well as lists signed by trusted publishers. The trusted publisher public keys are specified in the config.

New lists are expected to include the following data:

"blob": Base64-encoded JSON string containing a "sequence", "validFrom", "validUntil", and "validators" field. "validFrom" contains the Ripple timestamp (seconds since January 1st, 2000 (00:00 UTC)) for when the list becomes valid. "validUntil" contains the Ripple timestamp for when the list expires. "validators" contains an array of objects with a "validation_public_key" and optional "manifest" field. "validation_public_key" should be the hex-encoded master public key. "manifest" should be the base64-encoded validator manifest.

"manifest": Base64-encoded serialization of a manifest containing the publisher's master and signing public keys.

"signature": Hex-encoded signature of the blob using the publisher's signing key.

"version": 1

Individual validator lists are stored separately by publisher. The number of lists on which a validator's public key appears is also tracked.

The list of trusted validation public keys is reset at the start of each consensus round to take into account the latest known lists as well as the set of validators from whom validations are being received. Listed validation public keys are shuffled and then sorted by the number of lists they appear on. (The shuffling makes the order/rank of validators with the same number of listings non-deterministic.) A quorum value is calculated for the new trusted validator list. If there is only one list, all listed keys are trusted. Otherwise, the trusted list size is set to 125% of the quorum.

Definition at line 152 of file ValidatorList.h.

Member Typedef Documentation

◆ lock_guard

using xrpl::ValidatorList::lock_guard = std::lock_guard<decltype(mutex_)>

private

Definition at line 210 of file ValidatorList.h.

◆ shared_lock

using xrpl::ValidatorList::shared_lock = std::shared_lock<decltype(mutex_)>

private

Definition at line 211 of file ValidatorList.h.

◆ QuorumKeys

using xrpl::ValidatorList::QuorumKeys = std::pair<std::size_t const, hash_set<PublicKey> >

Definition at line 637 of file ValidatorList.h.

Constructor & Destructor Documentation

◆ ValidatorList()

xrpl::ValidatorList::ValidatorList	(	ManifestCache &	validatorManifests,
		ManifestCache &	publisherManifests,
		TimeKeeper &	timeKeeper,
		std::string const &	databasePath,
		beast::Journal	j,
		std::optional< std::size_t >	minimumQuorum = `std::nullopt`
	)

Definition at line 98 of file ValidatorList.cpp.

◆ ~ValidatorList()

xrpl::ValidatorList::~ValidatorList ( )

default

Member Function Documentation

◆ load()

bool xrpl::ValidatorList::load	(	std::optional< PublicKey > const &	localSigningKey,
		std::vector< std::string > const &	configKeys,
		std::vector< std::string > const &	publisherKeys,
		std::optional< std::size_t >	listThreshold = `{}`
	)

Load configured trusted keys.

Parameters

localSigningKey	This node's validation public key
configKeys	List of trusted keys from config. Each entry consists of a base58 encoded validation public key, optionally followed by a comment.
publisherKeys	List of trusted publisher public keys. Each entry contains a base58 encoded account public key.

Thread Safety

May be called concurrently

Returns: false if an entry is invalid or unparsable

Definition at line 117 of file ValidatorList.cpp.

◆ parseBlobs() [1/3]

std::vector< ValidatorBlobInfo > xrpl::ValidatorList::parseBlobs	(	std::uint32_t	version,
		Json::Value const &	body
	)

static

Pull the blob/signature/manifest information out of the appropriate Json body fields depending on the version.

Returns: An empty vector indicates malformed Json.

Definition at line 357 of file ValidatorList.cpp.

◆ parseBlobs() [2/3]

std::vector< ValidatorBlobInfo > xrpl::ValidatorList::parseBlobs ( protocol::TMValidatorList const & body )

static

Definition at line 414 of file ValidatorList.cpp.

◆ parseBlobs() [3/3]

std::vector< ValidatorBlobInfo > xrpl::ValidatorList::parseBlobs ( protocol::TMValidatorListCollection const & body )

static

Definition at line 421 of file ValidatorList.cpp.

◆ sendValidatorList() [1/2]

void xrpl::ValidatorList::sendValidatorList	(	Peer &	peer,
		std::uint64_t	peerSequence,
		PublicKey const &	publisherKey,
		std::size_t	maxSequence,
		std::uint32_t	rawVersion,
		std::string const &	rawManifest,
		std::map< std::size_t, ValidatorBlobInfo > const &	blobInfos,
		HashRouter &	hashRouter,
		beast::Journal	j
	)

static

Definition at line 728 of file ValidatorList.cpp.

◆ buildValidatorListMessages()

std::pair< std::size_t, std::size_t > xrpl::ValidatorList::buildValidatorListMessages	(	std::size_t	messageVersion,
		std::uint64_t	peerSequence,
		std::size_t	maxSequence,
		std::uint32_t	rawVersion,
		std::string const &	rawManifest,
		std::map< std::size_t, ValidatorBlobInfo > const &	blobInfos,
		std::vector< MessageWithHash > &	messages,
		std::size_t	maxSize = `maximumMessageSize`
	)

static

Definition at line 612 of file ValidatorList.cpp.

◆ applyListsAndBroadcast()

ValidatorList::PublisherListStats xrpl::ValidatorList::applyListsAndBroadcast	(	std::string const &	manifest,
		std::uint32_t	version,
		std::vector< ValidatorBlobInfo > const &	blobs,
		std::string	siteUri,
		uint256 const &	hash,
		Overlay &	overlay,
		HashRouter &	hashRouter,
		NetworkOPs &	networkOPs
	)

Apply multiple published lists of public keys, then broadcast it to all peers that have not seen it or sent it.

Parameters

manifest	base64-encoded publisher key manifest
version	Version of published list format
blobs	Vector of BlobInfos representing one or more encoded validator lists and signatures (and optional manifests)
siteUri	Uri of the site from which the list was validated
hash	Hash of the data parameters
overlay	Overlay object which will handle sending the message
hashRouter	HashRouter object which will determine which peers not to send to
networkOPs	NetworkOPs object which will be informed if there is a valid VL

Returns: ListDisposition::accepted, plus some of the publisher information, if list was successfully applied

Thread Safety

May be called concurrently

Definition at line 834 of file ValidatorList.cpp.

◆ applyLists()

ValidatorList::PublisherListStats xrpl::ValidatorList::applyLists	(	std::string const &	manifest,
		std::uint32_t	version,
		std::vector< ValidatorBlobInfo > const &	blobs,
		std::string	siteUri,
		std::optional< uint256 > const &	hash = `{}`
	)

Apply multiple published lists of public keys.

Parameters

manifest	base64-encoded publisher key manifest
version	Version of published list format
blobs	Vector of BlobInfos representing one or more encoded validator lists and signatures (and optional manifests)
siteUri	Uri of the site from which the list was validated
hash	Optional hash of the data parameters

Returns: ListDisposition::accepted, plus some of the publisher information, if list was successfully applied

Thread Safety

May be called concurrently

Definition at line 883 of file ValidatorList.cpp.

◆ loadLists()

std::vector< std::string > xrpl::ValidatorList::loadLists ( )

Definition at line 1161 of file ValidatorList.cpp.

◆ updateTrusted()

TrustChanges xrpl::ValidatorList::updateTrusted	(	hash_set< NodeID > const &	seenValidators,
		NetClock::time_point	closeTime,
		NetworkOPs &	ops,
		Overlay &	overlay,
		HashRouter &	hashRouter
	)

Update trusted nodes.

Reset the trusted nodes based on latest manifests, received validations, and lists.

Parameters

seenValidators Set of NodeIDs of validators that have signed recently received validations

Returns: TrustedKeyChanges instance with newly trusted or untrusted node identities.

Thread Safety

May be called concurrently

Definition at line 1734 of file ValidatorList.cpp.

◆ quorum()

std::size_t xrpl::ValidatorList::quorum ( ) const

Get quorum value for current trusted key set.

The quorum is the minimum number of validations needed for a ledger to be fully validated. It can change when the set of trusted validation keys is updated (at the start of each consensus round) and primarily depends on the number of trusted keys.

Thread Safety

May be called concurrently

Returns: quorum value

Definition at line 479 of file ValidatorList.h.

◆ trusted() [1/2]

bool xrpl::ValidatorList::trusted ( PublicKey const & identity ) const

Returns true if public key is trusted.

Parameters

identity Validation public key

Thread Safety

May be called concurrently

Definition at line 1312 of file ValidatorList.cpp.

◆ listed()

bool xrpl::ValidatorList::listed ( PublicKey const & identity ) const

Returns true if public key is included on any lists.

Parameters

identity Validation public key

Thread Safety

May be called concurrently

Definition at line 1296 of file ValidatorList.cpp.

◆ getTrustedKey() [1/2]

std::optional< PublicKey > xrpl::ValidatorList::getTrustedKey ( PublicKey const & identity ) const

Returns master public key if public key is trusted.

Parameters

identity Validation public key

Returns: std::nullopt if key is not trusted

Thread Safety

May be called concurrently

Definition at line 1339 of file ValidatorList.cpp.

◆ getListedKey()

std::optional< PublicKey > xrpl::ValidatorList::getListedKey ( PublicKey const & identity ) const

Returns listed master public if public key is included on any lists.

Parameters

identity Validation public key

Returns: std::nullopt if key is not listed

Thread Safety

May be called concurrently

Definition at line 1319 of file ValidatorList.cpp.

◆ trustedPublisher()

bool xrpl::ValidatorList::trustedPublisher ( PublicKey const & identity ) const

Returns true if public key is a trusted publisher.

Parameters

identity Publisher public key

Thread Safety

May be called concurrently

Definition at line 1347 of file ValidatorList.cpp.

◆ localPublicKey()

std::optional< PublicKey > xrpl::ValidatorList::localPublicKey ( ) const

This function returns the local validator public key or a std::nullopt.

Thread Safety

May be called concurrently

Definition at line 1355 of file ValidatorList.cpp.

◆ for_each_listed()

void xrpl::ValidatorList::for_each_listed ( std::function< void(PublicKey const &, bool)> func ) const

Invokes the callback once for every listed validation public key.

Note: Undefined behavior results when calling ValidatorList members from within the callback

The arguments passed into the lambda are:

The validation public key

A boolean indicating whether this is a trusted key

Thread Safety

May be called concurrently

Definition at line 1589 of file ValidatorList.cpp.

◆ for_each_available()

void xrpl::ValidatorList::for_each_available ( std::function< void(std::string const &manifest, std::uint32_t version, std::map< std::size_t, ValidatorBlobInfo > const &blobInfos, PublicKey const &pubKey, std::size_t maxSequence, uint256 const &hash)> func ) const

Invokes the callback once for every available publisher list's raw data members.

Note: Undefined behavior results when calling ValidatorList members from within the callback

The arguments passed into the lambda are:

The raw manifest string

The raw "blob" string containing the values for the validator list

The signature string used to sign the blob

The version number

The PublicKey of the blob signer (matches the value from [validator_list_keys])

The sequence number of the "blob"

The precomputed hash of the original / raw elements

Thread Safety

May be called concurrently

Definition at line 1598 of file ValidatorList.cpp.

◆ getAvailable()

std::optional< Json::Value > xrpl::ValidatorList::getAvailable	(	std::string_view	pubKey,
		std::optional< std::uint32_t >	forceVersion = `{}`
	)

Returns the current valid list for the given publisher key, if available, as a Json object.

Definition at line 1624 of file ValidatorList.cpp.

◆ count() [1/2]

std::size_t xrpl::ValidatorList::count ( ) const

Return the number of configured validator list sites.

Definition at line 1401 of file ValidatorList.cpp.

◆ expires() [1/2]

std::optional< TimeKeeper::time_point > xrpl::ValidatorList::expires ( ) const

Return the time when the validator list will expire.

Note: This may be a time in the past if a published list has not been updated since its validUntil. It will be std::nullopt if any configured published list has not been fetched.

Thread Safety: May be called concurrently

Definition at line 1457 of file ValidatorList.cpp.

◆ getJson()

Json::Value xrpl::ValidatorList::getJson ( ) const

Return a JSON representation of the state of the validator list.

Thread Safety: May be called concurrently

Definition at line 1464 of file ValidatorList.cpp.

◆ getQuorumKeys()

QuorumKeys xrpl::ValidatorList::getQuorumKeys ( ) const

Get the quorum and all of the trusted keys.

Returns: quorum and keys.

Definition at line 643 of file ValidatorList.h.

◆ getTrustedMasterKeys()

hash_set< PublicKey > xrpl::ValidatorList::getTrustedMasterKeys ( ) const

get the trusted master public keys

Returns: the public keys

Definition at line 1906 of file ValidatorList.cpp.

◆ getListThreshold()

std::size_t xrpl::ValidatorList::getListThreshold ( ) const

get the validator list threshold

Returns: the threshold

Definition at line 1913 of file ValidatorList.cpp.

◆ getNegativeUNL()

hash_set< PublicKey > xrpl::ValidatorList::getNegativeUNL ( ) const

get the master public keys of Negative UNL validators

Returns: the master public keys

Definition at line 1920 of file ValidatorList.cpp.

◆ setNegativeUNL()

void xrpl::ValidatorList::setNegativeUNL ( hash_set< PublicKey > const & negUnl )

set the Negative UNL with validators' master public keys

Parameters

negUnl the public keys

Definition at line 1927 of file ValidatorList.cpp.

◆ negativeUNLFilter()

std::vector< std::shared_ptr< STValidation > > xrpl::ValidatorList::negativeUNLFilter ( std::vector< std::shared_ptr< STValidation > > && validations ) const

Remove validations that are from validators on the negative UNL.

Parameters

validations the validations to filter

Returns: a filtered copy of the validations

Definition at line 1934 of file ValidatorList.cpp.

◆ count() [2/2]

std::size_t xrpl::ValidatorList::count ( ValidatorList::shared_lock const & ) const

private

Return the number of configured validator list sites.

Definition at line 1395 of file ValidatorList.cpp.

◆ trusted() [2/2]

bool xrpl::ValidatorList::trusted	(	ValidatorList::shared_lock const &	,
		PublicKey const &	identity
	)		const

private

Returns true if public key is trusted.

Parameters

identity Validation public key

Thread Safety

May be called concurrently

Definition at line 1305 of file ValidatorList.cpp.

◆ getTrustedKey() [2/2]

std::optional< PublicKey > xrpl::ValidatorList::getTrustedKey	(	ValidatorList::shared_lock const &	,
		PublicKey const &	identity
	)		const

private

Returns master public key if public key is trusted.

Parameters

identity Validation public key

Returns: std::nullopt if key is not trusted

Thread Safety

May be called concurrently

Definition at line 1330 of file ValidatorList.cpp.

◆ expires() [2/2]

std::optional< TimeKeeper::time_point > xrpl::ValidatorList::expires ( ValidatorList::shared_lock const & ) const

private

Return the time when the validator list will expire.

Note: This may be a time in the past if a published list has not been updated since its expiration. It will be std::nullopt if any configured published list has not been fetched.

Thread Safety: May be called concurrently

Definition at line 1408 of file ValidatorList.cpp.

◆ applyList()

ValidatorList::PublisherListStats xrpl::ValidatorList::applyList	(	std::string const &	globalManifest,
		std::optional< std::string > const &	localManifest,
		std::string const &	blob,
		std::string const &	signature,
		std::uint32_t	version,
		std::string	siteUri,
		std::optional< uint256 > const &	hash,
		ValidatorList::lock_guard const &	lock
	)

private

Apply published list of public keys.

Parameters

manifest	base64-encoded publisher key manifest
blob	base64-encoded json containing published validator list
signature	Signature of the decoded blob
version	Version of published list format
siteUri	Uri of the site from which the list was validated
hash	Optional hash of the data parameters. Defaults to uninitialized

Returns: ListDisposition::accepted, plus some of the publisher information, if list was successfully applied

Thread Safety

May be called concurrently

Definition at line 1005 of file ValidatorList.cpp.

◆ updatePublisherList()

void xrpl::ValidatorList::updatePublisherList	(	PublicKey const &	pubKey,
		PublisherList const &	current,
		std::vector< PublicKey > const &	oldList,
		ValidatorList::lock_guard const &
	)

private

Definition at line 947 of file ValidatorList.cpp.

◆ buildBlobInfos() [1/2]

void xrpl::ValidatorList::buildBlobInfos	(	std::map< std::size_t, ValidatorBlobInfo > &	blobInfos,
		ValidatorList::PublisherListCollection const &	lists
	)

staticprivate

Definition at line 746 of file ValidatorList.cpp.

◆ buildBlobInfos() [2/2]

std::map< std::size_t, ValidatorBlobInfo > xrpl::ValidatorList::buildBlobInfos ( ValidatorList::PublisherListCollection const & lists )

staticprivate

Definition at line 761 of file ValidatorList.cpp.

◆ broadcastBlobs()

void xrpl::ValidatorList::broadcastBlobs	(	PublicKey const &	publisherKey,
		ValidatorList::PublisherListCollection const &	lists,
		std::size_t	maxSequence,
		uint256 const &	hash,
		Overlay &	overlay,
		HashRouter &	hashRouter,
		beast::Journal	j
	)

staticprivate

Definition at line 770 of file ValidatorList.cpp.

◆ sendValidatorList() [2/2]

void xrpl::ValidatorList::sendValidatorList	(	Peer &	peer,
		std::uint64_t	peerSequence,
		PublicKey const &	publisherKey,
		std::size_t	maxSequence,
		std::uint32_t	rawVersion,
		std::string const &	rawManifest,
		std::map< std::size_t, ValidatorBlobInfo > const &	blobInfos,
		std::vector< MessageWithHash > &	messages,
		HashRouter &	hashRouter,
		beast::Journal	j
	)

staticprivate

Definition at line 666 of file ValidatorList.cpp.

◆ getCacheFileName()

boost::filesystem::path xrpl::ValidatorList::getCacheFileName	(	ValidatorList::lock_guard const &	,
		PublicKey const &	pubKey
	)		const

private

Get the filename used for caching UNLs.

Definition at line 254 of file ValidatorList.cpp.

◆ buildFileData() [1/2]

Json::Value xrpl::ValidatorList::buildFileData	(	std::string const &	pubKey,
		ValidatorList::PublisherListCollection const &	pubCollection,
		beast::Journal	j
	)

staticprivate

Build a Json representation of the collection, suitable for writing to a cache file, or serving to a /vl/ query.

Definition at line 261 of file ValidatorList.cpp.

◆ buildFileData() [2/2]

Json::Value xrpl::ValidatorList::buildFileData	(	std::string const &	pubKey,
		ValidatorList::PublisherListCollection const &	pubCollection,
		std::optional< std::uint32_t >	forceVersion,
		beast::Journal	j
	)

staticprivate

Build a Json representation of the collection, suitable for writing to a cache file, or serving to a /vl/ query.

Definition at line 271 of file ValidatorList.cpp.

◆ cacheValidatorFile()

void xrpl::ValidatorList::cacheValidatorFile	(	ValidatorList::lock_guard const &	lock,
		PublicKey const &	pubKey
	)		const

private

Write a JSON UNL to a cache file.

Definition at line 330 of file ValidatorList.cpp.

◆ verify()

std::pair< ListDisposition, std::optional< PublicKey > > xrpl::ValidatorList::verify	(	ValidatorList::lock_guard const &	lock,
		Json::Value &	list,
		Manifest	manifest,
		std::string const &	blob,
		std::string const &	signature
	)

private

Check response for trusted valid published list.

Returns: ListDisposition::accepted if list can be applied

Thread Safety

Calling public member function is expected to lock mutex

Definition at line 1216 of file ValidatorList.cpp.

◆ removePublisherList()

bool xrpl::ValidatorList::removePublisherList	(	ValidatorList::lock_guard const &	,
		PublicKey const &	publisherKey,
		PublisherStatus	reason
	)

private

Stop trusting publisher's list of keys.

Parameters

publisherKey Publisher public key

Returns: false if key was not trusted

Thread Safety

Calling public member function is expected to lock mutex

Definition at line 1362 of file ValidatorList.cpp.

◆ calculateQuorum()

std::size_t xrpl::ValidatorList::calculateQuorum	(	std::size_t	unlSize,
		std::size_t	effectiveUnlSize,
		std::size_t	seenSize
	)

private

Return quorum for trusted validator set.

Parameters

unlSize	Number of trusted validator keys
effectiveUnlSize	Number of trusted validator keys that are not in the NegativeUNL
seenSize	Number of trusted validators that have signed recently received validations

Definition at line 1649 of file ValidatorList.cpp.

Friends And Related Symbol Documentation

◆ hash_append

template<class Hasher >

void hash_append	(	Hasher &	h,
		PublisherListCollection	pl
	)

friend

Definition at line 821 of file ValidatorList.h.

Member Data Documentation

◆ validatorManifests_

ManifestCache& xrpl::ValidatorList::validatorManifests_

private

Definition at line 204 of file ValidatorList.h.

◆ publisherManifests_

ManifestCache& xrpl::ValidatorList::publisherManifests_

private

Definition at line 205 of file ValidatorList.h.

◆ timeKeeper_

TimeKeeper& xrpl::ValidatorList::timeKeeper_

private

Definition at line 206 of file ValidatorList.h.

◆ dataPath_

boost::filesystem::path const xrpl::ValidatorList::dataPath_

private

Definition at line 207 of file ValidatorList.h.

◆ j_

beast::Journal const xrpl::ValidatorList::j_

private

Definition at line 208 of file ValidatorList.h.

◆ mutex_

std::shared_mutex xrpl::ValidatorList::mutex_

mutableprivate

Definition at line 209 of file ValidatorList.h.

◆ quorum_

std::atomic<std::size_t> xrpl::ValidatorList::quorum_

private

Definition at line 213 of file ValidatorList.h.

◆ minimumQuorum_

std::optional<std::size_t> xrpl::ValidatorList::minimumQuorum_

private

Definition at line 214 of file ValidatorList.h.

◆ publisherLists_

hash_map<PublicKey, PublisherListCollection> xrpl::ValidatorList::publisherLists_

private

Definition at line 217 of file ValidatorList.h.

◆ keyListings_

hash_map<PublicKey, std::size_t> xrpl::ValidatorList::keyListings_

private

Definition at line 220 of file ValidatorList.h.

◆ trustedMasterKeys_

hash_set<PublicKey> xrpl::ValidatorList::trustedMasterKeys_

private

Definition at line 223 of file ValidatorList.h.

◆ listThreshold_

std::size_t xrpl::ValidatorList::listThreshold_

private

Definition at line 226 of file ValidatorList.h.

◆ trustedSigningKeys_

hash_set<PublicKey> xrpl::ValidatorList::trustedSigningKeys_

private

Definition at line 231 of file ValidatorList.h.

◆ localPubKey_

std::optional<PublicKey> xrpl::ValidatorList::localPubKey_

private

Definition at line 233 of file ValidatorList.h.

◆ localPublisherList

PublisherList xrpl::ValidatorList::localPublisherList

private

Definition at line 243 of file ValidatorList.h.

◆ negativeUNL_

hash_set<PublicKey> xrpl::ValidatorList::negativeUNL_

private

Definition at line 246 of file ValidatorList.h.

◆ supportedListVersions

constexpr std::uint32_t xrpl::ValidatorList::supportedListVersions[] {1, 2}

staticconstexprprivate

Definition at line 249 of file ValidatorList.h.

◆ maxSupportedBlobs

constexpr std::size_t xrpl::ValidatorList::maxSupportedBlobs = 5

staticconstexprprivate

Definition at line 252 of file ValidatorList.h.

◆ filePrefix_

std::string const xrpl::ValidatorList::filePrefix_ = "cache."

staticprivate

Definition at line 254 of file ValidatorList.h.

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Trusted Validators List

Member Typedef Documentation

◆ lock_guard

◆ shared_lock

◆ QuorumKeys

Constructor & Destructor Documentation

◆ ValidatorList()

◆ ~ValidatorList()

Member Function Documentation

◆ load()

◆ parseBlobs() [1/3]

◆ parseBlobs() [2/3]

◆ parseBlobs() [3/3]

◆ sendValidatorList() [1/2]

◆ buildValidatorListMessages()

◆ applyListsAndBroadcast()

◆ applyLists()

◆ loadLists()

◆ updateTrusted()

◆ quorum()

◆ trusted() [1/2]

◆ listed()

◆ getTrustedKey() [1/2]

◆ getListedKey()

◆ trustedPublisher()

◆ localPublicKey()

◆ for_each_listed()

◆ for_each_available()

◆ getAvailable()

◆ count() [1/2]

◆ expires() [1/2]

◆ getJson()

◆ getQuorumKeys()

◆ getTrustedMasterKeys()

◆ getListThreshold()

◆ getNegativeUNL()

◆ setNegativeUNL()

◆ negativeUNLFilter()

◆ count() [2/2]

◆ trusted() [2/2]

◆ getTrustedKey() [2/2]

◆ expires() [2/2]

◆ applyList()

◆ updatePublisherList()

◆ buildBlobInfos() [1/2]

◆ buildBlobInfos() [2/2]

◆ broadcastBlobs()

◆ sendValidatorList() [2/2]

◆ getCacheFileName()

◆ buildFileData() [1/2]

◆ buildFileData() [2/2]

◆ cacheValidatorFile()

◆ verify()

◆ removePublisherList()

◆ calculateQuorum()

Friends And Related Symbol Documentation

◆ hash_append

Member Data Documentation

◆ validatorManifests_

◆ publisherManifests_

◆ timeKeeper_

◆ dataPath_

◆ j_

◆ mutex_

◆ quorum_

◆ minimumQuorum_

◆ publisherLists_

◆ keyListings_

◆ trustedMasterKeys_