The module for init Genesis
- Function
initialize
- Function
initialize_v2
- Function
do_initialize
- Function
initialize_for_unit_tests
- Module Specification
use 0x1::Account;
use 0x1::Block;
use 0x1::BlockReward;
use 0x1::ChainId;
use 0x1::Collection;
use 0x1::Config;
use 0x1::ConsensusConfig;
use 0x1::ConsensusStrategy;
use 0x1::CoreAddresses;
use 0x1::DummyToken;
use 0x1::Epoch;
use 0x1::GenesisNFT;
use 0x1::GenesisSignerCapability;
use 0x1::Option;
use 0x1::PackageTxnManager;
use 0x1::STC;
use 0x1::STCUSDOracle;
use 0x1::Signer;
use 0x1::StdlibUpgradeScripts;
use 0x1::Timestamp;
use 0x1::Token;
use 0x1::TransactionFee;
use 0x1::TransactionPublishOption;
use 0x1::TransactionTimeoutConfig;
use 0x1::Treasury;
use 0x1::TreasuryWithdrawDaoProposal;
use 0x1::VMConfig;
use 0x1::Vector;
use 0x1::Version;
public entry fun initialize(stdlib_version: u64, reward_delay: u64, pre_mine_stc_amount: u128, time_mint_stc_amount: u128, time_mint_stc_period: u64, parent_hash: vector<u8>, association_auth_key: vector<u8>, genesis_auth_key: vector<u8>, chain_id: u8, genesis_timestamp: u64, uncle_rate_target: u64, epoch_block_count: u64, base_block_time_target: u64, base_block_difficulty_window: u64, base_reward_per_block: u128, base_reward_per_uncle_percent: u64, min_block_time_target: u64, max_block_time_target: u64, base_max_uncles_per_block: u64, base_block_gas_limit: u64, strategy: u8, script_allowed: bool, module_publishing_allowed: bool, instruction_schedule: vector<u8>, native_schedule: vector<u8>, global_memory_per_byte_cost: u64, global_memory_per_byte_write_cost: u64, min_transaction_gas_units: u64, large_transaction_cutoff: u64, instrinsic_gas_per_byte: u64, maximum_number_of_gas_units: u64, min_price_per_gas_unit: u64, max_price_per_gas_unit: u64, max_transaction_size_in_bytes: u64, gas_unit_scaling_factor: u64, default_account_size: u64, voting_delay: u64, voting_period: u64, voting_quorum_rate: u8, min_action_delay: u64, transaction_timeout: u64)
Implementation
public entry fun initialize(
stdlib_version: u64,
// block reward config
reward_delay: u64,
pre_mine_stc_amount: u128,
time_mint_stc_amount: u128,
time_mint_stc_period: u64,
parent_hash: vector<u8>,
association_auth_key: vector<u8>,
genesis_auth_key: vector<u8>,
chain_id: u8,
genesis_timestamp: u64,
//consensus config
uncle_rate_target: u64,
epoch_block_count: u64,
base_block_time_target: u64,
base_block_difficulty_window: u64,
base_reward_per_block: u128,
base_reward_per_uncle_percent: u64,
min_block_time_target: u64,
max_block_time_target: u64,
base_max_uncles_per_block: u64,
base_block_gas_limit: u64,
strategy: u8,
//vm config
script_allowed: bool,
module_publishing_allowed: bool,
instruction_schedule: vector<u8>,
native_schedule: vector<u8>,
//gas constants
global_memory_per_byte_cost: u64,
global_memory_per_byte_write_cost: u64,
min_transaction_gas_units: u64,
large_transaction_cutoff: u64,
instrinsic_gas_per_byte: u64,
maximum_number_of_gas_units: u64,
min_price_per_gas_unit: u64,
max_price_per_gas_unit: u64,
max_transaction_size_in_bytes: u64,
gas_unit_scaling_factor: u64,
default_account_size: u64,
// dao config
voting_delay: u64,
voting_period: u64,
voting_quorum_rate: u8,
min_action_delay: u64,
// transaction timeout config
transaction_timeout: u64,
) {
assert!(Timestamp::is_genesis(), 1);
// create genesis account
let genesis_account = Account::create_genesis_account(CoreAddresses::GENESIS_ADDRESS());
//Init global time
Timestamp::initialize(&genesis_account, genesis_timestamp);
ChainId::initialize(&genesis_account, chain_id);
ConsensusStrategy::initialize(&genesis_account, strategy);
Block::initialize(&genesis_account, parent_hash);
TransactionPublishOption::initialize(
&genesis_account,
script_allowed,
module_publishing_allowed,
);
// init config
VMConfig::initialize(
&genesis_account,
instruction_schedule,
native_schedule,
global_memory_per_byte_cost,
global_memory_per_byte_write_cost,
min_transaction_gas_units,
large_transaction_cutoff,
instrinsic_gas_per_byte,
maximum_number_of_gas_units,
min_price_per_gas_unit,
max_price_per_gas_unit,
max_transaction_size_in_bytes,
gas_unit_scaling_factor,
default_account_size,
);
TransactionTimeoutConfig::initialize(&genesis_account, transaction_timeout);
ConsensusConfig::initialize(
&genesis_account,
uncle_rate_target,
epoch_block_count,
base_block_time_target,
base_block_difficulty_window,
base_reward_per_block,
base_reward_per_uncle_percent,
min_block_time_target,
max_block_time_target,
base_max_uncles_per_block,
base_block_gas_limit,
strategy,
);
Epoch::initialize(&genesis_account);
BlockReward::initialize(&genesis_account, reward_delay);
TransactionFee::initialize(&genesis_account);
let association = Account::create_genesis_account(
CoreAddresses::ASSOCIATION_ROOT_ADDRESS(),
);
Config::publish_new_config<Version::Version>(&genesis_account, Version::new_version(stdlib_version));
// stdlib use two phase upgrade strategy.
PackageTxnManager::update_module_upgrade_strategy(
&genesis_account,
PackageTxnManager::get_strategy_two_phase(),
Option::some(0u64),
);
// stc should be initialized after genesis_account's module upgrade strategy set.
{
STC::initialize(&genesis_account, voting_delay, voting_period, voting_quorum_rate, min_action_delay);
Account::do_accept_token<STC>(&genesis_account);
DummyToken::initialize(&genesis_account);
Account::do_accept_token<STC>(&association);
};
if (pre_mine_stc_amount > 0) {
let stc = Token::mint<STC>(&genesis_account, pre_mine_stc_amount);
Account::deposit(Signer::address_of(&association), stc);
};
if (time_mint_stc_amount > 0) {
let cap = Token::remove_mint_capability<STC>(&genesis_account);
let key = Token::issue_linear_mint_key<STC>(&cap, time_mint_stc_amount, time_mint_stc_period);
Token::add_mint_capability(&genesis_account, cap);
Collection::put(&association, key);
};
// only dev network set genesis auth key.
if (!Vector::is_empty(&genesis_auth_key)) {
let genesis_rotate_key_cap = Account::extract_key_rotation_capability(&genesis_account);
Account::rotate_authentication_key_with_capability(&genesis_rotate_key_cap, genesis_auth_key);
Account::restore_key_rotation_capability(genesis_rotate_key_cap);
};
let assoc_rotate_key_cap = Account::extract_key_rotation_capability(&association);
Account::rotate_authentication_key_with_capability(&assoc_rotate_key_cap, association_auth_key);
Account::restore_key_rotation_capability(assoc_rotate_key_cap);
//Start time, Timestamp::is_genesis() will return false. this call should at the end of genesis init.
Timestamp::set_time_has_started(&genesis_account);
Account::release_genesis_signer(genesis_account);
Account::release_genesis_signer(association);
}
public entry fun initialize_v2(stdlib_version: u64, reward_delay: u64, total_stc_amount: u128, pre_mine_stc_amount: u128, time_mint_stc_amount: u128, time_mint_stc_period: u64, parent_hash: vector<u8>, association_auth_key: vector<u8>, genesis_auth_key: vector<u8>, chain_id: u8, genesis_timestamp: u64, uncle_rate_target: u64, epoch_block_count: u64, base_block_time_target: u64, base_block_difficulty_window: u64, base_reward_per_block: u128, base_reward_per_uncle_percent: u64, min_block_time_target: u64, max_block_time_target: u64, base_max_uncles_per_block: u64, base_block_gas_limit: u64, strategy: u8, script_allowed: bool, module_publishing_allowed: bool, instruction_schedule: vector<u8>, native_schedule: vector<u8>, global_memory_per_byte_cost: u64, global_memory_per_byte_write_cost: u64, min_transaction_gas_units: u64, large_transaction_cutoff: u64, instrinsic_gas_per_byte: u64, maximum_number_of_gas_units: u64, min_price_per_gas_unit: u64, max_price_per_gas_unit: u64, max_transaction_size_in_bytes: u64, gas_unit_scaling_factor: u64, default_account_size: u64, voting_delay: u64, voting_period: u64, voting_quorum_rate: u8, min_action_delay: u64, transaction_timeout: u64)
Implementation
public entry fun initialize_v2(
stdlib_version: u64,
// block reward and stc config
reward_delay: u64,
total_stc_amount: u128,
pre_mine_stc_amount: u128,
time_mint_stc_amount: u128,
time_mint_stc_period: u64,
parent_hash: vector<u8>,
association_auth_key: vector<u8>,
genesis_auth_key: vector<u8>,
chain_id: u8,
genesis_timestamp: u64,
//consensus config
uncle_rate_target: u64,
epoch_block_count: u64,
base_block_time_target: u64,
base_block_difficulty_window: u64,
base_reward_per_block: u128,
base_reward_per_uncle_percent: u64,
min_block_time_target: u64,
max_block_time_target: u64,
base_max_uncles_per_block: u64,
base_block_gas_limit: u64,
strategy: u8,
//vm config
script_allowed: bool,
module_publishing_allowed: bool,
instruction_schedule: vector<u8>,
native_schedule: vector<u8>,
//gas constants
global_memory_per_byte_cost: u64,
global_memory_per_byte_write_cost: u64,
min_transaction_gas_units: u64,
large_transaction_cutoff: u64,
instrinsic_gas_per_byte: u64,
maximum_number_of_gas_units: u64,
min_price_per_gas_unit: u64,
max_price_per_gas_unit: u64,
max_transaction_size_in_bytes: u64,
gas_unit_scaling_factor: u64,
default_account_size: u64,
// dao config
voting_delay: u64,
voting_period: u64,
voting_quorum_rate: u8,
min_action_delay: u64,
// transaction timeout config
transaction_timeout: u64,
) {
Self::do_initialize(
stdlib_version,
reward_delay,
total_stc_amount,
pre_mine_stc_amount,
time_mint_stc_amount,
time_mint_stc_period,
parent_hash,
association_auth_key,
genesis_auth_key,
chain_id,
genesis_timestamp,
uncle_rate_target,
epoch_block_count,
base_block_time_target,
base_block_difficulty_window,
base_reward_per_block,
base_reward_per_uncle_percent,
min_block_time_target,
max_block_time_target,
base_max_uncles_per_block,
base_block_gas_limit,
strategy,
script_allowed,
module_publishing_allowed,
instruction_schedule,
native_schedule,
global_memory_per_byte_cost,
global_memory_per_byte_write_cost,
min_transaction_gas_units,
large_transaction_cutoff,
instrinsic_gas_per_byte,
maximum_number_of_gas_units,
min_price_per_gas_unit,
max_price_per_gas_unit,
max_transaction_size_in_bytes,
gas_unit_scaling_factor,
default_account_size,
voting_delay,
voting_period,
voting_quorum_rate,
min_action_delay,
transaction_timeout,
);
}
fun do_initialize(stdlib_version: u64, reward_delay: u64, total_stc_amount: u128, pre_mine_stc_amount: u128, time_mint_stc_amount: u128, time_mint_stc_period: u64, parent_hash: vector<u8>, association_auth_key: vector<u8>, genesis_auth_key: vector<u8>, chain_id: u8, genesis_timestamp: u64, uncle_rate_target: u64, epoch_block_count: u64, base_block_time_target: u64, base_block_difficulty_window: u64, base_reward_per_block: u128, base_reward_per_uncle_percent: u64, min_block_time_target: u64, max_block_time_target: u64, base_max_uncles_per_block: u64, base_block_gas_limit: u64, strategy: u8, script_allowed: bool, module_publishing_allowed: bool, instruction_schedule: vector<u8>, native_schedule: vector<u8>, global_memory_per_byte_cost: u64, global_memory_per_byte_write_cost: u64, min_transaction_gas_units: u64, large_transaction_cutoff: u64, instrinsic_gas_per_byte: u64, maximum_number_of_gas_units: u64, min_price_per_gas_unit: u64, max_price_per_gas_unit: u64, max_transaction_size_in_bytes: u64, gas_unit_scaling_factor: u64, default_account_size: u64, voting_delay: u64, voting_period: u64, voting_quorum_rate: u8, min_action_delay: u64, transaction_timeout: u64)
Implementation
fun do_initialize(
stdlib_version: u64,
// block reward and stc config
reward_delay: u64,
total_stc_amount: u128,
pre_mine_stc_amount: u128,
time_mint_stc_amount: u128,
time_mint_stc_period: u64,
parent_hash: vector<u8>,
association_auth_key: vector<u8>,
genesis_auth_key: vector<u8>,
chain_id: u8,
genesis_timestamp: u64,
//consensus config
uncle_rate_target: u64,
epoch_block_count: u64,
base_block_time_target: u64,
base_block_difficulty_window: u64,
base_reward_per_block: u128,
base_reward_per_uncle_percent: u64,
min_block_time_target: u64,
max_block_time_target: u64,
base_max_uncles_per_block: u64,
base_block_gas_limit: u64,
strategy: u8,
//vm config
script_allowed: bool,
module_publishing_allowed: bool,
instruction_schedule: vector<u8>,
native_schedule: vector<u8>,
//gas constants
global_memory_per_byte_cost: u64,
global_memory_per_byte_write_cost: u64,
min_transaction_gas_units: u64,
large_transaction_cutoff: u64,
instrinsic_gas_per_byte: u64,
maximum_number_of_gas_units: u64,
min_price_per_gas_unit: u64,
max_price_per_gas_unit: u64,
max_transaction_size_in_bytes: u64,
gas_unit_scaling_factor: u64,
default_account_size: u64,
// dao config
voting_delay: u64,
voting_period: u64,
voting_quorum_rate: u8,
min_action_delay: u64,
// transaction timeout config
transaction_timeout: u64,
){
Timestamp::assert_genesis();
// create genesis account
let genesis_account = Account::create_genesis_account(CoreAddresses::GENESIS_ADDRESS());
//Init global time
Timestamp::initialize(&genesis_account, genesis_timestamp);
ChainId::initialize(&genesis_account, chain_id);
ConsensusStrategy::initialize(&genesis_account, strategy);
Block::initialize(&genesis_account, parent_hash);
TransactionPublishOption::initialize(
&genesis_account,
script_allowed,
module_publishing_allowed,
);
// init config
VMConfig::initialize(
&genesis_account,
instruction_schedule,
native_schedule,
global_memory_per_byte_cost,
global_memory_per_byte_write_cost,
min_transaction_gas_units,
large_transaction_cutoff,
instrinsic_gas_per_byte,
maximum_number_of_gas_units,
min_price_per_gas_unit,
max_price_per_gas_unit,
max_transaction_size_in_bytes,
gas_unit_scaling_factor,
default_account_size,
);
TransactionTimeoutConfig::initialize(&genesis_account, transaction_timeout);
ConsensusConfig::initialize(
&genesis_account,
uncle_rate_target,
epoch_block_count,
base_block_time_target,
base_block_difficulty_window,
base_reward_per_block,
base_reward_per_uncle_percent,
min_block_time_target,
max_block_time_target,
base_max_uncles_per_block,
base_block_gas_limit,
strategy,
);
Epoch::initialize(&genesis_account);
let association = Account::create_genesis_account(
CoreAddresses::ASSOCIATION_ROOT_ADDRESS(),
);
Config::publish_new_config<Version::Version>(&genesis_account, Version::new_version(stdlib_version));
// stdlib use two phase upgrade strategy.
PackageTxnManager::update_module_upgrade_strategy(
&genesis_account,
PackageTxnManager::get_strategy_two_phase(),
Option::some(0u64),
);
BlockReward::initialize(&genesis_account, reward_delay);
// stc should be initialized after genesis_account's module upgrade strategy set and all on chain config init.
let withdraw_cap = STC::initialize_v2(&genesis_account, total_stc_amount, voting_delay, voting_period, voting_quorum_rate, min_action_delay);
Account::do_accept_token<STC>(&genesis_account);
Account::do_accept_token<STC>(&association);
DummyToken::initialize(&genesis_account);
if (pre_mine_stc_amount > 0) {
let stc = Treasury::withdraw_with_capability<STC>(&mut withdraw_cap, pre_mine_stc_amount);
Account::deposit(Signer::address_of(&association), stc);
};
if (time_mint_stc_amount > 0) {
let liner_withdraw_cap = Treasury::issue_linear_withdraw_capability<STC>(&mut withdraw_cap, time_mint_stc_amount, time_mint_stc_period);
Treasury::add_linear_withdraw_capability(&association, liner_withdraw_cap);
};
// Lock the TreasuryWithdrawCapability to Dao
TreasuryWithdrawDaoProposal::plugin(&genesis_account, withdraw_cap);
TransactionFee::initialize(&genesis_account);
// only test/dev network set genesis auth key.
if (!Vector::is_empty(&genesis_auth_key)) {
let genesis_rotate_key_cap = Account::extract_key_rotation_capability(&genesis_account);
Account::rotate_authentication_key_with_capability(&genesis_rotate_key_cap, genesis_auth_key);
Account::restore_key_rotation_capability(genesis_rotate_key_cap);
};
let assoc_rotate_key_cap = Account::extract_key_rotation_capability(&association);
Account::rotate_authentication_key_with_capability(&assoc_rotate_key_cap, association_auth_key);
Account::restore_key_rotation_capability(assoc_rotate_key_cap);
// v5 -> v6
{
let cap = Account::remove_signer_capability(&genesis_account);
GenesisSignerCapability::initialize(&genesis_account, cap);
//register oracle
STCUSDOracle::register(&genesis_account);
let merkle_root = x"5969f0e8e19f8769276fb638e6060d5c02e40088f5fde70a6778dd69d659ee6d";
let image = b"ipfs://QmSPcvcXgdtHHiVTAAarzTeubk5X3iWymPAoKBfiRFjPMY";
GenesisNFT::initialize(&genesis_account, merkle_root, 1639u64, image);
};
StdlibUpgradeScripts::do_upgrade_from_v6_to_v7_with_language_version(&genesis_account, 6);
StdlibUpgradeScripts::do_upgrade_from_v11_to_v12(&genesis_account);
//Start time, Timestamp::is_genesis() will return false. this call should at the end of genesis init.
Timestamp::set_time_has_started(&genesis_account);
Account::release_genesis_signer(genesis_account);
Account::release_genesis_signer(association);
}
Init the genesis for unit tests
public fun initialize_for_unit_tests()
Implementation
public fun initialize_for_unit_tests(){
let stdlib_version: u64 = 6;
let reward_delay: u64 = 7;
let total_stc_amount: u128 = 3185136000000000000u128;
let pre_mine_stc_amount: u128 = 159256800000000000u128;
let time_mint_stc_amount: u128 = (85043130u128 * 3u128 + 74213670u128 * 3u128)*1000000000u128;
let time_mint_stc_period: u64 = 1000000000;
let parent_hash: vector<u8> = x"0000000000000000000000000000000000000000000000000000000000000000";
let association_auth_key: vector<u8> = x"0000000000000000000000000000000000000000000000000000000000000000";
let genesis_auth_key: vector<u8> = x"0000000000000000000000000000000000000000000000000000000000000000";
let chain_id: u8 = 255;
let genesis_timestamp: u64 =0;
//consensus config
let uncle_rate_target: u64 = 80;
let epoch_block_count: u64 = 240;
let base_block_time_target: u64 = 10000;
let base_block_difficulty_window: u64 = 24;
let base_reward_per_block: u128 = 1000000000;
let base_reward_per_uncle_percent: u64 = 10;
let min_block_time_target: u64 = 1000;
let max_block_time_target: u64 = 20000;
let base_max_uncles_per_block: u64 = 2;
let base_block_gas_limit: u64 = 500000000;
let strategy: u8 = 0;
//vm config
let script_allowed: bool = true;
let module_publishing_allowed: bool = true;
//TODO init the gas table.
let instruction_schedule: vector<u8> = Vector::empty();
let native_schedule: vector<u8> = Vector::empty();
//gas constants
let global_memory_per_byte_cost: u64 = 1;
let global_memory_per_byte_write_cost: u64 = 1;
let min_transaction_gas_units: u64 = 1;
let large_transaction_cutoff: u64 = 1;
let instrinsic_gas_per_byte: u64 = 1;
let maximum_number_of_gas_units: u64 = 1;
let min_price_per_gas_unit: u64 = 1;
let max_price_per_gas_unit: u64 = 10000;
let max_transaction_size_in_bytes: u64 = 1024*1024;
let gas_unit_scaling_factor: u64 = 1;
let default_account_size: u64 = 600;
// dao config
let voting_delay: u64 = 1000;
let voting_period: u64 = 6000;
let voting_quorum_rate: u8 = 4;
let min_action_delay: u64 = 1000;
// transaction timeout config
let transaction_timeout: u64 = 10000;
Self::do_initialize(
stdlib_version,
reward_delay,
total_stc_amount,
pre_mine_stc_amount,
time_mint_stc_amount,
time_mint_stc_period,
parent_hash,
association_auth_key,
genesis_auth_key,
chain_id,
genesis_timestamp,
uncle_rate_target,
epoch_block_count,
base_block_time_target,
base_block_difficulty_window,
base_reward_per_block,
base_reward_per_uncle_percent,
min_block_time_target,
max_block_time_target,
base_max_uncles_per_block,
base_block_gas_limit,
strategy,
script_allowed,
module_publishing_allowed,
instruction_schedule,
native_schedule,
global_memory_per_byte_cost,
global_memory_per_byte_write_cost,
min_transaction_gas_units,
large_transaction_cutoff,
instrinsic_gas_per_byte,
maximum_number_of_gas_units,
min_price_per_gas_unit,
max_price_per_gas_unit,
max_transaction_size_in_bytes,
gas_unit_scaling_factor,
default_account_size,
voting_delay,
voting_period,
voting_quorum_rate,
min_action_delay,
transaction_timeout,
);
}
pragma verify = false;
pragma aborts_if_is_partial = false;
pragma aborts_if_is_strict = true;