Skip to main content

StubChainApi

Struct StubChainApi 

Source
pub struct StubChainApi {
    pub(crate) me: Address,
    pub(crate) key_addr_map: BiMap<OffchainPublicKey, Address>,
    pub(crate) channels: Vec<ChannelEntry>,
    pub(crate) id_mapper: StubKeyIdMapper,
    pub(crate) ticket_price: HoprBalance,
    pub(crate) win_prob: WinningProbability,
}
Expand description

Lightweight in-memory stub implementing the chain-API traits needed by HoprEncoder / HoprDecoder / HoprTicketProcessor.

All lookups are simple BiMap or Vec scans — no async I/O, no database.

Fields§

§me: Address§key_addr_map: BiMap<OffchainPublicKey, Address>§channels: Vec<ChannelEntry>§id_mapper: StubKeyIdMapper§ticket_price: HoprBalance§win_prob: WinningProbability

Implementations§

Source§

impl StubChainApi

Source

pub fn builder() -> StubChainApiBuilder

Returns a new StubChainApiBuilder.

Source

pub fn key_addr_map(&self) -> &BiMap<OffchainPublicKey, Address>

Returns the key-address mapping.

Source

pub fn channels(&self) -> &[ChannelEntry]

Returns the registered channels.

Trait Implementations§

Source§

impl ChainKeyOperations for StubChainApi

Source§

type Error = StubError

Source§

type Mapper = StubKeyIdMapper

Mapping between [HoprKeyIdent] and [OffchainPublicKey].
Source§

fn chain_key_to_packet_key( &self, chain: &Address, ) -> Result<Option<OffchainPublicKey>, Self::Error>

Translates [Address] into [OffchainPublicKey].
Source§

fn packet_key_to_chain_key( &self, packet: &OffchainPublicKey, ) -> Result<Option<Address>, Self::Error>

Translates [OffchainPublicKey] into [Address].
Source§

fn key_id_mapper_ref(&self) -> &Self::Mapper

Returns a reference to [KeyIdMapping] for offchain key IDs.
Source§

impl ChainReadChannelOperations for StubChainApi

Source§

type Error = StubError

Source§

fn me(&self) -> &Address

Returns on-chain [Address] of the current node.
Source§

fn channel_by_id( &self, channel_id: &ChannelId, ) -> Result<Option<ChannelEntry>, Self::Error>

Returns a single channel given channel_id.
Source§

fn stream_channels<'a>( &'a self, _selector: ChannelSelector, ) -> Result<BoxStream<'a, ChannelEntry>, Self::Error>

Returns a stream of channels given the [ChannelSelector].
§

fn channel_by_parties( &self, src: &Address, dst: &Address, ) -> Result<Option<ChannelEntry>, Self::Error>

Returns a single channel given src and dst.
Source§

impl ChainReadTicketOperations for StubChainApi

Source§

type Error = StubError

Source§

fn outgoing_ticket_values( &self, configured_wp: Option<WinningProbability>, configured_price: Option<HoprBalance>, ) -> Result<(WinningProbability, HoprBalance), Self::Error>

Retrieves the winning probability and ticket price for outgoing tickets, with respect to the optionally pre-configured values. Read more
Source§

fn incoming_ticket_values( &self, ) -> Result<(WinningProbability, HoprBalance), Self::Error>

Retrieves the expected minimum winning probability and ticket price for incoming tickets. Read more
Source§

impl ChainValues for StubChainApi

Source§

type Error = StubError

Source§

fn balance<'life0, 'async_trait, C, A>( &'life0 self, _address: A, ) -> Pin<Box<dyn Future<Output = Result<Balance<C>, Self::Error>> + Send + 'async_trait>>
where C: 'async_trait + Currency, A: 'async_trait + Into<Address> + Send, Self: 'async_trait, 'life0: 'async_trait,

Returns the native or token currency balance of the given on-chain account.
Source§

fn domain_separators<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<DomainSeparators, Self::Error>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Retrieves the domain separators of HOPR smart contracts.
Source§

fn minimum_incoming_ticket_win_prob<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<WinningProbability, Self::Error>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Retrieves the network-set minimum incoming ticket winning probability.
Source§

fn minimum_ticket_price<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<HoprBalance, Self::Error>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Retrieves the network-set minimum ticket price.
Source§

fn key_binding_fee<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<HoprBalance, Self::Error>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Retrieves the current key binding fee used for new key-binding announcements.
Source§

fn channel_closure_notice_period<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Duration, Self::Error>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Gets the grace period for channel closure finalization.
Source§

fn chain_info<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ChainInfo, Self::Error>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Gets the information about the HOPR network on-chain deployment.
Source§

fn redemption_stats<'life0, 'async_trait, A>( &'life0 self, __arg1: A, ) -> Pin<Box<dyn Future<Output = Result<RedemptionStats, Self::Error>> + Send + 'async_trait>>
where A: 'async_trait + Into<Address> + Send, Self: 'async_trait, 'life0: 'async_trait,

Gets the ticket redemption stats for the given safe address.
Source§

fn typical_resolution_time<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Duration, Self::Error>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns the expected time for on-chain events to be resolved.
Source§

impl Clone for StubChainApi

Source§

fn clone(&self) -> StubChainApi

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more