Module pallet_circuit::pallet

source ·
Expand description

The pallet module in each FRAME pallet hosts the most important items needed to construct this pallet.

The main components of this pallet are:

  • Pallet, which implements all of the dispatchable extrinsics of the pallet, among other public functions.
    • The subset of the functions that are dispatchable can be identified either in the dispatchables module or in the Call enum.
  • storage_types, which contains the list of all types that are representing a storage item. Otherwise, all storage items are listed among Type Definitions.
  • Config, which contains the configuration trait of this pallet.
  • Event and Error, which are listed among the Enums.

Re-exports

  • pub use crate::weights::WeightInfo;
  • pub use __tt_error_token_1 as tt_error_token;
  • pub use __tt_default_parts_7 as tt_default_parts;
  • pub use __tt_extra_parts_7 as tt_extra_parts;

Modules

  • dispatchables
    Auto-generated docs-only module listing all defined dispatchables for this pallet.
  • storage_types
    Auto-generated docs-only module listing all (public and private) defined storage types for this pallet.

Structs

  • Pallet
    The Pallet struct, the main type that implements traits and standalone functions within the pallet.
  • XbiResult
    A result containing the status of the call

Enums

  • Call
    Contains a variant per dispatchable extrinsic that this pallet has.
  • Error
    The Error enum of this pallet.
  • Event
    Events for the pallet.
  • Status
    A representation of the status of an XBI execution

Traits

  • Config
    Configuration trait of this pallet.

Type Definitions

  • AccountId20
  • AccountId32
  • AssetId
    A representation of an Asset Id, this is utilised for xbi instructions relating to multiple assets
  • DLQ
    Storage type is [StorageMap] with key type XExecSignalId < T > and value type (BlockNumberFor < T >, Vec < TargetId >, SpeedMode).
  • Data
  • EscrowBalance
  • FinalizedXtx
    Storage type is [StorageMap] with key type XExecSignalId < T > and value type BlockNumberFor < T >.
  • FullSideEffects
    Current Circuit’s context of active full side effects (requested + confirmation proofs) Lifecycle tips: FSX entries are created at the time of Xtx submission, where still uncertain whether Xtx will be accepted for execution (picked up in the bidding process).
  • GMP
    Storage type is [StorageMap] with key type H256 and value type H256.
  • Gas
  • LocalXtxStates
    LocalXtxStates stores the map of LocalState - additional state to be used to communicate between SFX that belong to the same Xtx
  • ModuleDeprecated
    Type alias to Pallet, to be used by construct_runtime.
  • PendingXtxBidsTimeoutsMap
    Temporary bidding timeouts map for SFX executions. Cleaned out each Config::BidsInterval, where for each FSX::best_bid bidders are assigned for SFX::enforce_executor or Xtx is dropped.
  • PendingXtxTimeoutsMap
    Current Circuit’s context of active Xtx used for the on_initialize clock to discover the ones pending for execution too long, that eventually need to be killed
  • SFX2XTXLinksMap
    Links mapping SFX 2 XTX
  • StorageMigrations
    Storage type is [StorageValue] with value type u32.
  • Value
  • Value32
  • Value64
  • Value128
  • Value256
  • ValueEvm
  • XExecSignals
    Current Circuit’s context of all accepted for execution cross-chain transactions.