Struct Pallet

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

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

Implementations

impl<T: Config> Pallet<T>

pub fn submit_bundle( origin: OriginFor<T>, opaque_bundle: OpaqueBundleOf<T>, ) -> DispatchResultWithPostInfo

pub fn submit_fraud_proof( origin: OriginFor<T>, fraud_proof: Box<FraudProofFor<T>>, ) -> DispatchResultWithPostInfo

pub fn register_domain_runtime( origin: OriginFor<T>, runtime_name: String, runtime_type: RuntimeType, raw_genesis_storage: Vec<u8>, ) -> DispatchResult

pub fn upgrade_domain_runtime( origin: OriginFor<T>, runtime_id: RuntimeId, raw_genesis_storage: Vec<u8>, ) -> DispatchResult

pub fn register_operator( origin: OriginFor<T>, domain_id: DomainId, amount: <T as Config>::Balance, config: OperatorConfig<<T as Config>::Balance>, signing_key_proof_of_ownership: OperatorSignature, ) -> DispatchResult

pub fn nominate_operator( origin: OriginFor<T>, operator_id: OperatorId, amount: <T as Config>::Balance, ) -> DispatchResult

pub fn instantiate_domain( origin: OriginFor<T>, domain_config_params: DomainConfigParams<T::AccountId, <T as Config>::Balance>, ) -> DispatchResult

pub fn deregister_operator( origin: OriginFor<T>, operator_id: OperatorId, ) -> DispatchResult

pub fn withdraw_stake( origin: OriginFor<T>, operator_id: OperatorId, to_withdraw: WithdrawStake<<T as Config>::Balance, T::Share>, ) -> DispatchResult

pub fn unlock_funds( origin: OriginFor<T>, operator_id: OperatorId, ) -> DispatchResult

Unlocks the first withdrawal given the unlocking period is complete. Even if rest of the withdrawals are out of unlocking period, nominator should call this extrinsic to unlock each withdrawal

pub fn unlock_nominator( origin: OriginFor<T>, operator_id: OperatorId, ) -> DispatchResult

Unlocks the nominator under given operator given the unlocking period is complete. A nominator can initiate their unlock given operator is already deregistered.

pub fn update_domain_operator_allow_list( origin: OriginFor<T>, domain_id: DomainId, operator_allow_list: OperatorAllowList<T::AccountId>, ) -> DispatchResult

Extrinsic to update domain’s operator allow list. Note:

• If the previous allowed list is set to specific operators and new allow list is set to Anyone, then domain will become permissioned to open for all operators.
• If the previous allowed list is set to Anyone or specific operators and the new allow list is set to specific operators, then all the registered not allowed operators will continue to operate until they de-register themselves.

pub fn force_staking_epoch_transition( origin: OriginFor<T>, domain_id: DomainId, ) -> DispatchResultWithPostInfo

Force staking epoch transition for a given domain

pub fn set_permissioned_action_allowed_by( origin: OriginFor<T>, permissioned_action_allowed_by: PermissionedActionAllowedBy<T::AccountId>, ) -> DispatchResult

Update permissioned action allowed by storage by Sudo.

pub fn send_domain_sudo_call( origin: OriginFor<T>, domain_id: DomainId, call: Vec<u8>, ) -> DispatchResult

Submit a domain sudo call.

pub fn freeze_domain( origin: OriginFor<T>, domain_id: DomainId, ) -> DispatchResult

Freezes a given domain. A frozen domain does not accept new bundles but accepts fraud proofs.

pub fn unfreeze_domain( origin: OriginFor<T>, domain_id: DomainId, ) -> DispatchResult

Unfreezes a frozen domain.

pub fn prune_domain_execution_receipt( origin: OriginFor<T>, domain_id: DomainId, bad_receipt_hash: ReceiptHashFor<T>, ) -> DispatchResultWithPostInfo

Prunes a given execution receipt for given frozen domain. This call assumes the execution receipt to be bad and implicitly trusts Sudo to do necessary validation of the ER before dispatching this call.

pub fn transfer_treasury_funds( origin: OriginFor<T>, account_id: T::AccountId, balance: <T as Config>::Balance, ) -> DispatchResult

Transfer funds from treasury to given account

pub fn submit_receipt( origin: OriginFor<T>, singleton_receipt: SingletonReceiptOf<T>, ) -> DispatchResultWithPostInfo

impl<T: Config> Pallet<T>

pub fn operator_signing_key<KArg>(k: KArg) -> Option<OperatorId>

where KArg: EncodeLike<OperatorPublicKey>,

An auto-generated getter for OperatorSigningKey.

impl<T: Config> Pallet<T>

pub fn domain_staking_summary<KArg>( k: KArg, ) -> Option<StakingSummary<OperatorId, <T as Config>::Balance>>

where KArg: EncodeLike<DomainId>,

An auto-generated getter for DomainStakingSummary.

impl<T: Config> Pallet<T>

pub fn next_domain_id() -> DomainId

An auto-generated getter for NextDomainId.

impl<T: Config> Pallet<T>

pub fn consensus_block_info<KArg1, KArg2>( k1: KArg1, k2: KArg2, ) -> Option<T::Hash>

where KArg1: EncodeLike<DomainId>, KArg2: EncodeLike<BlockNumberFor<T>>,

An auto-generated getter for ConsensusBlockHash.

impl<T: Config> Pallet<T>

pub fn latest_confirmed_domain_execution_receipt<KArg>( k: KArg, ) -> Option<ExecutionReceiptOf<T>>

where KArg: EncodeLike<DomainId>,

An auto-generated getter for LatestConfirmedDomainExecutionReceipt.

impl<T: Config> Pallet<T>

pub fn latest_submitted_er<KArg>(k: KArg) -> DomainBlockNumberFor<T>

where KArg: EncodeLike<(DomainId, OperatorId)>,

An auto-generated getter for LatestSubmittedER.

impl<T: Config> Pallet<T>

pub fn successful_bundles(domain_id: DomainId) -> Vec<H256>

pub fn domain_runtime_code(domain_id: DomainId) -> Option<Vec<u8>>

pub fn domain_best_number( domain_id: DomainId, ) -> Result<DomainBlockNumberFor<T>, BundleError>

pub fn runtime_id(domain_id: DomainId) -> Option<RuntimeId>

pub fn domain_instance_data( domain_id: DomainId, ) -> Option<(DomainInstanceData, BlockNumberFor<T>)>

pub fn genesis_state_root(domain_id: DomainId) -> Option<H256>

pub fn domain_tx_range(domain_id: DomainId) -> U256

Returns the tx range for the domain.

pub fn bundle_producer_election_params( domain_id: DomainId, ) -> Option<BundleProducerElectionParams<<T as Config>::Balance>>

pub fn operator( operator_id: OperatorId, ) -> Option<(OperatorPublicKey, <T as Config>::Balance)>

pub fn head_receipt_number(domain_id: DomainId) -> DomainBlockNumberFor<T>

Returns the best execution chain number.

pub fn oldest_unconfirmed_receipt_number( domain_id: DomainId, ) -> Option<DomainBlockNumberFor<T>>

Returns the block number of the oldest existing unconfirmed execution receipt, return None means there is no unconfirmed ER exist or submitted yet.

pub fn latest_confirmed_domain_block_number( domain_id: DomainId, ) -> DomainBlockNumberFor<T>

Returns the latest confirmed domain block number for a given domain Zero block is always a default confirmed block.

pub fn latest_confirmed_domain_block( domain_id: DomainId, ) -> Option<(DomainBlockNumberFor<T>, T::DomainHash)>

pub fn domain_bundle_limit( domain_id: DomainId, ) -> Result<Option<DomainBundleLimit>, DomainRegistryError>

Returns the domain bundle limit of the given domain

pub fn non_empty_er_exists(domain_id: DomainId) -> bool

Returns if there are any ERs in the challenge period that have non empty extrinsics. Note that Genesis ER is also considered special and hence non empty

pub fn extrinsics_shuffling_seed() -> T::Hash

pub fn execution_receipt( receipt_hash: ReceiptHashFor<T>, ) -> Option<ExecutionReceiptOf<T>>

pub fn receipt_hash( domain_id: DomainId, domain_number: DomainBlockNumberFor<T>, ) -> Option<ReceiptHashFor<T>>

pub fn confirmed_domain_block_storage_key(domain_id: DomainId) -> Vec<u8>

pub fn is_bad_er_pending_to_prune( domain_id: DomainId, receipt_number: DomainBlockNumberFor<T>, ) -> bool

pub fn is_operator_pending_to_slash( domain_id: DomainId, operator_id: OperatorId, ) -> bool

pub fn max_submit_bundle_weight() -> Weight

pub fn max_submit_receipt_weight() -> Weight

pub fn max_staking_epoch_transition() -> Weight

pub fn max_prune_domain_execution_receipt() -> Weight

pub fn reward_domain_operators( domain_id: DomainId, source: OperatorRewardSource<BlockNumberFor<T>>, rewards: <T as Config>::Balance, )

Reward the active operators of this domain epoch.

pub fn storage_fund_account_balance( operator_id: OperatorId, ) -> <T as Config>::Balance

pub fn operator_highest_slot_from_previous_block( operator_id: OperatorId, pre_dispatch: bool, ) -> u64

pub fn get_domain_runtime_code_for_receipt( domain_id: DomainId, receipt: &ExecutionReceiptOf<T>, maybe_domain_runtime_code_at: Option<DomainRuntimeCodeAt<BlockNumberFor<T>, T::Hash, T::MmrHash>>, ) -> Result<Vec<u8>, FraudProofError>

pub fn is_domain_runtime_upgraded_since( domain_id: DomainId, at: BlockNumberFor<T>, ) -> Option<bool>

pub fn verify_mmr_proof_and_extract_state_root( mmr_leaf_proof: ConsensusChainMmrLeafProof<BlockNumberFor<T>, T::Hash, T::MmrHash>, expected_block_number: BlockNumberFor<T>, ) -> Result<T::Hash, FraudProofError>

pub fn is_domain_registered(domain_id: DomainId) -> bool

Returns true if the Domain is registered.

pub fn domain_sudo_call(domain_id: DomainId) -> Option<Vec<u8>>

Returns domain’s sudo call if any.

pub fn receipt_gap( domain_id: DomainId, ) -> Result<DomainBlockNumberFor<T>, BundleError>

impl<T> Pallet<T>

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

pub fn submit_bundle_unsigned(opaque_bundle: OpaqueBundleOf<T>)

Submits an unsigned extrinsic Call::submit_bundle.

pub fn submit_receipt_unsigned(singleton_receipt: SingletonReceiptOf<T>)

Submits an unsigned extrinsic Call::submit_receipt.

pub fn submit_fraud_proof_unsigned(fraud_proof: FraudProofFor<T>)

Submits an unsigned extrinsic Call::submit_fraud_proof.

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

fn is_domain_owner(domain_id: DomainId, acc: T::AccountId) -> bool

Returns true if the account is the domain owner.

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

type InCodeStorageVersion = StorageVersion

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(_: 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> 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 pre_dispatch(call: &Self::Call) -> Result<(), TransactionValidityError>

Validate the call right before dispatch.

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

Return the validity of the call

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>