Struct dock_token_migration::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

The module declaration.

pub fn migrate( origin: OriginFor<T>, recipients: BTreeMap<T::AccountId, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance> ) -> DispatchResult

Does a token migration. The migrator should have sufficient balance to give tokens to recipients The check whether it is a valid migrator is made inside the SignedExtension. Migrators are assumed to not be adversarial and not do DoS attacks on the chain. They might act in their benefit and try to send more fee txns then allowed which is guarded against. A bad migrator can flood the network with properly signed but invalid txns like trying to pay more than he has, make the network reject his txn but still spend network resources for free.

pub fn expand_migrator( origin: OriginFor<T>, migrator: T::AccountId, increase_migrations_by: u16 ) -> DispatchResultWithPostInfo

Increase the migrators allowed migrations by the given number

pub fn contract_migrator( origin: OriginFor<T>, migrator: T::AccountId, decrease_migrations_by: u16 ) -> DispatchResultWithPostInfo

Decrease the migrators allowed migrations by the given number

pub fn add_migrator( origin: OriginFor<T>, migrator: T::AccountId, allowed_migrations: u16 ) -> DispatchResultWithPostInfo

Add a new migrator

pub fn remove_migrator( origin: OriginFor<T>, migrator: T::AccountId ) -> DispatchResultWithPostInfo

Remove an existing migrator

pub fn give_bonuses( origin: OriginFor<T>, swap_bonus_recips: Vec<(T::AccountId, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, u32)>, vesting_bonus_recips: Vec<(T::AccountId, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, u32)> ) -> DispatchResult

Give bonuses to recipients. Only callable by migrator. An alternate data structure of both bonus args could be a map from AccountId -> Set<(amount, offset)>

2 storage entries are touched (read and write) per recipient, its account and bonus. Repeated recipients are not counted. Locks don’t contribute to DB weight as once an account data is read from disk, locks are loaded as well Ignoring weight of in-memory operations

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

Claim bonus if any and can be claimed

There is 1 read and write for bonus storage. Ignoring weight of in-memory operations

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

Similar to claim_bonus but done for another account. The bonus does not credit to the sending account’s free balance

There are 2 reads, one for bonus storage, one for account storage. Similarly for writes. Ignoring weight of in-memory operations

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

Claim swap bonus if any and can be claimed

There is 1 read and write for bonus storage. Ignoring weight of in-memory operations

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

Similar to claim_swap_bonus but done for another account. The bonus does not credit to the sending account’s free balance

There are 2 reads, one for bonus storage, one for account storage. Similarly for writes. Ignoring weight of in-memory operations

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

Claim vesting bonus if any and can be claimed

There is 1 read and write for bonus storage. Ignoring weight of in-memory operations

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

Similar to claim_vesting_bonus but done for another account. The bonus does not credit to the sending account’s free balance

There are 2 reads, one for bonus storage, one for account storage. Similarly for writes. Ignoring weight of in-memory operations

impl<T: Config> Pallet<T>

pub fn migrators<KArg>(k: KArg) -> Option<u16>where KArg: EncodeLike<T::AccountId>,

Track accounts registered as migrators

impl<T: Config> Pallet<T>

pub fn bonus<KArg>(k: KArg) -> Option<Bonus<T>>where KArg: EncodeLike<T::AccountId>,

Tracks swap and vesting bonuses that will be given to holders

Trait Implementations

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_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_initialize(_n: BlockNumber) -> Weight

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

fn on_runtime_upgrade() -> Weight

Perform a module 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.

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>