Trait multiversx_sc_modules::pause::PauseModule

pub trait PauseModule: ContractBase + Sized {
    // Required method
    fn paused_status(&self) -> SingleValueMapper<Self::Api, bool>;

    // Provided methods
    fn is_paused(&self) -> bool { ... }
    fn not_paused(&self) -> bool { ... }
    fn set_paused(&self, paused: bool) { ... }
    fn pause_endpoint(&self) { ... }
    fn unpause_endpoint(&self) { ... }
    fn require_paused(&self) { ... }
    fn require_not_paused(&self) { ... }
}

Standard smart contract module that, when added to a smart contract, offers pausability.

It provides a flag that contracts can use to check if owner decided to pause the entire contract. Use the features module for more granular on/off switches.

It offers:

• an endpoint where the owner can pause/unpause contract
• a method to check if contract is paused or not

Required Methods

fn paused_status(&self) -> SingleValueMapper<Self::Api, bool>

Provided Methods

fn is_paused(&self) -> bool

fn not_paused(&self) -> bool

fn set_paused(&self, paused: bool)

fn pause_endpoint(&self)

fn unpause_endpoint(&self)

fn require_paused(&self)

fn require_not_paused(&self)

Object Safety

This trait is not object safe.

Implementors

impl<C> PauseModule for C

where C: AutoImpl,