Struct sn_client::SpendDag

pub struct SpendDag { /* private fields */ }

A DAG representing the spends from a specific Spend all the way to the UTXOs. Starting from Genesis, this would encompass all the spends that have happened on the network at a certain point in time.

                                  -> Spend7 ---> UTXO_11
                                /
Genesis -> Spend1 -----> Spend2 ---> Spend5 ---> UTXO_10
                  \
                    ---> Spend3 ---> Spend6 ---> UTXO_9
                    \
                      -> Spend4 ---> UTXO_8

Implementations

impl SpendDag

pub fn new(source: SpendAddress) -> Self

Create a new DAG with a given source

pub fn source(&self) -> SpendAddress

pub fn load_from_file<P: AsRef<Path>>(path: P) -> Result<Self, Error>

pub fn dump_to_file<P: AsRef<Path>>(&self, path: P) -> Result<(), Error>

pub fn insert(&mut self, spend_addr: SpendAddress, spend: SignedSpend) -> bool

Insert a spend into the dag Creating edges (links) from its ancestors and to its descendants If the inserted spend is already known, it will be ignored If the inserted spend is a double spend, it will be saved along with the previous spend Return true if the spend was inserted and false if it was already in the DAG

pub fn get_pending_spends(&self) -> BTreeSet<SpendAddress>

Get spend addresses that probably exist as they are refered to by spends we know, but we haven’t gathered them yet This includes UTXOs and unknown ancestors

pub fn get_utxos(&self) -> BTreeSet<SpendAddress>

Get the UTXOs: all the addresses that are refered to as children by other spends but that don’t have children themselves. Those will eventually exist on the Network as the address is spent by their owners.

pub fn dump_dot_format(&self) -> String

pub fn dump_creation_reasons_statistics(&self) -> String

pub fn merge(&mut self, sub_dag: SpendDag) -> Result<(), DagError>

Merges the given dag into ours

pub fn get_spend(&self, addr: &SpendAddress) -> SpendDagGet

Get the spend at a given address

pub fn get_spend_faults(&self, addr: &SpendAddress) -> BTreeSet<SpendFault>

Get the recorded faults if any for a given spend address

pub fn get_spend_indexes(&self, addr: &SpendAddress) -> Vec<usize>

Helper to get underlying index of spend entry in the DAG This unstable API is used to access the underlying graph for testing purposes An empty vec is returned if the spend is not in the DAG

pub fn all_spends(&self) -> Vec<&SignedSpend>

Get all spends from the DAG

pub fn all_royalties(&self) -> Result<Vec<CashNoteRedemption>, Error>

Get all royalties from the DAG

pub fn record_faults(&mut self, source: &SpendAddress) -> Result<(), DagError>

Verify the DAG and record faults in the DAG If the DAG is invalid, return an error immediately, without mutating the DAG

pub fn verify( &self, source: &SpendAddress ) -> Result<BTreeSet<SpendFault>, DagError>

Verify the DAG and return faults detected in the DAG If the DAG itself is invalid, return an error immediately

Trait Implementations

impl Clone for SpendDag

fn clone(&self) -> SpendDag

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SpendDag

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SpendDag

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SpendDag

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.