Struct pallet_gilt::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn place_bid(
    origin: OriginFor<T>,
    amount: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
    duration: u32
) -> DispatchResultWithPostInfo

Place a bid for a gilt to be issued.

Origin must be Signed, and account must have at least amount in free balance.

• amount: The amount of the bid; these funds will be reserved. If the bid is successfully elevated into an issued gilt, then these funds will continue to be reserved until the gilt expires. Must be at least MinFreeze.
• duration: The number of periods for which the funds will be locked if the gilt is issued. It will expire only after this period has elapsed after the point of issuance. Must be greater than 1 and no more than QueueCount.

Complexities:

• Queues[duration].len() (just take max).

pub fn retract_bid(
    origin: OriginFor<T>,
    amount: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
    duration: u32
) -> DispatchResultWithPostInfo

Retract a previously placed bid.

Origin must be Signed, and the account should have previously issued a still-active bid of amount for duration.

• amount: The amount of the previous bid.
• duration: The duration of the previous bid.

pub fn set_target(
    origin: OriginFor<T>,
    target: Perquintill
) -> DispatchResultWithPostInfo

Set target proportion of gilt-funds.

Origin must be AdminOrigin.

• target: The target proportion of effective issued funds that should be under gilts at any one time.

pub fn thaw(
    origin: OriginFor<T>,
    index: ActiveIndex
) -> DispatchResultWithPostInfo

Remove an active but expired gilt. Reserved funds under gilt are freed and balance is adjusted to ensure that the funds grow or shrink to maintain the equivalent proportion of effective total issued funds.

Origin must be Signed and the account must be the owner of the gilt of the given index.

• index: The index of the gilt to be thawed.

impl<T: Config> Pallet<T>

pub fn target() -> Perquintill

Get the target amount of Gilts that we’re aiming for.

pub fn issuance(
) -> IssuanceInfo<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>

Returns information on the issuance of gilts.

pub fn pursue_target(max_bids: u32) -> Weight

Attempt to enlarge our gilt-set from bids in order to satisfy our desired target amount of funds frozen into gilts.

pub fn enlarge(
    amount: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
    max_bids: u32
) -> (u32, u32)

Freeze additional funds from queue of bids up to amount. Use at most max_bids from the queue.

Return the number of bids taken and the number of distinct queues taken from.

Trait Implementations

impl<T> Benchmarking for Pallet<T>where
    T: Config + Config,

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”.

fn run_benchmark(
    extrinsic: &[u8],
    c: &[(BenchmarkParameter, u32)],
    whitelist: &[TrackedStorageKey],
    verify: bool,
    internal_repeats: u32
) -> Result<Vec<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

impl<T: Config> Callable<T> for Pallet<T>

type Call = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Pallet<T>

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

Formats the value using the given formatter.

impl<T: Config> GetStorageVersion for Pallet<T>

fn current_storage_version() -> StorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config> Hooks<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: T::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn try_state(_n: BlockNumber) -> Result<(), &'static str>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

fn integrity_test()

Run integrity test.

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

Run integrity test.

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq<Pallet<T>> for Pallet<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T> Eq for Pallet<T>