Struct StakingInstance

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

A Staking instance.

Contains type-safe methods for interacting with an on-chain instance of the Staking 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> StakingInstance<P, N>

Instantiation and getters/setters.

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

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

See the wrapper’s documentation for more details.

pub async fn deploy(provider: P) -> Result<StakingInstance<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) -> 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> StakingInstance<&P, N>

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

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

impl<P: Provider<N>, N: Network> StakingInstance<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 adminKickValidatorInNextEpoch( &self, validatorStakerAddress: Address, ) -> SolCallBuilder<&P, adminKickValidatorInNextEpochCall, N>

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

pub fn adminRejoinValidator( &self, staker: Address, ) -> SolCallBuilder<&P, adminRejoinValidatorCall, N>

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

pub fn adminResetEpoch(&self) -> SolCallBuilder<&P, adminResetEpochCall, N>

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

pub fn adminSlashValidator( &self, validatorStakerAddress: Address, amountToPenalize: U256, ) -> SolCallBuilder<&P, adminSlashValidatorCall, N>

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

pub fn adminStakeForValidator( &self, staker: Address, amount: U256, ) -> SolCallBuilder<&P, adminStakeForValidatorCall, N>

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

pub fn advanceEpoch(&self) -> SolCallBuilder<&P, advanceEpochCall, N>

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

pub fn checkVersion( &self, version: <Version as SolType>::RustType, ) -> SolCallBuilder<&P, checkVersionCall, N>

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

pub fn complaintConfig( &self, reason: U256, ) -> SolCallBuilder<&P, complaintConfigCall, N>

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

pub fn config(&self) -> SolCallBuilder<&P, configCall, N>

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

pub fn contractResolver(&self) -> SolCallBuilder<&P, contractResolverCall, N>

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

pub fn countOfCurrentValidatorsReadyForNextEpoch( &self, ) -> SolCallBuilder<&P, countOfCurrentValidatorsReadyForNextEpochCall, N>

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

pub fn countOfNextValidatorsReadyForNextEpoch( &self, ) -> SolCallBuilder<&P, countOfNextValidatorsReadyForNextEpochCall, N>

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

pub fn currentValidatorCountForConsensus( &self, ) -> SolCallBuilder<&P, currentValidatorCountForConsensusCall, N>

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

pub fn diamondCut( &self, _diamondCut: Vec<<FacetCut as SolType>::RustType>, _init: Address, _calldata: Bytes, ) -> SolCallBuilder<&P, diamondCutCall, N>

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

pub fn emitClearOfflinePhaseData( &self, dataType: U256, ) -> SolCallBuilder<&P, emitClearOfflinePhaseDataCall, N>

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

pub fn emitCountOfflinePhaseData( &self, dataType: U256, ) -> SolCallBuilder<&P, emitCountOfflinePhaseDataCall, N>

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

pub fn epoch(&self) -> SolCallBuilder<&P, epochCall, N>

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

pub fn exit(&self) -> SolCallBuilder<&P, exitCall, N>

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

pub fn facetAddress( &self, _functionSelector: FixedBytes<4>, ) -> SolCallBuilder<&P, facetAddressCall, N>

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

pub fn facetAddresses(&self) -> SolCallBuilder<&P, facetAddressesCall, N>

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

pub fn facetFunctionSelectors( &self, _facet: Address, ) -> SolCallBuilder<&P, facetFunctionSelectorsCall, N>

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

pub fn facets(&self) -> SolCallBuilder<&P, facetsCall, N>

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

pub fn getActiveUnkickedValidatorStructs( &self, ) -> SolCallBuilder<&P, getActiveUnkickedValidatorStructsCall, N>

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

pub fn getActiveUnkickedValidatorStructsAndCounts( &self, ) -> SolCallBuilder<&P, getActiveUnkickedValidatorStructsAndCountsCall, N>

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

pub fn getActiveUnkickedValidators( &self, ) -> SolCallBuilder<&P, getActiveUnkickedValidatorsCall, N>

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

pub fn getKeyTypes(&self) -> SolCallBuilder<&P, getKeyTypesCall, N>

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

pub fn getKickedValidators( &self, ) -> SolCallBuilder<&P, getKickedValidatorsCall, N>

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

pub fn getMaxVersion(&self) -> SolCallBuilder<&P, getMaxVersionCall, N>

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

pub fn getMaxVersionString( &self, ) -> SolCallBuilder<&P, getMaxVersionStringCall, N>

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

pub fn getMinVersion(&self) -> SolCallBuilder<&P, getMinVersionCall, N>

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

pub fn getMinVersionString( &self, ) -> SolCallBuilder<&P, getMinVersionStringCall, N>

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

pub fn getNodeStakerAddressMappings( &self, addresses: Vec<Address>, ) -> SolCallBuilder<&P, getNodeStakerAddressMappingsCall, N>

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

pub fn getReward(&self) -> SolCallBuilder<&P, getRewardCall, N>

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

pub fn getStakingBalancesAddress( &self, ) -> SolCallBuilder<&P, getStakingBalancesAddressCall, N>

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

pub fn getTokenAddress(&self) -> SolCallBuilder<&P, getTokenAddressCall, N>

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

pub fn getValidatorsInCurrentEpoch( &self, ) -> SolCallBuilder<&P, getValidatorsInCurrentEpochCall, N>

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

pub fn getValidatorsInCurrentEpochLength( &self, ) -> SolCallBuilder<&P, getValidatorsInCurrentEpochLengthCall, N>

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

pub fn getValidatorsInNextEpoch( &self, ) -> SolCallBuilder<&P, getValidatorsInNextEpochCall, N>

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

pub fn getValidatorsStructs( &self, addresses: Vec<Address>, ) -> SolCallBuilder<&P, getValidatorsStructsCall, N>

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

pub fn getValidatorsStructsInCurrentEpoch( &self, ) -> SolCallBuilder<&P, getValidatorsStructsInCurrentEpochCall, N>

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

pub fn getValidatorsStructsInNextEpoch( &self, ) -> SolCallBuilder<&P, getValidatorsStructsInNextEpochCall, N>

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

pub fn getVotingStatusToKickValidator( &self, epochNumber: U256, validatorStakerAddress: Address, voterStakerAddress: Address, ) -> SolCallBuilder<&P, getVotingStatusToKickValidatorCall, N>

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

pub fn isActiveValidator( &self, account: Address, ) -> SolCallBuilder<&P, isActiveValidatorCall, N>

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

pub fn isActiveValidatorByNodeAddress( &self, account: Address, ) -> SolCallBuilder<&P, isActiveValidatorByNodeAddressCall, N>

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

pub fn isReadyForNextEpoch( &self, ) -> SolCallBuilder<&P, isReadyForNextEpochCall, N>

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

pub fn kickPenaltyPercentByReason( &self, reason: U256, ) -> SolCallBuilder<&P, kickPenaltyPercentByReasonCall, N>

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

pub fn kickValidatorInNextEpoch( &self, validatorStakerAddress: Address, reason: U256, data: Bytes, ) -> SolCallBuilder<&P, kickValidatorInNextEpochCall, N>

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

pub fn lockValidatorsForNextEpoch( &self, ) -> SolCallBuilder<&P, lockValidatorsForNextEpochCall, N>

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

pub fn nextValidatorCountForConsensus( &self, ) -> SolCallBuilder<&P, nextValidatorCountForConsensusCall, N>

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

pub fn nodeAddressToStakerAddress( &self, nodeAddress: Address, ) -> SolCallBuilder<&P, nodeAddressToStakerAddressCall, N>

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

pub fn owner(&self) -> SolCallBuilder<&P, ownerCall, N>

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

pub fn readyForNextEpoch( &self, stakerAddress: Address, ) -> SolCallBuilder<&P, readyForNextEpochCall, N>

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

pub fn requestToJoin( &self, ip: u32, ipv6: u128, port: u32, nodeAddress: Address, senderPubKey: U256, receiverPubKey: U256, ) -> SolCallBuilder<&P, requestToJoinCall, N>

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

pub fn requestToLeave(&self) -> SolCallBuilder<&P, requestToLeaveCall, N>

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

pub fn requestToLeaveAsNode( &self, ) -> SolCallBuilder<&P, requestToLeaveAsNodeCall, N>

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

pub fn setComplaintConfig( &self, reason: U256, config: <ComplaintConfig as SolType>::RustType, ) -> SolCallBuilder<&P, setComplaintConfigCall, N>

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

pub fn setConfig( &self, newConfig: <Config as SolType>::RustType, ) -> SolCallBuilder<&P, setConfigCall, N>

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

pub fn setContractResolver( &self, newResolverAddress: Address, ) -> SolCallBuilder<&P, setContractResolverCall, N>

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

pub fn setDevopsAdmin( &self, newDevopsAdmin: Address, ) -> SolCallBuilder<&P, setDevopsAdminCall, N>

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

pub fn setEpochEndTime( &self, newEpochEndTime: U256, ) -> SolCallBuilder<&P, setEpochEndTimeCall, N>

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

pub fn setEpochLength( &self, newEpochLength: U256, ) -> SolCallBuilder<&P, setEpochLengthCall, N>

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

pub fn setEpochState( &self, newState: <States as SolType>::RustType, ) -> SolCallBuilder<&P, setEpochStateCall, N>

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

pub fn setEpochTimeout( &self, newEpochTimeout: U256, ) -> SolCallBuilder<&P, setEpochTimeoutCall, N>

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

pub fn setIpPortNodeAddressAndCommunicationPubKeys( &self, ip: u32, ipv6: u128, port: u32, nodeAddress: Address, senderPubKey: U256, receiverPubKey: U256, ) -> SolCallBuilder<&P, setIpPortNodeAddressAndCommunicationPubKeysCall, N>

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

pub fn setKickPenaltyPercent( &self, reason: U256, newKickPenaltyPercent: U256, ) -> SolCallBuilder<&P, setKickPenaltyPercentCall, N>

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

pub fn setMaxVersion( &self, version: <Version as SolType>::RustType, ) -> SolCallBuilder<&P, setMaxVersionCall, N>

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

pub fn setMinVersion( &self, version: <Version as SolType>::RustType, ) -> SolCallBuilder<&P, setMinVersionCall, N>

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

pub fn shouldKickValidator( &self, stakerAddress: Address, ) -> SolCallBuilder<&P, shouldKickValidatorCall, N>

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

pub fn signalReadyForNextEpoch( &self, epochNumber: U256, ) -> SolCallBuilder<&P, signalReadyForNextEpochCall, N>

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

pub fn stake(&self, amount: U256) -> SolCallBuilder<&P, stakeCall, N>

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

pub fn stakeAndJoin( &self, amount: U256, ip: u32, ipv6: u128, port: u32, nodeAddress: Address, senderPubKey: U256, receiverPubKey: U256, ) -> SolCallBuilder<&P, stakeAndJoinCall, N>

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

pub fn state(&self) -> SolCallBuilder<&P, stateCall, N>

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

pub fn supportsInterface( &self, _interfaceId: FixedBytes<4>, ) -> SolCallBuilder<&P, supportsInterfaceCall, N>

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

pub fn transferOwnership( &self, _newOwner: Address, ) -> SolCallBuilder<&P, transferOwnershipCall, N>

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

pub fn validators( &self, stakerAddress: Address, ) -> SolCallBuilder<&P, validatorsCall, N>

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

pub fn withdraw(&self, amount: U256) -> SolCallBuilder<&P, withdrawCall, N>

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

impl<P: Provider<N>, N: Network> StakingInstance<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 ClearOfflinePhaseData_filter( &self, ) -> Event<&P, ClearOfflinePhaseData, N>

Creates a new event filter for the ClearOfflinePhaseData event.

pub fn ComplaintConfigSet_filter(&self) -> Event<&P, ComplaintConfigSet, N>

Creates a new event filter for the ComplaintConfigSet event.

pub fn ConfigSet_filter(&self) -> Event<&P, ConfigSet, N>

Creates a new event filter for the ConfigSet event.

pub fn CountOfflinePhaseData_filter( &self, ) -> Event<&P, CountOfflinePhaseData, N>

Creates a new event filter for the CountOfflinePhaseData event.

pub fn DevopsAdminSet_filter(&self) -> Event<&P, DevopsAdminSet, N>

Creates a new event filter for the DevopsAdminSet event.

pub fn DiamondCut_filter(&self) -> Event<&P, DiamondCut, N>

Creates a new event filter for the DiamondCut event.

pub fn EpochEndTimeSet_filter(&self) -> Event<&P, EpochEndTimeSet, N>

Creates a new event filter for the EpochEndTimeSet event.

pub fn EpochLengthSet_filter(&self) -> Event<&P, EpochLengthSet, N>

Creates a new event filter for the EpochLengthSet event.

pub fn EpochTimeoutSet_filter(&self) -> Event<&P, EpochTimeoutSet, N>

Creates a new event filter for the EpochTimeoutSet event.

pub fn KickPenaltyPercentSet_filter( &self, ) -> Event<&P, KickPenaltyPercentSet, N>

Creates a new event filter for the KickPenaltyPercentSet event.

pub fn OwnershipTransferred_filter(&self) -> Event<&P, OwnershipTransferred, N>

Creates a new event filter for the OwnershipTransferred event.

pub fn ReadyForNextEpoch_filter(&self) -> Event<&P, ReadyForNextEpoch, N>

Creates a new event filter for the ReadyForNextEpoch event.

pub fn Recovered_filter(&self) -> Event<&P, Recovered, N>

Creates a new event filter for the Recovered event.

pub fn RequestToJoin_filter(&self) -> Event<&P, RequestToJoin, N>

Creates a new event filter for the RequestToJoin event.

pub fn RequestToLeave_filter(&self) -> Event<&P, RequestToLeave, N>

Creates a new event filter for the RequestToLeave event.

pub fn ResolverContractAddressSet_filter( &self, ) -> Event<&P, ResolverContractAddressSet, N>

Creates a new event filter for the ResolverContractAddressSet event.

pub fn RewardsDurationUpdated_filter( &self, ) -> Event<&P, RewardsDurationUpdated, N>

Creates a new event filter for the RewardsDurationUpdated event.

pub fn StakingTokenSet_filter(&self) -> Event<&P, StakingTokenSet, N>

Creates a new event filter for the StakingTokenSet event.

pub fn StateChanged_filter(&self) -> Event<&P, StateChanged, N>

Creates a new event filter for the StateChanged event.

pub fn ValidatorKickedFromNextEpoch_filter( &self, ) -> Event<&P, ValidatorKickedFromNextEpoch, N>

Creates a new event filter for the ValidatorKickedFromNextEpoch event.

pub fn ValidatorRejoinedNextEpoch_filter( &self, ) -> Event<&P, ValidatorRejoinedNextEpoch, N>

Creates a new event filter for the ValidatorRejoinedNextEpoch event.

pub fn VersionRequirementsUpdated_filter( &self, ) -> Event<&P, VersionRequirementsUpdated, N>

Creates a new event filter for the VersionRequirementsUpdated event.

pub fn VotedToKickValidatorInNextEpoch_filter( &self, ) -> Event<&P, VotedToKickValidatorInNextEpoch, N>

Creates a new event filter for the VotedToKickValidatorInNextEpoch event.

Trait Implementations

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

fn clone(&self) -> StakingInstance<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 StakingInstance<P, N>

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

Formats the value using the given formatter.