--- a/pallets/inflation/src/lib.rs +++ b/pallets/inflation/src/lib.rs @@ -14,6 +14,20 @@ // You should have received a copy of the GNU General Public License // along with Unique Network. If not, see . +//! # Inflation +//! +//! The inflation pallet is designed to increase the number of tokens at certain intervals. +//! With each iteration, increases the `total_issuance` value for the native token. +//! Executing an `on_initialize` hook at the beginning of each block, causing inflation to begin. +//! +//! ## Interface +//! +//! ### Dispatchable Functions +//! +//! * `start_inflation` - This method sets the inflation start date. Can be only called once. +//! Inflation start block can be backdated and will catch up. The method will create Treasury +//! account if it does not exist and perform the first inflation deposit. + // #![recursion_limit = "1024"] #![cfg_attr(not(feature = "std"), no_std)]