Struct Pallet

pub struct Pallet<T>(/* private fields */);

The Subspace Pallet

Implementations

impl<T: Config> Pallet<T>

pub fn store_segment_headers( origin: OriginFor<T>, segment_headers: Vec<SegmentHeader>, ) -> DispatchResult

Submit new segment header to the blockchain. This is an inherent extrinsic and part of the Subspace consensus logic.

pub fn enable_solution_range_adjustment( origin: OriginFor<T>, solution_range_override: Option<u64>, voting_solution_range_override: Option<u64>, ) -> DispatchResult

Enable solution range adjustment after every era. Note: No effect on the solution range for the current era

pub fn vote( origin: OriginFor<T>, signed_vote: Box<SignedVote<BlockNumberFor<T>, T::Hash, T::AccountId>>, ) -> DispatchResult

Farmer vote, currently only used for extra rewards to farmers.

pub fn enable_rewards_at( origin: OriginFor<T>, enable_rewards_at: EnableRewardsAt<BlockNumberFor<T>>, ) -> DispatchResult

Enable rewards for blocks and votes at specified block height.

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

Enable storage access for all users.

pub fn set_pot_slot_iterations( origin: OriginFor<T>, slot_iterations: NonZeroU32, ) -> DispatchResult

Update proof of time slot iterations

impl<T: Config> Pallet<T>

pub fn block_slots() -> BoundedBTreeMap<BlockNumberFor<T>, Slot, T::BlockSlotCount>

An auto-generated getter for BlockSlots.

impl<T: Config> Pallet<T>

pub fn solution_ranges() -> SolutionRanges

An auto-generated getter for SolutionRanges.

impl<T: Config> Pallet<T>

pub fn should_adjust_solution_range() -> bool

An auto-generated getter for ShouldAdjustSolutionRange.

impl<T: Config> Pallet<T>

pub fn segment_commitment<KArg>(k: KArg) -> Option<SegmentCommitment>

where KArg: EncodeLike<SegmentIndex>,

An auto-generated getter for SegmentCommitment.

impl<T: Config> Pallet<T>

pub fn root_plot_public_key() -> Option<PublicKey>

An auto-generated getter for RootPlotPublicKey.

impl<T: Config> Pallet<T>

pub fn history_size() -> HistorySize

Total number of pieces in the blockchain

pub fn pot_parameters() -> PotParameters

Proof of time parameters

pub fn current_slot() -> Slot

Current slot number

pub fn archived_history_size() -> u64

Size of the archived history of the blockchain in bytes

impl<T> Pallet<T>

where T: Config + CreateUnsigned<Call<T>>,

pub fn submit_vote( signed_vote: SignedVote<BlockNumberFor<T>, T::Hash, T::AccountId>, )

Submit farmer vote that is essentially a header with bigger solution range than acceptable for block authoring.

Trait Implementations

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

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

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

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

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

fn find_block_reward_address() -> Option<T::AccountId>

Find the address for a block rewards based on the pre-runtime digests.

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

fn find_voting_reward_addresses() -> Vec<T::AccountId>

Find the addresses for voting rewards based on transactions found in the block.

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

type InCodeStorageVersion = NoStorageVersionSet

This type is generated by the pallet macro.

fn in_code_storage_version() -> Self::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: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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

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

fn on_finalize(block_number: BlockNumberFor<T>)

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 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.

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

fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)

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

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

fn eq(&self, other: &Self) -> 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: Config> ProvideInherent for Pallet<T>

const INHERENT_IDENTIFIER: InherentIdentifier = INHERENT_IDENTIFIER

The inherent identifier used by this inherent.

type Call = Call<T>

The call type of the pallet.

type Error = InherentError

The error returned by check_inherent.

fn create_inherent(data: &InherentData) -> Option<Self::Call>

Create an inherent out of the given InherentData.

fn is_inherent_required( data: &InherentData, ) -> Result<Option<Self::Error>, Self::Error>

Determines whether this inherent is required in this block.

fn check_inherent( call: &Self::Call, data: &InherentData, ) -> Result<(), Self::Error>

Check whether the given inherent is valid. Checking the inherent is optional and can be omitted by using the default implementation.

fn is_inherent(call: &Self::Call) -> bool

Return whether the call is an inherent call.

impl<T: Config> Randomness<<T as Config>::Hash, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn random(subject: &[u8]) -> (T::Hash, BlockNumberFor<T>)

Get the most recently determined random seed, along with the time in the past since when it was determinable by chain observers.

fn random_seed() -> (T::Hash, BlockNumberFor<T>)

Get the basic random seed.

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

fn rewards_enabled() -> bool

Determine whether rewards are enabled or not

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

fn storage_info() -> Vec<StorageInfo>

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

type Call = Call<T>

The call to validate

fn validate_unsigned( source: TransactionSource, call: &Self::Call, ) -> TransactionValidity

Return the validity of the call

fn pre_dispatch(call: &Self::Call) -> Result<(), TransactionValidityError>

Validate the call right before dispatch.

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

fn prefix() -> [u8; 16]

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>