Struct pallet_circuit::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 on_local_trigger( origin: OriginFor<T>, trigger: Vec<u8> ) -> DispatchResult

Used by other pallets that want to create the exec order

pub fn on_xcm_trigger(_origin: OriginFor<T>) -> DispatchResultWithPostInfo

pub fn on_remote_gateway_trigger( _origin: OriginFor<T> ) -> DispatchResultWithPostInfo

pub fn cancel_xtx( origin: OriginFor<T>, xtx_id: T::Hash ) -> DispatchResultWithPostInfo

pub fn revert( origin: OriginFor<T>, xtx_id: T::Hash ) -> DispatchResultWithPostInfo

pub fn trigger_dlq(origin: OriginFor<T>) -> DispatchResultWithPostInfo

pub fn on_remote_origin_trigger( origin: OriginFor<T>, order_origin: T::AccountId, side_effects: Vec<SideEffect<T::AccountId, BalanceOf<T>>>, speed_mode: SpeedMode ) -> DispatchResultWithPostInfo

pub fn on_extrinsic_trigger( origin: OriginFor<T>, side_effects: Vec<SideEffect<T::AccountId, BalanceOf<T>>>, speed_mode: SpeedMode, preferred_security_level: SecurityLvl ) -> DispatchResultWithPostInfo

pub fn escrow( origin: OriginFor<T>, sfx_id: SideEffectId<T> ) -> DispatchResultWithPostInfo

pub fn bid_sfx( origin: OriginFor<T>, sfx_id: SideEffectId<T>, bid_amount: BalanceOf<T> ) -> DispatchResultWithPostInfo

pub fn confirm_side_effect( origin: OriginFor<T>, sfx_id: SideEffectId<T>, confirmation: ConfirmedSideEffect<<T as Config>::AccountId, BlockNumberFor<T>, BalanceOf<T>> ) -> DispatchResultWithPostInfo

Blind version should only be used for testing - unsafe since skips inclusion proof check.

impl<T: Config> Pallet<T>

pub fn storage_migrations_done() -> u32

An auto-generated getter for StorageMigrations.

impl<T: Config> Pallet<T>

pub fn get_gmp<KArg>(k: KArg) -> Option<H256>where KArg: EncodeLike<H256>,

An auto-generated getter for GMP.

impl<T: Config> Pallet<T>

pub fn get_sfx_2_xtx_links<KArg>(k: KArg) -> Option<XExecSignalId<T>>where KArg: EncodeLike<SideEffectId<T>>,

An auto-generated getter for SFX2XTXLinksMap.

impl<T: Config> Pallet<T>

pub fn get_active_timing_links<KArg>( k: KArg ) -> Option<AdaptiveTimeout<BlockNumberFor<T>, [u8; 4]>>where KArg: EncodeLike<XExecSignalId<T>>,

An auto-generated getter for PendingXtxTimeoutsMap.

impl<T: Config> Pallet<T>

pub fn get_pending_xtx_bids_timeouts<KArg>(k: KArg) -> Option<BlockNumberFor<T>>where KArg: EncodeLike<XExecSignalId<T>>,

An auto-generated getter for PendingXtxBidsTimeoutsMap.

impl<T: Config> Pallet<T>

pub fn get_finalized_xtx<KArg>(k: KArg) -> Option<BlockNumberFor<T>>where KArg: EncodeLike<XExecSignalId<T>>,

An auto-generated getter for FinalizedXtx.

impl<T: Config> Pallet<T>

pub fn get_x_exec_signals<KArg>( k: KArg ) -> Option<XExecSignal<<T as Config>::AccountId, BlockNumberFor<T>>>where KArg: EncodeLike<XExecSignalId<T>>,

An auto-generated getter for XExecSignals.

impl<T: Config> Pallet<T>

pub fn get_local_xtx_state<KArg>(k: KArg) -> Option<LocalState>where KArg: EncodeLike<XExecSignalId<T>>,

An auto-generated getter for LocalXtxStates.

impl<T: Config> Pallet<T>

pub fn get_full_side_effects<KArg>( k: KArg ) -> Option<Vec<Vec<FullSideEffect<<T as Config>::AccountId, BlockNumberFor<T>, BalanceOf<T>>>>>where KArg: EncodeLike<XExecSignalId<T>>,

An auto-generated getter for FullSideEffects.

impl<T: Config> Pallet<T>

pub fn get_dlq<KArg>( k: KArg ) -> Option<(BlockNumberFor<T>, Vec<TargetId>, SpeedMode)>where KArg: EncodeLike<XExecSignalId<T>>,

An auto-generated getter for DLQ.

impl<T: Config> Pallet<T>

pub fn get_signal_queue( ) -> BoundedVec<(T::AccountId, ExecutionSignal<T::Hash>), T::SignalQueueDepth>

“ Handles queued signals“ “” “ This operation is performed lazily in on_initialize.“

impl<T: Config> Pallet<T>

pub fn get_all_xtx_targets(xtx_id: XExecSignalId<T>) -> Vec<TargetId>

pub fn ensure_all_gateways_are_active(targets: Vec<TargetId>) -> bool

At the XTX submission fn verify ensures that all of the gateways are active. At either confirmation or revert attempt, ensure that all of the gateways are active, so that Executor won’t be slashed.

pub fn exec_in_xtx_ctx( _xtx_id: T::Hash, _local_state: LocalState, _full_side_effects: &mut Vec<FullSideEffect<T::AccountId, BlockNumberFor<T>, BalanceOf<T>>>, _steps_cnt: (u32, u32) ) -> Result<Vec<FullSideEffect<T::AccountId, BlockNumberFor<T>, BalanceOf<T>>>, Error<T>>

pub fn account_id() -> T::AccountId

The account ID of the Circuit Vault.

pub fn get_pending_sfx_bids( xtx_id: T::Hash, sfx_id: T::Hash ) -> Result<Option<SFXBid<T::AccountId, BalanceOf<T>, u32>>, Error<T>>

Get pending Bids for SFX - Pending meaning that the SFX is still In Bidding

pub fn convert_side_effects( side_effects: Vec<Vec<u8>> ) -> Result<Vec<SideEffect<T::AccountId, BalanceOf<T>>>, &'static str>

pub fn process_xtx_tick_queue( n: BlockNumberFor<T>, kill_interval: BlockNumberFor<T>, max_allowed_weight: Weight ) -> Weight

pub fn process_adaptive_xtx_timeout_queue( n: BlockNumberFor<T>, _verifier: &GatewayVendor ) -> Weight

pub fn process_emergency_revert_xtx_queue( n: BlockNumberFor<T>, revert_interval: BlockNumberFor<T>, max_allowed_weight: Weight ) -> Weight

pub fn get_adaptive_timeout( xtx_id: T::Hash, maybe_speed_mode: Option<SpeedMode> ) -> AdaptiveTimeout<BlockNumberFor<T>, TargetId>

pub fn add_xtx_to_dlq( xtx_id: T::Hash, targets: Vec<TargetId>, speed_mode: SpeedMode ) -> (Weight, bool)

Adds a cross-chain transaction (Xtx) to the Dead Letter Queue (DLQ).

Arguments

• xtx_id - The ID of the Xtx to be added to the DLQ.
• targets - The targets of the Xtx.
• speed_mode - The speed mode of the Xtx.

Returns

A tuple containing the weight of the operation and a boolean indicating whether the operation was successful.

pub fn remove_xtx_from_dlq(xtx_id: T::Hash) -> (Weight, bool)

Removes a cross-chain transaction (Xtx) from the Dead Letter Queue (DLQ).

Arguments

• xtx_id - The ID of the Xtx to be removed from the DLQ.

Returns

A tuple containing the weight of the operation and a boolean indicating whether the operation was successful.

pub fn process_dlq(_n: BlockNumberFor<T>) -> Weight

Processes the Dead Letter Queue (DLQ).

Arguments

• _n - The current block number.

Returns

The total weight of the operation.

pub fn process_revert_one(xtx_id: XExecSignalId<T>) -> (Weight, bool)

Processes a single cross-chain transaction (Xtx) revert operation.

Arguments

• xtx_id - The ID of the Xtx to be processed.

Returns

A tuple containing the weight of the operation and a boolean indicating whether the operation was successful.

pub fn request_sfx_attestation(local_ctx: &LocalXtxCtx<T, BalanceOf<T>>)

pub fn process_tick_one(xtx_id: XExecSignalId<T>) -> Weight

pub fn process_tick_two(xtx_id: XExecSignalId<T>) -> Weight

pub fn process_signal_queue( _n: BlockNumberFor<T>, _interval: BlockNumberFor<T>, max_allowed_weight: Weight ) -> Weight

pub fn recover_local_ctx_by_sfx_id( sfx_id: SideEffectId<T> ) -> Result<LocalXtxCtx<T, BalanceOf<T>>, Error<T>>

Trait Implementations

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

type RuntimeCall = Call<T>

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

fn process_dlq(n: BlockNumberFor<T>) -> Weight

fn process_adaptive_xtx_timeout_queue( n: BlockNumberFor<T>, verifier: &GatewayVendor ) -> Weight

impl<T: Config> CircuitSubmitAPI<T, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance> for Pallet<T>

fn on_extrinsic_trigger( origin: OriginFor<T>, side_effects: Vec<SideEffect<T::AccountId, BalanceOf<T>>>, speed_mode: SpeedMode, preferred_security_level: SecurityLvl ) -> DispatchResultWithPostInfo

fn on_remote_origin_trigger( origin: OriginFor<T>, order_origin: T::AccountId, side_effects: Vec<SideEffect<T::AccountId, BalanceOf<T>>>, speed_mode: SpeedMode ) -> DispatchResultWithPostInfo

fn store_gmp_payload(id: H256, payload: H256) -> bool

fn bid( origin: OriginFor<T>, sfx_id: SideEffectId<T>, amount: BalanceOf<T> ) -> DispatchResultWithPostInfo

fn get_gmp_payload(id: H256) -> Option<H256>

fn verify_sfx_proof( target: TargetId, speed_mode: SpeedMode, source: Option<ExecutionSource>, encoded_proof: Vec<u8> ) -> Result<InclusionReceipt<BlockNumberFor<T>>, DispatchError>

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

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

fn on_finalize(_n: BlockNumberFor<T>)

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

fn offchain_worker(_n: BlockNumberFor<T>)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

This will be run when the block is being finalized (before on_finalize).

fn integrity_test()

Run integrity test.

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

fn integrity_test()

Run 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>)

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

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

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

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

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

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

impl<T: Config> OnLocalTrigger<T, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance> for Pallet<T>

fn load_local_state( origin: &OriginFor<T>, maybe_xtx_id: Option<T::Hash> ) -> Result<LocalStateExecutionView<T, BalanceOf<T>>, DispatchError>

fn on_local_trigger( origin: &OriginFor<T>, trigger: LocalTrigger<T> ) -> Result<LocalStateExecutionView<T, BalanceOf<T>>, DispatchError>

fn on_signal( origin: &OriginFor<T>, signal: ExecutionSignal<T::Hash> ) -> DispatchResult

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

fn on_runtime_upgrade() -> Weight

Perform a module 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 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> ReadSFX<<T as Config>::Hash, <T as Config>::AccountId, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn get_fsx_of_xtx(xtx_id: T::Hash) -> Result<Vec<T::Hash>, DispatchError>

fn get_fsx_status(fsx_id: T::Hash) -> Result<CircuitStatus, DispatchError>

fn recover_latest_submitted_xtx_id() -> Result<T::Hash, DispatchError>

fn get_fsx_executor( fsx_id: T::Hash ) -> Result<Option<T::AccountId>, DispatchError>

fn get_fsx( fsx_id: T::Hash ) -> Result<FullSideEffect<T::AccountId, BlockNumberFor<T>, BalanceOf<T>>, DispatchError>

fn get_fsx_requester(fsx_id: T::Hash) -> Result<T::AccountId, DispatchError>

fn get_pending_xtx_ids() -> Vec<T::Hash>

fn get_pending_xtx_for( for_executor: T::AccountId ) -> Vec<(T::Hash, Vec<SideEffect<T::AccountId, BalanceOf<T>>>, Vec<T::Hash>)>

fn get_xtx_status( xtx_id: T::Hash ) -> Result<(CircuitStatus, AdaptiveTimeout<BlockNumberFor<T>, TargetId>), DispatchError>

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

fn storage_info() -> Vec<StorageInfo>

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>