Struct HoprChannelsInstance

pub struct HoprChannelsInstance<P, N = Ethereum> { /* private fields */ }

A HoprChannels instance.

Contains type-safe methods for interacting with an on-chain instance of the HoprChannels contract located at a given address, using a given provider P.

If the contract bytecode is available (see the sol! documentation on how to provide it), the deploy and deploy_builder methods can be used to deploy a new instance of the contract.

See the module-level documentation for all the available methods.

Implementations

impl<P: Provider<N>, N: Network> HoprChannelsInstance<P, N>

Instantiation and getters/setters.

pub const fn new(address: Address, provider: P) -> Self

Creates a new wrapper around an on-chain HoprChannels contract instance.

See the wrapper’s documentation for more details.

pub async fn deploy( provider: P, _token: Address, _noticePeriodChannelClosure: <Timestamp as SolType>::RustType, _safeRegistry: Address, ) -> Result<HoprChannelsInstance<P, N>>

Deploys this contract using the given provider and constructor arguments, if any.

Returns a new instance of the contract, if the deployment was successful.

For more fine-grained control over the deployment process, use deploy_builder instead.

pub fn deploy_builder( provider: P, _token: Address, _noticePeriodChannelClosure: <Timestamp as SolType>::RustType, _safeRegistry: Address, ) -> RawCallBuilder<P, N>

Creates a RawCallBuilder for deploying this contract using the given provider and constructor arguments, if any.

This is a simple wrapper around creating a RawCallBuilder with the data set to the bytecode concatenated with the constructor’s ABI-encoded arguments.

pub const fn address(&self) -> &Address

Returns a reference to the address.

pub fn set_address(&mut self, address: Address)

Sets the address.

pub fn at(self, address: Address) -> Self

Sets the address and returns self.

pub const fn provider(&self) -> &P

Returns a reference to the provider.

impl<P: Clone, N> HoprChannelsInstance<&P, N>

pub fn with_cloned_provider(self) -> HoprChannelsInstance<P, N>

Clones the provider and returns a new instance with the cloned provider.

impl<P: Provider<N>, N: Network> HoprChannelsInstance<P, N>

Function calls.

pub fn call_builder<C: SolCall>(&self, call: &C) -> SolCallBuilder<&P, C, N>

Creates a new call builder using this contract instance’s provider and address.

Note that the call can be any function call, not just those defined in this contract. Prefer using the other methods for building type-safe contract calls.

pub fn ERC777_HOOK_FUND_CHANNEL_MULTI_SIZE( &self, ) -> SolCallBuilder<&P, ERC777_HOOK_FUND_CHANNEL_MULTI_SIZECall, N>

Creates a new call builder for the [ERC777_HOOK_FUND_CHANNEL_MULTI_SIZE] function.

pub fn ERC777_HOOK_FUND_CHANNEL_SIZE( &self, ) -> SolCallBuilder<&P, ERC777_HOOK_FUND_CHANNEL_SIZECall, N>

Creates a new call builder for the [ERC777_HOOK_FUND_CHANNEL_SIZE] function.

pub fn LEDGER_VERSION(&self) -> SolCallBuilder<&P, LEDGER_VERSIONCall, N>

Creates a new call builder for the [LEDGER_VERSION] function.

pub fn MAX_USED_BALANCE(&self) -> SolCallBuilder<&P, MAX_USED_BALANCECall, N>

Creates a new call builder for the [MAX_USED_BALANCE] function.

pub fn MIN_USED_BALANCE(&self) -> SolCallBuilder<&P, MIN_USED_BALANCECall, N>

Creates a new call builder for the [MIN_USED_BALANCE] function.

pub fn TOKENS_RECIPIENT_INTERFACE_HASH( &self, ) -> SolCallBuilder<&P, TOKENS_RECIPIENT_INTERFACE_HASHCall, N>

Creates a new call builder for the [TOKENS_RECIPIENT_INTERFACE_HASH] function.

pub fn VERSION(&self) -> SolCallBuilder<&P, VERSIONCall, N>

Creates a new call builder for the [VERSION] function.

pub fn _currentBlockTimestamp( &self, ) -> SolCallBuilder<&P, _currentBlockTimestampCall, N>

Creates a new call builder for the [_currentBlockTimestamp] function.

pub fn _getChannelId( &self, source: Address, destination: Address, ) -> SolCallBuilder<&P, _getChannelIdCall, N>

Creates a new call builder for the [_getChannelId] function.

pub fn _getTicketHash( &self, redeemable: <RedeemableTicket as SolType>::RustType, ) -> SolCallBuilder<&P, _getTicketHashCall, N>

Creates a new call builder for the [_getTicketHash] function.

pub fn _isWinningTicket( &self, ticketHash: FixedBytes<32>, redeemable: <RedeemableTicket as SolType>::RustType, params: <VRFParameters as SolType>::RustType, ) -> SolCallBuilder<&P, _isWinningTicketCall, N>

Creates a new call builder for the [_isWinningTicket] function.

pub fn canImplementInterfaceForAddress( &self, interfaceHash: FixedBytes<32>, account: Address, ) -> SolCallBuilder<&P, canImplementInterfaceForAddressCall, N>

Creates a new call builder for the [canImplementInterfaceForAddress] function.

pub fn channels( &self, _0: FixedBytes<32>, ) -> SolCallBuilder<&P, channelsCall, N>

Creates a new call builder for the [channels] function.

pub fn closeIncomingChannel( &self, source: Address, ) -> SolCallBuilder<&P, closeIncomingChannelCall, N>

Creates a new call builder for the [closeIncomingChannel] function.

pub fn closeIncomingChannelSafe( &self, selfAddress: Address, source: Address, ) -> SolCallBuilder<&P, closeIncomingChannelSafeCall, N>

Creates a new call builder for the [closeIncomingChannelSafe] function.

pub fn domainSeparator(&self) -> SolCallBuilder<&P, domainSeparatorCall, N>

Creates a new call builder for the [domainSeparator] function.

pub fn finalizeOutgoingChannelClosure( &self, destination: Address, ) -> SolCallBuilder<&P, finalizeOutgoingChannelClosureCall, N>

Creates a new call builder for the [finalizeOutgoingChannelClosure] function.

pub fn finalizeOutgoingChannelClosureSafe( &self, selfAddress: Address, destination: Address, ) -> SolCallBuilder<&P, finalizeOutgoingChannelClosureSafeCall, N>

Creates a new call builder for the [finalizeOutgoingChannelClosureSafe] function.

pub fn fundChannel( &self, account: Address, amount: <Balance as SolType>::RustType, ) -> SolCallBuilder<&P, fundChannelCall, N>

Creates a new call builder for the [fundChannel] function.

pub fn fundChannelSafe( &self, selfAddress: Address, account: Address, amount: <Balance as SolType>::RustType, ) -> SolCallBuilder<&P, fundChannelSafeCall, N>

Creates a new call builder for the [fundChannelSafe] function.

pub fn initiateOutgoingChannelClosure( &self, destination: Address, ) -> SolCallBuilder<&P, initiateOutgoingChannelClosureCall, N>

Creates a new call builder for the [initiateOutgoingChannelClosure] function.

pub fn initiateOutgoingChannelClosureSafe( &self, selfAddress: Address, destination: Address, ) -> SolCallBuilder<&P, initiateOutgoingChannelClosureSafeCall, N>

Creates a new call builder for the [initiateOutgoingChannelClosureSafe] function.

pub fn ledgerDomainSeparator( &self, ) -> SolCallBuilder<&P, ledgerDomainSeparatorCall, N>

Creates a new call builder for the [ledgerDomainSeparator] function.

pub fn multicall( &self, data: Vec<Bytes>, ) -> SolCallBuilder<&P, multicallCall, N>

Creates a new call builder for the [multicall] function.

pub fn noticePeriodChannelClosure( &self, ) -> SolCallBuilder<&P, noticePeriodChannelClosureCall, N>

Creates a new call builder for the [noticePeriodChannelClosure] function.

pub fn redeemTicket( &self, redeemable: <RedeemableTicket as SolType>::RustType, params: <VRFParameters as SolType>::RustType, ) -> SolCallBuilder<&P, redeemTicketCall, N>

Creates a new call builder for the [redeemTicket] function.

pub fn redeemTicketSafe( &self, selfAddress: Address, redeemable: <RedeemableTicket as SolType>::RustType, params: <VRFParameters as SolType>::RustType, ) -> SolCallBuilder<&P, redeemTicketSafeCall, N>

Creates a new call builder for the [redeemTicketSafe] function.

pub fn token(&self) -> SolCallBuilder<&P, tokenCall, N>

Creates a new call builder for the [token] function.

pub fn tokensReceived( &self, _0: Address, from: Address, to: Address, amount: U256, userData: Bytes, _5: Bytes, ) -> SolCallBuilder<&P, tokensReceivedCall, N>

Creates a new call builder for the [tokensReceived] function.

pub fn updateDomainSeparator( &self, ) -> SolCallBuilder<&P, updateDomainSeparatorCall, N>

Creates a new call builder for the [updateDomainSeparator] function.

pub fn updateLedgerDomainSeparator( &self, ) -> SolCallBuilder<&P, updateLedgerDomainSeparatorCall, N>

Creates a new call builder for the [updateLedgerDomainSeparator] function.

impl<P: Provider<N>, N: Network> HoprChannelsInstance<P, N>

Event filters.

pub fn event_filter<E: SolEvent>(&self) -> Event<&P, E, N>

Creates a new event filter using this contract instance’s provider and address.

Note that the type can be any event, not just those defined in this contract. Prefer using the other methods for building type-safe event filters.

pub fn ChannelBalanceDecreased_filter( &self, ) -> Event<&P, ChannelBalanceDecreased, N>

Creates a new event filter for the ChannelBalanceDecreased event.

pub fn ChannelBalanceIncreased_filter( &self, ) -> Event<&P, ChannelBalanceIncreased, N>

Creates a new event filter for the ChannelBalanceIncreased event.

pub fn ChannelClosed_filter(&self) -> Event<&P, ChannelClosed, N>

Creates a new event filter for the ChannelClosed event.

pub fn ChannelOpened_filter(&self) -> Event<&P, ChannelOpened, N>

Creates a new event filter for the ChannelOpened event.

pub fn DomainSeparatorUpdated_filter( &self, ) -> Event<&P, DomainSeparatorUpdated, N>

Creates a new event filter for the DomainSeparatorUpdated event.

pub fn LedgerDomainSeparatorUpdated_filter( &self, ) -> Event<&P, LedgerDomainSeparatorUpdated, N>

Creates a new event filter for the LedgerDomainSeparatorUpdated event.

pub fn OutgoingChannelClosureInitiated_filter( &self, ) -> Event<&P, OutgoingChannelClosureInitiated, N>

Creates a new event filter for the OutgoingChannelClosureInitiated event.

pub fn TicketRedeemed_filter(&self) -> Event<&P, TicketRedeemed, N>

Creates a new event filter for the TicketRedeemed event.

Trait Implementations

impl<P: Clone, N: Clone> Clone for HoprChannelsInstance<P, N>

fn clone(&self) -> HoprChannelsInstance<P, N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P, N> Debug for HoprChannelsInstance<P, N>

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

Formats the value using the given formatter.