ConsensusStrategy.md

Module 0x1::ConsensusStrategy

The module provides the information of current consensus strategy.

• Struct ConsensusStrategy
• Function initialize
• Function get
• Module Specification

use 0x1::Config;
use 0x1::CoreAddresses;
use 0x1::Timestamp;

Struct ConsensusStrategy

ConsensusStrategy data.

struct ConsensusStrategy has copy, drop, store

Fields

value: u8

Value of strategy

Function initialize

Publish the chain ID under the genesis account

public fun initialize(account: &signer, consensus_strategy: u8)

Implementation

public fun initialize(account: &signer, consensus_strategy: u8) {
    Timestamp::assert_genesis();
    CoreAddresses::assert_genesis_address(account);
    let cap = Config::publish_new_config_with_capability<ConsensusStrategy>(
        account,
        ConsensusStrategy { value:consensus_strategy }
    );
    //destroy the cap, so ConsensusStrategy can not been change.
    Config::destroy_modify_config_capability(cap);
}

Specification

aborts_if !Timestamp::is_genesis();
aborts_if Signer::address_of(account) != CoreAddresses::GENESIS_ADDRESS();
aborts_if exists<Config::Config<ConsensusStrategy>>(Signer::address_of(account));
aborts_if exists<Config::ModifyConfigCapabilityHolder<ConsensusStrategy>>(Signer::address_of(account));
ensures exists<Config::Config<ConsensusStrategy>>(Signer::address_of(account));

Function get

Return the consensus strategy type of this chain

public fun get(): u8

Implementation

public fun get(): u8 {
    Config::get_by_address<ConsensusStrategy>(CoreAddresses::GENESIS_ADDRESS()).value
}

Specification

aborts_if !exists<Config::Config<ConsensusStrategy>>(CoreAddresses::GENESIS_ADDRESS());

Module Specification

pragma verify = false;
pragma aborts_if_is_strict = true;