Referral

Struct Referral 

Source
#[repr(C)]
pub struct Referral { pub authority: Pubkey, pub total_referred: u64, pub total_sol_earned: u64, pub total_oil_earned: u64, pub pending_sol: u64, pub pending_oil: u64, }
Expand description

Referral account tracks a referrer’s stats and pending rewards.

Anyone can create a Referral account to become a referrer. When a new miner signs up with their referral link, 0.5% of that miner’s claimed rewards from each mode (block-based and auction-based) are credited to the referrer’s pending balance, totaling 1% across both modes.

Fields§

§authority: Pubkey

The authority (wallet) of this referrer.

§total_referred: u64

Total number of miners referred by this referrer.

§total_sol_earned: u64

Total SOL earned from referrals (lifetime, for stats).

§total_oil_earned: u64

Total OIL earned from referrals (lifetime, for stats).

§pending_sol: u64

Pending SOL rewards to claim.

§pending_oil: u64

Pending OIL rewards to claim.

Implementations§

Source§

impl Referral

Source

pub fn claim_sol(&mut self) -> u64

Claims pending SOL rewards. Returns the amount of SOL that can be claimed and resets pending_sol to 0.

Source

pub fn claim_oil(&mut self) -> u64

Claims pending OIL rewards. Returns the amount of OIL that can be claimed and resets pending_oil to 0.

Source

pub fn credit_sol_referral(&mut self, total_amount: u64) -> u64

Calculates and credits SOL referral bonus (0.5% of total amount). Returns the referral amount that should be transferred to this referral account.

This function handles:

  • Calculating 0.5% referral bonus
  • Crediting pending_sol
  • Updating total_sol_earned
Source

pub fn credit_oil_referral(&mut self, total_amount: u64) -> u64

Calculates and credits OIL referral bonus (0.5% of total amount). Returns the referral amount that should be transferred to this referral account.

This function handles:

  • Calculating 0.5% referral bonus
  • Crediting pending_oil
  • Updating total_oil_earned
Source

pub fn process_new_miner_referral<'a>( referral_info_opt: Option<&AccountInfo<'a>>, referrer: Pubkey, authority: Pubkey, ) -> Result<(), ProgramError>

Validates and increments referral count for a new miner.

This function:

  • Validates the referrer is not default and not self-referral
  • Validates the referral account exists and matches the referrer
  • Increments the referral’s total_referred count

Returns Ok(()) if referral was processed, or Err if validation fails. If referrer is invalid (default or self), returns Ok(()) without processing.

Source§

impl Referral

Source

pub fn to_bytes(&self) -> &[u8]

Trait Implementations§

Source§

impl AccountValidation for Referral

Source§

fn assert<F>(&self, condition: F) -> Result<&Self, ProgramError>
where F: Fn(&Self) -> bool,

Source§

fn assert_err<F>( &self, condition: F, err: ProgramError, ) -> Result<&Self, ProgramError>
where F: Fn(&Self) -> bool,

Source§

fn assert_msg<F>(&self, condition: F, msg: &str) -> Result<&Self, ProgramError>
where F: Fn(&Self) -> bool,

Source§

fn assert_mut<F>(&mut self, condition: F) -> Result<&mut Self, ProgramError>
where F: Fn(&Self) -> bool,

Source§

fn assert_mut_err<F>( &mut self, condition: F, err: ProgramError, ) -> Result<&mut Self, ProgramError>
where F: Fn(&Self) -> bool,

Source§

fn assert_mut_msg<F>( &mut self, condition: F, msg: &str, ) -> Result<&mut Self, ProgramError>
where F: Fn(&Self) -> bool,

Source§

impl Clone for Referral

Source§

fn clone(&self) -> Referral

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Referral

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Referral

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Discriminator for Referral

Source§

impl PartialEq for Referral

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Referral

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Zeroable for Referral

Source§

fn zeroed() -> Self

Source§

impl Copy for Referral

Source§

impl Pod for Referral

Source§

impl StructuralPartialEq for Referral

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> AccountDeserialize for T
where T: Discriminator + Pod,

Source§

impl<T> AccountHeaderDeserialize for T
where T: Discriminator + Pod,

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<T> CheckedBitPattern for T
where T: AnyBitPattern,

Source§

type Bits = T

Self must have the same layout as the specified Bits except for the possible invalid bit patterns being checked during is_valid_bit_pattern.
Source§

fn is_valid_bit_pattern(_bits: &T) -> bool

If this function returns true, then it must be valid to reinterpret bits as &Self.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

Source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
Source§

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

Source§

fn lossy_into(self) -> Dst

Performs the conversion.
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> AnyBitPattern for T
where T: Pod,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> NoUninit for T
where T: Pod,