dn724/dncurrency
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Some comments documenting pending_key and pending_info classes

Browse source
This commit is contained in:
Dimitrios Siganos 2024-04-13 02:16:54 +09:00
commit ded54b2f7b
1 changed files with 10 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

15
nano/secure/pending_info.hpp
View file

@ -18,6 +18,7 @@ namespace nano
{ {
/** /**
* Information on an uncollected send * Information on an uncollected send
* This class captures the data stored in a pending table entry
*/ */
class pending_info final class pending_info final
{ {
@ -27,9 +28,9 @@ public:
size_t db_size () const; size_t db_size () const;
bool deserialize (nano::stream &); bool deserialize (nano::stream &);
bool operator== (nano::pending_info const &) const; bool operator== (nano::pending_info const &) const;
nano::account source{}; nano::account source{}; // the account sending the funds
nano::amount amount{ 0 }; nano::amount amount{ 0 }; // amount receivable in this transaction
nano::epoch epoch{ nano::epoch::epoch_0 }; nano::epoch epoch{ nano::epoch::epoch_0 }; // epoch of sending block, this info is stored here to make it possible to prune the send block
friend std::ostream & operator<< (std::ostream & os, const nano::pending_info & info) friend std::ostream & operator<< (std::ostream & os, const nano::pending_info & info)
{ {
@ -38,6 +39,9 @@ public:
return os; return os;
} }
}; };
// This class represents the data written into the pending (receivable) database table key
// the receiving account and hash of the send block identify a pending db table entry
class pending_key final class pending_key final
{ {
public: public:
@ -47,8 +51,8 @@ public:
bool operator== (nano::pending_key const &) const; bool operator== (nano::pending_key const &) const;
bool operator< (nano::pending_key const &) const; bool operator< (nano::pending_key const &) const;
nano::account const & key () const; nano::account const & key () const;
nano::account account{}; nano::account account{}; // receiving account
nano::block_hash hash{ 0 }; nano::block_hash hash{ 0 }; // hash of the send block
friend std::ostream & operator<< (std::ostream & os, const nano::pending_key & key) friend std::ostream & operator<< (std::ostream & os, const nano::pending_key & key)
{ {
@ -56,6 +60,7 @@ public:
return os; return os;
} }
}; };
// This class iterates receivable enttries for an account // This class iterates receivable enttries for an account
class receivable_iterator class receivable_iterator
{ {