Struct HoprNodeDb 

pub struct HoprNodeDb { /* private fields */ }

Implementations

impl HoprNodeDb

pub async fn new( directory: &Path, chain_key: ChainKeypair, cfg: HoprNodeDbConfig, ) -> Result<Self, NodeDbError>

pub async fn new_in_memory(chain_key: ChainKeypair) -> Result<Self, NodeDbError>

pub async fn invalidate_unrealized_value(&self, channel: &ChannelEntry)

pub fn config(&self) -> &HoprNodeDbConfig

impl HoprNodeDb

pub async fn upsert_ticket( &self, acknowledged_ticket: AcknowledgedTicket, ) -> Result<(), NodeDbError>

Used only by non-SQLite code and tests.

impl HoprNodeDb

pub fn start_ticket_processing<S>( &self, ticket_notifier: Option<S>, ) -> Result<(), NodeDbError>

where S: Sink<AcknowledgedTicket> + Send + 'static, S::Error: Display + Error,

Starts ticket processing by the TicketManager with an optional new ticket notifier. Without calling this method, tickets will not be persisted into the DB.

If the notifier is given, it will receive notifications once a new ticket has been persisted into the Tickets DB.

Trait Implementations

impl Clone for HoprNodeDb

fn clone(&self) -> HoprNodeDb

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl HoprDbPeersOperations for HoprNodeDb

type Error = NodeDbError

fn add_network_peer<'life0, 'life1, 'async_trait>( &'life0 self, peer: &'life1 PeerId, origin: PeerOrigin, mas: Vec<Multiaddr>, backoff: f64, quality_window: u32, ) -> Pin<Box<dyn Future<Output = Result<(), NodeDbError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Adds a peer to the backend.

fn remove_network_peer<'life0, 'life1, 'async_trait>( &'life0 self, peer: &'life1 PeerId, ) -> Pin<Box<dyn Future<Output = Result<(), NodeDbError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Removes the peer from the backend.

fn update_network_peer<'life0, 'async_trait>( &'life0 self, new_status: PeerStatus, ) -> Pin<Box<dyn Future<Output = Result<(), NodeDbError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Updates stored information about the peer. Should fail if the peer does not exist in the store.

fn get_network_peer<'life0, 'life1, 'async_trait>( &'life0 self, peer: &'life1 PeerId, ) -> Pin<Box<dyn Future<Output = Result<Option<PeerStatus>, NodeDbError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Gets stored information about the peer.

fn get_network_peers<'a, 'async_trait>( &'a self, selector: PeerSelector, sort_last_seen_asc: bool, ) -> Pin<Box<dyn Future<Output = Result<BoxStream<'a, PeerStatus>, NodeDbError>> + Send + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait,

Returns a stream of all stored peers, optionally matching the given PeerSelector filter.

fn network_peer_stats<'life0, 'async_trait>( &'life0 self, quality_threshold: f64, ) -> Pin<Box<dyn Future<Output = Result<Stats, NodeDbError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the statistics on the stored peers.

impl HoprDbProtocolOperations for HoprNodeDb

type Error = NodeDbError

fn handle_acknowledgement<'life0, 'life1, 'async_trait, R>( &'life0 self, ack: VerifiedAcknowledgement, resolver: &'life1 R, ) -> Pin<Box<dyn Future<Output = Result<(), NodeDbError>> + Send + 'async_trait>>

where R: ChainReadChannelOperations + ChainValues + Send + Sync + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Processes the acknowledgements for the pending tickets

fn find_surb<'life0, 'async_trait>( &'life0 self, matcher: SurbMatcher, ) -> Pin<Box<dyn Future<Output = Result<FoundSurb, NodeDbError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Attempts to find SURB and its ID given the SurbMatcher.

fn get_surb_config(&self) -> SurbCacheConfig

Returns the SURB cache configuration.

fn to_send_no_ack<'life0, 'life1, 'async_trait, R>( &'life0 self, data: Box<[u8]>, destination: OffchainPublicKey, resolver: &'life1 R, ) -> Pin<Box<dyn Future<Output = Result<OutgoingPacket, NodeDbError>> + Send + 'async_trait>>

where R: ChainKeyOperations + ChainValues + Send + Sync + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Process the data into an outgoing packet that is not going to be acknowledged.

fn to_send<'life0, 'life1, 'async_trait, R>( &'life0 self, data: Box<[u8]>, routing: ResolvedTransportRouting, outgoing_ticket_win_prob: Option<WinningProbability>, outgoing_ticket_price: Option<HoprBalance>, signals: PacketSignals, resolver: &'life1 R, ) -> Pin<Box<dyn Future<Output = Result<OutgoingPacket, NodeDbError>> + Send + 'async_trait>>

where R: ChainReadChannelOperations + ChainKeyOperations + ChainValues + Send + Sync + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Process the data into an outgoing packet

fn from_recv<'life0, 'life1, 'life2, 'async_trait, R>( &'life0 self, data: Box<[u8]>, pkt_keypair: &'life1 OffchainKeypair, sender: OffchainPublicKey, outgoing_ticket_win_prob: Option<WinningProbability>, outgoing_ticket_price: Option<HoprBalance>, resolver: &'life2 R, ) -> Pin<Box<dyn Future<Output = Result<IncomingPacket, IncomingPacketError<NodeDbError>>> + Send + 'async_trait>>

where R: ChainReadChannelOperations + ChainKeyOperations + ChainValues + Send + Sync + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Process the incoming packet into data

impl HoprDbTicketOperations for HoprNodeDb

type Error = NodeDbError

fn stream_tickets<'c, 'async_trait>( &'c self, selector: Option<TicketSelector>, ) -> Pin<Box<dyn Future<Output = Result<BoxStream<'c, AcknowledgedTicket>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'c: 'async_trait,

Retrieve acknowledged winning tickets, according to the given selector.

fn mark_tickets_as<'life0, 'async_trait>( &'life0 self, selector: TicketSelector, mark_as: TicketMarker, ) -> Pin<Box<dyn Future<Output = Result<usize, NodeDbError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Marks tickets as the given TicketMarker, removing them from the DB and updating the ticket statistics for each ticket’s channel.

fn mark_unsaved_ticket_rejected<'life0, 'life1, 'async_trait>( &'life0 self, ticket: &'life1 Ticket, ) -> Pin<Box<dyn Future<Output = Result<(), NodeDbError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Updates the ticket statistics according to the fact that the given ticket has been rejected by the packet processing pipeline.

fn update_ticket_states_and_fetch<'a, 'async_trait>( &'a self, selector: TicketSelector, new_state: AcknowledgedTicketStatus, ) -> Pin<Box<dyn Future<Output = Result<BoxStream<'a, AcknowledgedTicket>, NodeDbError>> + Send + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait,

Updates state of the tickets matching the given selector.

fn update_ticket_states<'life0, 'async_trait>( &'life0 self, selector: TicketSelector, new_state: AcknowledgedTicketStatus, ) -> Pin<Box<dyn Future<Output = Result<usize, NodeDbError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Updates state of the tickets matching the given selector.

fn get_ticket_statistics<'life0, 'async_trait>( &'life0 self, channel_id: Option<Hash>, ) -> Pin<Box<dyn Future<Output = Result<ChannelTicketStatistics, NodeDbError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieves the ticket statistics for the given channel.

fn reset_ticket_statistics<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), NodeDbError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Resets the ticket statistics about neglected, rejected, and redeemed tickets.

fn get_tickets_value<'life0, 'async_trait>( &'life0 self, selector: TicketSelector, ) -> Pin<Box<dyn Future<Output = Result<(usize, HoprBalance), NodeDbError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Counts the tickets matching the given selector and their total value.

fn compare_and_set_outgoing_ticket_index<'life0, 'async_trait>( &'life0 self, channel_id: Hash, index: u64, ) -> Pin<Box<dyn Future<Output = Result<u64, NodeDbError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sets the stored outgoing ticket index to index, only if the currently stored value is less than index. This ensures the stored value can only be growing.

fn reset_outgoing_ticket_index<'life0, 'async_trait>( &'life0 self, channel_id: Hash, ) -> Pin<Box<dyn Future<Output = Result<u64, NodeDbError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Resets the outgoing ticket index to 0 for the given channel id.

fn increment_outgoing_ticket_index<'life0, 'async_trait>( &'life0 self, channel_id: Hash, ) -> Pin<Box<dyn Future<Output = Result<u64, NodeDbError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Increments the outgoing ticket index in the given channel ID and returns the value before incrementing.

fn get_outgoing_ticket_index<'life0, 'async_trait>( &'life0 self, channel_id: Hash, ) -> Pin<Box<dyn Future<Output = Result<Arc<AtomicU64>, NodeDbError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Gets the current outgoing ticket index for the given channel id.

fn persist_outgoing_ticket_indices<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<usize, NodeDbError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Compares outgoing ticket indices in the cache with the stored values and updates the stored value where changed.