Struct pallet_vesting::pallet::Pallet[−][src]

pub struct Pallet<T>(_);

Expand description

The pallet implementing the on-chain logic.

Implementations

[src]

impl<T: Config> Pallet<T>

[src]

pub fn vest(origin: OriginFor<T>) -> DispatchResult

Unlock any vested funds of the sender account.

The dispatch origin for this call must be Signed and the sender must have funds still locked under this pallet.

Emits either VestingCompleted or VestingUpdated.

O(1).
DbWeight: 2 Reads, 2 Writes
- Reads: Vesting Storage, Balances Locks, [Sender Account]
- Writes: Vesting Storage, Balances Locks, [Sender Account]

[src]

pub fn vest_other(
    origin: OriginFor<T>, 
    target: <T::Lookup as StaticLookup>::Source
) -> DispatchResult

Unlock any vested funds of a target account.

The dispatch origin for this call must be Signed.

target: The account whose vested funds should be unlocked. Must have funds still locked under this pallet.

Emits either VestingCompleted or VestingUpdated.

O(1).
DbWeight: 3 Reads, 3 Writes
- Reads: Vesting Storage, Balances Locks, Target Account
- Writes: Vesting Storage, Balances Locks, Target Account

[src]

pub fn vested_transfer(
    origin: OriginFor<T>, 
    target: <T::Lookup as StaticLookup>::Source, 
    schedule: VestingInfo<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, T::BlockNumber>
) -> DispatchResult

Create a vested transfer.

The dispatch origin for this call must be Signed.

target: The account that should be transferred the vested funds.
amount: The amount of funds to transfer and will be vested.
schedule: The vesting schedule attached to the transfer.

Emits VestingCreated.

O(1).
DbWeight: 3 Reads, 3 Writes
- Reads: Vesting Storage, Balances Locks, Target Account, [Sender Account]
- Writes: Vesting Storage, Balances Locks, Target Account, [Sender Account]

[src]

pub fn force_vested_transfer(
    origin: OriginFor<T>, 
    source: <T::Lookup as StaticLookup>::Source, 
    target: <T::Lookup as StaticLookup>::Source, 
    schedule: VestingInfo<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, T::BlockNumber>
) -> DispatchResult

Force a vested transfer.

The dispatch origin for this call must be Root.

source: The account whose funds should be transferred.
target: The account that should be transferred the vested funds.
amount: The amount of funds to transfer and will be vested.
schedule: The vesting schedule attached to the transfer.

Emits VestingCreated.

O(1).
DbWeight: 4 Reads, 4 Writes
- Reads: Vesting Storage, Balances Locks, Target Account, Source Account
- Writes: Vesting Storage, Balances Locks, Target Account, Source Account

[src]

impl<T: Config> Pallet<T>

[src]

pub fn vesting<KArg>(
    k: KArg
) -> Option<VestingInfo<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, T::BlockNumber>> where
    KArg: EncodeLike<T::AccountId>,

Information regarding the vesting of a given account.

Trait Implementations

[src]

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

[src]

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”. Read more

[src]

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

Run the benchmarks for this pallet.

[src]

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

type Call = Call<T>

[src]

impl<T> Clone for Pallet<T>

[src]

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

[src]

impl<T> Debug for Pallet<T>

[src]

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

Formats the value using the given formatter. Read more

[src]

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

[src]

fn current_storage_version() -> StorageVersion

Returns the current storage version as supported by the pallet.

[src]

fn on_chain_storage_version() -> StorageVersion

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

[src]

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

[src]

fn on_finalize(_n: BlockNumber)

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

[src]

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

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. Read more

[src]

fn on_initialize(_n: BlockNumber) -> u64

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

[src]

fn on_runtime_upgrade() -> u64

Perform a module upgrade. Read more

[src]

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

Execute some pre-checks prior to a runtime upgrade. Read more

[src]

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

Execute some post-checks after a runtime upgrade. Read more

[src]

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. Read more

[src]

fn integrity_test()

Run integrity test. Read more

[src]

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

[src]

fn integrity_test()

Run integrity test. Read more

[src]

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

[src]

fn metadata() -> &'static [ErrorMetadata]

[src]

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

[src]

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

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

[src]

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

[src]

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

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

[src]

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

[src]

fn on_genesis()

Something that should happen at genesis.

[src]

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

[src]

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. Read more

[src]

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

[src]

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

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

[src]

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

[src]

fn on_runtime_upgrade() -> Weight

Perform a module upgrade. Read more

[src]

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

Execute some pre-checks prior to a runtime upgrade. Read more

[src]

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

Execute some post-checks after a runtime upgrade. Read more

[src]

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

[src]

fn index() -> usize

Index of the pallet as configured in the runtime.

[src]

fn name() -> &'static str

Name of the pallet as configured in the runtime.

[src]

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

[src]

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

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

1.0.0[src]

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

This method tests for !=.

[src]

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

[src]

fn storage_info() -> Vec<StorageInfo>

[src]

impl<T: Config> VestingSchedule<<T as Config>::AccountId> for Pallet<T> where
    <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance: MaybeSerializeDeserialize + Debug,

[src]

fn vesting_balance(
    who: &T::AccountId
) -> Option<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance>

Get the amount that is currently being vested and cannot be transferred out of this account.

[src]

fn add_vesting_schedule(
    who: &T::AccountId, 
    locked: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, 
    per_block: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, 
    starting_block: T::BlockNumber
) -> DispatchResult

Adds a vesting schedule to a given account.

If there already exists a vesting schedule for the given account, an Err is returned and nothing is updated.

On success, a linearly reducing amount of funds will be locked. In order to realise any reduction of the lock over time as it diminishes, the account owner must use vest or vest_other.

Is a no-op if the amount to be vested is zero.

[src]

fn remove_vesting_schedule(who: &T::AccountId)

Remove a vesting schedule for a given account.

type Moment = T::BlockNumber

The quantity used to denote time; usually just a BlockNumber.

type Currency = T::Currency

The currency that this schedule applies to.

[src]

impl<T> Eq for Pallet<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for Pallet<T> where
    T: RefUnwindSafe,

impl<T> Send for Pallet<T> where
    T: Send,

impl<T> Sync for Pallet<T> where
    T: Sync,

impl<T> Unpin for Pallet<T> where
    T: Unpin,

impl<T> UnwindSafe for Pallet<T> where
    T: UnwindSafe,

Blanket Implementations

[src]

impl<T> Any for T where
    T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
    T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

impl<T> CheckedConversion for T

[src]

fn checked_from<T>(t: T) -> Option<Self> where
    Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more

[src]

fn checked_into<T>(self) -> Option<T> where
    Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more

impl<T> Downcast for T where
    T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

pub fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
    T: Any + Send + Sync,

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

[src]

impl<T> DynClone for T where
    T: Clone,

[src]

pub fn __clone_box(&self, Private) -> *mut ()

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T> Instrument for T

[src]

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

[src]

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

[src]

impl<T, U> Into<U> for T where
    U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T> IsType<T> for T

[src]

pub fn from_ref(t: &T) -> &T

Cast reference.

[src]

pub fn into_ref(&self) -> &T

Cast reference.

[src]

pub fn from_mut(t: &mut T) -> &mut T

Cast mutable reference.

[src]

pub fn into_mut(&mut self) -> &mut T

Cast mutable reference.

[src]

impl<T, Outer> IsWrappedBy<Outer> for T where
    T: From<Outer>,
    Outer: AsRef<T> + AsMut<T> + From<T>,

[src]

pub fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

[src]

pub fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

[src]

impl<U> OnRuntimeUpgradeHelpersExt for U where
    U: OnRuntimeUpgrade,

[src]

fn storage_key(ident: &str) -> [u8; 32]

Generate a storage key unique to this runtime upgrade. Read more

[src]

fn get_temp_storage<T>(at: &str) -> Option<T> where
    T: Decode,

Get temporary storage data written by Self::set_temp_storage. Read more

[src]

fn set_temp_storage<T>(data: T, at: &str) where
    T: Encode,

Write some temporary data to a specific storage that can be read (potentially in post-upgrade hook) via Self::get_temp_storage. Read more

[src]

impl<T> PalletVersionToStorageVersionHelper for T where
    T: GetStorageVersion + PalletInfoAccess,

[src]

pub fn migrate(db_weight: &RuntimeDbWeight) -> u64

impl<T> Same<T> for T

type Output = T

Should always be Self

[src]

impl<T> SaturatedConversion for T

[src]

fn saturated_from<T>(t: T) -> Self where
    Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more

[src]

fn saturated_into<T>(self) -> T where
    Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>,

pub fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

pub fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

pub fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

pub fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

[src]

impl<T> ToOwned for T where
    T: Clone,

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

[src]

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

[src]

impl<S, T> UncheckedInto<T> for S where
    T: UncheckedFrom<S>,

[src]

pub fn unchecked_into(self) -> T

The counterpart to unchecked_from.

[src]

impl<T, S> UniqueSaturatedInto<T> for S where
    T: Bounded,
    S: TryInto<T>,

[src]

pub fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> MaybeDebug for T where
    T: Debug,

impl<T> MaybeDebug for T where
    T: Debug,

[src]

impl<T> MaybeRefUnwindSafe for T where
    T: RefUnwindSafe,

[src]

impl<T> Member for T where
    T: 'static + Send + Sync + Debug + Eq + PartialEq<T> + Clone,