Struct HoprChain

pub struct HoprChain<T: HoprDbAllOperations + Send + Sync + Clone + Debug> { /* private fields */ }

Represents all chain interactions exported to be used in the hopr-lib

NOTE: instead of creating a unified interface the HoprChain exports some functionality (e.g. the [ChainActions] as a referentially used) object. This behavior will be refactored and hidden behind a trait in the future implementations.

Implementations

impl<T: HoprDbAllOperations + Send + Sync + Clone + Debug + 'static> HoprChain<T>

pub fn new( me_onchain: ChainKeypair, db: T, chain_config: ChainNetworkConfig, module_address: Address, contract_addresses: ContractAddresses, safe_address: Address, indexer_cfg: IndexerConfig, indexer_events_tx: Sender<SignificantChainEvent>, ) -> Result<Self>

pub async fn start(&self) -> Result<HashMap<HoprChainProcess, AbortHandle>>

Execute all processes of the HoprChain object.

This method will spawn the HoprChainProcess::Indexer and HoprChainProcess::OutgoingOnchainActionQueue processes and return join handles to the calling function.

pub fn me_onchain(&self) -> Address

pub fn action_state(&self) -> Arc<IndexerActionTracker>

pub async fn accounts_announced_on_chain(&self) -> Result<Vec<AccountEntry>>

pub async fn channel( &self, src: &Address, dest: &Address, ) -> Result<ChannelEntry>

pub async fn channels_from(&self, src: &Address) -> Result<Vec<ChannelEntry>>

pub async fn channels_to(&self, dest: &Address) -> Result<Vec<ChannelEntry>>

pub async fn all_channels(&self) -> Result<Vec<ChannelEntry>>

pub async fn ticket_price(&self) -> Result<Option<HoprBalance>>

pub async fn safe_allowance(&self) -> Result<HoprBalance>

pub fn actions_ref(&self) -> &ChainActions<T>

pub fn actions_mut_ref(&mut self) -> &mut ChainActions<T>

pub fn rpc(&self) -> &RpcOperations<DefaultHttpRequestor>

pub async fn get_balance<C: Currency + Send>(&self) -> Result<Balance<C>>

Retrieves the balance of the node’s on-chain account for the specified currency.

This method queries the on-chain balance of the node’s account for the given currency. It supports querying balances for XDai and WxHOPR currencies. If the currency is unsupported, an error is returned.

Returns

• Result<Balance<C>> - The balance of the node’s account for the specified currency, or an error if the query fails.

pub async fn get_safe_balance<C: Currency + Send>( &self, safe_address: Address, ) -> Result<Balance<C>>

Retrieves the balance of the specified address for the given currency.

This method queries the on-chain balance of the provided address for the specified currency. It supports querying balances for XDai and WxHOPR currencies. If the currency is unsupported, an error is returned.

Arguments

• address - The address whose balance is to be retrieved.

Returns

• Result<Balance<C>> - The balance of the specified address for the given currency, or an error if the query fails.

pub async fn get_safe_hopr_allowance(&self) -> Result<HoprBalance>

Retrieves the HOPR token allowance granted by the safe address to the channels contract.

This method queries the on-chain HOPR token contract to determine how many tokens the safe address has approved the channels contract to spend on its behalf.

Returns

• Result<HoprBalance> - The current allowance amount, or an error if the query fails

pub async fn get_channel_closure_notice_period(&self) -> Result<Duration>

pub async fn get_eligibility_status(&self) -> Result<bool>

pub async fn get_minimum_winning_probability( &self, ) -> Result<WinningProbability>

pub async fn get_minimum_ticket_price(&self) -> Result<HoprBalance>

Trait Implementations

impl<T: Clone + HoprDbAllOperations + Send + Sync + Clone + Debug> Clone for HoprChain<T>

fn clone(&self) -> HoprChain<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + HoprDbAllOperations + Send + Sync + Clone + Debug> Debug for HoprChain<T>

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

Formats the value using the given formatter.