ore_api/state/

round.rs

use serde::{Deserialize, Serialize};
use steel::*;

use crate::state::{round_pda, OreAccountV4};

use super::OreAccount;

#[repr(C)]
#[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable, Serialize, Deserialize)]
pub struct Round {
    /// The round number.
    pub id: u64,

    /// The amount of SOL deployed in each square.
    pub deployed: [u64; 25],

    /// The hash of the end slot, provided by solana, used for random number generation.
    pub slot_hash: [u8; 32],

    /// The count of miners on each square.
    pub count: [u64; 25],

    /// The slot at which claims for this round account end.
    pub expires_at: u64,

    /// The amount of ORE in the motherlode.
    pub motherlode: u64,

    /// The account to which rent should be returned when this account is closed.
    pub rent_payer: Pubkey,

    /// The top miner of the round.
    pub top_miner: Pubkey,

    /// The amount of ORE to distribute to the top miner.
    pub top_miner_reward: u64,

    /// The total amount of SOL deployed in the round.
    pub total_deployed: u64,

    /// The total number of unique miners that played in the round.
    pub total_miners: u64,

    /// The total amount of SOL put in the ORE vault.
    pub total_vaulted: u64,

    /// The total amount of SOL won by miners for the round.
    pub total_winnings: u64,
}

#[repr(C)]
#[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable, Serialize, Deserialize)]
pub struct RoundV4 {
    /// The round number.
    pub id: u64,

    /// The amount of SOL deployed in each square.
    pub sol: [u64; 25],

    /// The amount of mass deployed in each square.
    pub mass: [u64; 25],

    /// The number of unique miners on each square.
    pub miners: [u64; 25],

    /// The entropy value.
    pub entropy: [u8; 32],

    /// The slot after which this account may be closed.
    pub closes_at: u64,

    /// The amount of ORE distributed as the motherlode reward.
    pub motherlode: u64,

    /// The account to which rent should be returned to when this account is closed.
    pub rent_payer: Pubkey,

    /// The amount of ORE to distribute to miners.
    pub rewards: [u64; 25],

    /// The total SOL collected by the protocol.
    pub protocol_fee: u64,

    /// The total number of unique miners that played in the round.
    pub unique_miners: u64,

    /// The winner of the solo reward.
    pub winner: Pubkey,
}

impl Round {
    pub fn pda(&self) -> (Pubkey, u8) {
        round_pda(self.id)
    }

    pub fn rng(&self) -> Option<u64> {
        if self.slot_hash == [0; 32] || self.slot_hash == [u8::MAX; 32] {
            return None;
        }
        let r1 = u64::from_le_bytes(self.slot_hash[0..8].try_into().unwrap());
        let r2 = u64::from_le_bytes(self.slot_hash[8..16].try_into().unwrap());
        let r3 = u64::from_le_bytes(self.slot_hash[16..24].try_into().unwrap());
        let r4 = u64::from_le_bytes(self.slot_hash[24..32].try_into().unwrap());
        let r = r1 ^ r2 ^ r3 ^ r4;
        Some(r)
    }

    pub fn winning_square(&self, rng: u64) -> usize {
        (rng % 25) as usize
    }

    pub fn top_miner_sample(&self, rng: u64, winning_square: usize) -> u64 {
        if self.deployed[winning_square] == 0 {
            return 0;
        }
        rng.reverse_bits() % self.deployed[winning_square]
    }

    pub fn calculate_total_winnings(&self, winning_square: usize) -> u64 {
        let mut total_winnings = 0;
        for (i, &deployed) in self.deployed.iter().enumerate() {
            if i != winning_square {
                total_winnings += deployed;
            }
        }
        total_winnings
    }

    pub fn is_split_reward(&self, rng: u64) -> bool {
        // One out of four rounds get split rewards.
        let rng = rng.reverse_bits().to_le_bytes();
        let r1 = u16::from_le_bytes(rng[0..2].try_into().unwrap());
        let r2 = u16::from_le_bytes(rng[2..4].try_into().unwrap());
        let r3 = u16::from_le_bytes(rng[4..6].try_into().unwrap());
        let r4 = u16::from_le_bytes(rng[6..8].try_into().unwrap());
        let r = r1 ^ r2 ^ r3 ^ r4;
        r % 2 == 0
    }

    pub fn did_hit_motherlode(&self, rng: u64) -> bool {
        rng.reverse_bits() % 625 == 0
    }
}

impl RoundV4 {
    pub fn pda(&self) -> (Pubkey, u8) {
        round_pda(self.id)
    }

    pub fn rng(&self) -> Option<u64> {
        if self.entropy == [0; 32] || self.entropy == [u8::MAX; 32] {
            return None;
        }
        let r1 = u64::from_le_bytes(self.entropy[0..8].try_into().unwrap());
        let r2 = u64::from_le_bytes(self.entropy[8..16].try_into().unwrap());
        let r3 = u64::from_le_bytes(self.entropy[16..24].try_into().unwrap());
        let r4 = u64::from_le_bytes(self.entropy[24..32].try_into().unwrap());
        let r = r1 ^ r2 ^ r3 ^ r4;
        Some(r)
    }

    pub fn winning_square(&self, rng: u64) -> usize {
        (rng % 25) as usize
    }

    pub fn top_miner_sample(&self, rng: u64, winning_square: usize) -> u64 {
        if self.sol[winning_square] == 0 {
            return 0;
        }
        rng.reverse_bits() % self.sol[winning_square]
    }

    pub fn calculate_total_winnings(&self, winning_square: usize) -> u64 {
        let mut total_winnings = 0;
        for (i, &sol) in self.sol.iter().enumerate() {
            if i != winning_square {
                total_winnings += sol;
            }
        }
        total_winnings
    }

    pub fn is_split_reward(&self, rng: u64) -> bool {
        // One out of four rounds get split rewards.
        let rng = rng.reverse_bits().to_le_bytes();
        let r1 = u16::from_le_bytes(rng[0..2].try_into().unwrap());
        let r2 = u16::from_le_bytes(rng[2..4].try_into().unwrap());
        let r3 = u16::from_le_bytes(rng[4..6].try_into().unwrap());
        let r4 = u16::from_le_bytes(rng[6..8].try_into().unwrap());
        let r = r1 ^ r2 ^ r3 ^ r4;
        r % 2 == 0
    }

    pub fn did_hit_motherlode(&self, rng: u64) -> bool {
        rng.reverse_bits() % 625 == 0
    }
}

account!(OreAccount, Round);
account!(OreAccountV4, RoundV4);

pub enum RoundAccount {
    Round(Round),
    RoundV4(RoundV4),
}

impl RoundAccount {
    pub fn id(&self) -> u64 {
        match self {
            RoundAccount::Round(r) => r.id,
            RoundAccount::RoundV4(r) => r.id,
        }
    }

    pub fn deployed(&self) -> [u64; 25] {
        match self {
            RoundAccount::Round(r) => r.deployed,
            RoundAccount::RoundV4(r) => r.sol,
        }
    }

    pub fn slot_hash(&self) -> [u8; 32] {
        match self {
            RoundAccount::Round(r) => r.slot_hash,
            RoundAccount::RoundV4(r) => r.entropy,
        }
    }

    pub fn count(&self) -> [u64; 25] {
        match self {
            RoundAccount::Round(r) => r.count,
            RoundAccount::RoundV4(r) => r.miners,
        }
    }

    pub fn expires_at(&self) -> u64 {
        match self {
            RoundAccount::Round(r) => r.expires_at,
            RoundAccount::RoundV4(r) => r.closes_at,
        }
    }

    pub fn motherlode(&self) -> u64 {
        match self {
            RoundAccount::Round(r) => r.motherlode,
            RoundAccount::RoundV4(r) => r.motherlode,
        }
    }

    pub fn rent_payer(&self) -> Pubkey {
        match self {
            RoundAccount::Round(r) => r.rent_payer,
            RoundAccount::RoundV4(r) => r.rent_payer,
        }
    }

    pub fn top_miner(&self) -> Pubkey {
        match self {
            RoundAccount::Round(r) => r.top_miner,
            RoundAccount::RoundV4(r) => r.winner,
        }
    }

    pub fn top_miner_reward(&self) -> u64 {
        match self {
            RoundAccount::Round(r) => r.top_miner_reward,
            RoundAccount::RoundV4(_) => 0,
        }
    }

    pub fn total_deployed(&self) -> u64 {
        match self {
            RoundAccount::Round(r) => r.total_deployed,
            RoundAccount::RoundV4(r) => r.sol.iter().sum(),
        }
    }

    pub fn total_miners(&self) -> u64 {
        match self {
            RoundAccount::Round(r) => r.total_miners,
            RoundAccount::RoundV4(r) => r.unique_miners,
        }
    }

    pub fn total_vaulted(&self) -> u64 {
        match self {
            RoundAccount::Round(r) => r.total_vaulted,
            RoundAccount::RoundV4(_) => 0,
        }
    }

    pub fn total_winnings(&self) -> u64 {
        match self {
            RoundAccount::Round(r) => r.total_winnings,
            RoundAccount::RoundV4(_) => 0,
        }
    }

    pub fn pda(&self) -> (Pubkey, u8) {
        match self {
            RoundAccount::Round(r) => r.pda(),
            RoundAccount::RoundV4(r) => r.pda(),
        }
    }

    pub fn rng(&self) -> Option<u64> {
        match self {
            RoundAccount::Round(r) => r.rng(),
            RoundAccount::RoundV4(r) => r.rng(),
        }
    }

    pub fn winning_square(&self, rng: u64) -> usize {
        match self {
            RoundAccount::Round(r) => r.winning_square(rng),
            RoundAccount::RoundV4(r) => r.winning_square(rng),
        }
    }

    pub fn top_miner_sample(&self, rng: u64, winning_square: usize) -> u64 {
        match self {
            RoundAccount::Round(r) => r.top_miner_sample(rng, winning_square),
            RoundAccount::RoundV4(r) => r.top_miner_sample(rng, winning_square),
        }
    }

    pub fn calculate_total_winnings(&self, winning_square: usize) -> u64 {
        match self {
            RoundAccount::Round(r) => r.calculate_total_winnings(winning_square),
            RoundAccount::RoundV4(r) => r.calculate_total_winnings(winning_square),
        }
    }

    pub fn is_split_reward(&self, rng: u64) -> bool {
        match self {
            RoundAccount::Round(r) => r.is_split_reward(rng),
            RoundAccount::RoundV4(r) => r.is_split_reward(rng),
        }
    }

    pub fn did_hit_motherlode(&self, rng: u64) -> bool {
        match self {
            RoundAccount::Round(r) => r.did_hit_motherlode(rng),
            RoundAccount::RoundV4(r) => r.did_hit_motherlode(rng),
        }
    }
}