hopr-api 1.6.0

Common high-level external and internal API traits used by hopr-lib to implement the HOPR protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

use std::{error::Error, time::Duration};

pub use hopr_types::{
    chain::ContractAddresses, internal::prelude::WinningProbability, primitive::balance::HoprBalance,
};
use hopr_types::{
    crypto::prelude::Hash,
    primitive::{
        balance::{Balance, Currency},
        prelude::Address,
    },
};

/// Contains domain separator information.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct DomainSeparators {
    /// HOPR Ledger smart contract domain separator.
    pub ledger: Hash,
    /// HOPR Node Safe Registry smart contract domain separator.
    pub safe_registry: Hash,
    /// HOPR Channels smart contract domain separator.
    pub channel: Hash,
}

/// Contains information about the HOPR on-chain network deployment.
#[derive(Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct ChainInfo {
    /// ID of the blockchain network (e.g.: `0x64` for Gnosis Chain)
    pub chain_id: u64,
    /// Name of the HOPR network (e.g.: `dufour`)
    pub hopr_network_name: String,
    /// Addresses of the deployed HOPR smart contracts.
    pub contract_addresses: ContractAddresses,
}

/// Ticket redemption statistics for a Safe.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct RedemptionStats {
    /// Total number of tickets that have been redeemed.
    pub redeemed_count: u64,
    /// Total value of tickets that have been redeemed.
    pub redeemed_value: HoprBalance,
}

/// Retrieves various on-chain information.
#[async_trait::async_trait]
#[auto_impl::auto_impl(&, Box, Arc)]
pub trait ChainValues {
    type Error: Error + Send + Sync + 'static;

    /// Returns the native or token currency balance of the given on-chain account.
    async fn balance<C: Currency, A: Into<Address> + Send>(&self, address: A) -> Result<Balance<C>, Self::Error>;
    /// Retrieves the domain separators of HOPR smart contracts.
    async fn domain_separators(&self) -> Result<DomainSeparators, Self::Error>;
    /// Retrieves the network-set minimum **incoming** ticket winning probability.
    async fn minimum_incoming_ticket_win_prob(&self) -> Result<WinningProbability, Self::Error>;
    /// Retrieves the network-set minimum ticket price.
    async fn minimum_ticket_price(&self) -> Result<HoprBalance, Self::Error>;
    /// Retrieves the current key binding fee
    /// used for new key-binding [announcements](crate::chain::ChainWriteAccountOperations::announce).
    async fn key_binding_fee(&self) -> Result<HoprBalance, Self::Error>;
    /// Gets the grace period for channel closure finalization.
    async fn channel_closure_notice_period(&self) -> Result<Duration, Self::Error>;
    /// Gets the information about the HOPR network on-chain deployment.
    async fn chain_info(&self) -> Result<ChainInfo, Self::Error>;
    /// Gets the ticket redemption stats for the given safe address.
    async fn redemption_stats<A: Into<Address>>(&self, safe_addr: A) -> Result<RedemptionStats, Self::Error>;
}