Struct UserBalance 

pub struct UserBalance {
    pub total: NearToken,
    pub storage_locked: NearToken,
    pub storage_usage: u64,
    pub locked: NearToken,
}

Account balance on the NEAR blockchain.

This balance doesn’t include staked NEAR tokens or storage

Fields

total: NearToken

The total amount of NEAR tokens in the account.

Please note that this is the total amount of NEAR tokens in the account, not the amount available for use.

storage_locked: NearToken

The amount of NEAR tokens locked in the account for storage usage.

The storage lock equal to Self::storage_usage * STORAGE_COST_PER_BYTE

storage_usage: u64

The storage usage by the account in bytes.

locked: NearToken

The amount of NEAR tokens staked on a protocol level. Applicable for staking pools only in 99.99% of the cases.

The PoS allows particular users to stake funds to become a validator, but the protocol itself doesn’t allow other users to delegate tokens to the validator. This is why, the NEP-27 defines a Staking Pool smart contract that allows other users to delegate tokens to the validator.

Even though, the user can stake and become validator itself, it’s highly unlikely and this field will be 0 for almost all the users, and not 0 for StakingPool contracts.

Please note that this is not related to your delegations into the staking pools. To get your delegation information in the staking pools, use [near-api::Delegation]

Trait Implementations

impl Clone for UserBalance

fn clone(&self) -> UserBalance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserBalance

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

Formats the value using the given formatter.

impl Default for UserBalance

fn default() -> UserBalance

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UserBalance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UserBalance

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for UserBalance

impl StructuralPartialEq for UserBalance