pub struct HoprBlockchainConnector<C, B, P, R> { /* private fields */ }Expand description
A connector acting as a middleware between the HOPR APIs (see the hopr_api crate) and the Blokli Client API (see
the [blokli_client] crate).
The connector object cannot be cloned, and shall be used inside an Arc if cloning is needed.
Implementations§
Source§impl<B, C, P> HoprBlockchainConnector<C, B, P, P::TxRequest>where
B: Backend + Send + Sync + 'static,
C: BlokliSubscriptionClient + BlokliQueryClient + BlokliTransactionClient + Send + Sync + 'static,
P: PayloadGenerator + Send + Sync + 'static,
P::TxRequest: Send + Sync + 'static,
impl<B, C, P> HoprBlockchainConnector<C, B, P, P::TxRequest>where
B: Backend + Send + Sync + 'static,
C: BlokliSubscriptionClient + BlokliQueryClient + BlokliTransactionClient + Send + Sync + 'static,
P: PayloadGenerator + Send + Sync + 'static,
P::TxRequest: Send + Sync + 'static,
Sourcepub fn new(
chain_key: ChainKeypair,
cfg: BlockchainConnectorConfig,
client: C,
backend: B,
payload_generator: P,
) -> Self
pub fn new( chain_key: ChainKeypair, cfg: BlockchainConnectorConfig, client: C, backend: B, payload_generator: P, ) -> Self
Creates a new instance.
Sourcepub async fn connect(&mut self, timeout: Duration) -> Result<(), ConnectorError>
pub async fn connect(&mut self, timeout: Duration) -> Result<(), ConnectorError>
Connects to the chain using the underlying client, syncs all on-chain data and subscribes for all future updates.
If the sync of the current state does not happen within timeout, a ConnectorError::ConnectionTimeout
error is returned.
Source§impl<B, C, P, R> HoprBlockchainConnector<C, R, B, P>
impl<B, C, P, R> HoprBlockchainConnector<C, R, B, P>
Sourcepub fn invalidate_caches(&self)
pub fn invalidate_caches(&self)
Invalidates all cached on-chain data.
Source§impl<B, C, P, R> HoprBlockchainConnector<C, B, P, R>
impl<B, C, P, R> HoprBlockchainConnector<C, B, P, R>
Sourcepub fn as_path_resolver(&self) -> ChainPathResolver<'_, Self>
pub fn as_path_resolver(&self) -> ChainPathResolver<'_, Self>
Returns a PathAddressResolver using this connector.
Trait Implementations§
Source§impl<B, C, P, R> ChainEvents for HoprBlockchainConnector<C, B, P, R>
impl<B, C, P, R> ChainEvents for HoprBlockchainConnector<C, B, P, R>
type Error = ConnectorError
Source§fn subscribe_with_state_sync<I: IntoIterator<Item = StateSyncOptions>>(
&self,
options: I,
) -> Result<impl Stream<Item = ChainEvent> + Send + 'static, Self::Error>
fn subscribe_with_state_sync<I: IntoIterator<Item = StateSyncOptions>>( &self, options: I, ) -> Result<impl Stream<Item = ChainEvent> + Send + 'static, Self::Error>
Subscribe to on-chain events. Read more
Source§impl<B, C, P, R> ChainKeyOperations for HoprBlockchainConnector<C, B, P, R>
impl<B, C, P, R> ChainKeyOperations for HoprBlockchainConnector<C, B, P, R>
type Error = ConnectorError
type Mapper = HoprKeyMapper<B>
Source§fn chain_key_to_packet_key<'life0, 'life1, 'async_trait>(
&'life0 self,
chain: &'life1 Address,
) -> Pin<Box<dyn Future<Output = Result<Option<OffchainPublicKey>, Self::Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn chain_key_to_packet_key<'life0, 'life1, 'async_trait>(
&'life0 self,
chain: &'life1 Address,
) -> Pin<Box<dyn Future<Output = Result<Option<OffchainPublicKey>, Self::Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Translates
Address into OffchainPublicKey.Source§fn packet_key_to_chain_key<'life0, 'life1, 'async_trait>(
&'life0 self,
packet: &'life1 OffchainPublicKey,
) -> Pin<Box<dyn Future<Output = Result<Option<Address>, Self::Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn packet_key_to_chain_key<'life0, 'life1, 'async_trait>(
&'life0 self,
packet: &'life1 OffchainPublicKey,
) -> Pin<Box<dyn Future<Output = Result<Option<Address>, Self::Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Translates
OffchainPublicKey into Address.Source§fn key_id_mapper_ref(&self) -> &Self::Mapper
fn key_id_mapper_ref(&self) -> &Self::Mapper
Returns mapper for offchain key IDs as a reference.
Source§impl<B, C, P, R> ChainReadAccountOperations for HoprBlockchainConnector<C, B, P, R>
impl<B, C, P, R> ChainReadAccountOperations for HoprBlockchainConnector<C, B, P, R>
type Error = ConnectorError
Source§fn get_balance<'life0, 'async_trait, Cy, A>(
&'life0 self,
address: A,
) -> Pin<Box<dyn Future<Output = Result<Balance<Cy>, Self::Error>> + Send + 'async_trait>>
fn get_balance<'life0, 'async_trait, Cy, A>( &'life0 self, address: A, ) -> Pin<Box<dyn Future<Output = Result<Balance<Cy>, Self::Error>> + Send + 'async_trait>>
Returns the native or token currency balance of the given on-chain account.
Source§fn safe_allowance<'life0, 'async_trait, Cy, A>(
&'life0 self,
address: A,
) -> Pin<Box<dyn Future<Output = Result<Balance<Cy>, Self::Error>> + Send + 'async_trait>>
fn safe_allowance<'life0, 'async_trait, Cy, A>( &'life0 self, address: A, ) -> Pin<Box<dyn Future<Output = Result<Balance<Cy>, Self::Error>> + Send + 'async_trait>>
Returns the native or token currency Safe allowance.
Source§fn stream_accounts<'a, 'async_trait>(
&'a self,
selector: AccountSelector,
) -> Pin<Box<dyn Future<Output = Result<BoxStream<'a, AccountEntry>, Self::Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
fn stream_accounts<'a, 'async_trait>(
&'a self,
selector: AccountSelector,
) -> Pin<Box<dyn Future<Output = Result<BoxStream<'a, AccountEntry>, Self::Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
Returns on-chain node accounts with the given
AccountSelector.Source§fn count_accounts<'life0, 'async_trait>(
&'life0 self,
selector: AccountSelector,
) -> Pin<Box<dyn Future<Output = Result<usize, Self::Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn count_accounts<'life0, 'async_trait>(
&'life0 self,
selector: AccountSelector,
) -> Pin<Box<dyn Future<Output = Result<usize, Self::Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Counts the accounts with the given
AccountSelector. Read moreSource§impl<B, C, P, R> ChainReadChannelOperations for HoprBlockchainConnector<C, B, P, R>
impl<B, C, P, R> ChainReadChannelOperations for HoprBlockchainConnector<C, B, P, R>
type Error = ConnectorError
Source§fn channel_by_parties<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
src: &'life1 Address,
dst: &'life2 Address,
) -> Pin<Box<dyn Future<Output = Result<Option<ChannelEntry>, Self::Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
fn channel_by_parties<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
src: &'life1 Address,
dst: &'life2 Address,
) -> Pin<Box<dyn Future<Output = Result<Option<ChannelEntry>, Self::Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Returns a single channel given
src and dst.Source§fn channel_by_id<'life0, 'life1, 'async_trait>(
&'life0 self,
channel_id: &'life1 ChannelId,
) -> Pin<Box<dyn Future<Output = Result<Option<ChannelEntry>, Self::Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn channel_by_id<'life0, 'life1, 'async_trait>(
&'life0 self,
channel_id: &'life1 ChannelId,
) -> Pin<Box<dyn Future<Output = Result<Option<ChannelEntry>, Self::Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Returns a single channel given
channel_id.Source§fn stream_channels<'a, 'async_trait>(
&'a self,
selector: ChannelSelector,
) -> Pin<Box<dyn Future<Output = Result<BoxStream<'a, ChannelEntry>, Self::Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
fn stream_channels<'a, 'async_trait>(
&'a self,
selector: ChannelSelector,
) -> Pin<Box<dyn Future<Output = Result<BoxStream<'a, ChannelEntry>, Self::Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
Returns a stream of channels given the
ChannelSelector.Source§impl<B, R, C, P> ChainValues for HoprBlockchainConnector<C, B, P, R>
impl<B, R, C, P> ChainValues for HoprBlockchainConnector<C, B, P, R>
type Error = ConnectorError
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,
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,
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,
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§impl<B, C, P> ChainWriteAccountOperations for HoprBlockchainConnector<C, B, P, P::TxRequest>where
B: Send + Sync,
C: BlokliTransactionClient + BlokliQueryClient + Send + Sync + 'static,
P: PayloadGenerator + Send + Sync + 'static,
P::TxRequest: Send + Sync + 'static,
impl<B, C, P> ChainWriteAccountOperations for HoprBlockchainConnector<C, B, P, P::TxRequest>where
B: Send + Sync,
C: BlokliTransactionClient + BlokliQueryClient + Send + Sync + 'static,
P: PayloadGenerator + Send + Sync + 'static,
P::TxRequest: Send + Sync + 'static,
type Error = ConnectorError
Source§fn announce<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
multiaddrs: &'life1 [Multiaddr],
key: &'life2 OffchainKeypair,
) -> Pin<Box<dyn Future<Output = Result<BoxFuture<'_, Result<ChainReceipt, Self::Error>>, AnnouncementError<Self::Error>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
fn announce<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
multiaddrs: &'life1 [Multiaddr],
key: &'life2 OffchainKeypair,
) -> Pin<Box<dyn Future<Output = Result<BoxFuture<'_, Result<ChainReceipt, Self::Error>>, AnnouncementError<Self::Error>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Announces transport key and list of multi addresses.
Source§fn withdraw<'life0, 'life1, 'async_trait, Cy>(
&'life0 self,
balance: Balance<Cy>,
recipient: &'life1 Address,
) -> Pin<Box<dyn Future<Output = Result<BoxFuture<'_, Result<ChainReceipt, Self::Error>>, Self::Error>> + Send + 'async_trait>>
fn withdraw<'life0, 'life1, 'async_trait, Cy>( &'life0 self, balance: Balance<Cy>, recipient: &'life1 Address, ) -> Pin<Box<dyn Future<Output = Result<BoxFuture<'_, Result<ChainReceipt, Self::Error>>, Self::Error>> + Send + 'async_trait>>
Withdraws native or token currency.
Source§fn register_safe<'life0, 'life1, 'async_trait>(
&'life0 self,
safe_address: &'life1 Address,
) -> Pin<Box<dyn Future<Output = Result<BoxFuture<'_, Result<ChainReceipt, Self::Error>>, SafeRegistrationError<Self::Error>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn register_safe<'life0, 'life1, 'async_trait>(
&'life0 self,
safe_address: &'life1 Address,
) -> Pin<Box<dyn Future<Output = Result<BoxFuture<'_, Result<ChainReceipt, Self::Error>>, SafeRegistrationError<Self::Error>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Registers Safe address with the current node.
Source§impl<B, C, P> ChainWriteChannelOperations for HoprBlockchainConnector<C, B, P, P::TxRequest>where
B: Backend + Send + Sync + 'static,
C: BlokliQueryClient + BlokliTransactionClient + Send + Sync + 'static,
P: PayloadGenerator + Send + Sync + 'static,
P::TxRequest: Send + Sync + 'static,
impl<B, C, P> ChainWriteChannelOperations for HoprBlockchainConnector<C, B, P, P::TxRequest>where
B: Backend + Send + Sync + 'static,
C: BlokliQueryClient + BlokliTransactionClient + Send + Sync + 'static,
P: PayloadGenerator + Send + Sync + 'static,
P::TxRequest: Send + Sync + 'static,
type Error = ConnectorError
Source§fn open_channel<'a, 'async_trait>(
&'a self,
dst: &'a Address,
amount: HoprBalance,
) -> Pin<Box<dyn Future<Output = Result<BoxFuture<'a, Result<(ChannelId, ChainReceipt), Self::Error>>, Self::Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
fn open_channel<'a, 'async_trait>(
&'a self,
dst: &'a Address,
amount: HoprBalance,
) -> Pin<Box<dyn Future<Output = Result<BoxFuture<'a, Result<(ChannelId, ChainReceipt), Self::Error>>, Self::Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
Opens a channel with
dst and amount.Source§fn fund_channel<'a, 'async_trait>(
&'a self,
channel_id: &'a ChannelId,
amount: HoprBalance,
) -> Pin<Box<dyn Future<Output = Result<BoxFuture<'a, Result<ChainReceipt, Self::Error>>, Self::Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
fn fund_channel<'a, 'async_trait>(
&'a self,
channel_id: &'a ChannelId,
amount: HoprBalance,
) -> Pin<Box<dyn Future<Output = Result<BoxFuture<'a, Result<ChainReceipt, Self::Error>>, Self::Error>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
Funds an existing channel.
Source§impl<B, C, P> ChainWriteTicketOperations for HoprBlockchainConnector<C, B, P, P::TxRequest>where
B: Backend + Send + Sync + 'static,
C: BlokliTransactionClient + BlokliQueryClient + Send + Sync + 'static,
P: PayloadGenerator + Send + Sync + 'static,
P::TxRequest: Send + Sync + 'static,
impl<B, C, P> ChainWriteTicketOperations for HoprBlockchainConnector<C, B, P, P::TxRequest>where
B: Backend + Send + Sync + 'static,
C: BlokliTransactionClient + BlokliQueryClient + Send + Sync + 'static,
P: PayloadGenerator + Send + Sync + 'static,
P::TxRequest: Send + Sync + 'static,
type Error = ConnectorError
Source§fn redeem_ticket<'a, 'async_trait>(
&'a self,
ticket: AcknowledgedTicket,
) -> Pin<Box<dyn Future<Output = Result<BoxFuture<'a, Result<(VerifiedTicket, ChainReceipt), TicketRedeemError<Self::Error>>>, TicketRedeemError<Self::Error>>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
fn redeem_ticket<'a, 'async_trait>(
&'a self,
ticket: AcknowledgedTicket,
) -> Pin<Box<dyn Future<Output = Result<BoxFuture<'a, Result<(VerifiedTicket, ChainReceipt), TicketRedeemError<Self::Error>>>, TicketRedeemError<Self::Error>>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
Redeems a single ticket on-chain. Read more
Source§fn redeem_tickets_via_selector<'life0, 'life1, 'async_trait, Db>(
&'life0 self,
db: &'life1 Db,
selector: TicketSelector,
) -> Pin<Box<dyn Future<Output = Result<BatchRedemptionResult<Self::Error>, <Db as HoprDbTicketOperations>::Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
Db: HoprDbTicketOperations + Sync + 'async_trait,
Self: Sync + 'async_trait,
fn redeem_tickets_via_selector<'life0, 'life1, 'async_trait, Db>(
&'life0 self,
db: &'life1 Db,
selector: TicketSelector,
) -> Pin<Box<dyn Future<Output = Result<BatchRedemptionResult<Self::Error>, <Db as HoprDbTicketOperations>::Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
Db: HoprDbTicketOperations + Sync + 'async_trait,
Self: Sync + 'async_trait,
Fetches a batch of tickets via
selector to HoprDbTicketOperations
and performs batched ticket redemption. Read moreAuto Trait Implementations§
impl<C, B, P, R> Freeze for HoprBlockchainConnector<C, B, P, R>where
P: Freeze,
impl<C, B, P, R> !RefUnwindSafe for HoprBlockchainConnector<C, B, P, R>
impl<C, B, P, R> Send for HoprBlockchainConnector<C, B, P, R>
impl<C, B, P, R> Sync for HoprBlockchainConnector<C, B, P, R>
impl<C, B, P, R> Unpin for HoprBlockchainConnector<C, B, P, R>where
P: Unpin,
impl<C, B, P, R> !UnwindSafe for HoprBlockchainConnector<C, B, P, R>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T, E> HoprChainApi for Twhere
T: ChainWriteChannelOperations<Error = E> + ChainEvents<Error = E> + ChainWriteAccountOperations<Error = E> + ChainKeyOperations<Error = E> + ChainValues<Error = E> + ChainReadChannelOperations<Error = E> + ChainWriteTicketOperations<Error = E> + ChainReadAccountOperations<Error = E>,
E: Error + Send + Sync + 'static,
impl<T, E> HoprChainApi for Twhere
T: ChainWriteChannelOperations<Error = E> + ChainEvents<Error = E> + ChainWriteAccountOperations<Error = E> + ChainKeyOperations<Error = E> + ChainValues<Error = E> + ChainReadChannelOperations<Error = E> + ChainWriteTicketOperations<Error = E> + ChainReadAccountOperations<Error = E>,
E: Error + Send + Sync + 'static,
type ChainError = E
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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