Struct pallet_broker::pallet::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 current_price() -> Result<BalanceOf<T>, DispatchError>

If there is an ongoing sale returns the current price of a core.

impl<T: Config> Pallet<T>

pub fn current_timeslice() -> Timeslice

pub fn latest_timeslice_ready_to_commit(config: &ConfigRecordOf<T>) -> Timeslice

pub fn next_timeslice_to_commit( config: &ConfigRecordOf<T>, status: &StatusRecord, ) -> Option<Timeslice>

pub fn account_id() -> T::AccountId

pub fn sale_price( sale: &SaleInfoRecordOf<T>, now: RelayBlockNumberOf<T>, ) -> BalanceOf<T>

pub fn issue( core: CoreIndex, begin: Timeslice, mask: CoreMask, end: Timeslice, owner: Option<T::AccountId>, paid: Option<BalanceOf<T>>, ) -> RegionId

impl<T: Config> Pallet<T>

pub fn configure( origin: OriginFor<T>, config: ConfigRecordOf<T>, ) -> DispatchResultWithPostInfo

Configure the pallet.

• origin: Must be Root or pass AdminOrigin.
• config: The configuration for this pallet.

pub fn reserve( origin: OriginFor<T>, workload: Schedule, ) -> DispatchResultWithPostInfo

Reserve a core for a workload.

The workload will be given a reservation, but two sale period boundaries must pass before the core is actually assigned.

• origin: Must be Root or pass AdminOrigin.
• workload: The workload which should be permanently placed on a core.

pub fn unreserve( origin: OriginFor<T>, item_index: u32, ) -> DispatchResultWithPostInfo

Cancel a reservation for a workload.

• origin: Must be Root or pass AdminOrigin.
• item_index: The index of the reservation. Usually this will also be the index of the core on which the reservation has been scheduled. However, it is possible that if other cores are reserved or unreserved in the same sale rotation that they won’t correspond, so it’s better to look up the core properly in the Reservations storage.

pub fn set_lease( origin: OriginFor<T>, task: TaskId, until: Timeslice, ) -> DispatchResultWithPostInfo

Reserve a core for a single task workload for a limited period.

In the interlude and sale period where Bulk Coretime is sold for the period immediately after until, then the same workload may be renewed.

• origin: Must be Root or pass AdminOrigin.
• task: The workload which should be placed on a core.
• until: The timeslice now earlier than which task should be placed as a workload on a core.

pub fn start_sales( origin: OriginFor<T>, end_price: BalanceOf<T>, extra_cores: CoreIndex, ) -> DispatchResultWithPostInfo

Begin the Bulk Coretime sales rotation.

• origin: Must be Root or pass AdminOrigin.
• end_price: The price after the leadin period of Bulk Coretime in the first sale.
• extra_cores: Number of extra cores that should be requested on top of the cores required for Reservations and Leases.

This will call Self::request_core_count internally to set the correct core count on the relay chain.

pub fn purchase( origin: OriginFor<T>, price_limit: BalanceOf<T>, ) -> DispatchResultWithPostInfo

Purchase Bulk Coretime in the ongoing Sale.

• origin: Must be a Signed origin with at least enough funds to pay the current price of Bulk Coretime.
• price_limit: An amount no more than which should be paid.

pub fn renew( origin: OriginFor<T>, core: CoreIndex, ) -> DispatchResultWithPostInfo

Renew Bulk Coretime in the ongoing Sale or its prior Interlude Period.

• origin: Must be a Signed origin with at least enough funds to pay the renewal price of the core.
• core: The core which should be renewed.

pub fn transfer( origin: OriginFor<T>, region_id: RegionId, new_owner: T::AccountId, ) -> DispatchResult

Transfer a Bulk Coretime Region to a new owner.

• origin: Must be a Signed origin of the account which owns the Region region_id.
• region_id: The Region whose ownership should change.
• new_owner: The new owner for the Region.

pub fn partition( origin: OriginFor<T>, region_id: RegionId, pivot: Timeslice, ) -> DispatchResult

Split a Bulk Coretime Region into two non-overlapping Regions at a particular time into the region.

• origin: Must be a Signed origin of the account which owns the Region region_id.
• region_id: The Region which should be partitioned into two non-overlapping Regions.
• pivot: The offset in time into the Region at which to make the split.

pub fn interlace( origin: OriginFor<T>, region_id: RegionId, pivot: CoreMask, ) -> DispatchResult

Split a Bulk Coretime Region into two wholly-overlapping Regions with complementary interlace masks which together make up the original Region’s interlace mask.

• origin: Must be a Signed origin of the account which owns the Region region_id.
• region_id: The Region which should become two interlaced Regions of incomplete regularity.
• pivot: The interlace mask of one of the two new regions (the other is its partial complement).

pub fn assign( origin: OriginFor<T>, region_id: RegionId, task: TaskId, finality: Finality, ) -> DispatchResultWithPostInfo

Assign a Bulk Coretime Region to a task.

• origin: Must be a Signed origin of the account which owns the Region region_id.
• region_id: The Region which should be assigned to the task.
• task: The task to assign.
• finality: Indication of whether this assignment is final (in which case it may be eligible for renewal) or provisional (in which case it may be manipulated and/or reassigned at a later stage).

pub fn pool( origin: OriginFor<T>, region_id: RegionId, payee: T::AccountId, finality: Finality, ) -> DispatchResultWithPostInfo

Place a Bulk Coretime Region into the Instantaneous Coretime Pool.

• origin: Must be a Signed origin of the account which owns the Region region_id.
• region_id: The Region which should be assigned to the Pool.
• payee: The account which is able to collect any revenue due for the usage of this Coretime.

pub fn claim_revenue( origin: OriginFor<T>, region_id: RegionId, max_timeslices: Timeslice, ) -> DispatchResultWithPostInfo

Claim the revenue owed from inclusion in the Instantaneous Coretime Pool.

• origin: Must be a Signed origin.
• region_id: The Region which was assigned to the Pool.
• max_timeslices: The maximum number of timeslices which should be processed. This must be greater than 0. This may affect the weight of the call but should be ideally made equivalent to the length of the Region region_id. If less, further dispatches will be required with the same region_id to claim revenue for the remainder.

pub fn purchase_credit( origin: OriginFor<T>, amount: BalanceOf<T>, beneficiary: RelayAccountIdOf<T>, ) -> DispatchResult

Purchase credit for use in the Instantaneous Coretime Pool.

• origin: Must be a Signed origin able to pay at least amount.
• amount: The amount of credit to purchase.
• beneficiary: The account on the Relay-chain which controls the credit (generally this will be the collator’s hot wallet).

pub fn drop_region( _origin: OriginFor<T>, region_id: RegionId, ) -> DispatchResultWithPostInfo

Drop an expired Region from the chain.

• origin: Can be any kind of origin.
• region_id: The Region which has expired.

pub fn drop_contribution( _origin: OriginFor<T>, region_id: RegionId, ) -> DispatchResultWithPostInfo

Drop an expired Instantaneous Pool Contribution record from the chain.

• origin: Can be any kind of origin.
• region_id: The Region identifying the Pool Contribution which has expired.

pub fn drop_history( _origin: OriginFor<T>, when: Timeslice, ) -> DispatchResultWithPostInfo

Drop an expired Instantaneous Pool History record from the chain.

• origin: Can be any kind of origin.
• region_id: The time of the Pool History record which has expired.

pub fn drop_renewal( _origin: OriginFor<T>, core: CoreIndex, when: Timeslice, ) -> DispatchResultWithPostInfo

Drop an expired Allowed Renewal record from the chain.

• origin: Can be any kind of origin.
• core: The core to which the expired renewal refers.
• when: The timeslice to which the expired renewal refers. This must have passed.

pub fn request_core_count( origin: OriginFor<T>, core_count: CoreIndex, ) -> DispatchResult

Request a change to the number of cores available for scheduling work.

• origin: Must be Root or pass AdminOrigin.
• core_count: The desired number of cores to be made available.

pub fn notify_core_count( origin: OriginFor<T>, core_count: CoreIndex, ) -> DispatchResult

pub fn notify_revenue( origin: OriginFor<T>, revenue: OnDemandRevenueRecordOf<T>, ) -> DispatchResult

pub fn enable_auto_renew( origin: OriginFor<T>, core: CoreIndex, task: TaskId, workload_end_hint: Option<Timeslice>, ) -> DispatchResult

Extrinsic for enabling auto renewal.

Callable by the sovereign account of the task on the specified core. This account will be charged at the start of every bulk period for renewing core time.

• origin: Must be the sovereign account of the task
• core: The core to which the task to be renewed is currently assigned.
• task: The task for which we want to enable auto renewal.
• workload_end_hint: should be used when enabling auto-renewal for a core that is not expiring in the upcoming bulk period (e.g., due to holding a lease) since it would be inefficient to look up when the core expires to schedule the next renewal.

pub fn disable_auto_renew( origin: OriginFor<T>, core: CoreIndex, task: TaskId, ) -> DispatchResult

Extrinsic for disabling auto renewal.

Callable by the sovereign account of the task on the specified core.

• origin: Must be the sovereign account of the task.
• core: The core for which we want to disable auto renewal.
• task: The task for which we want to disable auto renewal.

pub fn force_reserve( origin: OriginFor<T>, workload: Schedule, core: CoreIndex, ) -> DispatchResultWithPostInfo

Reserve a core for a workload immediately.

• origin: Must be Root or pass AdminOrigin.
• workload: The workload which should be permanently placed on a core starting immediately.
• core: The core to which the assignment should be made until the reservation takes effect. It is left to the caller to either add this new core or reassign any other tasks to this existing core.

This reserves the workload and then injects the workload into the Workplan for the next two sale periods. This overwrites any existing assignments for this core at the start of the next sale period.

pub fn swap_leases( origin: OriginFor<T>, id: TaskId, other: TaskId, ) -> DispatchResult

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> 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: 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> 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(_now: BlockNumberFor<T>) -> Weight

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

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.

fn integrity_test()

Check the integrity of this pallet’s configuration.

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

type ItemId = u128

Type for identifying an item.

fn owner(item: &Self::ItemId) -> Option<T::AccountId>

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

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

fn integrity_test()

See [Hooks::integrity_test].

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

We don’t really support burning and minting.

We only need this to allow the region to be reserve transferable.

For reserve transfers that are not ‘local’, the asset must first be withdrawn to the holding register and then deposited into the designated account. This process necessitates that the asset is capable of being ‘burned’ and ‘minted’.

Since each region is associated with specific record data, we will not actually burn the asset. If we did, we wouldn’t know what record to assign to the newly minted region. Therefore, instead of burning, we set the asset’s owner to None. In essence, ‘burning’ a region involves setting its owner to None, whereas ‘minting’ the region assigns its owner to an actual account. This way we never lose track of the associated record data.

fn mint_into(item: &Self::ItemId, who: &T::AccountId) -> DispatchResult

Deposit a region into an account.

fn burn( item: &Self::ItemId, maybe_check_owner: Option<&T::AccountId>, ) -> DispatchResult

Withdraw a region from account.

fn set_attribute( _item: &Self::ItemId, _key: &[u8], _value: &[u8], ) -> Result<(), DispatchError>

Set attribute value of item’s key.

fn set_typed_attribute<K, V>( item: &Self::ItemId, key: &K, value: &V, ) -> Result<(), DispatchError>

where K: Encode, V: Encode,

Attempt to set the strongly-typed attribute value of item’s key.

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

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

See [Hooks::pre_upgrade].

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

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

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

fn storage_info() -> Vec<StorageInfo>

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

fn transfer(item: &Self::ItemId, dest: &T::AccountId) -> DispatchResult

Transfer item into destination account.

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

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

fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect, ) -> Result<(), TryRuntimeError>

Execute the state checks.

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>