sigil-economics · staking

pub const MIN_BP_STAKE: u64;

pub const MIN_BV_STAKE: u64;

pub const UNBONDING_EPOCHS: u64;

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct StakeRecord {
/// OAS DID of the validator.

pub validator_did: String,
/// OAS DID of the human root that spawned this validator.

pub human_root_did: String,
/// Lineage generation (0 = human root itself, 1 = direct child, ...).

pub generation: u32,
/// micro-MINT staked by the validator itself.

pub self_stake: u64,
/// micro-MINT delegated to this validator by others.

pub delegated_stake: u64,
/// Whether this validator produces blocks or only validates them.

pub mode: ValidatorMode,
/// Current lifecycle status.

pub status: StakeStatus,
/// Epoch at which unbonding completes (set when unbonding begins).

pub unbonding_epoch: Option<u64>
}

pub fn total_stake(&self) -> u64;

pub fn meets_minimum(&self) -> bool;

pub fn can_unstake(&self) -> bool;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum StakeStatus {
    /// Validator is active and participating in consensus.
    Active,
    /// Validator has initiated unstake; waiting for unbonding period.
    Unbonding,
    /// Unbonding complete; funds are free.
    Unbonded,
    /// Validator is jailed (e.g., for double-signing).
    Jailed,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Delegation {
/// OAS DID of the delegator.

pub delegator_did: String,
/// OAS DID of the validator receiving delegation.

pub validator_did: String,
/// micro-MINT delegated.

pub amount: u64,
/// Epoch at which this delegation started.

pub start_epoch: u64,
/// If set, the delegator is withdrawing some portion.

pub pending_undelegation: Option<PendingUndelegation>
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct PendingUndelegation {
/// micro-MINT being undelegated.

pub amount: u64,
/// Epoch when undelegation completes.

pub completion_epoch: u64
}

pub fn min_stake_for_mode(mode: &ValidatorMode) -> u64;

pub fn apply_stake_deposit(record: &mut StakeRecord, amount: u64) -> Result<(), EconomicsError>;

pub fn apply_unstake(
    record: &mut StakeRecord,
    amount: u64,
    current_epoch: u64,
) -> Result<(), EconomicsError>;

pub fn apply_delegation(delegation: &mut Delegation, amount: u64) -> Result<(), EconomicsError>;

pub fn apply_undelegation(
    delegation: &mut Delegation,
    amount: u64,
    current_epoch: u64,
) -> Result<(), EconomicsError>;

pub fn complete_unbonding(record: &mut StakeRecord, current_epoch: u64) -> Option<u64>;