events.h

#pragma once
 
#include <csf/Tx.h>
#include <csf/Validation.h>
#include <csf/ledgers.h>
 
namespace xrpl::test::csf {
 
// Events are emitted by peers at a variety of points during the simulation.
// Each event is emitted by a particular peer at a particular time. Collectors
// process these events, perhaps calculating statistics or storing events to
// a log for post-processing.
//
// The Event types can be arbitrary, but should be copyable and lightweight.
//
// Example collectors can be found in collectors.h, but have the general
// interface:
//
// @code
//     template <class T>
//     struct Collector
//     {
//        template <class Event>
//        void
//        on(peerID who, SimTime when, Event e);
//     };
// @endcode
//
// CollectorRef.f defines a type-erased holder for arbitrary Collectors.  If
// any new events are added, the interface there needs to be updated.

template <class V>
struct Share
{
    V val;
};

template <class V>
struct Relay
{
    PeerID to;

    V val;
};

template <class V>
struct Receive
{
    PeerID from;

    V val;
};

struct SubmitTx
{
    Tx tx;
};

struct StartRound
{
    Ledger::ID bestLedger{};

    Ledger prevLedger;
};

struct CloseLedger
{
    // The ledger closed on
    Ledger prevLedger;
 
    // Initial txs for including in ledger
    TxSetType txs;
};

struct AcceptLedger
{
    // The newly created ledger
    Ledger ledger;
 
    // The prior ledger (this is a jump if prior.id() != ledger.parentID())
    Ledger prior;
};

struct WrongPrevLedger
{
    // ID of wrong ledger we had
    Ledger::ID wrong;
    // ID of what we think is the correct ledger
    Ledger::ID right;
};

struct FullyValidateLedger
{
    Ledger ledger;

    Ledger prior;
};
 
}  // namespace xrpl::test::csf