Trait frame_support::traits::OnRuntimeUpgrade

source ·

pub trait OnRuntimeUpgrade {
    // Provided methods
    fn on_runtime_upgrade() -> Weight { ... }
    fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError> { ... }
    fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError> { ... }
    fn post_upgrade(_state: Vec<u8>) -> Result<(), TryRuntimeError> { ... }
}

Expand description

The runtime upgrade trait.

Implementing this lets you express what should happen when the runtime upgrades, and changes may need to occur to your module.

Provided Methods§

source

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

§Warning

This function will be called before we initialized any runtime state, aka on_initialize wasn’t called yet. So, information like the block number and any other block local data are not accessible.

Return the non-negotiable weight consumed for runtime upgrade.

source

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

Same as on_runtime_upgrade, but perform the optional pre_upgrade and post_upgrade as well.

source

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

Execute some pre-checks prior to a runtime upgrade.

Return a Vec<u8> that can contain arbitrary encoded data (usually some pre-upgrade state), which will be passed to post_upgrade after upgrading for post-check. An empty vector should be returned if there is no such need.

This hook is never meant to be executed on-chain but is meant to be used by testing tools.

This hook must not write to any state, as it would make the main on_runtime_upgrade path inaccurate.

source

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

Execute some post-checks after a runtime upgrade.

The state parameter is the Vec<u8> returned by pre_upgrade before upgrading, which can be used for post-check. NOTE: if pre_upgrade is not implemented an empty vector will be passed in, in such case post_upgrade should ignore it.

This hook is never meant to be executed on-chain but is meant to be used by testing tools.

This hook must not write to any state, as it would make the main on_runtime_upgrade path inaccurate.

Object Safety§

This trait is not object safe.

Trait frame_support::traits::OnRuntimeUpgradeCopy item path

Provided Methods§

fn on_runtime_upgrade() -> Weight

§Warning

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

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

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

Object Safety§

Implementations on Foreign Types§

impl OnRuntimeUpgrade for ()

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

impl<TupleElement0: OnRuntimeUpgrade> OnRuntimeUpgrade for (TupleElement0,)

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

impl<TupleElement0: OnRuntimeUpgrade, TupleElement1: OnRuntimeUpgrade> OnRuntimeUpgrade for (TupleElement0, TupleElement1)

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

impl<TupleElement0: OnRuntimeUpgrade, TupleElement1: OnRuntimeUpgrade, TupleElement2: OnRuntimeUpgrade> OnRuntimeUpgrade for (TupleElement0, TupleElement1, TupleElement2)

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

impl<TupleElement0: OnRuntimeUpgrade, TupleElement1: OnRuntimeUpgrade, TupleElement2: OnRuntimeUpgrade, TupleElement3: OnRuntimeUpgrade> OnRuntimeUpgrade for (TupleElement0, TupleElement1, TupleElement2, TupleElement3)

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

impl<TupleElement0: OnRuntimeUpgrade, TupleElement1: OnRuntimeUpgrade, TupleElement2: OnRuntimeUpgrade, TupleElement3: OnRuntimeUpgrade, TupleElement4: OnRuntimeUpgrade> OnRuntimeUpgrade for (TupleElement0, TupleElement1, TupleElement2, TupleElement3, TupleElement4)

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

fn on_runtime_upgrade() -> Weight

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, TryRuntimeError>

Trait frame_support::traits::OnRuntimeUpgrade