Struct HoprChannels

pub struct HoprChannels<M>(/* private fields */);

Implementations

impl<M: Middleware> HoprChannels<M>

pub fn new<T: Into<Address>>(address: T, client: Arc<M>) -> Self

Creates a new contract instance with the specified ethers client at address. The contract derefs to a ethers::Contract object.

pub fn deploy<T: Tokenize>( client: Arc<M>, constructor_args: T, ) -> Result<ContractDeployer<M, Self>, ContractError<M>>

Constructs the general purpose Deployer instance based on the provided constructor arguments and sends it. Returns a new instance of a deployer that returns an instance of this contract after sending the transaction

Notes:

• If there are no constructor arguments, you should pass () as the argument.
• The default poll duration is 7 seconds.
• The default number of confirmations is 1 block.

Example

Generate contract bindings with abigen! and deploy a new contract instance.

Note: this requires a bytecode and abi object in the greeter.json artifact.

    abigen!(Greeter, "../greeter.json");

   let greeter_contract = Greeter::deploy(client, "Hello world!".to_string()).unwrap().send().await.unwrap();
   let msg = greeter_contract.greet().call().await.unwrap();

pub fn erc777_hook_fund_channel_multi_size(&self) -> ContractCall<M, U256>

Calls the contract’s ERC777_HOOK_FUND_CHANNEL_MULTI_SIZE (0x78d8016d) function

pub fn erc777_hook_fund_channel_size(&self) -> ContractCall<M, U256>

Calls the contract’s ERC777_HOOK_FUND_CHANNEL_SIZE (0x44dae6f8) function

pub fn ledger_version(&self) -> ContractCall<M, String>

Calls the contract’s LEDGER_VERSION (0xddad1902) function

pub fn max_used_balance(&self) -> ContractCall<M, u128>

Calls the contract’s MAX_USED_BALANCE (0x5d2f07c5) function

pub fn min_used_balance(&self) -> ContractCall<M, u128>

Calls the contract’s MIN_USED_BALANCE (0x29392e32) function

pub fn tokens_recipient_interface_hash(&self) -> ContractCall<M, [u8; 32]>

Calls the contract’s TOKENS_RECIPIENT_INTERFACE_HASH (0x72581cc0) function

pub fn version(&self) -> ContractCall<M, String>

Calls the contract’s VERSION (0xffa1ad74) function

pub fn current_block_timestamp(&self) -> ContractCall<M, u32>

Calls the contract’s _currentBlockTimestamp (0xb920deed) function

pub fn get_channel_id( &self, source: Address, destination: Address, ) -> ContractCall<M, [u8; 32]>

Calls the contract’s _getChannelId (0xbe9babdc) function

pub fn get_ticket_hash( &self, redeemable: RedeemableTicket, ) -> ContractCall<M, [u8; 32]>

Calls the contract’s _getTicketHash (0x24086cc2) function

pub fn is_winning_ticket( &self, ticket_hash: [u8; 32], redeemable: RedeemableTicket, params: Vrfparameters, ) -> ContractCall<M, bool>

Calls the contract’s _isWinningTicket (0x8c3710c9) function

pub fn can_implement_interface_for_address( &self, interface_hash: [u8; 32], account: Address, ) -> ContractCall<M, [u8; 32]>

Calls the contract’s canImplementInterfaceForAddress (0x249cb3fa) function

pub fn channels( &self, p0: [u8; 32], ) -> ContractCall<M, (u128, u64, u32, u32, u8)>

Calls the contract’s channels (0x7a7ebd7b) function

pub fn close_incoming_channel(&self, source: Address) -> ContractCall<M, ()>

Calls the contract’s closeIncomingChannel (0x1a7ffe7a) function

pub fn close_incoming_channel_safe( &self, self_: Address, source: Address, ) -> ContractCall<M, ()>

Calls the contract’s closeIncomingChannelSafe (0x54a2edf5) function

pub fn domain_separator(&self) -> ContractCall<M, [u8; 32]>

Calls the contract’s domainSeparator (0xf698da25) function

pub fn finalize_outgoing_channel_closure( &self, destination: Address, ) -> ContractCall<M, ()>

Calls the contract’s finalizeOutgoingChannelClosure (0x23cb3ac0) function

pub fn finalize_outgoing_channel_closure_safe( &self, self_: Address, destination: Address, ) -> ContractCall<M, ()>

Calls the contract’s finalizeOutgoingChannelClosureSafe (0x651514bf) function

pub fn fund_channel( &self, account: Address, amount: u128, ) -> ContractCall<M, ()>

Calls the contract’s fundChannel (0xfc55309a) function

pub fn fund_channel_safe( &self, self_: Address, account: Address, amount: u128, ) -> ContractCall<M, ()>

Calls the contract’s fundChannelSafe (0x0abec58f) function

pub fn initiate_outgoing_channel_closure( &self, destination: Address, ) -> ContractCall<M, ()>

Calls the contract’s initiateOutgoingChannelClosure (0x7c8e28da) function

pub fn initiate_outgoing_channel_closure_safe( &self, self_: Address, destination: Address, ) -> ContractCall<M, ()>

Calls the contract’s initiateOutgoingChannelClosureSafe (0xbda65f45) function

pub fn ledger_domain_separator(&self) -> ContractCall<M, [u8; 32]>

Calls the contract’s ledgerDomainSeparator (0xc966c4fe) function

pub fn multicall(&self, data: Vec<Bytes>) -> ContractCall<M, Vec<Bytes>>

Calls the contract’s multicall (0xac9650d8) function

pub fn notice_period_channel_closure(&self) -> ContractCall<M, u32>

Calls the contract’s noticePeriodChannelClosure (0x87352d65) function

pub fn redeem_ticket( &self, redeemable: RedeemableTicket, params: Vrfparameters, ) -> ContractCall<M, ()>

Calls the contract’s redeemTicket (0xfcb7796f) function

pub fn redeem_ticket_safe( &self, self_: Address, redeemable: RedeemableTicket, params: Vrfparameters, ) -> ContractCall<M, ()>

Calls the contract’s redeemTicketSafe (0x0cd88d72) function

pub fn token(&self) -> ContractCall<M, Address>

Calls the contract’s token (0xfc0c546a) function

pub fn tokens_received( &self, p0: Address, from: Address, to: Address, amount: U256, user_data: Bytes, p5: Bytes, ) -> ContractCall<M, ()>

Calls the contract’s tokensReceived (0x0023de29) function

pub fn update_domain_separator(&self) -> ContractCall<M, ()>

Calls the contract’s updateDomainSeparator (0x89ccfe89) function

pub fn update_ledger_domain_separator(&self) -> ContractCall<M, ()>

Calls the contract’s updateLedgerDomainSeparator (0xdc96fd50) function

pub fn channel_balance_decreased_filter( &self, ) -> Event<Arc<M>, M, ChannelBalanceDecreasedFilter>

Gets the contract’s ChannelBalanceDecreased event

pub fn channel_balance_increased_filter( &self, ) -> Event<Arc<M>, M, ChannelBalanceIncreasedFilter>

Gets the contract’s ChannelBalanceIncreased event

pub fn channel_closed_filter(&self) -> Event<Arc<M>, M, ChannelClosedFilter>

Gets the contract’s ChannelClosed event

pub fn channel_opened_filter(&self) -> Event<Arc<M>, M, ChannelOpenedFilter>

Gets the contract’s ChannelOpened event

pub fn domain_separator_updated_filter( &self, ) -> Event<Arc<M>, M, DomainSeparatorUpdatedFilter>

Gets the contract’s DomainSeparatorUpdated event

pub fn ledger_domain_separator_updated_filter( &self, ) -> Event<Arc<M>, M, LedgerDomainSeparatorUpdatedFilter>

Gets the contract’s LedgerDomainSeparatorUpdated event

pub fn outgoing_channel_closure_initiated_filter( &self, ) -> Event<Arc<M>, M, OutgoingChannelClosureInitiatedFilter>

Gets the contract’s OutgoingChannelClosureInitiated event

pub fn ticket_redeemed_filter(&self) -> Event<Arc<M>, M, TicketRedeemedFilter>

Gets the contract’s TicketRedeemed event

pub fn events(&self) -> Event<Arc<M>, M, HoprChannelsEvents>

Returns an Event builder for all the events of this contract.

Methods from Deref<Target = Contract<M>>

pub fn address(&self) -> H160

Returns the contract’s address

pub fn abi(&self) -> &Contract

Returns a reference to the contract’s ABI.

pub fn client(&self) -> B

where B: Clone,

Returns a pointer to the contract’s client.

pub fn client_ref(&self) -> &M

Returns a reference to the contract’s client.

pub fn connect<N>(&self, client: Arc<N>) -> ContractInstance<Arc<N>, N>

where N: Middleware,

Returns a new contract instance using the provided client

Clones self internally

pub fn connect_with<C, N>(&self, client: C) -> ContractInstance<C, N>

where C: Borrow<N>,

Returns a new contract instance using the provided client

Clones self internally

pub fn event_with_filter<D>(&self, filter: Filter) -> Event<B, M, D>

Returns an [Event] builder with the provided filter.

pub fn event<D>(&self) -> Event<B, M, D>

where D: EthEvent,

Returns an [Event] builder for the provided event.

pub fn event_for_name<D>(&self, name: &str) -> Result<Event<B, M, D>, Error>

Returns an [Event] builder with the provided name.

pub fn method_hash<T, D>( &self, signature: [u8; 4], args: T, ) -> Result<FunctionCall<B, M, D>, AbiError>

where T: Tokenize, D: Detokenize,

Returns a transaction builder for the selected function signature. This should be preferred if there are overloaded functions in your smart contract

pub fn method<T, D>( &self, name: &str, args: T, ) -> Result<FunctionCall<B, M, D>, AbiError>

where T: Tokenize, D: Detokenize,

Returns a transaction builder for the provided function name. If there are multiple functions with the same name due to overloading, consider using the method_hash method instead, since this will use the first match.

pub fn at<T>(&self, address: T) -> ContractInstance<B, M>

where T: Into<H160>,

Returns a new contract instance at address.

Clones self internally

Methods from Deref<Target = BaseContract>

pub fn encode<T>(&self, name: &str, args: T) -> Result<Bytes, AbiError>

where T: Tokenize,

Returns the ABI encoded data for the provided function and arguments

If the function exists multiple times and you want to use one of the overloaded versions, consider using encode_with_selector

pub fn encode_with_selector<T>( &self, signature: [u8; 4], args: T, ) -> Result<Bytes, AbiError>

where T: Tokenize,

Returns the ABI encoded data for the provided function selector and arguments

pub fn decode<D, T>(&self, name: &str, bytes: T) -> Result<D, AbiError>

where D: Detokenize, T: AsRef<[u8]>,

Decodes the provided ABI encoded function arguments with the selected function name.

If the function exists multiple times and you want to use one of the overloaded versions, consider using decode_with_selector

pub fn decode_raw<T>( &self, name: &str, bytes: T, ) -> Result<Vec<Token>, AbiError>

where T: AsRef<[u8]>,

Decodes the provided ABI encoded function arguments with the selected function name.

If the function exists multiple times and you want to use one of the overloaded versions, consider using decode_with_selector

Returns a [Token] vector, which lets you decode function arguments dynamically without knowing the return type.

pub fn decode_output<D, T>(&self, name: &str, bytes: T) -> Result<D, AbiError>

where D: Detokenize, T: AsRef<[u8]>,

Decodes the provided ABI encoded function output with the selected function name.

If the function exists multiple times and you want to use one of the overloaded versions, consider using decode_with_selector

pub fn decode_output_raw<T>( &self, name: &str, bytes: T, ) -> Result<Vec<Token>, AbiError>

where T: AsRef<[u8]>,

Decodes the provided ABI encoded function output with the selected function name.

If the function exists multiple times and you want to use one of the overloaded versions, consider using decode_with_selector

Returns a [Token] vector, which lets you decode function arguments dynamically without knowing the return type.

pub fn decode_event<D>( &self, name: &str, topics: Vec<H256>, data: Bytes, ) -> Result<D, AbiError>

where D: Detokenize,

Decodes for a given event name, given the log.topics and log.data fields from the transaction receipt

pub fn decode_event_raw( &self, name: &str, topics: Vec<H256>, data: Bytes, ) -> Result<Vec<Token>, AbiError>

Decodes for a given event name, given the log.topics and log.data fields from the transaction receipt

Returns a [Token] vector, which lets you decode function arguments dynamically without knowing the return type.

pub fn decode_with_selector_raw<T>( &self, signature: [u8; 4], bytes: T, ) -> Result<Vec<Token>, AbiError>

where T: AsRef<[u8]>,

Decodes the provided ABI encoded bytes with the selected function selector

Returns a [Token] vector, which lets you decode function arguments dynamically without knowing the return type.

pub fn decode_with_selector<D, T>( &self, signature: [u8; 4], bytes: T, ) -> Result<D, AbiError>

where D: Detokenize, T: AsRef<[u8]>,

Decodes the provided ABI encoded bytes with the selected function selector

pub fn decode_input_raw<T>(&self, bytes: T) -> Result<Vec<Token>, AbiError>

where T: AsRef<[u8]>,

Decodes the provided ABI encoded input bytes

Returns a [Token] vector, which lets you decode function arguments dynamically without knowing the return type.

pub fn decode_input<D, T>(&self, bytes: T) -> Result<D, AbiError>

where D: Detokenize, T: AsRef<[u8]>,

Decodes the provided ABI encoded input bytes

pub fn decode_output_with_selector<D, T>( &self, signature: [u8; 4], bytes: T, ) -> Result<D, AbiError>

where D: Detokenize, T: AsRef<[u8]>,

Decode the provided ABI encoded bytes as the output of the provided function selector

pub fn decode_output_with_selector_raw<T>( &self, signature: [u8; 4], bytes: T, ) -> Result<Vec<Token>, AbiError>

where T: AsRef<[u8]>,

Decodes the provided ABI encoded bytes with the selected function selector

Returns a [Token] vector, which lets you decode function arguments dynamically without knowing the return type.

pub fn abi(&self) -> &Contract

Returns a reference to the contract’s ABI

Trait Implementations

impl<M> Clone for HoprChannels<M>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M> Debug for HoprChannels<M>

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

Formats the value using the given formatter.

impl<M> Deref for HoprChannels<M>

type Target = ContractInstance<Arc<M>, M>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<M> DerefMut for HoprChannels<M>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<M: Middleware> From<ContractInstance<Arc<M>, M>> for HoprChannels<M>

fn from(contract: Contract<M>) -> Self

Converts to this type from the input type.