Module `0x1::Genesis`

The <code><a href="Genesis.md#0x1_Genesis">Genesis</a></code> module defines the Move initialization entry point of the Diem framework when executing from a fresh state.

TODO: Currently there are a few additional functions called from Rust during genesis. Document which these are and in which order they are called.

Function initialize
Function initialize_internal
Function create_initialize_owners_operators

<pre><code>use <a href="AccountFreezing.md#0x1_AccountFreezing">0x1::AccountFreezing</a>; use <a href="ChainId.md#0x1_ChainId">0x1::ChainId</a>; use <a href="Diem.md#0x1_Diem">0x1::Diem</a>; use <a href="DiemAccount.md#0x1_DiemAccount">0x1::DiemAccount</a>; use <a href="DiemBlock.md#0x1_DiemBlock">0x1::DiemBlock</a>; use <a href="DiemConfig.md#0x1_DiemConfig">0x1::DiemConfig</a>; use <a href="DiemConsensusConfig.md#0x1_DiemConsensusConfig">0x1::DiemConsensusConfig</a>; use <a href="DiemSystem.md#0x1_DiemSystem">0x1::DiemSystem</a>; use <a href="DiemTimestamp.md#0x1_DiemTimestamp">0x1::DiemTimestamp</a>; use <a href="DiemTransactionPublishingOption.md#0x1_DiemTransactionPublishingOption">0x1::DiemTransactionPublishingOption</a>; use <a href="DiemVMConfig.md#0x1_DiemVMConfig">0x1::DiemVMConfig</a>; use <a href="DiemVersion.md#0x1_DiemVersion">0x1::DiemVersion</a>; use <a href="DualAttestation.md#0x1_DualAttestation">0x1::DualAttestation</a>; use <a href="../../../../../../move-stdlib/docs/Signer.md#0x1_Signer">0x1::Signer</a>; use <a href="TransactionFee.md#0x1_TransactionFee">0x1::TransactionFee</a>; use <a href="ValidatorConfig.md#0x1_ValidatorConfig">0x1::ValidatorConfig</a>; use <a href="ValidatorOperatorConfig.md#0x1_ValidatorOperatorConfig">0x1::ValidatorOperatorConfig</a>; use <a href="../../../../../../move-stdlib/docs/Vector.md#0x1_Vector">0x1::Vector</a>; use <a href="XDX.md#0x1_XDX">0x1::XDX</a>; use <a href="XUS.md#0x1_XUS">0x1::XUS</a>; </code></pre>

Function `initialize`

Initializes the Diem framework.

<pre><code>fun <a href="Genesis.md#0x1_Genesis_initialize">initialize</a>(dr_account: signer, tc_account: signer, dr_auth_key: vector<u8>, tc_auth_key: vector<u8>, initial_script_allow_list: vector<vector<u8>>, is_open_module: bool, instruction_schedule: vector<u8>, native_schedule: vector<u8>, chain_id: u8, initial_diem_version: u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="Genesis.md#0x1_Genesis_initialize">initialize</a>( dr_account: signer, tc_account: signer, dr_auth_key: vector<u8>, tc_auth_key: vector<u8>, initial_script_allow_list: vector<vector<u8>>, is_open_module: bool, instruction_schedule: vector<u8>, native_schedule: vector<u8>, chain_id: u8, initial_diem_version: u64, ) { <a href="Genesis.md#0x1_Genesis_initialize_internal">initialize_internal</a>( &dr_account, &tc_account, dr_auth_key, tc_auth_key, initial_script_allow_list, is_open_module, instruction_schedule, native_schedule, chain_id, initial_diem_version, ) } </code></pre> </details> <details> <summary>Specification</summary>

For verification of genesis, the goal is to prove that all the invariants which become active after the end of this function hold. This cannot be achieved with modular verification as we do in regular continuous testing. Rather, this module must be verified together with the module(s) which provides the invariant.

TODO: currently verifying this module together with modules providing invariants (see above) times out. This can likely be solved by making more of the initialize functions called by this function opaque, and prove the according invariants locally to each module.

Assume that this is called in genesis state (no timestamp).

<pre><code>requires <a href="DiemTimestamp.md#0x1_DiemTimestamp_is_genesis">DiemTimestamp::is_genesis</a>(); </code></pre> </details>

Function `initialize_internal`

Initializes the Diem Framework. Internal so it can be used by both genesis code, and for testing purposes

<pre><code>fun <a href="Genesis.md#0x1_Genesis_initialize_internal">initialize_internal</a>(dr_account: &signer, tc_account: &signer, dr_auth_key: vector<u8>, tc_auth_key: vector<u8>, initial_script_allow_list: vector<vector<u8>>, is_open_module: bool, instruction_schedule: vector<u8>, native_schedule: vector<u8>, chain_id: u8, initial_diem_version: u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="Genesis.md#0x1_Genesis_initialize_internal">initialize_internal</a>( dr_account: &signer, tc_account: &signer, dr_auth_key: vector<u8>, tc_auth_key: vector<u8>, initial_script_allow_list: vector<vector<u8>>, is_open_module: bool, instruction_schedule: vector<u8>, native_schedule: vector<u8>, chain_id: u8, initial_diem_version: u64, ) { <a href="DiemAccount.md#0x1_DiemAccount_initialize">DiemAccount::initialize</a>(dr_account, x"00000000000000000000000000000000"); <a href="ChainId.md#0x1_ChainId_initialize">ChainId::initialize</a>(dr_account, chain_id); // On-chain config setup <a href="DiemConfig.md#0x1_DiemConfig_initialize">DiemConfig::initialize</a>(dr_account); // Consensus config setup <a href="DiemConsensusConfig.md#0x1_DiemConsensusConfig_initialize">DiemConsensusConfig::initialize</a>(dr_account); // Currency setup <a href="Diem.md#0x1_Diem_initialize">Diem::initialize</a>(dr_account); // Currency setup <a href="XUS.md#0x1_XUS_initialize">XUS::initialize</a>(dr_account, tc_account); <a href="XDX.md#0x1_XDX_initialize">XDX::initialize</a>(dr_account, tc_account); <a href="AccountFreezing.md#0x1_AccountFreezing_initialize">AccountFreezing::initialize</a>(dr_account); <a href="TransactionFee.md#0x1_TransactionFee_initialize">TransactionFee::initialize</a>(tc_account); <a href="DiemSystem.md#0x1_DiemSystem_initialize_validator_set">DiemSystem::initialize_validator_set</a>(dr_account); <a href="DiemVersion.md#0x1_DiemVersion_initialize">DiemVersion::initialize</a>(dr_account, initial_diem_version); <a href="DualAttestation.md#0x1_DualAttestation_initialize">DualAttestation::initialize</a>(dr_account); <a href="DiemBlock.md#0x1_DiemBlock_initialize_block_metadata">DiemBlock::initialize_block_metadata</a>(dr_account); // Rotate auth keys for DiemRoot and TreasuryCompliance accounts to the given // values let dr_rotate_key_cap = <a href="DiemAccount.md#0x1_DiemAccount_extract_key_rotation_capability">DiemAccount::extract_key_rotation_capability</a>(dr_account); <a href="DiemAccount.md#0x1_DiemAccount_rotate_authentication_key">DiemAccount::rotate_authentication_key</a>(&dr_rotate_key_cap, dr_auth_key); <a href="DiemAccount.md#0x1_DiemAccount_restore_key_rotation_capability">DiemAccount::restore_key_rotation_capability</a>(dr_rotate_key_cap); let tc_rotate_key_cap = <a href="DiemAccount.md#0x1_DiemAccount_extract_key_rotation_capability">DiemAccount::extract_key_rotation_capability</a>(tc_account); <a href="DiemAccount.md#0x1_DiemAccount_rotate_authentication_key">DiemAccount::rotate_authentication_key</a>(&tc_rotate_key_cap, tc_auth_key); <a href="DiemAccount.md#0x1_DiemAccount_restore_key_rotation_capability">DiemAccount::restore_key_rotation_capability</a>(tc_rotate_key_cap); <a href="DiemTransactionPublishingOption.md#0x1_DiemTransactionPublishingOption_initialize">DiemTransactionPublishingOption::initialize</a>( dr_account, initial_script_allow_list, is_open_module, ); <a href="DiemVMConfig.md#0x1_DiemVMConfig_initialize">DiemVMConfig::initialize</a>( dr_account, instruction_schedule, native_schedule, ); // After we have called this function, all invariants which are guarded by // `<a href="DiemTimestamp.md#0x1_DiemTimestamp_is_operating">DiemTimestamp::is_operating</a>() ==> ...` will become active and a verification condition. // See also discussion at function specification. <a href="DiemTimestamp.md#0x1_DiemTimestamp_set_time_has_started">DiemTimestamp::set_time_has_started</a>(dr_account); } </code></pre> </details>

Function `create_initialize_owners_operators`

Sets up the initial validator set for the Diem network. The validator "owner" accounts, their UTF-8 names, and their authentication keys are encoded in the <code>owners</code>, <code>owner_names</code>, and <code>owner_auth_key</code> vectors. Each validator signs consensus messages with the private key corresponding to the Ed25519 public key in <code>consensus_pubkeys</code>. Each validator owner has its operation delegated to an "operator" (which may be the owner). The operators, their names, and their authentication keys are encoded in the <code>operators</code>, <code>operator_names</code>, and <code>operator_auth_keys</code> vectors. Finally, each validator must specify the network address (see diem/types/src/network_address/mod.rs) for itself and its full nodes.

<pre><code>fun <a href="Genesis.md#0x1_Genesis_create_initialize_owners_operators">create_initialize_owners_operators</a>(dr_account: signer, owners: vector<signer>, owner_names: vector<vector<u8>>, owner_auth_keys: vector<vector<u8>>, consensus_pubkeys: vector<vector<u8>>, operators: vector<signer>, operator_names: vector<vector<u8>>, operator_auth_keys: vector<vector<u8>>, validator_network_addresses: vector<vector<u8>>, full_node_network_addresses: vector<vector<u8>>) </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="Genesis.md#0x1_Genesis_create_initialize_owners_operators">create_initialize_owners_operators</a>( dr_account: signer, owners: vector<signer>, owner_names: vector<vector<u8>>, owner_auth_keys: vector<vector<u8>>, consensus_pubkeys: vector<vector<u8>>, operators: vector<signer>, operator_names: vector<vector<u8>>, operator_auth_keys: vector<vector<u8>>, validator_network_addresses: vector<vector<u8>>, full_node_network_addresses: vector<vector<u8>>, ) { let num_owners = <a href="../../../../../../move-stdlib/docs/Vector.md#0x1_Vector_length">Vector::length</a>(&owners); let num_owner_names = <a href="../../../../../../move-stdlib/docs/Vector.md#0x1_Vector_length">Vector::length</a>(&owner_names); assert(num_owners == num_owner_names, 0); let num_owner_keys = <a href="../../../../../../move-stdlib/docs/Vector.md#0x1_Vector_length">Vector::length</a>(&owner_auth_keys); assert(num_owner_names == num_owner_keys, 0); let num_operators = <a href="../../../../../../move-stdlib/docs/Vector.md#0x1_Vector_length">Vector::length</a>(&operators); assert(num_owner_keys == num_operators, 0); let num_operator_names = <a href="../../../../../../move-stdlib/docs/Vector.md#0x1_Vector_length">Vector::length</a>(&operator_names); assert(num_operators == num_operator_names, 0); let num_operator_keys = <a href="../../../../../../move-stdlib/docs/Vector.md#0x1_Vector_length">Vector::length</a>(&operator_auth_keys); assert(num_operator_names == num_operator_keys, 0); let num_validator_network_addresses = <a href="../../../../../../move-stdlib/docs/Vector.md#0x1_Vector_length">Vector::length</a>(&validator_network_addresses); assert(num_operator_keys == num_validator_network_addresses, 0); let num_full_node_network_addresses = <a href="../../../../../../move-stdlib/docs/Vector.md#0x1_Vector_length">Vector::length</a>(&full_node_network_addresses); assert(num_validator_network_addresses == num_full_node_network_addresses, 0); let i = 0; let dummy_auth_key_prefix = x"00000000000000000000000000000000"; while (i < num_owners) { let owner = <a href="../../../../../../move-stdlib/docs/Vector.md#0x1_Vector_borrow">Vector::borrow</a>(&owners, i); let owner_address = <a href="../../../../../../move-stdlib/docs/Signer.md#0x1_Signer_address_of">Signer::address_of</a>(owner); let owner_name = *<a href="../../../../../../move-stdlib/docs/Vector.md#0x1_Vector_borrow">Vector::borrow</a>(&owner_names, i); // create each validator account and rotate its auth key to the correct value <a href="DiemAccount.md#0x1_DiemAccount_create_validator_account">DiemAccount::create_validator_account</a>( &dr_account, owner_address, copy dummy_auth_key_prefix, owner_name ); let owner_auth_key = *<a href="../../../../../../move-stdlib/docs/Vector.md#0x1_Vector_borrow">Vector::borrow</a>(&owner_auth_keys, i); let rotation_cap = <a href="DiemAccount.md#0x1_DiemAccount_extract_key_rotation_capability">DiemAccount::extract_key_rotation_capability</a>(owner); <a href="DiemAccount.md#0x1_DiemAccount_rotate_authentication_key">DiemAccount::rotate_authentication_key</a>(&rotation_cap, owner_auth_key); <a href="DiemAccount.md#0x1_DiemAccount_restore_key_rotation_capability">DiemAccount::restore_key_rotation_capability</a>(rotation_cap); let operator = <a href="../../../../../../move-stdlib/docs/Vector.md#0x1_Vector_borrow">Vector::borrow</a>(&operators, i); let operator_address = <a href="../../../../../../move-stdlib/docs/Signer.md#0x1_Signer_address_of">Signer::address_of</a>(operator); let operator_name = *<a href="../../../../../../move-stdlib/docs/Vector.md#0x1_Vector_borrow">Vector::borrow</a>(&operator_names, i); // create the operator account + rotate its auth key if it does not already exist if (!<a href="DiemAccount.md#0x1_DiemAccount_exists_at">DiemAccount::exists_at</a>(operator_address)) { <a href="DiemAccount.md#0x1_DiemAccount_create_validator_operator_account">DiemAccount::create_validator_operator_account</a>( &dr_account, operator_address, copy dummy_auth_key_prefix, copy operator_name ); let operator_auth_key = *<a href="../../../../../../move-stdlib/docs/Vector.md#0x1_Vector_borrow">Vector::borrow</a>(&operator_auth_keys, i); let rotation_cap = <a href="DiemAccount.md#0x1_DiemAccount_extract_key_rotation_capability">DiemAccount::extract_key_rotation_capability</a>(operator); <a href="DiemAccount.md#0x1_DiemAccount_rotate_authentication_key">DiemAccount::rotate_authentication_key</a>(&rotation_cap, operator_auth_key); <a href="DiemAccount.md#0x1_DiemAccount_restore_key_rotation_capability">DiemAccount::restore_key_rotation_capability</a>(rotation_cap); }; // assign the operator to its validator assert(<a href="ValidatorOperatorConfig.md#0x1_ValidatorOperatorConfig_get_human_name">ValidatorOperatorConfig::get_human_name</a>(operator_address) == operator_name, 0); <a href="ValidatorConfig.md#0x1_ValidatorConfig_set_operator">ValidatorConfig::set_operator</a>(owner, operator_address); // use the operator account set up the validator config let validator_network_address = *<a href="../../../../../../move-stdlib/docs/Vector.md#0x1_Vector_borrow">Vector::borrow</a>(&validator_network_addresses, i); let full_node_network_address = *<a href="../../../../../../move-stdlib/docs/Vector.md#0x1_Vector_borrow">Vector::borrow</a>(&full_node_network_addresses, i); let consensus_pubkey = *<a href="../../../../../../move-stdlib/docs/Vector.md#0x1_Vector_borrow">Vector::borrow</a>(&consensus_pubkeys, i); <a href="ValidatorConfig.md#0x1_ValidatorConfig_set_config">ValidatorConfig::set_config</a>( operator, owner_address, consensus_pubkey, validator_network_address, full_node_network_address ); // finally, add this validator to the validator set <a href="DiemSystem.md#0x1_DiemSystem_add_validator">DiemSystem::add_validator</a>(&dr_account, owner_address); i = i + 1; } } </code></pre> </details>

Module `0x1::Genesis`

Module 0x1::Genesis

Function initialize

Function initialize_internal

Function create_initialize_owners_operators

Module `0x1::Genesis`

Function `initialize`

Function `initialize_internal`

Function `create_initialize_owners_operators`