Trait pink::system::System

source ·

pub trait System: ContractEnv {
Show 42 associated items
    type versionOutput: ImpliesReturn<VersionTuple>;
    type grantAdminOutput: ImpliesReturn<Result<()>>;
    type isAdminOutput: ImpliesReturn<bool>;
    type setDriverOutput: ImpliesReturn<Result<()>>;
    type getDriverOutput: ImpliesReturn<Option<AccountId>>;
    type getDriver2Output: ImpliesReturn<Option<(BlockNumber, AccountId)>>;
    type deploySidevmToOutput: ImpliesReturn<Result<()>>;
    type stopSidevmAtOutput: ImpliesReturn<Result<()>>;
    type setHookOutput: ImpliesReturn<Result<()>>;
    type setContractWeightOutput: ImpliesReturn<Result<()>>;
    type totalBalanceOfOutput: ImpliesReturn<Balance>;
    type freeBalanceOfOutput: ImpliesReturn<Balance>;
    type upgradeSystemContractOutput: ImpliesReturn<Result<()>>;
    type doUpgradeOutput: ImpliesReturn<Result<()>>;
    type upgradeRuntimeOutput: ImpliesReturn<Result<()>>;
    type codeExistsOutput: ImpliesReturn<bool>;
    type codeHashOutput: ImpliesReturn<Option<Hash>>;
    type driverHistoryOutput: ImpliesReturn<Option<Vec<(BlockNumber, AccountId)>>>;
    type currentEventChainHeadOutput: ImpliesReturn<(u64, Hash)>;
    type deploySidevmToWorkersOutput: ImpliesReturn<Result<()>>;
    type setSidevmDeadlineOutput: ImpliesReturn<Result<()>>;

    // Required methods
    fn version(&self) -> Self::versionOutput;
    fn grant_admin(&mut self, contract_id: AccountId) -> Self::grantAdminOutput;
    fn is_admin(&self, contract_id: AccountId) -> Self::isAdminOutput;
    fn set_driver(
        &mut self,
        name: String,
        contract_id: AccountId
    ) -> Self::setDriverOutput;
    fn get_driver(&self, name: String) -> Self::getDriverOutput;
    fn get_driver2(&self, name: String) -> Self::getDriver2Output;
    fn deploy_sidevm_to(
        &self,
        contract_id: AccountId,
        code_hash: Hash
    ) -> Self::deploySidevmToOutput;
    fn stop_sidevm_at(&self, contract_id: AccountId) -> Self::stopSidevmAtOutput;
    fn set_hook(
        &mut self,
        hook: HookPoint,
        contract_id: AccountId,
        selector: u32,
        gas_limit: u64
    ) -> Self::setHookOutput;
    fn set_contract_weight(
        &self,
        contract_id: AccountId,
        weight: u32
    ) -> Self::setContractWeightOutput;
    fn total_balance_of(&self, account: AccountId) -> Self::totalBalanceOfOutput;
    fn free_balance_of(&self, account: AccountId) -> Self::freeBalanceOfOutput;
    fn upgrade_system_contract(&mut self) -> Self::upgradeSystemContractOutput;
    fn do_upgrade(&self, from_version: VersionTuple) -> Self::doUpgradeOutput;
    fn upgrade_runtime(
        &mut self,
        version: (u32, u32)
    ) -> Self::upgradeRuntimeOutput;
    fn code_exists(
        &self,
        code_hash: Hash,
        code_type: CodeType
    ) -> Self::codeExistsOutput;
    fn code_hash(&self, account: AccountId) -> Self::codeHashOutput;
    fn driver_history(&self, name: String) -> Self::driverHistoryOutput;
    fn current_event_chain_head(&self) -> Self::currentEventChainHeadOutput;
    fn deploy_sidevm_to_workers(
        &self,
        contract_id: AccountId,
        code_hash: Hash,
        workers: Vec<WorkerId>,
        config: SidevmConfig
    ) -> Self::deploySidevmToWorkersOutput;
    fn set_sidevm_deadline(
        &self,
        contract_id: AccountId,
        run_until: BlockNumber
    ) -> Self::setSidevmDeadlineOutput;
}

Expand description

The doc is messed up by the ink macro. See SystemForDoc for a clean version

The pink system contract interface.

The system contract, instantiated with each cluster creation, manages access permissions to the privileged chain extension functions and pink events. Some of these functions or events are exclusive to the system contract. User contracts wishing to call these functions or emit these events must first request the system contract, which then checks the permissions to either execute or reject the request.