Struct Token

pub struct Token {
    pub id: Uuid,
    pub name: String,
    pub symbol: Option<String>,
    pub maximum_supply: Decimal,
    pub current_supply: Decimal,
    pub initial_supply_percentage: Decimal,
    pub inflation_rate: Option<Decimal>,
    pub burn_rate: Option<Decimal>,
    pub initial_price: Option<Decimal>,
    pub airdrop_percentage: Option<Decimal>,
    pub unlock_schedule: Option<Vec<UnlockEvent>>,
}

Token.

Fields

id: Uuid

ID for the token.

name: String

Name of the token.

symbol: Option<String>

Symbol of the token.

maximum_supply: Decimal

Maximum supply of the token.

current_supply: Decimal

Current supply of the token.

initial_supply_percentage: Decimal

Initial supply of the token, in percentage of maximum supply.

inflation_rate: Option<Decimal>

Annual percentage increase in supply, if supply is inflationary.

burn_rate: Option<Decimal>

Percentage of tokens burned during each transaction, if deflationary.

initial_price: Option<Decimal>

Initial price of the token in simulation

airdrop_percentage: Option<Decimal>

Airdrop amount of the token, in percentage of maximum supply.

unlock_schedule: Option<Vec<UnlockEvent>>

Unlock schedule.

Implementations

impl Token

pub fn airdrop(&mut self, percentage: Decimal) -> Decimal

Perform an airdrop.

Arguments

• percentage - The percentage of the maximum supply to airdrop.

Returns

The amount of tokens airdropped.

pub fn add_unlock_event(&mut self, date: DateTime<Utc>, amount: Decimal)

Add an unlock event to the schedule.

Arguments

• date - The date and time of the unlock event.
• amount - The amount of tokens to unlock.

pub fn process_unlocks(&mut self, current_date: DateTime<Utc>)

Process unlock events up to the current date.

Arguments

• current_date - The current date and time.

pub fn initial_supply(&self) -> Decimal

Calculate the initial supply based on the initial supply percentage.

Returns

Initial supply of the token.

Trait Implementations

impl Clone for Token

fn clone(&self) -> Token

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Token

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

Formats the value using the given formatter.

impl Default for Token

fn default() -> Self

Create a new token with default values.

Returns

New token with default values.

impl<'de> Deserialize<'de> for Token

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Token

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

where __S: Serializer,

Serialize this value into the given Serde serializer.