hopr-types 1.8.0

Complete collection of Rust types used in Hoprnet and other related projects
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

//! This module contains various on-chain related modules and types.

/// Types representing events emitted by HOPR smart contracts.
pub mod chain_events;
/// Error types for chain-related operations.
pub mod errors;
#[cfg(feature = "use-bindings")]
mod parser;
/// Ethereum transaction payload generators for on-chain actions.
pub mod payload;

#[cfg(feature = "use-bindings")]
pub use {
    hopr_bindings::{
        ContractAddresses, exports, exports::alloy::primitives::Address as AlloyAddress,
    },
    parser::ParsedHoprChainAction,
};

pub mod prelude {
    #[cfg(feature = "use-bindings")]
    pub use super::payload::{BasicPayloadGenerator, SafePayloadGenerator, TransactionRequest};
    pub use super::{
        ContractAddresses,
        chain_events::ChainEvent,
        payload::{GasEstimation, PayloadGenerator, SignableTransaction},
    };
}

#[cfg(not(feature = "use-bindings"))]
/// Holds addresses of all smart contracts.
#[serde_with::serde_as]
#[derive(Clone, Copy, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize, Default)]
pub struct ContractAddresses {
    /// Token contract
    #[serde_as(as = "serde_with::DisplayFromStr")]
    pub token: crate::primitive::primitives::Address,
    /// Channels contract
    #[serde_as(as = "serde_with::DisplayFromStr")]
    pub channels: crate::primitive::primitives::Address,
    /// Announcement contract
    #[serde_as(as = "serde_with::DisplayFromStr")]
    pub announcements: crate::primitive::primitives::Address,
    /// Safe registry contract
    #[serde_as(as = "serde_with::DisplayFromStr")]
    pub node_safe_registry: crate::primitive::primitives::Address,
    /// Price oracle contract
    #[serde_as(as = "serde_with::DisplayFromStr")]
    pub ticket_price_oracle: crate::primitive::primitives::Address,
    /// Minimum ticket winning probability contract
    #[serde_as(as = "serde_with::DisplayFromStr")]
    pub winning_probability_oracle: crate::primitive::primitives::Address,
    /// Migration helper for node safes and modules
    #[serde_as(as = "serde_with::DisplayFromStr")]
    pub node_safe_migration: crate::primitive::primitives::Address,
    /// Stake factory contract
    #[serde_as(as = "serde_with::DisplayFromStr")]
    pub node_stake_factory: crate::primitive::primitives::Address,
    /// Node management module contract (can be zero if safe is not used)
    #[serde_as(as = "serde_with::DisplayFromStr")]
    pub module_implementation: crate::primitive::primitives::Address,
}

#[cfg(not(feature = "use-bindings"))]
impl IntoIterator for &ContractAddresses {
    type IntoIter = std::vec::IntoIter<crate::primitive::primitives::Address>;
    type Item = crate::primitive::primitives::Address;

    fn into_iter(self) -> Self::IntoIter {
        vec![
            self.token,
            self.channels,
            self.announcements,
            self.node_safe_registry,
            self.ticket_price_oracle,
            self.winning_probability_oracle,
            self.node_stake_factory,
            self.module_implementation,
        ]
        .into_iter()
    }
}

/// Returns chain ID and contract addresses for a known HOPR network on-chain deployment with the given `name` (e.g.
/// `rotsee` or `dufour`)
///
/// Returns `None` if network deployment with the given `name` is not known.
#[cfg(feature = "use-bindings")]
pub fn contract_addresses_for_network(name: &str) -> Option<(u64, ContractAddresses)> {
    hopr_bindings::config::NetworksWithContractAddresses::default()
        .networks
        .get(name)
        .cloned()
        .map(|n| (n.chain_id, n.addresses))
}

// Used instead of From implementation to avoid alloy being a dependency of the primitive crates
#[cfg(feature = "use-bindings")]
#[inline]
pub(in crate::chain) fn a2al(a: crate::primitive::prelude::Address) -> AlloyAddress {
    AlloyAddress::from_slice(a.as_ref())
}