Struct Bid

pub struct Bid { /* private fields */ }

An entry in the validator map.

Implementations

impl Bid

pub fn from_non_unified( validator_bid: ValidatorBid, delegators: BTreeMap<DelegatorKind, DelegatorBid>, ) -> Self

pub fn locked( validator_public_key: PublicKey, bonding_purse: URef, staked_amount: U512, delegation_rate: DelegationRate, release_timestamp_millis: u64, ) -> Self

Creates new instance of a bid with locked funds.

pub fn unlocked( validator_public_key: PublicKey, bonding_purse: URef, staked_amount: U512, delegation_rate: DelegationRate, ) -> Self

Creates new instance of a bid with unlocked funds.

pub fn empty(validator_public_key: PublicKey, bonding_purse: URef) -> Self

Creates a new inactive instance of a bid with 0 staked amount.

pub fn validator_public_key(&self) -> &PublicKey

Gets the validator public key of the provided bid

pub fn bonding_purse(&self) -> &URef

Gets the bonding purse of the provided bid

pub fn is_locked(&self, timestamp_millis: u64) -> bool

Checks if a bid is still locked under a vesting schedule.

Returns true if a timestamp falls below the initial lockup period + 91 days release schedule, otherwise false.

pub fn is_locked_with_vesting_schedule( &self, timestamp_millis: u64, vesting_schedule_period_millis: u64, ) -> bool

Checks if a bid is still locked under a vesting schedule.

Returns true if a timestamp falls below the initial lockup period + 91 days release schedule, otherwise false.

pub fn staked_amount(&self) -> &U512

Gets the staked amount of the provided bid

pub fn staked_amount_mut(&mut self) -> &mut U512

Gets the staked amount of the provided bid

pub fn delegation_rate(&self) -> &DelegationRate

Gets the delegation rate of the provided bid

pub fn vesting_schedule(&self) -> Option<&VestingSchedule>

Returns a reference to the vesting schedule of the provided bid. None if a non-genesis validator.

pub fn vesting_schedule_mut(&mut self) -> Option<&mut VestingSchedule>

Returns a mutable reference to the vesting schedule of the provided bid. None if a non-genesis validator.

pub fn delegators(&self) -> &BTreeMap<PublicKey, Delegator>

Returns a reference to the delegators of the provided bid

pub fn delegators_mut(&mut self) -> &mut BTreeMap<PublicKey, Delegator>

Returns a mutable reference to the delegators of the provided bid

pub fn inactive(&self) -> bool

Returns true if validator is inactive

pub fn decrease_stake( &mut self, amount: U512, era_end_timestamp_millis: u64, ) -> Result<U512, Error>

Decreases the stake of the provided bid

pub fn increase_stake(&mut self, amount: U512) -> Result<U512, Error>

Increases the stake of the provided bid

pub fn with_delegation_rate( &mut self, delegation_rate: DelegationRate, ) -> &mut Self

Updates the delegation rate of the provided bid

pub fn process(&mut self, timestamp_millis: u64) -> bool

Initializes the vesting schedule of provided bid if the provided timestamp is greater than or equal to the bid’s initial release timestamp and the bid is owned by a genesis validator. This method initializes with default 14 week vesting schedule.

Returns true if the provided bid’s vesting schedule was initialized.

pub fn process_with_vesting_schedule( &mut self, timestamp_millis: u64, vesting_schedule_period_millis: u64, ) -> bool

Initializes the vesting schedule of provided bid if the provided timestamp is greater than or equal to the bid’s initial release timestamp and the bid is owned by a genesis validator.

Returns true if the provided bid’s vesting schedule was initialized.

pub fn activate(&mut self) -> bool

Sets given bid’s inactive field to false

pub fn deactivate(&mut self) -> bool

Sets given bid’s inactive field to true

pub fn total_staked_amount(&self) -> Result<U512, Error>

Returns the total staked amount of validator + all delegators

Trait Implementations

impl CLTyped for Bid

fn cl_type() -> CLType

The CLType of Self.

impl Clone for Bid

fn clone(&self) -> Bid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DataSize for Bid

const IS_DYNAMIC: bool = true

If true, the type has a heap size that can vary at runtime, depending on the actual value.

const STATIC_HEAP_SIZE: usize = 0usize

The amount of space a value of the type always occupies. If IS_DYNAMIC is false, this is the total amount of heap memory occupied by the value. Otherwise this is a lower bound.

fn estimate_heap_size(&self) -> usize

Estimates the size of heap memory taken up by this value.

impl Debug for Bid

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Bid

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Bid

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

Formats the value using the given formatter.

impl From<&Bid> for SeigniorageRecipientV1

fn from(bid: &Bid) -> Self

Converts to this type from the input type.

impl From<&Bid> for SeigniorageRecipientV2

fn from(bid: &Bid) -> Self

Converts to this type from the input type.

impl From<Bid> for StoredValue

fn from(bid: Bid) -> StoredValue

Converts to this type from the input type.

impl From<Bid> for ValidatorBid

fn from(bid: Bid) -> Self

Converts to this type from the input type.

impl FromBytes for Bid

fn from_bytes(bytes: &[u8]) -> Result<(Self, &[u8]), Error>

Deserializes the slice into Self.

fn from_vec(bytes: Vec<u8>) -> Result<(Self, Vec<u8>), Error>

Deserializes the Vec<u8> into Self.

impl JsonSchema for Bid

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for Bid

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Bid

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToBytes for Bid

fn to_bytes(&self) -> Result<Vec<u8>, Error>

Serializes &self to a Vec<u8>.

fn serialized_length(&self) -> usize

Returns the length of the Vec<u8> which would be returned from a successful call to to_bytes() or into_bytes(). The data is not actually serialized, so this call is relatively cheap.

fn write_bytes(&self, writer: &mut Vec<u8>) -> Result<(), Error>

Writes &self into a mutable writer.

fn into_bytes(self) -> Result<Vec<u8>, Error>

where Self: Sized,

Consumes self and serializes to a Vec<u8>.

impl TryFrom<StoredValue> for Bid

type Error = TypeMismatch

The type returned in the event of a conversion error.

fn try_from(value: StoredValue) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Bid

impl StructuralPartialEq for Bid