Type Alias Nis

pub type Nis = Pallet<Runtime>;

Aliased Type

struct Nis(/* private fields */);

Implementations

impl<T> Pallet<T>

where T: Config,

pub fn place_bid( origin: <T as Config>::RuntimeOrigin, amount: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance, duration: u32, ) -> Result<(), DispatchError>

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: <T as Config>::RuntimeOrigin, amount: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance, duration: u32, ) -> Result<(), DispatchError>

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: <T as Config>::RuntimeOrigin, ) -> Result<(), DispatchError>

Ensure we have sufficient funding for all potential payouts.

• origin: Must be accepted by FundOrigin.

pub fn thaw_private( origin: <T as Config>::RuntimeOrigin, index: u32, maybe_proportion: Option<Perquintill>, ) -> Result<(), DispatchError>

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: <T as Config>::RuntimeOrigin, index: u32, ) -> Result<(), DispatchError>

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: <T as Config>::RuntimeOrigin, index: u32, ) -> Result<(), DispatchError>

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

pub fn privatize( origin: <T as Config>::RuntimeOrigin, index: u32, ) -> Result<(), DispatchError>

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

impl<T> Pallet<T>

where T: Config,

pub fn account_id() -> <T as Config>::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 Inspect<<T as Config>::AccountId>>::Balance>

Returns information on the issuance within the system.

pub fn issuance_with( our_account: &<T as Config>::AccountId, summary: &SummaryRecord<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance>, ) -> IssuanceInfo<<<T as Config>::Currency as Inspect<<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> BeforeAllRuntimeMigrations for Pallet<T>

where T: Config,

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

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> Callable<T> for Pallet<T>

where T: Config,

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

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

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<(), Error>

Formats the value using the given formatter.

impl<T> DispatchViewFunction for Pallet<T>

where T: Config,

fn dispatch_view_function<O>( id: &ViewFunctionId, input: &mut &[u8], output: &mut O, ) -> Result<(), ViewFunctionDispatchError>

where O: Output,

impl<T> GetStorageVersion for Pallet<T>

where T: Config,

type InCodeStorageVersion = NoStorageVersionSet

This type is generated by the pallet macro.

fn in_code_storage_version() -> <Pallet<T> as GetStorageVersion>::InCodeStorageVersion

Returns the in-code storage version as specified in the storage_version attribute, or NoStorageVersionSet if the attribute is missing.

fn on_chain_storage_version() -> StorageVersion

Returns the storage version of the pallet as last set in the actual on-chain storage.

fn current_storage_version() -> Self::InCodeStorageVersion

👎Deprecated: This method has been renamed to in_code_storage_version and will be removed after March 2024.

DEPRECATED: Use Self::current_storage_version instead.

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

where T: Config,

fn on_initialize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> 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_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application.

fn on_runtime_upgrade() -> Weight

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

fn try_state(_n: BlockNumber) -> Result<(), DispatchError>

Execute the sanity checks of this pallet, per block.

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

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8>) -> 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 blockchain execution.

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

where T: Config,

type ItemId = u32

Type for identifying an item.

fn owner(item: &u32) -> Option<<T as Config>::AccountId>

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

fn attribute( item: &<Pallet<T> as Inspect<<T as Config>::AccountId>>::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> IntegrityTest for Pallet<T>

where T: Config,

fn integrity_test()

See Hooks::integrity_test.

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

where T: Config,

fn offchain_worker( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, )

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

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

where T: Config,

fn on_finalize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, )

See Hooks::on_finalize.

impl<T> OnGenesis for Pallet<T>

where T: Config,

fn on_genesis()

Something that should happen at genesis.

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

where T: Config,

fn on_idle( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, remaining_weight: Weight, ) -> Weight

See Hooks::on_idle.

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

where T: Config,

fn on_initialize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Weight

See Hooks::on_initialize.

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

where T: Config,

fn on_poll( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, weight: &mut WeightMeter, )

Code to execute every now and then at the beginning of the block after inherent application.

impl<T> OnRuntimeUpgrade for Pallet<T>

where T: Config,

fn on_runtime_upgrade() -> Weight

See Hooks::on_runtime_upgrade.

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

See Hooks::pre_upgrade.

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

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> PalletInfoAccess for Pallet<T>

where T: Config,

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 name_hash() -> [u8; 16]

Two128 hash of name.

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> PalletsInfoAccess for Pallet<T>

where T: Config,

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 for Pallet<T>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> StorageInfoTrait for Pallet<T>

where T: Config,

fn storage_info() -> Vec<StorageInfo>

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

where T: Config,

fn transfer( index: &u32, dest: &<T as Config>::AccountId, ) -> Result<(), DispatchError>

Transfer item into destination account.

impl<T> TryDecodeEntireStorage for Pallet<T>

where T: Config,

fn try_decode_entire_state() -> Result<usize, Vec<TryDecodeEntireStorageError>>

Decode the entire data under the given storage, returning Ok(bytes_decoded) if success.

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

where T: Config,

fn try_state( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, _s: Select, ) -> Result<(), DispatchError>

Execute the state checks.

impl<T> ViewFunctionIdPrefix for Pallet<T>

where T: Config,

fn prefix() -> [u8; 16]

impl<T> WhitelistedStorageKeys for Pallet<T>

where T: Config,

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>