Struct pallet_bootstrap::pallet::Pallet

pub struct Pallet<T>(_);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Implementations

impl<T: Config> Pallet<T>

pub fn provision( origin: OriginFor<T>, token_id: <<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::CurrencyId, amount: <<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::Balance ) -> DispatchResult

Allows for provisioning one of the tokens from currently bootstrapped pair. Can only be called during:

• BootstrapPhase::Whitelist
• BootstrapPhase::Public

phases.

Args:

• token_id - id of the token to provision (should be one of the currently bootstraped pair(ActivePair))
• amount - amount of the token to provision

pub fn whitelist_accounts( origin: OriginFor<T>, accounts: Vec<T::AccountId> ) -> DispatchResult

Allows for whitelisting accounts, so they can participate in during whitelist phase. The list of account is extended with every subsequent call

pub fn schedule_bootstrap( origin: OriginFor<T>, first_token_id: <<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::CurrencyId, second_token_id: <<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::CurrencyId, ido_start: BlockNumberFor<T>, whitelist_phase_length: Option<u32>, public_phase_length: u32, max_first_to_second_ratio: Option<(<<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::Balance, <<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::Balance)>, promote_bootstrap_pool: bool ) -> DispatchResult

Used for starting/scheduling new bootstrap

Args:

• first_token_id - first token of the tokens pair
• second_token_id: second token of the tokens pair
• ido_start - number of block when bootstrap will be started (people will be allowed to participate)
• whitelist_phase_length: - length of whitelist phase
• public_phase_lenght- length of public phase
• promote_bootstrap_pool- whether liquidity pool created by bootstrap should be promoted
• max_first_to_second_ratio - represented as (numerator,denominator) - Ratio may be used to limit participations of second token id. Ratio between first and second token needs to be held during whole bootstrap. Whenever user tries to participate (using Pallet::provision extrinsic) the following conditions is check.

all previous first participations + first token participations             ratio numerator
----------------------------------------------------------------------- <= ------------------
all previous second token participations + second token participations     ratio denominator

and if it evaluates to false extrinsic will fail.

Because of above equation only participations with first token of a bootstrap pair are limited!

Examples

Consider:

• user willing to participate 1000 of first token, when:
  • ratio set during bootstrap schedule is is set to (1/2)
  • sum of first token participations - 10_000
  • sum of second token participations - 20_000

participation extrinsic will fail because ratio condition is not met

10_000 + 10_000      1
--------------- <=  ---
    20_000           2

• user willing to participate 1000 of first token, when:
  • ratio set during bootstrap schedule is is set to (1/2)
  • sum of first token participations - 10_000
  • sum of second token participations - 40_000

participation extrinsic will succeed because ratio condition is met

10_000 + 10_000      1
--------------- <=  ---
    40_000           2

If one doesn’t want to limit participations in any way, ratio should be set to (u128::MAX,0) - then ratio requirements are always met

all previous first participations + first token participations                u128::MAX
----------------------------------------------------------------------- <= ------------------
all previous second token participations + second token participations            1

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

Used to cancel active bootstrap. Can only be called before bootstrap is actually started

pub fn update_promote_bootstrap_pool( origin: OriginFor<T>, promote_bootstrap_pool: bool ) -> DispatchResult

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

When bootstrap is in BootstrapPhase::Finished state user can claim his part of liquidity tokens.

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

When bootstrap is in BootstrapPhase::Finished state user can claim his part of liquidity tokens comparing to claim_liquidity_tokens when calling claim_and_activate_liquidity_tokens tokens will be automatically activated.

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

Used to reset Bootstrap state of large storages and prepare it for running another bootstrap. It should be called multiple times until it produces Event::BootstrapReadyToBeFinalized event.

!!! Cleaning up storage is complex operation and pruning all storage items related to particular bootstrap might not fit in a single block. As a result tx can be rejected !!!

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

Used to complete resetting Bootstrap state and prepare it for running another bootstrap. It should be called after pre_finalize has produced the Event::BootstrapReadyToBeFinalized event.

pub fn claim_liquidity_tokens_for_account( origin: OriginFor<T>, account: T::AccountId, activate_rewards: bool ) -> DispatchResult

Allows claiming rewards for some account that haven’t done that yet. The only difference between calling Pallet::claim_liquidity_tokens_for_account by some other account and calling Pallet::claim_liquidity_tokens directly by that account is account that will be charged for transaction fee.

Args:

• other - account in behalf of which liquidity tokens should be claimed

impl<T: Config> Pallet<T>

pub fn provisions<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> <<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::Balancewhere KArg1: EncodeLike<T::AccountId>, KArg2: EncodeLike<<<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::CurrencyId>,

An auto-generated getter for Provisions.

impl<T: Config> Pallet<T>

pub fn vested_provisions<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> (<<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::Balance, <<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::Balance, <<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::Balance)where KArg1: EncodeLike<T::AccountId>, KArg2: EncodeLike<<<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::CurrencyId>,

An auto-generated getter for VestedProvisions.

impl<T: Config> Pallet<T>

pub fn whitelisted_accounts<KArg>(k: KArg)where KArg: EncodeLike<T::AccountId>,

An auto-generated getter for WhitelistedAccount.

impl<T: Config> Pallet<T>

pub fn phase() -> BootstrapPhase

An auto-generated getter for Phase.

impl<T: Config> Pallet<T>

pub fn valuations( ) -> (<<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::Balance, <<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::Balance)

An auto-generated getter for Valuations.

impl<T: Config> Pallet<T>

pub fn config( ) -> Option<(BlockNumberFor<T>, u32, u32, (<<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::Balance, <<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::Balance))>

An auto-generated getter for BootstrapSchedule.

impl<T: Config> Pallet<T>

pub fn minted_liquidity( ) -> (<<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::CurrencyId, <<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::Balance)

An auto-generated getter for MintedLiquidity.

impl<T: Config> Pallet<T>

pub fn claimed_rewards<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> <<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::Balancewhere KArg1: EncodeLike<T::AccountId>, KArg2: EncodeLike<<<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::CurrencyId>,

An auto-generated getter for ClaimedRewards.

impl<T: Config> Pallet<T>

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

An auto-generated getter for ProvisionAccounts.

impl<T: Config> Pallet<T>

pub fn pair( ) -> Option<(<<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::CurrencyId, <<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::CurrencyId)>

An auto-generated getter for ActivePair.

impl<T: Config> Pallet<T>

pub fn get_promote_bootstrap_pool() -> bool

An auto-generated getter for PromoteBootstrapPool.

impl<T: Config> Pallet<T>

pub fn archived( ) -> Vec<(BlockNumberFor<T>, u32, u32, (<<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::Balance, <<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::Balance))>

An auto-generated getter for ArchivedBootstrap.

impl<T: Config> Pallet<T>

pub fn do_provision( sender: &T::AccountId, token_id: <<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::CurrencyId, amount: <<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::Balance ) -> DispatchResult

Trait Implementations

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

type RuntimeCall = 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: Config> Contains<(<<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::CurrencyId, <<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::CurrencyId)> for Pallet<T>

fn contains( pair: &(<<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::CurrencyId, <<T as Config>::Currency as MultiTokenCurrency<<T as Config>::AccountId>>::CurrencyId) ) -> bool

Return true if this “contains” the given value t.

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>

type CurrentStorageVersion = StorageVersion

This will be filled out by the pallet macro.

fn current_storage_version() -> Self::CurrentStorageVersion

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>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution.

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

Hook to consume a block’s idle time. This will run when the block is being finalized (before Hooks::on_finalize).

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by FRAME.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main wasm runtime.

fn integrity_test()

Check the integrity of this pallet’s configuration.

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

fn integrity_test()

See Hooks::integrity_test.

impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn offchain_worker(n: BlockNumberFor<T>)

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

impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_finalize(n: BlockNumberFor<T>)

See Hooks::on_finalize.

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See Hooks::on_idle.

impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See Hooks::on_initialize.

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

fn on_runtime_upgrade() -> Weight

See Hooks::on_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: Config> WhitelistedStorageKeys for Pallet<T>

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>