Crate pallet_capacity

Capacity Pallet

The Capacity pallet provides functionality for staking tokens to the Frequency network.

• Configuration: Config
• Extrinsics: Call
• Event Enum: Event
• Error Enum: Error

Overview

Capacity is a refillable resource that can be used to make transactions on the network. Tokens may be staked to the network targeting a provider MSA account to which the network will grant Capacity.

The network generates Capacity based on a Capacity-generating function that considers usage and network congestion. When token is staked, the targeted provider MSA receives the Capacity generated.

This Capacity can be used to pay for transactions given that the key used to pay for those transactions have a minimum balance of the existential deposit.

The staked amount may be increased, targeting either the same or a different target to receive the newly generated Capacity. As a result, every time the network is staked to, the staked tokens are locked until unstaked.

Unstaking schedules some amount of token to be unlocked. Any amount up to the total staked amount may be unstaked, however, there is a a limit on how many concurrently scheduled unstaking requests can exist. After scheduling tokens to be unlocked, they must undergo a thaw period before being withdrawn.

After thawing, the tokens may be withdrawn using the withdraw_unstaked extrinsic. On success, the tokens are unlocked and free up space to submit more unstaking request.

The Capacity pallet provides functions for:

• staking and, updating,

Terminology

• Capacity: A refillable and non-transferable resource that can be used to pay for transactions on the network.
• Staker: An account that stakes tokens to the Frequency network in exchange for Capacity.
• Target A provider MSA account that receives Capacity.
• Epoch Period: The length of an epoch in blocks, used for replenishment and thawing.
• Replenishable: The ability of a provider MSA account to be refilled with Capacity after an epoch period.

Re-exports

• pub use pallet::*;
• pub use types::*;
• pub use weights::*;

Modules

• migration
  storage migrations
• pallet
  The pallet module in each FRAME pallet hosts the most important items needed to construct this pallet.
• types
  Types for the Capacity Pallet
• weights
  Autogenerated weights for pallet_capacity

Traits

• Nontransferable
  A trait for Non-transferable asset.
• Replenishable
  A trait for replenishing Capacity.
• TargetValidator
  A trait for checking that a target MSA can be staked to.

Functions

• wrap_binary_data
  Wraps PREFIX and POSTFIX around a Vec<u8> Returns PREFIX ++ data ++ POSTFIX

Type Aliases

• MessageSourceId
  Message Source Id or msaId is the unique identifier for Message Source Accounts