Struct pallet_nis::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 place_bid( origin: OriginFor<T>, amount: <<T as Config>::Currency as FunInspect<<T as Config>::AccountId>>::Balance, duration: u32 ) -> DispatchResult

Place a bid.

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, and if/when consolidated, removed. Must be at least MinBid.
• duration: The number of periods before which the newly consolidated bid may be thawed. 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 FunInspect<<T as Config>::AccountId>>::Balance, duration: u32 ) -> DispatchResult

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 fund_deficit(origin: OriginFor<T>) -> DispatchResult

Ensure we have sufficient funding for all potential payouts.

• origin: Must be accepted by FundOrigin.

pub fn thaw_private( origin: OriginFor<T>, index: ReceiptIndex, maybe_proportion: Option<Perquintill> ) -> DispatchResult

Reduce or remove an outstanding receipt, placing the according proportion of funds into the account of the owner.

• origin: Must be Signed and the account must be the owner of the receipt index as well as any fungible counterpart.
• index: The index of the receipt.
• portion: If Some, then only the given portion of the receipt should be thawed. If None, then all of it should be.

pub fn thaw_communal( origin: OriginFor<T>, index: ReceiptIndex ) -> DispatchResult

Reduce or remove an outstanding receipt, placing the according proportion of funds into the account of the owner.

• origin: Must be Signed and the account must be the owner of the fungible counterpart for receipt index.
• index: The index of the receipt.

pub fn communify(origin: OriginFor<T>, index: ReceiptIndex) -> DispatchResult

Make a private receipt communal and create fungible counterparts for its owner.

pub fn privatize(origin: OriginFor<T>, index: ReceiptIndex) -> DispatchResult

Make a communal receipt private and burn fungible counterparts from its owner.

impl<T: Config> Pallet<T>

pub fn account_id() -> T::AccountId

The account ID of the reserves.

This actually does computation. If you need to keep using it, then make sure you cache the value and only call this once.

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

Returns information on the issuance within the system.

pub fn issuance_with( our_account: &T::AccountId, summary: &SummaryRecord<BlockNumberFor<T>, <<T as Config>::Currency as FunInspect<<T as Config>::AccountId>>::Balance> ) -> IssuanceInfo<<<T as Config>::Currency as FunInspect<<T as Config>::AccountId>>::Balance>

Returns information on the issuance within the system

This function is equivalent to issuance, except that it accepts arguments rather than queries state. If the arguments are already known, then this may be slightly more performant.

• our_account: The value returned by Self::account_id().
• summary: The value returned by Summary::<T>::get().

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 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> 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 = NoStorageVersionSet

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 integrity_test()

Check the integrity of this pallet’s configuration.

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 try_state(_n: BlockNumber) -> Result<(), DispatchError>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<Vec<u8, Global>, DispatchError>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8, Global>) -> Result<(), DispatchError>

Execute some post-checks after a runtime upgrade.

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.

impl<T: Config> Inspect<<T as Config>::AccountId> for Pallet<T>

type ItemId = u32

Type for identifying an item.

fn owner(item: &ReceiptIndex) -> Option<T::AccountId>

Returns the owner of item, or None if the item doesn’t exist or has no owner.

fn attribute(item: &Self::ItemId, key: &[u8]) -> Option<Vec<u8>>

Returns the attribute value of item corresponding to key.

fn typed_attribute<K, V>(item: &Self::ItemId, key: &K) -> Option<V>where K: Encode, V: Decode,

Returns the strongly-typed attribute value of item corresponding to key.

fn can_transfer(_item: &Self::ItemId) -> bool

Returns true if the item may be transferred.

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.

fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>

See Hooks::pre_upgrade.

fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>

See Hooks::post_upgrade.

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>

The expected and default behavior of this method is to handle executing pre_upgrade -> on_runtime_upgrade -> post_upgrade hooks for a migration.

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> Transfer<<T as Config>::AccountId> for Pallet<T>

fn transfer(index: &ReceiptIndex, dest: &T::AccountId) -> DispatchResult

Transfer item into destination account.

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

fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect ) -> Result<(), TryRuntimeError>

Execute the state checks.

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>