Struct Allocation 

pub struct Allocation {
    pub params: AllocationParams,
    pub status: AllocationStatus,
    pub user: Addr,
    pub block_ts: u64,
}

Fields

params: AllocationParams

The allocation parameters

status: AllocationStatus

The allocation status

user: Addr

Allocation owner

block_ts: u64

Current block timestamp

Implementations

impl Allocation

pub fn must_load( storage: &dyn Storage, block_ts: u64, user: &Addr, ) -> Result<Self, ContractError>

pub fn save(self, storage: &mut dyn Storage) -> StdResult<()>

pub fn new_allocation( storage: &mut dyn Storage, block_ts: u64, user: &Addr, params: CreateAllocationParams, ) -> Result<Self, ContractError>

pub fn withdraw_and_update(&mut self) -> Result<Uint128, ContractError>

pub fn propose_new_receiver( &mut self, storage: &dyn Storage, new_receiver: &Addr, ) -> Result<(), ContractError>

pub fn drop_proposed_receiver(&mut self) -> Result<Addr, ContractError>

pub fn claim_allocation( self, storage: &mut dyn Storage, new_receiver: &Addr, ) -> Result<Self, ContractError>

Produces new allocation object for new receiver. Old allocation is removed from state.

pub fn compute_unlocked_amount(&self, timestamp: u64) -> Uint128

Computes number of tokens that are now unlocked for a given allocation

pub fn compute_withdraw_amount( &self, timestamp: u64, ) -> SimulateWithdrawResponse

Computes number of tokens that are withdrawable for a given allocation

pub fn decrease_allocation( &mut self, amount: Uint128, ) -> Result<(), ContractError>

pub fn increase_allocation( &mut self, amount: Uint128, ) -> Result<(), ContractError>

pub fn update_unlock_schedule( &mut self, new_schedule: &Schedule, ) -> StdResult<()>

Trait Implementations

impl Clone for Allocation

fn clone(&self) -> Allocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Allocation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Allocation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Allocation

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 Allocation

fn eq(&self, other: &Allocation) -> 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 Allocation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Allocation