Struct pallet_tidefi_stake::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn stake(
    origin: OriginFor<T>,
    currency_id: CurrencyId,
    amount: Balance,
    duration: T::BlockNumber
) -> DispatchResultWithPostInfo

Stake currency

• currency_id: The currency to stake
• amount: The amount to stake
• duration: The duration is in numbers of blocks. (blocks are ~6seconds)

Emits Staked event when successful.

Weight: O(1)

pub fn unstake(
    origin: OriginFor<T>,
    stake_id: Hash,
    force_unstake: bool
) -> DispatchResultWithPostInfo

Unstake

• stake_id: Unique Stake ID
• force_unstake: Unstake with extra fees, even if the staking is not expired

Emits Unstaked event when successful.

Weight: O(1)

pub fn set_operator_account_id(
    origin: OriginFor<T>,
    new_operator_account_id: T::AccountId
) -> DispatchResultWithPostInfo

Set Staking Operator Account TODO: Benchmark weight

impl<T: Config> Pallet<T>

pub fn account_id() -> T::AccountId

pub fn operator_account() -> T::AccountId

pub fn add_account_stake(
    account_id: &T::AccountId,
    currency_id: CurrencyId,
    amount: Balance,
    duration: T::BlockNumber
) -> Result<Hash, DispatchError>

pub fn do_on_idle_compound(remaining_weight: Weight) -> Weight

pub fn do_on_idle_unstake(remaining_weight: Weight) -> Weight

pub fn get_account_stakes(
    account_id: &T::AccountId
) -> Vec<(CurrencyId, Stake<BalanceInfo, T::BlockNumber>)>

impl<T: Config> Pallet<T>

pub fn staking_pool<KArg>(k: KArg) -> Option<Balance>where
    KArg: EncodeLike<CurrencyId>,

Staking pool

impl<T: Config> Pallet<T>

pub fn staking_rewards(
) -> BoundedVec<(T::BlockNumber, Percent), T::StakingRewardCap>

Staking rewards defined by the council

impl<T: Config> Pallet<T>

pub fn staking_meta<KArg>(k: KArg) -> Option<StakeCurrencyMeta<Balance>>where
    KArg: EncodeLike<CurrencyId>,

Staking metadata defined by the council (minimum and maximum stake amount)

impl<T: Config> Pallet<T>

pub fn unstake_fee() -> Percent

The percentage of fee when unstake is done before the ending.

impl<T: Config> Pallet<T>

pub fn interest_compound_last_session() -> SessionIndex

The last session we should compound the account interests.

impl<T: Config> Pallet<T>

pub fn pending_sessions<KArg>(
    k: KArg
) -> Option<BoundedVec<(CurrencyId, Balance), T::StakingRewardCap>>where
    KArg: EncodeLike<SessionIndex>,

Map from all pending stored sessions.

impl<T: Config> Pallet<T>

pub fn session_total_fees<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Balancewhere
    KArg1: EncodeLike<SessionIndex>,
    KArg2: EncodeLike<CurrencyId>,

The total fees for the session. If total hasn’t been set or has been removed then 0 stake is returned.

impl<T: Config> Pallet<T>

pub fn account_stakes<KArg>(
    k: KArg
) -> BoundedVec<Stake<Balance, T::BlockNumber>, T::StakeAccountCap>where
    KArg: EncodeLike<T::AccountId>,

Account staking by CurrencyID

impl<T: Config> Pallet<T>

pub fn operator_account_id() -> Option<T::AccountId>

Operator account

Trait Implementations

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

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Pallet<T>

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

Formats the value using the given formatter.

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

fn current_storage_version() -> StorageVersion

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.

impl<T: Config> Hooks<<T as Config>::BlockNumber> for Pallet<T>

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

Try to compute when chain is idle

fn on_finalize(_n: BlockNumber)

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

fn on_initialize(_n: BlockNumber) -> Weight

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

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

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.

fn integrity_test()

Run integrity test.

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

fn integrity_test()

Run integrity test.

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

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

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

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

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, 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.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

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

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

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

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.

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 ==.

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: Config> StakingExt<<T as Config>::AccountId> for Pallet<T>

fn account_id() -> T::AccountId

Get the staking account id where the funds are transfered

fn account_stakes_size() -> u64

Get the size of AccountStakes, used to predict the weight of on_session_end

fn on_session_end(
    session_index: SessionIndex,
    session_trade_values: Vec<(CurrencyId, Balance)>,
    fees_account_id: T::AccountId
) -> Result<(), DispatchError>

Triggered when a session end in the Fee pallet

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>