From d70716fb154339f4db71ae05edf8064013327b29 Mon Sep 17 00:00:00 2001 From: 0o-de-lally <1364012+0o-de-lally@users.noreply.github.com> Date: Fri, 29 Oct 2021 13:28:47 -0400 Subject: [PATCH] Organize Docs (#787) * organizing documentation --- ol/documentation/README.md | 30 ++++++++++ ol/documentation/{ops => accounts}/autopay.md | 0 .../{ops => accounts}/community_wallets.md | 0 .../create_account_on_chain.md | 12 +--- .../create_validator_account_on_chain.md} | 23 -------- .../archived/install_4.3_release_binaries.md | 0 .../{ops => }/archived/node_reset.md | 0 .../archived/ops_migrate_from_sudo.md | 0 .../archived/stdlib_upgrade_payload.md | 0 .../{ops => }/archived/v4.3.0_upgrade.md | 0 .../{ops => }/archived/v4.3.1_upgrade.md | 0 .../{ops => }/archived/v4.3.2_upgrade.md | 0 .../{ops => }/archived/v4.3.3_upgrade.md | 0 ol/documentation/{ops => }/cli_cheatsheet.md | 0 .../connect_client_to_network.md | 0 .../query_account_state.md} | 10 ++-- ...Improve_Rust_compile_times_with_sccache.md | 0 .../{devs => core-devs}/OS_dependencies.md | 0 .../QA_onboarding_validator.md | 0 .../QA_release_testing_on_devnet.md | 0 .../{devs => core-devs}/ZKP_info.md | 0 .../archived/QA_chain_upgrade.md | 0 .../archived/genesis_v4_registration.md | 0 ol/documentation/{devs => core-devs}/ci.md | 0 .../{devs => core-devs}/debug_rust.md | 0 .../debugging_epoch_reconfiguration.md | 0 .../deploy_move_modules_using_diem_testnet.md | 0 .../{devs => core-devs}/e2e_upgrade_test.md | 0 .../{devs => core-devs}/error_codes.md | 0 .../{devs => core-devs}/faster_build_times.md | 0 .../getting_started_with_move_persistence.md | 0 .../{devs => core-devs}/help_and_helping.md | 0 .../how_to_pull_new_diem_code.md | 0 .../{devs => core-devs}/move-prover-guide.md | 0 .../provision_debug_net.md | 0 .../{devs => core-devs}/provision_dev_net.md | 0 .../{devs => core-devs}/setup_dev_env.md | 0 .../spec_for_upgrades_with_breaking_schema.md | 0 .../start_diem_node_for_testing.md | 0 .../stdlib_breaking_upgrades.md | 0 .../stdlib_complile_and_test_fixtures.md} | 4 +- .../{devs => core-devs}/swarm_qa_tools.md | 0 .../{devs => core-devs}/testing_OL.md | 0 .../testing_chain_upgrades.md | 0 .../versioning_semantics.md | 0 ...ting_and_using_native_functions_in_move.md | 0 ...iting_and_publishing_thirdparty_modules.md | 0 .../stdlib_hot_upgrade.md | 0 .../cli_configs.md} | 0 .../{ops => node-ops}/start_a_full_node.md | 14 ++++- .../syncing_your_node.md} | 3 - .../tower_mining_VDF_proofs.md} | 4 +- ...ron_job_setup_for_validator_node_status.md | 0 .../node_falls_out_of_validator_set.md} | 0 .../validators}/node_statistics.md | 0 .../validators}/resetting_val_configs.md | 0 .../validators}/rust-config-output.png | Bin .../validators}/troubleshoting_onboarding.md | 0 .../update_validator_to_operator_mapping.md | 0 .../validators/validator_daemon_configs.md} | 35 ------------ .../validator_onboarding_easy_mode.md} | 0 .../validator_onboarding_hard_mode.md} | 5 +- .../web_monitor_account_dictionary.md | 0 .../ops/stdlib_upgrade_payload.md | 53 ------------------ ol/documentation/roadmap.md | 24 ++++---- 65 files changed, 69 insertions(+), 148 deletions(-) create mode 100644 ol/documentation/README.md rename ol/documentation/{ops => accounts}/autopay.md (100%) rename ol/documentation/{ops => accounts}/community_wallets.md (100%) rename ol/documentation/{create_accounts => accounts}/create_account_on_chain.md (87%) rename ol/documentation/{ops/create_account_on_chain.md => accounts/create_validator_account_on_chain.md} (68%) rename ol/documentation/{ops => }/archived/install_4.3_release_binaries.md (100%) rename ol/documentation/{ops => }/archived/node_reset.md (100%) rename ol/documentation/{ops => }/archived/ops_migrate_from_sudo.md (100%) rename ol/documentation/{ops => }/archived/stdlib_upgrade_payload.md (100%) rename ol/documentation/{ops => }/archived/v4.3.0_upgrade.md (100%) rename ol/documentation/{ops => }/archived/v4.3.1_upgrade.md (100%) rename ol/documentation/{ops => }/archived/v4.3.2_upgrade.md (100%) rename ol/documentation/{ops => }/archived/v4.3.3_upgrade.md (100%) rename ol/documentation/{ops => }/cli_cheatsheet.md (100%) rename ol/documentation/{ops => client}/connect_client_to_network.md (100%) rename ol/documentation/{ops/debugging_account_state.md => client/query_account_state.md} (90%) rename ol/documentation/{devs => core-devs}/Improve_Rust_compile_times_with_sccache.md (100%) rename ol/documentation/{devs => core-devs}/OS_dependencies.md (100%) rename ol/documentation/{devs => core-devs}/QA_onboarding_validator.md (100%) rename ol/documentation/{devs => core-devs}/QA_release_testing_on_devnet.md (100%) rename ol/documentation/{devs => core-devs}/ZKP_info.md (100%) rename ol/documentation/{devs => core-devs}/archived/QA_chain_upgrade.md (100%) rename ol/documentation/{devs => core-devs}/archived/genesis_v4_registration.md (100%) rename ol/documentation/{devs => core-devs}/ci.md (100%) rename ol/documentation/{devs => core-devs}/debug_rust.md (100%) rename ol/documentation/{devs => core-devs}/debugging_epoch_reconfiguration.md (100%) rename ol/documentation/{devs => core-devs}/deploy_move_modules_using_diem_testnet.md (100%) rename ol/documentation/{devs => core-devs}/e2e_upgrade_test.md (100%) rename ol/documentation/{devs => core-devs}/error_codes.md (100%) rename ol/documentation/{devs => core-devs}/faster_build_times.md (100%) rename ol/documentation/{devs => core-devs}/getting_started_with_move_persistence.md (100%) rename ol/documentation/{devs => core-devs}/help_and_helping.md (100%) rename ol/documentation/{devs => core-devs}/how_to_pull_new_diem_code.md (100%) rename ol/documentation/{devs => core-devs}/move-prover-guide.md (100%) rename ol/documentation/{devs => core-devs}/provision_debug_net.md (100%) rename ol/documentation/{devs => core-devs}/provision_dev_net.md (100%) rename ol/documentation/{devs => core-devs}/setup_dev_env.md (100%) rename ol/documentation/{devs => core-devs}/spec_for_upgrades_with_breaking_schema.md (100%) rename ol/documentation/{devs => core-devs}/start_diem_node_for_testing.md (100%) rename ol/documentation/{devs => core-devs}/stdlib_breaking_upgrades.md (100%) rename ol/documentation/{stdlib_upgrade_payload_v5.md => core-devs/stdlib_complile_and_test_fixtures.md} (98%) rename ol/documentation/{devs => core-devs}/swarm_qa_tools.md (100%) rename ol/documentation/{devs => core-devs}/testing_OL.md (100%) rename ol/documentation/{devs => core-devs}/testing_chain_upgrades.md (100%) rename ol/documentation/{devs => core-devs}/versioning_semantics.md (100%) rename ol/documentation/{devs => core-devs}/writing_and_using_native_functions_in_move.md (100%) rename ol/documentation/{ => move-dev}/writing_and_publishing_thirdparty_modules.md (100%) rename ol/documentation/{ops => network-upgrades}/stdlib_hot_upgrade.md (100%) rename ol/documentation/{ops/offline_app_configs.md => node-ops/cli_configs.md} (100%) rename ol/documentation/{ops => node-ops}/start_a_full_node.md (83%) rename ol/documentation/{ops/syncing_from_an_advanced_waypoint.md => node-ops/syncing_your_node.md} (99%) rename ol/documentation/{ops/mining_VDF_proofs.md => node-ops/tower_mining_VDF_proofs.md} (96%) rename ol/documentation/{ops => node-ops/validators}/cron_job_setup_for_validator_node_status.md (100%) rename ol/documentation/{ops/recover_validator_if_it_stops_mining_and_falls_out_of_validator_set.md => node-ops/validators/node_falls_out_of_validator_set.md} (100%) rename ol/documentation/{ops => node-ops/validators}/node_statistics.md (100%) rename ol/documentation/{ops => node-ops/validators}/resetting_val_configs.md (100%) rename ol/documentation/{ops => node-ops/validators}/rust-config-output.png (100%) rename ol/documentation/{ops => node-ops/validators}/troubleshoting_onboarding.md (100%) rename ol/documentation/{ops => node-ops/validators}/update_validator_to_operator_mapping.md (100%) rename ol/documentation/{ops/validator_deamon_configs.md => node-ops/validators/validator_daemon_configs.md} (75%) rename ol/documentation/{ops/validator_onboarding_guide_easy_mode.md => node-ops/validators/validator_onboarding_easy_mode.md} (100%) rename ol/documentation/{ops/validator_setup.md => node-ops/validators/validator_onboarding_hard_mode.md} (99%) rename ol/documentation/{ops => node-ops/validators}/web_monitor_account_dictionary.md (100%) delete mode 100644 ol/documentation/ops/stdlib_upgrade_payload.md diff --git a/ol/documentation/README.md b/ol/documentation/README.md new file mode 100644 index 0000000000..7894997b9e --- /dev/null +++ b/ol/documentation/README.md @@ -0,0 +1,30 @@ +# 0L Documentation +## CLI +[CLI Cheatsheet](cli_cheatsheet.md) + +## Running Tower, i.e Mining. + +[Start Tower app](node-ops/tower_mining_VDF_proofs.md) + +## Syncing your node +[Sync your node from to an advanced epoch](node-ops/syncing_your_node.md) + +## Fullnode Operations +[Starting a Fullnode](node-ops/start_a_full_node.md) + +## Validator Node Operations +[Onboard a validator node - easy mode](node-ops/validators/validator_onboarding_easy_mode.md) + +[Onboard a validator node - hard mode](node-ops/validators/validator_onboarding_hard_mode.md) + +[Run diem-node as daemon](node-ops/validators/validator_daemon_configs.md) + +[Troubleshooting Onboarding](node-ops/validators/troubleshoting_onboarding.md) + +[What to do when your node falls out of validator set](node-ops/validators/node_falls_out_of_validator_set.md) + +[update_validator_to_operator_mapping.md](node-ops/validators/update_validator_to_operator_mapping.md) + +# Network Upgrades + +[Hot network upgrades](network-upgrades/stdlib_hot_upgrade.md) \ No newline at end of file diff --git a/ol/documentation/ops/autopay.md b/ol/documentation/accounts/autopay.md similarity index 100% rename from ol/documentation/ops/autopay.md rename to ol/documentation/accounts/autopay.md diff --git a/ol/documentation/ops/community_wallets.md b/ol/documentation/accounts/community_wallets.md similarity index 100% rename from ol/documentation/ops/community_wallets.md rename to ol/documentation/accounts/community_wallets.md diff --git a/ol/documentation/create_accounts/create_account_on_chain.md b/ol/documentation/accounts/create_account_on_chain.md similarity index 87% rename from ol/documentation/create_accounts/create_account_on_chain.md rename to ol/documentation/accounts/create_account_on_chain.md index 4ebc362701..a09aa0453f 100644 --- a/ol/documentation/create_accounts/create_account_on_chain.md +++ b/ol/documentation/accounts/create_account_on_chain.md @@ -15,10 +15,6 @@ Alice: # if you don't have a mnemonic onboard keygen -#if you ALREADY have a mnemonic buy you need to discover your Auth Key. Find out with: -onboard keygen -w ->enter the mnemonic - # send your `auth key` to Bob so he can complete tx ``` @@ -30,7 +26,7 @@ Needs to send a minimum of 1 GAS coin so that Alice's account gets created. txs create-user -a -c # check that the account was created: -ol -a query --balance +ol query --balance -a ``` ## Alice: Create account configurations @@ -47,9 +43,6 @@ If you already have a mnemonic, and misplaced your account `address` or `authent # use keygen with --whoami, or -w onboard keygen -whoami -> enter your mnemonic now - -# you will see the print out of account and authkey ``` ## Alice: tell Bob your authkey @@ -62,12 +55,13 @@ Send the onboarding transaction txs create-user -a -c ``` + ## Alice or Bob: Confirm the account was created If the account creation was successful anyone should be able to see Alice's balance (of 1 GAS) with the following command. ``` -ol -a query --balance +ol query --balance -a ``` ## Alice: Set Slow Wallet, or Community Wallet diff --git a/ol/documentation/ops/create_account_on_chain.md b/ol/documentation/accounts/create_validator_account_on_chain.md similarity index 68% rename from ol/documentation/ops/create_account_on_chain.md rename to ol/documentation/accounts/create_validator_account_on_chain.md index 86a00436a7..e6f95a11d5 100644 --- a/ol/documentation/ops/create_account_on_chain.md +++ b/ol/documentation/accounts/create_validator_account_on_chain.md @@ -24,26 +24,3 @@ If it is not reachable, the `file` option below is possible. If there is an issue with sequence_number being out of sync. It's like that an automated transaction (like `tower`), got a transaction sent concurrently. Retry the transaction. - -## With file: - -a. Copy the `account.json` to your local node. - -b. Sumbit tx with `txs` app: - -``` -txs create-validator -f -``` - - -# New End User Accounts - -## With file: - -a. Copy the `account.json` to your local node. - -b. Sumbit tx with `txs` app: - -``` -txs create-user -f -``` \ No newline at end of file diff --git a/ol/documentation/ops/archived/install_4.3_release_binaries.md b/ol/documentation/archived/install_4.3_release_binaries.md similarity index 100% rename from ol/documentation/ops/archived/install_4.3_release_binaries.md rename to ol/documentation/archived/install_4.3_release_binaries.md diff --git a/ol/documentation/ops/archived/node_reset.md b/ol/documentation/archived/node_reset.md similarity index 100% rename from ol/documentation/ops/archived/node_reset.md rename to ol/documentation/archived/node_reset.md diff --git a/ol/documentation/ops/archived/ops_migrate_from_sudo.md b/ol/documentation/archived/ops_migrate_from_sudo.md similarity index 100% rename from ol/documentation/ops/archived/ops_migrate_from_sudo.md rename to ol/documentation/archived/ops_migrate_from_sudo.md diff --git a/ol/documentation/ops/archived/stdlib_upgrade_payload.md b/ol/documentation/archived/stdlib_upgrade_payload.md similarity index 100% rename from ol/documentation/ops/archived/stdlib_upgrade_payload.md rename to ol/documentation/archived/stdlib_upgrade_payload.md diff --git a/ol/documentation/ops/archived/v4.3.0_upgrade.md b/ol/documentation/archived/v4.3.0_upgrade.md similarity index 100% rename from ol/documentation/ops/archived/v4.3.0_upgrade.md rename to ol/documentation/archived/v4.3.0_upgrade.md diff --git a/ol/documentation/ops/archived/v4.3.1_upgrade.md b/ol/documentation/archived/v4.3.1_upgrade.md similarity index 100% rename from ol/documentation/ops/archived/v4.3.1_upgrade.md rename to ol/documentation/archived/v4.3.1_upgrade.md diff --git a/ol/documentation/ops/archived/v4.3.2_upgrade.md b/ol/documentation/archived/v4.3.2_upgrade.md similarity index 100% rename from ol/documentation/ops/archived/v4.3.2_upgrade.md rename to ol/documentation/archived/v4.3.2_upgrade.md diff --git a/ol/documentation/ops/archived/v4.3.3_upgrade.md b/ol/documentation/archived/v4.3.3_upgrade.md similarity index 100% rename from ol/documentation/ops/archived/v4.3.3_upgrade.md rename to ol/documentation/archived/v4.3.3_upgrade.md diff --git a/ol/documentation/ops/cli_cheatsheet.md b/ol/documentation/cli_cheatsheet.md similarity index 100% rename from ol/documentation/ops/cli_cheatsheet.md rename to ol/documentation/cli_cheatsheet.md diff --git a/ol/documentation/ops/connect_client_to_network.md b/ol/documentation/client/connect_client_to_network.md similarity index 100% rename from ol/documentation/ops/connect_client_to_network.md rename to ol/documentation/client/connect_client_to_network.md diff --git a/ol/documentation/ops/debugging_account_state.md b/ol/documentation/client/query_account_state.md similarity index 90% rename from ol/documentation/ops/debugging_account_state.md rename to ol/documentation/client/query_account_state.md index 7322f641cc..b0f8ec1411 100644 --- a/ol/documentation/ops/debugging_account_state.md +++ b/ol/documentation/client/query_account_state.md @@ -1,15 +1,15 @@ # Debugging Account state and balances -Use libra client with +Use the "toy" client with ``` cargo run --bin cli -- -u http://localhost: --waypoint ``` -Note the `auth_key` of the tower app in question. +Note the `account` of the tower app in question. Then in the libra shell: ``` -query account_state +query account_state ``` and you will see a result like this: @@ -76,7 +76,9 @@ Latest account state is: "00000000000000005942d356f114089d4a46f2f3b0b15b52", ), delegated_key_rotation_capability: false, - delegated_withdrawal_capability: false, + delegated_wi + + thdrawal_capability: false, role: Empty, }, ) diff --git a/ol/documentation/devs/Improve_Rust_compile_times_with_sccache.md b/ol/documentation/core-devs/Improve_Rust_compile_times_with_sccache.md similarity index 100% rename from ol/documentation/devs/Improve_Rust_compile_times_with_sccache.md rename to ol/documentation/core-devs/Improve_Rust_compile_times_with_sccache.md diff --git a/ol/documentation/devs/OS_dependencies.md b/ol/documentation/core-devs/OS_dependencies.md similarity index 100% rename from ol/documentation/devs/OS_dependencies.md rename to ol/documentation/core-devs/OS_dependencies.md diff --git a/ol/documentation/devs/QA_onboarding_validator.md b/ol/documentation/core-devs/QA_onboarding_validator.md similarity index 100% rename from ol/documentation/devs/QA_onboarding_validator.md rename to ol/documentation/core-devs/QA_onboarding_validator.md diff --git a/ol/documentation/devs/QA_release_testing_on_devnet.md b/ol/documentation/core-devs/QA_release_testing_on_devnet.md similarity index 100% rename from ol/documentation/devs/QA_release_testing_on_devnet.md rename to ol/documentation/core-devs/QA_release_testing_on_devnet.md diff --git a/ol/documentation/devs/ZKP_info.md b/ol/documentation/core-devs/ZKP_info.md similarity index 100% rename from ol/documentation/devs/ZKP_info.md rename to ol/documentation/core-devs/ZKP_info.md diff --git a/ol/documentation/devs/archived/QA_chain_upgrade.md b/ol/documentation/core-devs/archived/QA_chain_upgrade.md similarity index 100% rename from ol/documentation/devs/archived/QA_chain_upgrade.md rename to ol/documentation/core-devs/archived/QA_chain_upgrade.md diff --git a/ol/documentation/devs/archived/genesis_v4_registration.md b/ol/documentation/core-devs/archived/genesis_v4_registration.md similarity index 100% rename from ol/documentation/devs/archived/genesis_v4_registration.md rename to ol/documentation/core-devs/archived/genesis_v4_registration.md diff --git a/ol/documentation/devs/ci.md b/ol/documentation/core-devs/ci.md similarity index 100% rename from ol/documentation/devs/ci.md rename to ol/documentation/core-devs/ci.md diff --git a/ol/documentation/devs/debug_rust.md b/ol/documentation/core-devs/debug_rust.md similarity index 100% rename from ol/documentation/devs/debug_rust.md rename to ol/documentation/core-devs/debug_rust.md diff --git a/ol/documentation/devs/debugging_epoch_reconfiguration.md b/ol/documentation/core-devs/debugging_epoch_reconfiguration.md similarity index 100% rename from ol/documentation/devs/debugging_epoch_reconfiguration.md rename to ol/documentation/core-devs/debugging_epoch_reconfiguration.md diff --git a/ol/documentation/devs/deploy_move_modules_using_diem_testnet.md b/ol/documentation/core-devs/deploy_move_modules_using_diem_testnet.md similarity index 100% rename from ol/documentation/devs/deploy_move_modules_using_diem_testnet.md rename to ol/documentation/core-devs/deploy_move_modules_using_diem_testnet.md diff --git a/ol/documentation/devs/e2e_upgrade_test.md b/ol/documentation/core-devs/e2e_upgrade_test.md similarity index 100% rename from ol/documentation/devs/e2e_upgrade_test.md rename to ol/documentation/core-devs/e2e_upgrade_test.md diff --git a/ol/documentation/devs/error_codes.md b/ol/documentation/core-devs/error_codes.md similarity index 100% rename from ol/documentation/devs/error_codes.md rename to ol/documentation/core-devs/error_codes.md diff --git a/ol/documentation/devs/faster_build_times.md b/ol/documentation/core-devs/faster_build_times.md similarity index 100% rename from ol/documentation/devs/faster_build_times.md rename to ol/documentation/core-devs/faster_build_times.md diff --git a/ol/documentation/devs/getting_started_with_move_persistence.md b/ol/documentation/core-devs/getting_started_with_move_persistence.md similarity index 100% rename from ol/documentation/devs/getting_started_with_move_persistence.md rename to ol/documentation/core-devs/getting_started_with_move_persistence.md diff --git a/ol/documentation/devs/help_and_helping.md b/ol/documentation/core-devs/help_and_helping.md similarity index 100% rename from ol/documentation/devs/help_and_helping.md rename to ol/documentation/core-devs/help_and_helping.md diff --git a/ol/documentation/devs/how_to_pull_new_diem_code.md b/ol/documentation/core-devs/how_to_pull_new_diem_code.md similarity index 100% rename from ol/documentation/devs/how_to_pull_new_diem_code.md rename to ol/documentation/core-devs/how_to_pull_new_diem_code.md diff --git a/ol/documentation/devs/move-prover-guide.md b/ol/documentation/core-devs/move-prover-guide.md similarity index 100% rename from ol/documentation/devs/move-prover-guide.md rename to ol/documentation/core-devs/move-prover-guide.md diff --git a/ol/documentation/devs/provision_debug_net.md b/ol/documentation/core-devs/provision_debug_net.md similarity index 100% rename from ol/documentation/devs/provision_debug_net.md rename to ol/documentation/core-devs/provision_debug_net.md diff --git a/ol/documentation/devs/provision_dev_net.md b/ol/documentation/core-devs/provision_dev_net.md similarity index 100% rename from ol/documentation/devs/provision_dev_net.md rename to ol/documentation/core-devs/provision_dev_net.md diff --git a/ol/documentation/devs/setup_dev_env.md b/ol/documentation/core-devs/setup_dev_env.md similarity index 100% rename from ol/documentation/devs/setup_dev_env.md rename to ol/documentation/core-devs/setup_dev_env.md diff --git a/ol/documentation/devs/spec_for_upgrades_with_breaking_schema.md b/ol/documentation/core-devs/spec_for_upgrades_with_breaking_schema.md similarity index 100% rename from ol/documentation/devs/spec_for_upgrades_with_breaking_schema.md rename to ol/documentation/core-devs/spec_for_upgrades_with_breaking_schema.md diff --git a/ol/documentation/devs/start_diem_node_for_testing.md b/ol/documentation/core-devs/start_diem_node_for_testing.md similarity index 100% rename from ol/documentation/devs/start_diem_node_for_testing.md rename to ol/documentation/core-devs/start_diem_node_for_testing.md diff --git a/ol/documentation/devs/stdlib_breaking_upgrades.md b/ol/documentation/core-devs/stdlib_breaking_upgrades.md similarity index 100% rename from ol/documentation/devs/stdlib_breaking_upgrades.md rename to ol/documentation/core-devs/stdlib_breaking_upgrades.md diff --git a/ol/documentation/stdlib_upgrade_payload_v5.md b/ol/documentation/core-devs/stdlib_complile_and_test_fixtures.md similarity index 98% rename from ol/documentation/stdlib_upgrade_payload_v5.md rename to ol/documentation/core-devs/stdlib_complile_and_test_fixtures.md index 618d39b461..bd344b161b 100644 --- a/ol/documentation/stdlib_upgrade_payload_v5.md +++ b/ol/documentation/core-devs/stdlib_complile_and_test_fixtures.md @@ -1,4 +1,6 @@ -# Stdlib Upgrade payload (v5) +# Stdlib Compilation and Fixtures + + ## Hot Upgrades for production diff --git a/ol/documentation/devs/swarm_qa_tools.md b/ol/documentation/core-devs/swarm_qa_tools.md similarity index 100% rename from ol/documentation/devs/swarm_qa_tools.md rename to ol/documentation/core-devs/swarm_qa_tools.md diff --git a/ol/documentation/devs/testing_OL.md b/ol/documentation/core-devs/testing_OL.md similarity index 100% rename from ol/documentation/devs/testing_OL.md rename to ol/documentation/core-devs/testing_OL.md diff --git a/ol/documentation/devs/testing_chain_upgrades.md b/ol/documentation/core-devs/testing_chain_upgrades.md similarity index 100% rename from ol/documentation/devs/testing_chain_upgrades.md rename to ol/documentation/core-devs/testing_chain_upgrades.md diff --git a/ol/documentation/devs/versioning_semantics.md b/ol/documentation/core-devs/versioning_semantics.md similarity index 100% rename from ol/documentation/devs/versioning_semantics.md rename to ol/documentation/core-devs/versioning_semantics.md diff --git a/ol/documentation/devs/writing_and_using_native_functions_in_move.md b/ol/documentation/core-devs/writing_and_using_native_functions_in_move.md similarity index 100% rename from ol/documentation/devs/writing_and_using_native_functions_in_move.md rename to ol/documentation/core-devs/writing_and_using_native_functions_in_move.md diff --git a/ol/documentation/writing_and_publishing_thirdparty_modules.md b/ol/documentation/move-dev/writing_and_publishing_thirdparty_modules.md similarity index 100% rename from ol/documentation/writing_and_publishing_thirdparty_modules.md rename to ol/documentation/move-dev/writing_and_publishing_thirdparty_modules.md diff --git a/ol/documentation/ops/stdlib_hot_upgrade.md b/ol/documentation/network-upgrades/stdlib_hot_upgrade.md similarity index 100% rename from ol/documentation/ops/stdlib_hot_upgrade.md rename to ol/documentation/network-upgrades/stdlib_hot_upgrade.md diff --git a/ol/documentation/ops/offline_app_configs.md b/ol/documentation/node-ops/cli_configs.md similarity index 100% rename from ol/documentation/ops/offline_app_configs.md rename to ol/documentation/node-ops/cli_configs.md diff --git a/ol/documentation/ops/start_a_full_node.md b/ol/documentation/node-ops/start_a_full_node.md similarity index 83% rename from ol/documentation/ops/start_a_full_node.md rename to ol/documentation/node-ops/start_a_full_node.md index aea6743f7a..a1e069b8fc 100644 --- a/ol/documentation/ops/start_a_full_node.md +++ b/ol/documentation/node-ops/start_a_full_node.md @@ -16,13 +16,21 @@ These instructions target Ubuntu. 1.4. Config dependencies: -`cd && . ol/util/setup.sh` +``` +cd + +. ol/util/setup.sh` +``` For more details: (../devs/OS_dependencies.md) 1.5. Build the source and install binaries: -`cd && make bins` +``` +cd + +make bins install +``` ## 2. Catch-up to the network state, with a `fullnode` @@ -32,4 +40,4 @@ You do not need an account for this step, you are simply syncing the database. 2.2. `diem-node --config $HOME/.0L/fullnode.node.yaml` -**You can start the next steps while your node is catching up** +More details in: [syncing_your_node.md](syncing_your_node.md) \ No newline at end of file diff --git a/ol/documentation/ops/syncing_from_an_advanced_waypoint.md b/ol/documentation/node-ops/syncing_your_node.md similarity index 99% rename from ol/documentation/ops/syncing_from_an_advanced_waypoint.md rename to ol/documentation/node-ops/syncing_your_node.md index 80afb05167..06a3ba6d33 100644 --- a/ol/documentation/ops/syncing_from_an_advanced_waypoint.md +++ b/ol/documentation/node-ops/syncing_your_node.md @@ -49,9 +49,6 @@ Restore a specific epoch ol restore --epoch ``` - -`` - ## Hard Mode: If you are not using the `ol` tools ### Restore Epoch Waypoint diff --git a/ol/documentation/ops/mining_VDF_proofs.md b/ol/documentation/node-ops/tower_mining_VDF_proofs.md similarity index 96% rename from ol/documentation/ops/mining_VDF_proofs.md rename to ol/documentation/node-ops/tower_mining_VDF_proofs.md index b572ef3157..6c937adf8e 100644 --- a/ol/documentation/ops/mining_VDF_proofs.md +++ b/ol/documentation/node-ops/tower_mining_VDF_proofs.md @@ -1,10 +1,10 @@ -# Mining VDF proofs +# Running Tower: ie. Mining VDF proofs These instructions are to run the 0L `tower` app. This creates VDF proof of work, and submits to the chain sequentially. This documentation uses screen as terminal multiplexer, sure you can also use tmux or run it in a normal terminal session. -## Start a `screen` instance +## Start a `screen` or `tmux` instance Make `screen` work for backgrounding and resuming sessions: ``` diff --git a/ol/documentation/ops/cron_job_setup_for_validator_node_status.md b/ol/documentation/node-ops/validators/cron_job_setup_for_validator_node_status.md similarity index 100% rename from ol/documentation/ops/cron_job_setup_for_validator_node_status.md rename to ol/documentation/node-ops/validators/cron_job_setup_for_validator_node_status.md diff --git a/ol/documentation/ops/recover_validator_if_it_stops_mining_and_falls_out_of_validator_set.md b/ol/documentation/node-ops/validators/node_falls_out_of_validator_set.md similarity index 100% rename from ol/documentation/ops/recover_validator_if_it_stops_mining_and_falls_out_of_validator_set.md rename to ol/documentation/node-ops/validators/node_falls_out_of_validator_set.md diff --git a/ol/documentation/ops/node_statistics.md b/ol/documentation/node-ops/validators/node_statistics.md similarity index 100% rename from ol/documentation/ops/node_statistics.md rename to ol/documentation/node-ops/validators/node_statistics.md diff --git a/ol/documentation/ops/resetting_val_configs.md b/ol/documentation/node-ops/validators/resetting_val_configs.md similarity index 100% rename from ol/documentation/ops/resetting_val_configs.md rename to ol/documentation/node-ops/validators/resetting_val_configs.md diff --git a/ol/documentation/ops/rust-config-output.png b/ol/documentation/node-ops/validators/rust-config-output.png similarity index 100% rename from ol/documentation/ops/rust-config-output.png rename to ol/documentation/node-ops/validators/rust-config-output.png diff --git a/ol/documentation/ops/troubleshoting_onboarding.md b/ol/documentation/node-ops/validators/troubleshoting_onboarding.md similarity index 100% rename from ol/documentation/ops/troubleshoting_onboarding.md rename to ol/documentation/node-ops/validators/troubleshoting_onboarding.md diff --git a/ol/documentation/ops/update_validator_to_operator_mapping.md b/ol/documentation/node-ops/validators/update_validator_to_operator_mapping.md similarity index 100% rename from ol/documentation/ops/update_validator_to_operator_mapping.md rename to ol/documentation/node-ops/validators/update_validator_to_operator_mapping.md diff --git a/ol/documentation/ops/validator_deamon_configs.md b/ol/documentation/node-ops/validators/validator_daemon_configs.md similarity index 75% rename from ol/documentation/ops/validator_deamon_configs.md rename to ol/documentation/node-ops/validators/validator_daemon_configs.md index 7f328760d3..68697885d1 100644 --- a/ol/documentation/ops/validator_deamon_configs.md +++ b/ol/documentation/node-ops/validators/validator_daemon_configs.md @@ -1,9 +1,5 @@ # Running 0L validator as a system service -<<<<<<< HEAD -This guide will create a daemon service which runs a `diem-node` and restarts on failure and on reboot. -======= This guide will create a daemon service which runs `diem-node` and restarts on failure and on reboot. ->>>>>>> 4d472361166d7f7fa816b02bb0002d3858d68390 Note that this guide: - targets Ubuntu 20.4. @@ -23,11 +19,7 @@ There are a few file paths you will be working from: This will use a `make` recipe to start the node daemon and install the daemon configs. -<<<<<<< HEAD First. Copy a template for systemd from `/util/diem-node.system` into your 0L home path, usually `~/.0L`. This is non-root template file needs to be edited: replace occurrences of `<>` with the username under which the service will run. -======= -First. Copy a template for systemd from `/util/diem-node.system.template` into your 0L home path, usually `~/.0L`. There are two templates for running as `root` or with a `user`. Note that the non-root template file needs to be edited: replace occurrences of `[USER]` with the username under which the service will run. ->>>>>>> 4d472361166d7f7fa816b02bb0002d3858d68390 BEFORE PROCEEDING: Check you have `~/.0L/diem-node.system` in place and edited with your usename. @@ -40,44 +32,21 @@ From the project root: # Slow Start ## Build binaries and copy to appropriate path -<<<<<<< HEAD Use `make bins install` or alternatively: ## Create the service configurations for Systemd In `~/.config/systemd/user/` you should create a file like this. (Note: again, `make daemon` does this for you) -======= -Use `make bins` - -## Validator Wizard - -If your config files have not been created or misplaced run: -`cargo run -p tower -- val-wizard` - -## Create the service configurations for Systemd -cd /lib/systemd/system/ -vim diem-node.service ->>>>>>> 4d472361166d7f7fa816b02bb0002d3858d68390 ``` # edit this document and replace <> with your linux user [Unit] -<<<<<<< HEAD Description=0L Node Service [Service] LimitNOFILE=20000 WorkingDirectory=/home/node/.0L ExecStart=/home/node/bin/diem-node --config /home/node/.0L/validator.node.yaml -======= -Description=Diem Node Service - -[Service] -#File descriptors frequently run out -LimitNOFILE=65536 -WorkingDirectory=/root/.0L -ExecStart=/usr/local/bin/diem-node --config /root/.0L/node.yaml ->>>>>>> 4d472361166d7f7fa816b02bb0002d3858d68390 Restart=always RestartSec=10s @@ -89,10 +58,6 @@ StandardError=file:/home/node/logs/node.log [Install] WantedBy=multi-user.target Alias=diem-node.service -<<<<<<< HEAD - -======= ->>>>>>> 4d472361166d7f7fa816b02bb0002d3858d68390 ``` ### NOTE: When you update any `*service` file, you must reload `ststemctl` `systemctl daemon-reload` diff --git a/ol/documentation/ops/validator_onboarding_guide_easy_mode.md b/ol/documentation/node-ops/validators/validator_onboarding_easy_mode.md similarity index 100% rename from ol/documentation/ops/validator_onboarding_guide_easy_mode.md rename to ol/documentation/node-ops/validators/validator_onboarding_easy_mode.md diff --git a/ol/documentation/ops/validator_setup.md b/ol/documentation/node-ops/validators/validator_onboarding_hard_mode.md similarity index 99% rename from ol/documentation/ops/validator_setup.md rename to ol/documentation/node-ops/validators/validator_onboarding_hard_mode.md index f3d6473f5e..ddf3c2f7c1 100644 --- a/ol/documentation/ops/validator_setup.md +++ b/ol/documentation/node-ops/validators/validator_onboarding_hard_mode.md @@ -1,6 +1,4 @@ # Validator Setup - - ## Requirements - A unix host machine, e.g Linux Ubuntu 20.4 - A fixed IP address of the machine @@ -133,7 +131,8 @@ ol restore **note**: temporarily: as of v4.2.8 you'll need to increase your host's file descriptors. Fix is in the works. For now: run this before starting your `tmux` session. ``` -# increase file descriptors +# increase file d +escriptors ulimit -n 100000 # check that they have been increased ulimit -n diff --git a/ol/documentation/ops/web_monitor_account_dictionary.md b/ol/documentation/node-ops/validators/web_monitor_account_dictionary.md similarity index 100% rename from ol/documentation/ops/web_monitor_account_dictionary.md rename to ol/documentation/node-ops/validators/web_monitor_account_dictionary.md diff --git a/ol/documentation/ops/stdlib_upgrade_payload.md b/ol/documentation/ops/stdlib_upgrade_payload.md deleted file mode 100644 index b36080eb54..0000000000 --- a/ol/documentation/ops/stdlib_upgrade_payload.md +++ /dev/null @@ -1,53 +0,0 @@ -# Stdlib Upgrade payload (v5) - -## Hot Upgrades for production - -Generate a stdlib file which can be used in the Upgrade Oracle. - -#### 1. Run the stdlib build. - -You need a newly compiled stdlib, otherwise you risk using stale code. - - `ol/util/build-stdlib.sh` - -#### 2. Create a concatenated stdlib.mv file. - -`ol/util/create-upgrade-payload.sh` - -- this should write a stdlib file to `language/stdlib/staged/stdlib.mv` - - -## e2e Testing - -`cargo test -p language-e2e-testsuite -- --nocapture test_successful_upgrade_txs` - -The e2e test simulates the oracle process, by updating the stdlib to include a new function, foo(). - -**Note:** -The following steps are required when there is a major change in move-stdlib or Move lang etc.. (e.g. upgrade to new diem-core version). Otherwise, this test expected to pass without any code/file change. - -### Generate fixtures. -On every major Stdlib refactor (including renaming of *resource structs*), new fixtures for e2e tests need to be generated. -The main fixtures is a `fixture_upgraded_stdlib.mv`. -The important feature of this file is that it is essentially identical to the stdlib (in development) with one exception, it contains a function foo() which is only located in it. - -1. - Uncomment the code at the end of Upgrade.move, which includes foo(). - - Remove .e2e extension of `language/diem-framework/modules/0L_transaction_scripts/ol_e2e_test_upgrade_foo_tx.move.e2e`. - -2. Build stdlib: `ol/util/build-stdlib.sh` - -3. Create a concatenated stdlib.mv file: `ol/util/create-upgrade-payload.sh`. - This should write a stdlib file to `stdlib/staged/stdlib.mv` - Check: Open `stdlib.mv` as text and search/verify both `ol_oracle_upgrade_foo_tx` and `foo` exist (in different lines). - -4. Copy `fn encode_ol_oracle_upgrade_foo_tx_script_function()` from `sdk/transaction-builder/src/stdlib.rs` into `ol_oracle_setup.rs` - -5. Copy concatenated file from `language/diem-framework/staged/stdlib.mv`, to `fixtures/upgrade_payload/foo_stdlib.mv` - -- `cp language/diem-framework/staged/stdlib.mv ol/fixtures/upgrade_payload/foo_stdlib.mv` - -6. Important, you must now *comment away* the foo() code again in Upgrade.move and - add `.e2e` extension - rename to `language/diem-framework/modules/0L_transaction_scripts/ol_e2e_test_upgrade_foo_tx.move.e2e`. - -7. Rebuild stdlib again. (Otherwise the e2e test will be starting from an stdlib which includes foo(), when it should not) -`ol/util/build-stdlib.sh` diff --git a/ol/documentation/roadmap.md b/ol/documentation/roadmap.md index 81021fcfe0..5cd465f701 100644 --- a/ol/documentation/roadmap.md +++ b/ol/documentation/roadmap.md @@ -2,17 +2,6 @@ ### V.5.0.0 + - -1. Merge Upstream 1.3.0 - 1. Package 0L changes as a module - 1. Regex libra->diem - -1. Packaging of non-stdlib smart contract (module) - Documentation (AD) - -1. Audit (JM) - 1. Audit of v5 Move contracts. - 1. Formal verification of access control to functions. - ### Future 1. Cross chain prototype (ZM) @@ -74,4 +63,15 @@ 1. Genesis from archive 1. create a genesis blob from epoch snapshot - 1. modify snapshot to update state before saving genesis. \ No newline at end of file + 1. modify snapshot to update state before saving genesis. + +### v5.0.0 +1. Merge Upstream 1.3.0 + 1. Package 0L changes as a module + 1. Regex libra->diem + +1. Packaging of non-stdlib smart contract (module) - Documentation (AD) + +1. Audit (JM) + 1. Audit of v5 Move contracts. + 1. Formal verification of access control to functions.