serai/substrate/staking/pallet/src/lib.rs

#![cfg_attr(not(feature = "std"), no_std)]

#[frame_support::pallet]
pub mod pallet {
  use sp_runtime::traits::TrailingZeroInput;
  use sp_std::vec::Vec;

  use frame_system::pallet_prelude::*;
  use frame_support::pallet_prelude::*;

  use serai_primitives::*;

  use coins_pallet::{Config as CoinsConfig, Pallet as Coins};

  use validator_sets_pallet::{
    primitives::{Session, ValidatorSet},
    Config as VsConfig, Pallet as VsPallet,
  };
  use pallet_session::{Config as SessionConfig, SessionManager};

  #[pallet::error]
  pub enum Error<T> {
    StakeUnavilable,
    NoDeallocation,
  }

  #[pallet::event]
  #[pallet::generate_deposit(pub(super) fn deposit_event)]
  pub enum Event<T: Config> {
    Staked {
      validator: T::AccountId,
      amount: Amount,
    },
    Unstaked {
      validator: T::AccountId,
      amount: Amount,
    },
    ImmediateDeallocation {
      validator: T::AccountId,
      network: NetworkId,
      amount: Amount,
    },
    DeallocationClaimed {
      validator: T::AccountId,
      network: NetworkId,
      session: Session,
      amount: Amount,
    },
  }

  #[pallet::config]
  pub trait Config:
    frame_system::Config + CoinsConfig + VsConfig + SessionConfig<ValidatorId = PublicKey>
  {
    type RuntimeEvent: IsType<<Self as frame_system::Config>::RuntimeEvent> + From<Event<Self>>;
  }

  #[pallet::pallet]
  pub struct Pallet<T>(PhantomData<T>);

  /// The amount of funds this account has staked.
  #[pallet::storage]
  #[pallet::getter(fn staked)]
  pub type Staked<T: Config> = StorageMap<_, Blake2_128Concat, T::AccountId, u64, ValueQuery>;

  /// The amount of stake this account has allocated to validator sets.
  #[pallet::storage]
  #[pallet::getter(fn allocated)]
  pub type Allocated<T: Config> = StorageMap<_, Blake2_128Concat, T::AccountId, u64, ValueQuery>;

  impl<T: Config> Pallet<T> {
    fn account() -> T::AccountId {
      // Substrate has a pattern of using simply using 8-bytes (as a PalletId) directly as an
      // AccountId. This replicates its internals to remove the 8-byte limit
      T::AccountId::decode(&mut TrailingZeroInput::new(b"staking")).unwrap()
    }

    fn add_stake(account: T::AccountId, amount: u64) {
      Staked::<T>::mutate(account, |staked| *staked += amount);
      Self::deposit_event(Event::Staked { validator: account, amount: Amount(amount) });
    }

    fn remove_stake(account: T::AccountId, amount: u64) -> Result<(), Error<T>> {
      Staked::<T>::mutate(account, |staked| {
        let available = *staked - Self::allocated(account);
        if available < amount {
          Err(Error::<T>::StakeUnavilable)?;
        }
        *staked -= amount;
        Self::deposit_event(Event::Unstaked { validator: account, amount: Amount(amount) });
        Ok::<_, Error<T>>(())
      })
    }

    fn allocate_internal(account: &T::AccountId, amount: u64) -> Result<(), Error<T>> {
      Allocated::<T>::try_mutate(account, |allocated| {
        let available = Self::staked(account) - *allocated;
        if available < amount {
          Err(Error::<T>::StakeUnavilable)?;
        }
        *allocated += amount;
        Ok(())
      })
    }

    fn deallocate_internal(account: &T::AccountId, amount: u64) -> Result<(), Error<T>> {
      Allocated::<T>::try_mutate(account, |allocated| {
        if *allocated < amount {
          Err(Error::<T>::StakeUnavilable)?;
        }
        *allocated -= amount;
        Ok(())
      })
    }
  }

  #[pallet::call]
  impl<T: Config> Pallet<T> {
    /// Stake funds from this account.
    #[pallet::call_index(0)]
    #[pallet::weight((0, DispatchClass::Operational))] // TODO
    pub fn stake(origin: OriginFor<T>, #[pallet::compact] amount: u64) -> DispatchResult {
      let signer = ensure_signed(origin)?;
      let balance = Balance { coin: Coin::Serai, amount: Amount(amount) };
      Coins::<T>::transfer_internal(signer, Self::account(), balance)?;
      Self::add_stake(signer, amount);
      Ok(())
    }

    /// Unstake funds from this account. Only unallocated funds may be unstaked.
    #[pallet::call_index(1)]
    #[pallet::weight((0, DispatchClass::Operational))] // TODO
    pub fn unstake(origin: OriginFor<T>, #[pallet::compact] amount: u64) -> DispatchResult {
      let signer = ensure_signed(origin)?;
      Self::remove_stake(signer, amount)?;
      let balance = Balance { coin: Coin::Serai, amount: Amount(amount) };
      Coins::<T>::transfer_internal(Self::account(), signer, balance)?;
      Ok(())
    }

    /// Allocate `amount` to a given validator set.
    #[pallet::call_index(2)]
    #[pallet::weight((0, DispatchClass::Operational))] // TODO
    pub fn allocate(
      origin: OriginFor<T>,
      network: NetworkId,
      #[pallet::compact] amount: u64,
    ) -> DispatchResult {
      let account = ensure_signed(origin)?;

      // add to amount allocated
      Self::allocate_internal(&account, amount)?;
      // This does not emit an event as the validator-sets pallet will

      // increase allocation for participant in validator set
      VsPallet::<T>::increase_allocation(network, account, Amount(amount))?;
      Ok(())
    }

    /// Deallocate `amount` from a given validator set.
    #[pallet::call_index(3)]
    #[pallet::weight((0, DispatchClass::Operational))] // TODO
    pub fn deallocate(
      origin: OriginFor<T>,
      network: NetworkId,
      #[pallet::compact] amount: u64,
    ) -> DispatchResult {
      let account = ensure_signed(origin)?;

      // decrease allocation in validator set
      let can_immediately_deallocate =
        VsPallet::<T>::decrease_allocation(network, account, Amount(amount))?;
      if can_immediately_deallocate {
        Self::deallocate_internal(&account, amount)?;
        Self::deposit_event(Event::ImmediateDeallocation {
          validator: account,
          network,
          amount: Amount(amount),
        });
      }

      Ok(())
    }

    #[pallet::call_index(4)]
    #[pallet::weight((0, DispatchClass::Operational))] // TODO
    pub fn claim_deallocation(
      origin: OriginFor<T>,
      network: NetworkId,
      session: Session,
    ) -> DispatchResult {
      let account = ensure_signed(origin)?;
      let Some(amount) = VsPallet::<T>::take_deallocatable_amount(network, session, account) else {
        Err(Error::<T>::NoDeallocation)?
      };
      Self::deallocate_internal(&account, amount.0)?;
      Self::deposit_event(Event::DeallocationClaimed {
        validator: account,
        network,
        session,
        amount,
      });
      Ok(())
    }
  }

  // Call order is end_session(i - 1) -> start_session(i) -> new_session(i + 1)
  // new_session(i + 1) is called immediately after start_session(i)
  // then we wait until the session ends then get a call to end_session(i) and so on.
  impl<T: Config> SessionManager<T::ValidatorId> for Pallet<T> {
    fn new_session(_new_index: u32) -> Option<Vec<T::ValidatorId>> {
      VsPallet::<T>::new_session();
      // TODO: Where do we return their stake?
      Some(VsPallet::<T>::select_validators(NetworkId::Serai))
    }

    fn new_session_genesis(_: u32) -> Option<Vec<T::ValidatorId>> {
      // TODO: Because we don't call new_session here, we don't emit NewSet { Serai, session: 1 }
      Some(VsPallet::<T>::select_validators(NetworkId::Serai))
    }

    fn end_session(end_index: u32) {
      VsPallet::<T>::retire_set(ValidatorSet {
        network: NetworkId::Serai,
        session: Session(end_index),
      })
    }

    fn start_session(_start_index: u32) {}
  }
}

pub use pallet::*;