Struct TreeImpl 

pub struct TreeImpl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap>(/* private fields */);

Trait Implementations

impl<TotalValue, Balance, Funds, InternalError, Error, ExternalId, NodeId, StorageMap> LockableTree for TreeImpl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap>

where Balance: BalanceTrait, Funds: Clone, TotalValue: ValueStorage<Value = Balance>, InternalError: Error, Error: From<InternalError>, ExternalId: Clone, NodeId: Copy, StorageMap: MapStorage<Key = NodeId, Value = GasNode<ExternalId, NodeId, Balance, Funds>>,

fn lock( key: impl Into<Self::NodeId>, id: LockId, amount: Self::Balance, ) -> Result<(), Self::Error>

Locking some value from underlying node balance.

fn unlock( key: impl Into<Self::NodeId>, id: LockId, amount: Self::Balance, ) -> Result<(), Self::Error>

Unlocking some value from node’s locked balance.

fn get_lock( key: impl Into<Self::NodeId>, id: LockId, ) -> Result<Self::Balance, Self::Error>

Get locked value associated with given id.

fn unlock_all( key: impl Into<Self::NodeId>, id: LockId, ) -> Result<Self::Balance, Self::Error>

Unlocking all value from node’s locked balance. Returns the actual amount having been unlocked (wrapped in a Result)

impl<TotalValue, Balance, Funds, InternalError, Error, ExternalId, NodeId, StorageMap> ReservableTree for TreeImpl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap>

where Balance: BalanceTrait, Funds: Clone, TotalValue: ValueStorage<Value = Balance>, InternalError: Error, Error: From<InternalError>, ExternalId: Clone, NodeId: Copy, StorageMap: MapStorage<Key = NodeId, Value = GasNode<ExternalId, NodeId, Balance, Funds>>,

fn reserve( key: impl Into<Self::NodeId>, new_key: impl Into<Self::NodeId>, amount: Self::Balance, ) -> Result<(), Self::Error>

Reserve some value from underlying balance.

fn system_reserve( key: impl Into<Self::NodeId>, amount: Self::Balance, ) -> Result<(), Self::Error>

Reserve some value from underlying balance.

fn system_unreserve( key: impl Into<Self::NodeId>, ) -> Result<Self::Balance, Self::Error>

Unreserve some value from underlying balance.

fn get_system_reserve( key: impl Into<Self::NodeId>, ) -> Result<Self::Balance, Self::Error>

Get system reserve value associated with given id.

impl<TotalValue, Balance, Funds, InternalError, Error, ExternalId, NodeId, StorageMap> Tree for TreeImpl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap>

where Balance: BalanceTrait, Funds: Clone, TotalValue: ValueStorage<Value = Balance>, InternalError: Error, Error: From<InternalError>, ExternalId: Clone, NodeId: Copy, StorageMap: MapStorage<Key = NodeId, Value = GasNode<ExternalId, NodeId, Balance, Funds>>,

fn consume(key: impl Into<Self::NodeId>) -> ConsumeResultOf<Self>

Marks a node with key as consumed, if possible, and tries to return it’s value and delete it. The function performs same procedure with all the nodes on the path from it to the root, if possible.

Marking a node as consumed is possible only for GasNode::External and GasNode::SpecifiedLocal nodes. That is because these nodes can be not deleted after the function call, because of, for instance, having children refs. Such nodes as GasNode::UnspecifiedLocal and GasNode::ReservedLocal are removed when the function is called, so there is no need for marking them as consumed.

When consuming the node, it’s value is mutated by calling catch_value, which tries to either return or move value upstream if possible. Read the catch_value function’s documentation for details.

To delete node, here should be two requirements:

1. Self::consume was called on the node.
2. The node has no children, i.e. spec/unspec refs.

So if it’s impossible to delete a node, then it’s impossible to delete its parent in the current call. Also if it’s possible to delete a node, then it doesn’t necessarily mean that its parent will be deleted. An example here could be the case, when during async execution original message went to wait list, so wasn’t consumed but the one generated during the execution of the original message went to message queue and was successfully executed.

fn spend( key: impl Into<Self::NodeId>, amount: Self::Balance, ) -> Result<Self::NegativeImbalance, Self::Error>

Spends amount of gas from the ancestor of node with key id.

Calling the function is possible even if an ancestor is consumed.

Note:

Node is considered as an ancestor of itself.

type ExternalOrigin = ExternalId

Type representing the external owner of a value (gas) item.

type NodeId = NodeId

Type that identifies a node of the tree.

type Balance = Balance

Type representing a quantity of value.

type Funds = Funds

Type representing a quantity of token balance.

type PositiveImbalance = PositiveImbalance<Balance>

PositiveImbalance indicates that some value has been added to circulation , i.e. total supply has increased.

type NegativeImbalance = NegativeImbalance<Balance>

NegativeImbalance indicates that some value has been removed from circulation, i.e. total supply has decreased.

type InternalError = InternalError

type Error = Error

Error type

fn total_supply() -> Self::Balance

The total amount of value currently in circulation.

fn create( origin: Self::ExternalOrigin, multiplier: GasMultiplier<Self::Funds, Self::Balance>, key: impl Into<Self::NodeId>, amount: Self::Balance, ) -> Result<Self::PositiveImbalance, Self::Error>

Increase the total issuance of the underlying value by creating some amount of it and attributing it to the origin.

fn get_origin_node( key: impl Into<Self::NodeId>, ) -> Result<OriginNodeDataOf<Self>, Self::Error>

The id of node, external origin and funds multiplier for a key.

fn get_limit_node( key: impl Into<Self::NodeId>, ) -> Result<(Self::Balance, Self::NodeId), Self::Error>

Get value associated with given id and the key of an ancestor, that keeps this value.

fn get_limit_node_consumed( key: impl Into<Self::NodeId>, ) -> Result<(Self::Balance, Self::NodeId), Self::Error>

Get value associated with given id and the key of an consumed ancestor, that keeps this value.

fn split_with_value( key: impl Into<Self::NodeId>, new_key: impl Into<Self::NodeId>, amount: Self::Balance, ) -> Result<(), Self::Error>

Split underlying value.

fn split( key: impl Into<Self::NodeId>, new_key: impl Into<Self::NodeId>, ) -> Result<(), Self::Error>

Split underlying value.

fn cut( key: impl Into<Self::NodeId>, new_key: impl Into<Self::NodeId>, amount: Self::Balance, ) -> Result<(), Self::Error>

Cut underlying value to a reserved node.

fn create_deposit( key: impl Into<Self::NodeId>, new_key: impl Into<Self::NodeId>, amount: Self::Balance, ) -> Result<(), Self::Error>

Creates deposit external node to be used as pre-defined gas node.

fn exists(key: impl Into<Self::NodeId>) -> bool

Return bool, defining does node exist.

fn exists_and_deposit(key: impl Into<Self::NodeId>) -> bool

Returns bool, defining does node exist and is external with deposit.

fn clear()

Removes all values.

fn get_external( key: impl Into<Self::NodeId>, ) -> Result<Self::ExternalOrigin, Self::Error>

The external origin for a key.

fn get_funds_multiplier( key: impl Into<Self::NodeId>, ) -> Result<GasMultiplier<Self::Funds, Self::Balance>, Self::Error>

The funds multiplier for a key.

fn get_origin_key( key: impl Into<Self::NodeId>, ) -> Result<Self::NodeId, Self::Error>

The id of external node for a key.

fn get_limit(key: impl Into<Self::NodeId>) -> Result<Self::Balance, Self::Error>

Get value associated with given id.

fn get_limit_consumed( key: impl Into<Self::NodeId>, ) -> Result<Self::Balance, Self::Error>

Get value associated with given id within consumed node.