Struct HoprStake

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

Implementations

impl<M: Middleware> HoprStake<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 basic_factor_numerator(&self) -> ContractCall<M, U256>

Calls the contract’s BASIC_FACTOR_NUMERATOR (0x6aa8d4cf) function

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

Calls the contract’s BASIC_START (0xf20c9124) function

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

Calls the contract’s BOOST_CAP (0xef0526a2) function

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

Calls the contract’s FACTOR_DENOMINATOR (0x5ef73d58) function

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

Calls the contract’s LOCK_TOKEN (0xd0da6801) function

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

Calls the contract’s PROGRAM_END (0xcbffa3c7) function

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

Calls the contract’s REWARD_TOKEN (0x99248ea7) function

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

Calls the contract’s SEED_FACTOR_NUMERATOR (0x2f998468) function

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

Calls the contract’s SEED_START (0x112376dc) function

pub fn accounts( &self, p0: Address, ) -> ContractCall<M, (U256, U256, U256, U256, U256)>

Calls the contract’s accounts (0x5e5c06e2) function

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

Calls the contract’s availableReward (0x4ad84b34) function

pub fn claim_rewards(&self, account: Address) -> ContractCall<M, ()>

Calls the contract’s claimRewards (0xef5cfb8c) function

pub fn get_cumulated_rewards_increment( &self, account: Address, ) -> ContractCall<M, U256>

Calls the contract’s getCumulatedRewardsIncrement (0x70af0934) function

pub fn lock( &self, investors: Vec<Address>, caps: Vec<U256>, ) -> ContractCall<M, ()>

Calls the contract’s lock (0x5c3c71f4) function

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

Calls the contract’s nftContract (0xd56d229d) function

pub fn on_erc721_received( &self, p0: Address, from: Address, token_id: U256, p3: Bytes, ) -> ContractCall<M, [u8; 4]>

Calls the contract’s onERC721Received (0x150b7a02) function

pub fn on_token_transfer( &self, from: Address, value: U256, p2: Bytes, ) -> ContractCall<M, bool>

Calls the contract’s onTokenTransfer (0xa4c0ed36) function

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

Calls the contract’s owner (0x8da5cb5b) function

pub fn reclaim_erc_20_tokens( &self, token_address: Address, ) -> ContractCall<M, ()>

Calls the contract’s reclaimErc20Tokens (0x6067bc15) function

pub fn reclaim_erc_721_tokens( &self, token_address: Address, token_id: U256, ) -> ContractCall<M, ()>

Calls the contract’s reclaimErc721Tokens (0x48c64e41) function

pub fn redeemed_factor(&self, p0: Address, p1: U256) -> ContractCall<M, U256>

Calls the contract’s redeemedFactor (0x81128c1d) function

pub fn redeemed_factor_index(&self, p0: Address) -> ContractCall<M, U256>

Calls the contract’s redeemedFactorIndex (0x1f014d83) function

pub fn redeemed_nft(&self, p0: Address, p1: U256) -> ContractCall<M, U256>

Calls the contract’s redeemedNft (0x0a1a257a) function

pub fn redeemed_nft_index(&self, p0: Address) -> ContractCall<M, U256>

Calls the contract’s redeemedNftIndex (0xd0c02d63) function

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

Calls the contract’s renounceOwnership (0x715018a6) function

pub fn sync(&self, account: Address) -> ContractCall<M, ()>

Calls the contract’s sync (0xa5841194) function

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

Calls the contract’s tokensReceived (0x0023de29) function

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

Calls the contract’s totalLocked (0x56891412) function

pub fn transfer_ownership(&self, new_owner: Address) -> ContractCall<M, ()>

Calls the contract’s transferOwnership (0xf2fde38b) function

pub fn unlock(&self, account: Address) -> ContractCall<M, ()>

Calls the contract’s unlock (0x2f6c493c) function

pub fn claimed_filter(&self) -> Event<Arc<M>, M, ClaimedFilter>

Gets the contract’s Claimed event

pub fn ownership_transferred_filter( &self, ) -> Event<Arc<M>, M, OwnershipTransferredFilter>

Gets the contract’s OwnershipTransferred event

pub fn redeemed_filter(&self) -> Event<Arc<M>, M, RedeemedFilter>

Gets the contract’s Redeemed event

pub fn released_filter(&self) -> Event<Arc<M>, M, ReleasedFilter>

Gets the contract’s Released event

pub fn reward_fueled_filter(&self) -> Event<Arc<M>, M, RewardFueledFilter>

Gets the contract’s RewardFueled event

pub fn staked_filter(&self) -> Event<Arc<M>, M, StakedFilter>

Gets the contract’s Staked event

pub fn sync_filter(&self) -> Event<Arc<M>, M, SyncFilter>

Gets the contract’s Sync event

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

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 HoprStake<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 HoprStake<M>

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

Formats the value using the given formatter.

impl<M> Deref for HoprStake<M>

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

The resulting type after dereferencing.

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

Dereferences the value.

impl<M> DerefMut for HoprStake<M>

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

Mutably dereferences the value.

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

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

Converts to this type from the input type.