Struct staking::pallet::Pallet

impl<T: Config> Pallet<T>

pub fn total_stake_at_index<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> <T as Config>::SignedFixedPointwhere KArg1: EncodeLike<T::Nonce>, KArg2: EncodeLike<DefaultVaultId<T>>,

An auto-generated getter for TotalStake.

impl<T: Config> Pallet<T>

pub fn total_current_stake_at_index<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> <T as Config>::SignedFixedPointwhere KArg1: EncodeLike<T::Nonce>, KArg2: EncodeLike<DefaultVaultId<T>>,

An auto-generated getter for TotalCurrentStake.

impl<T: Config> Pallet<T>

pub fn total_rewards<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> <T as Config>::SignedFixedPointwhere KArg1: EncodeLike<T::CurrencyId>, KArg2: EncodeLike<(T::Nonce, DefaultVaultId<T>)>,

An auto-generated getter for TotalRewards.

impl<T: Config> Pallet<T>

pub fn reward_per_token<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> <T as Config>::SignedFixedPointwhere KArg1: EncodeLike<T::CurrencyId>, KArg2: EncodeLike<(T::Nonce, DefaultVaultId<T>)>,

An auto-generated getter for RewardPerToken.

impl<T: Config> Pallet<T>

pub fn stake( vault_id: &DefaultVaultId<T>, nominator_id: &T::AccountId ) -> <T as Config>::SignedFixedPoint

Get the stake associated with a vault / nominator.

pub fn slash_tally( vault_id: &DefaultVaultId<T>, nominator_id: &T::AccountId ) -> <T as Config>::SignedFixedPoint

Get the nominator’s slash_tally for the staking pool.

pub fn nonce(vault_id: &DefaultVaultId<T>) -> T::Nonce

Get the newest nonce for the staking pool.

pub fn slash_per_token( vault_id: &DefaultVaultId<T> ) -> <T as Config>::SignedFixedPoint

Get the vault’s slash_per_token for the staking pool.

pub fn deposit_stake( vault_id: &DefaultVaultId<T>, nominator_id: &T::AccountId, amount: <T as Config>::SignedFixedPoint ) -> DispatchResult

Deposit an amount of stake to the vault_id for the nominator_id.

pub fn slash_stake( vault_id: &DefaultVaultId<T>, amount: <T as Config>::SignedFixedPoint ) -> DispatchResult

Slash an amount of stake from the vault_id.

pub fn compute_stake( vault_id: &DefaultVaultId<T>, nominator_id: &T::AccountId ) -> Result<<<T as Config>::SignedFixedPoint as FixedPointNumber>::Inner, DispatchError>

Delegates to compute_stake_at_index with the current nonce.

pub fn compute_stake_at_index( nonce: T::Nonce, vault_id: &DefaultVaultId<T>, nominator_id: &T::AccountId ) -> Result<<<T as Config>::SignedFixedPoint as FixedPointNumber>::Inner, DispatchError>

Compute the stake in vault_id owned by nominator_id.

pub fn compute_precise_stake_at_index( nonce: T::Nonce, vault_id: &DefaultVaultId<T>, nominator_id: &T::AccountId ) -> Result<<T as Config>::SignedFixedPoint, DispatchError>

pub fn distribute_reward( currency_id: T::CurrencyId, vault_id: &DefaultVaultId<T>, reward: <T as Config>::SignedFixedPoint ) -> Result<<T as Config>::SignedFixedPoint, DispatchError>

Distribute the reward to all participants.

pub fn compute_reward( currency_id: T::CurrencyId, vault_id: &DefaultVaultId<T>, nominator_id: &T::AccountId ) -> Result<<<T as Config>::SignedFixedPoint as FixedPointNumber>::Inner, DispatchError>

Delegates to compute_reward_at_index with the current nonce.

pub fn get_total_rewards( currency_id: T::CurrencyId ) -> <<T as Config>::SignedFixedPoint as FixedPointNumber>::Inner

Trait Implementations§

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<T> Debug for Pallet<T>

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

Formats the value using the given formatter. Read more

impl<T: Config> GetStorageVersion for Pallet<T>

type CurrentStorageVersion = NoStorageVersionSet

This will be filled out by the pallet macro. Read more

fn current_storage_version() -> Self::CurrentStorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

This will be run when the block is being finalized (before on_finalize). Read more

fn on_initialize(_n: BlockNumber) -> Weight

The block is being initialized. Implement to have something happen. Read more

fn on_runtime_upgrade() -> Weight

Perform a module upgrade. Read more

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain. Read more

fn integrity_test()

Run integrity test. Read more

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

Run integrity test. Read more

fn offchain_worker(n: BlockNumberFor<T>)

This function is being called after every block import (when fully synced). Read more

fn on_finalize(n: BlockNumberFor<T>)

The block is being finalized. Implement to have something happen. Read more

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation. Read more

fn on_initialize(n: BlockNumberFor<T>) -> Weight

The block is being initialized. Implement to have something happen. Read more

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

Perform a module upgrade. Read more

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents. Read more

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq<Pallet<T>> for Pallet<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, Balance> RewardsApi<(Option<<T as Config>::Nonce>, VaultId<<T as Config>::AccountId, <T as Config>::CurrencyId>), <T as Config>::AccountId, Balance> for Pallet<T>where T: Config, Balance: BalanceToFixedPoint<<T as Config>::SignedFixedPoint> + Saturating + PartialOrd + Copy, <T::SignedFixedPoint as FixedPointNumber>::Inner: TryInto<Balance>,

type CurrencyId = <T as Config>::CurrencyId

fn reward_currencies_len(_: &(Option<T::Nonce>, DefaultVaultId<T>)) -> u32

fn distribute_reward( (_, vault_id): &(Option<T::Nonce>, DefaultVaultId<T>), currency_id: T::CurrencyId, amount: Balance ) -> DispatchResult

Distribute the amount to all participants OR error if zero total stake.

fn compute_reward( (nonce, vault_id): &(Option<T::Nonce>, DefaultVaultId<T>), nominator_id: &T::AccountId, currency_id: T::CurrencyId ) -> Result<Balance, DispatchError>

Compute the expected reward for the stake_id.

fn withdraw_reward( (nonce, vault_id): &(Option<T::Nonce>, DefaultVaultId<T>), nominator_id: &T::AccountId, currency_id: T::CurrencyId ) -> Result<Balance, DispatchError>

Withdraw all rewards from the stake_id.

fn deposit_stake( (_, vault_id): &(Option<T::Nonce>, DefaultVaultId<T>), nominator_id: &T::AccountId, amount: Balance ) -> DispatchResult

Deposit stake for an account.

fn withdraw_stake( (nonce, vault_id): &(Option<T::Nonce>, DefaultVaultId<T>), nominator_id: &T::AccountId, amount: Balance ) -> DispatchResult

Withdraw stake for an account.

fn withdraw_all_stake( (nonce, vault_id): &(Option<T::Nonce>, DefaultVaultId<T>), nominator_id: &T::AccountId ) -> Result<Balance, DispatchError>

Withdraw all stake for an account.

fn get_total_stake( (_, vault_id): &(Option<T::Nonce>, DefaultVaultId<T>) ) -> Result<Balance, DispatchError>

Return the stake associated with the pool_id.

fn get_stake( (nonce, vault_id): &(Option<T::Nonce>, DefaultVaultId<T>), nominator_id: &T::AccountId ) -> Result<Balance, DispatchError>

Return the stake associated with the stake_id.

fn set_stake( pool_id: &PoolId, stake_id: &StakeId, amount: Balance ) -> Result<(), DispatchError>

Set the stake to amount for stake_id regardless of its current stake.

impl<T, Balance> StakingApi<VaultId<<T as Config>::AccountId, <T as Config>::CurrencyId>, <T as Config>::Nonce, Balance> for Pallet<T>where T: Config, Balance: BalanceToFixedPoint<<T as Config>::SignedFixedPoint>, <T::SignedFixedPoint as FixedPointNumber>::Inner: TryInto<Balance>,

fn nonce(vault_id: &DefaultVaultId<T>) -> T::Nonce

Get the newest nonce for the staking pool.

fn slash_stake(vault_id: &DefaultVaultId<T>, amount: Balance) -> DispatchResult

Slash an amount of stake from the pool_id.

fn force_refund(vault_id: &DefaultVaultId<T>) -> Result<Balance, DispatchError>

Force refund the entire nomination to pool_id.

impl<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> WhitelistedStorageKeys for Pallet<T>

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>

Auto Trait Implementations§

impl<T> RefUnwindSafe for Pallet<T>where T: RefUnwindSafe,

impl<T> Send for Pallet<T>where T: Send,

impl<T> Sync for Pallet<T>where T: Sync,

impl<T> Unpin for Pallet<T>where T: Unpin,

impl<T> UnwindSafe for Pallet<T>where T: UnwindSafe,

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CheckedConversion for T

fn checked_from<T>(t: T) -> Option<Self>where Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more

fn checked_into<T>(self) -> Option<T>where Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more

impl<T> Conv for T

fn conv<T>(self) -> Twhere Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> DynClone for Twhere T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IsType<T> for T

fn from_ref(t: &T) -> &T

Cast reference.

fn into_ref(&self) -> &T

Cast reference.

fn from_mut(t: &mut T) -> &mut T

Cast mutable reference.

fn into_mut(&mut self) -> &mut T

Cast mutable reference.

impl<T, Outer> IsWrappedBy<Outer> for Twhere Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

impl<T> Pipe for Twhere T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> Rwhere Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> Rwhere Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> SaturatedConversion for T

fn saturated_from<T>(t: T) -> Selfwhere Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more

fn saturated_into<T>(self) -> Twhere Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom for Twhere U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for Twhere U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source§

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<S, T> UncheckedInto<T> for Swhere T: UncheckedFrom<S>,

fn unchecked_into(self) -> T

The counterpart to unchecked_from.

impl<T, S> UniqueSaturatedInto<T> for Swhere T: Bounded, S: TryInto<T>,

fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> JsonSchemaMaybe for T

impl<T> MaybeDebug for Twhere T: Debug,

impl<T> MaybeRefUnwindSafe for Twhere T: RefUnwindSafe,