Struct orml_auction::Module

pub struct Module<T: Trait>(_);

Implementations

impl<T: Trait + 'static> Module<T>

pub fn auctions<K: EncodeLike<T::AuctionId>>(
    key: K
) -> Option<AuctionInfo<T::AccountId, T::Balance, T::BlockNumber>>

Stores on-going and future auctions. Closed auction are removed.

pub fn auctions_index() -> T::AuctionId

Track the next auction ID.

pub fn auction_end_time<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Option<()> where
    KArg1: EncodeLike<T::BlockNumber>,
    KArg2: EncodeLike<T::AuctionId>, 

impl<T: Trait> Module<T>

Can also be called using Call.

pub fn bid(
    origin: T::Origin,
    id: T::AuctionId,
    value: T::Balance
) -> DispatchResult

Bid an auction.

The dispatch origin for this call must be Signed by the transactor.

• Preconditions:
  • T::Handler is module_auction_manager of Acala
  • Indirectly needs orml_currencies and module_cdp_treasury of Acala
• Complexity: O(1)
• Db reads:
  • collateral auction: - best cases: 7 - worst cases: 14
  • surplus auction: - best cases: 5 - worst cases: 6
  • debit auction: - best cases: 8 - worst cases: 7
• Db writes:
  • collateral auction: - best cases: 7 - worst cases: 14
  • surplus auction: - best cases: 3 - worst cases: 5
  • debit auction: - best cases: 8 - worst cases: 8

---

Base Weight: - collateral auction: - best cases: 134 µs - worst cases: 300.4 µs - surplus auction: - best cases: 97.9 µs - worst cases: 157.6 µs - debit auction: - best cases: 140.7 µs - worst cases: 142.8 µs

NOTE: Calling this function will bypass origin filters.

Trait Implementations

impl<T: Trait> Auction<<T as Trait>::AccountId, <T as Trait>::BlockNumber> for Module<T>

type AuctionId = T::AuctionId

The id of an AuctionInfo

type Balance = T::Balance

The price to bid.

fn auction_info(
    id: Self::AuctionId
) -> Option<AuctionInfo<T::AccountId, Self::Balance, T::BlockNumber>>

The auction info of id

fn update_auction(
    id: Self::AuctionId,
    info: AuctionInfo<T::AccountId, Self::Balance, T::BlockNumber>
) -> DispatchResult

Update the auction info of id with info

fn new_auction(
    start: T::BlockNumber,
    end: Option<T::BlockNumber>
) -> Result<Self::AuctionId, DispatchError>

Create new auction with specific startblock and endblock, return the id of the auction

fn remove_auction(id: Self::AuctionId)

Remove auction by id

impl<T: Trait> Callable<T> for Module<T>

type Call = Call<T>

impl<T: Clone + Trait> Clone for Module<T>

fn clone(&self) -> Module<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy + Trait> Copy for Module<T>

impl<T: Trait> Debug for Module<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T: Eq + Trait> Eq for Module<T>

impl<T: Trait> IntegrityTest for Module<T>

fn integrity_test()

Run integrity test.

impl<T: Trait> ModuleErrorMetadata for Module<T>

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

impl<T: Trait + Trait> OffchainWorker<<T as Trait>::BlockNumber> for Module<T>

fn offchain_worker(_n: BlockNumber)

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

impl<T: Trait + Trait> OnFinalize<<T as Trait>::BlockNumber> for Module<T>

fn on_finalize(now: T::BlockNumber)

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

impl<T: Trait + Trait> OnInitialize<<T as Trait>::BlockNumber> for Module<T>

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

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

impl<T: Trait> OnRuntimeUpgrade for Module<T>

fn on_runtime_upgrade() -> u64

Perform a module upgrade.

impl<T: PartialEq + Trait> PartialEq<Module<T>> for Module<T>

fn eq(&self, other: &Module<T>) -> bool

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

fn ne(&self, other: &Module<T>) -> bool

This method tests for !=.

impl<T: Trait> StructuralEq for Module<T>

impl<T: Trait> StructuralPartialEq for Module<T>