Merge pull request #1 from fr1t2/main

Update Zond install instructions
theQRL · Sep 18, 2022 · 1df2263 · 1df2263
2 parents f11139c + 357d479
commit 1df2263
Show file tree

Hide file tree

Showing 4 changed files with 60 additions and 113 deletions.
diff --git a/docs/Node/node-cli.md b/docs/Node/node-cli.md
@@ -450,8 +450,31 @@ OPTIONS:
 
 #### `tx stake` Example Command
 
+
+```bash
+./zond/zond-cli tx stake --account-index 1 --amount 10000000000000 --gas 1000 --gas-price 0 --nonce 0 --broadcast --remote-addr 45.76.43.83:19009
+```
+
+This will create a `dilithium_keys` file in the local directory the command was issued. Move this file to the root Zond node directory `~/.zond/dilithium_keys` to begin staking.
+
 #### `tx stake` Response
 
+
+```bash
+{
+  "chainId": "1",
+  "nonce": "15",
+  "pk": "l/M/dy/8KnnkEHJ7L72Ft8U/ApLUzAQSgcqJeV0HCKoIBdB0VS7e1IhCf/GzPtCamsk5SzkGG8AVoPUxfGjfhvie7s0FaNuA70XDJQYAXEGAVZd+1K5zsCzqYFFt1jOOAeLMoPDip9l7FNT5DzsD+WKET0T9GUVWBU8Ofumrl3YlUtXUiJqHlkFcoagDiN6ktCj74VHiJdPxqdN2eQTbKhQd1i70lXg/S7ZPVgYo4ziIA84HxnGuIWwbsC48tKC9y+qm/xU9bAooqsdCcuMBb9jCz/luvfpdLZ2gC+XQjS4ihVWb5X+YrV8YopeK3ZeWCKU/3lJiKUGJms8uHSKtJr67bZRCnxgBOcwzBNvYr7t7RI+VX1Jyf1u49ogcGaSMdNeSiEUk/2QlCM8mhJbJLq8E5ecJVn7w9fosJktZmeQhFpC4W06HICPmC7w74XCOLZpYFU7puTGgo7jIM6+BuvovpgElh6vivsnwND9Nao8LfywmWnNzj4s6kfyFbrOTDRRXrlD6C4IuDla1gZo6+bp70wJ3mpCbFS424mtBIyj7/zbxKpzvN9ag6k7VaJMJ3kzBpWR+xMHhxTN4+08WIVnSmYSxJECJN8j3xyQQXo5luP3BIZI3AjAYkBFBEDNo8XphZGQdyi7CF6/XSLry1g9z5N1HwDpzGX+sUg+BfXY/aM8dl1UayaxkF+BPOpAa0sQXEW40A2hWZzd0lQyAEY3qtr4WCGmkMmTWjMU3idHMXabRP9b/bPCGQ5G0e8FvCb0L3mS47NnUZjf8W2YRTIouEn5ehq4yz2IlTR86UGQZsPwA7bigNmMQZ+ypKrLLX9IGuVEnW7enCUXTQTSJyDhoXJ1/pq7Wxs5iwvZdCqQC6FYUMBqkBlhbygKnKY2OfWqh4zKSRmGz9bG95A8g65bEKEIYfwAT/mKVp31s0wBn/Ni8RSVeoSwVQfO7fgokxMGoa3CjhRbc/mwzUKHsMCIITUsBIMzDg6tEpnftfrqgpvqfnKuG8xVYvRP+cBGZiADMyb+O36FRy+PXCfcZeNsmMAayN41h1zC2NCmYxtDHdPAw1Jn4NOI+J6OXx/ymBbOQGQ+izcG1P+ile1OdJEGeJkNWWdq/dxh//lnn3qHGdMRFHJ+DaW25z7X5bh39wFPN4MhAMMPNWbcsGnYzCvH7Mt8wd5PI0IdSxEwvlisFS3qNzduvbOpfDMA2GHzw4gSkuc92IqlJMs4trqUL0Vm3LxeAGExe2WePS2UHtb4XKsnlbk0krTlMXA51h8HdUUqi5CNhP1xgnEFQFzSHC2pRM0yqqtav3PqmyZsuK2VOhGRebIn8XrcTEL4qdzNOwvemIwG2OiWwKnYAtfG1/wK+tk3lAQmaj1KiPzkCUsR6UhzC293gPQAVtZNd/U9t9C3nVLOQ6Jp/bHeoVr1r3HzShwNwm3ErASOm9D6V7oEx4YY8YgWWCSEcwP/0/2/8HyuJz7pN6PfUg4NqqnCfiuqb4h61Mbhwsp7I0ftLusTSBoDyTV4v2jQUe1NXLKnE0MOV5QkmVouRwLBBPVJ62nPJRop/T04xCDQYzrPfOL2fJLG5c2ky8yNgzK6sISZt0gLxNKM5OsiNYgcLAPhHyfqiWJRTigdJATQojN7BDwqdVxIuQR1//ZUE56SP1ntaqt0iL3xUpZakjshjZJRdoIfJf6bpl1HpEPzMe43aTRakYsp4mh6oH0XZV9otOSuW3kIrowd35hSmOscsaJ3q8uTaXg/7ms5zd/Eb2nDlpE/QmUR2P6li+D1KN4FTsy7GUdeCyVJEs0OXAc891qKcXrwdKmbB9fNqhKehgUglGvmIqppKDQ+mHfKHj0kkMH4VBvEjou6mQtbUY71adMcYzqcMnbdO1FhDz/VezsTK0TRHrPbxm+Qpnjt+tre7CpdzJuJJInxv+eiCJxxpvW2SBVIbKsb1ZG9f1ls9iFy5Zeo=",
+  "signature": "AU+/zVNbiO4syd0QFrWif9Pr4m+yPgb/nhS/FoZphGpDTns/0FPLrgDp+BphHb1U44PBwGIb6LaTK+jw1gwjtTS9kV+WEt+xgeZrxwqDjKn6SvY1sExE/BDaNZxnwFvIyyJGvjpy9TiWKkorSmkWz6HTN++mxRFj3UN768nUC2tvLEsunAjXJxMWAFJdJ1CcXsEfOpvsTOh71/yKeC0kDQmHIBcDI0aQe2X2SdcZJ6SAq5jpnQ66amsPogvpqaYoeJD1fpbTt9mKP89jucxZ68VBRFlkwi5gUOvF9+fejxLTnoyTKkBHL4K6+6rpkywp3gxveW6EYsHHytv02zjNCddLvscjScuhHaWbTdNHr742I0WT3NEGh9UvzLXcPRDVjZSz6sD0UHIwsMewcI4AnMsgHrIL0WIrN3Ed7YXsJ58n3E5fazz0Ui/Z42lIoSL/iQn4SYr9YYikEnj7c3X4YP7bOU8z0Do6avLBRb100YdjwgLso0exKtxyDi+lgLg3QvshnHW2cCVZoLC7FUVznUTdMEq5EQNSSe6l4QrL6DwSj7doRgZ90TZXOal0gcdCZpXfjfbOMaAbaIHfC73eOHape05gXEqKqhYV8UHPtk1XVkB3+RwbaqrXZ6+d87VAESUIVxHCU3X1g4dE6sR/c/GjbGQF5M2YeqZv/qPnLtrz8vqc2Un6zoXcai0nycstIj6YcOG5u1wgfYfEVV1f+8wmEQnx3KRWWqu6BorcQ5oh5QB6jZvtXYTVbKaNEUXiG1eWcGkUsLOkbYLuR3CRH6Yd9Vg9lB+2Gyf8Z6VVv/JsBwEUk/1ZaSDGUx3SlUFCHNenAwJaKyL4YSd7twjNsOtMc0kn3ZWG94JT8N6VnirWcHtQ0y7h7ZK+eeb/rrOGGhbEvjJ0LebH9yw6a9NctVEco/CTNFdu54fkTVgmT04xND3MyCCDdYd2OhXKcv7O7rcvr0XaaEbBEc/CnzJH1OTv8EMHAh1JQfgtwM4BYopwNBLs59TYVsc9CT/2N61XXRyihNh2VqmcNd96gvL5BFxM6xLRU7JXZ6h1qI4axcpOM2xLqO+bQ+LmZflwAWinxBqvWtNPvPFBp60n+FH73nJCIv2m1MCUoVc2XXUUw7A0HEy73mfeNF7xDqOunIyUsGrhvIWkZLrzg/819wHF5krXxAWkMetmsHfikGZ4c0e0RCrhUa7ILrWe7tJLSVxkJlVy9iu2Vm//0OXV/mvxwZDWcBwEALxY0Psc7JZ9yu6oeVd64qNWtWyKlbQvrCGfc0OVBj+J03xH69Rfh1yFjMt2WPctoRCsvnwXJTjpemUpXSaILRWBsX48kbxG6h7szmCtpCJjHD0a+P5vhVPix6f7qPbLEg5lhLWBrBjhZ37PMElZx7iX4/Vwf1jxh4/tf23CLUnoaT0KJJa5O0YcA7qhvxM98jkajClRXesjTqWjVg7oq0zQSCqFgHGRwD055jgEutivRWvNDPv6USqoEoWZ/wYKBmv11tXlayMVUCiVZZCitLSS7B9y3iwnsVJRaDGnxHg4IniNTrMUDb/ibnOf4mUP5AYVCm+Z63zyV0ggPbiMriVh8quYww/iU0ZPUxB2hL7jB8UxNzaREnOuE2ixR0OLSKtqFMwKqoDm3MhfkQIcRRn2l4l0cOVWGfFAS6Lj64JSzOyKRAW1WqAuTe/MgFYEvGl/5MqJwUGrwy1fqWyeL2KBQKWH0Tx21gnteipkG76jXJJVr2GQbmSdJ09Lv2mOq/W+lhg1wbX6T6jkjJ7i3n73FXMoyrr9AciebiGvHKAr6rDOjl1NLigmLVZztsY/wqsp22nvpOXnBimPkmAj/cxlhU54oXnXst4LySdv39RABrIbkzCrGORNstwLXzp7tLIiBM053CEPT045uLzRvkE/I9gsCw2iakbJg910HZVuzgY0iV2K6wPRDVUTHRMHuYm+lg/JS/yYTC3x+v6a7AIW2TTpM9WP1Bl3zeoSmEcVJSA+d//EX0s3fukFOr5PsZ/A69KCmL0Lk5KPvEVtXsqDEEdoY1AV3Q9rE2Rpc1ZFWcqhuDb8s3HRQCz1N04dzm3vCqhOddH6IjTOeONsEfS+RE0FrSoPiunI7+mnuul7BJXzrC4SqHZqAUordNoJMZN+QHLROLzmOK1ScQcmFj2UTI93MiCxVAob374AcTM5fWUKYCjonZp5zgVo/KcR6j7GlQ3XuFPjObEsw/cQ5FlYmMcxofF9p2emPWdm6zXOo1C6L/jCmGzsYk5ka0WMgljD+8M43p13elWfaSdB0gLwNaNKOQRYVPkLDaKNdHBZoQ275K9fFq9lTxpLlmxrSwg+rSTZzeGPySVqUAfPoqcmzyO3e8/emAu86wQd2LdoRx5aD6kfnX1kmBDqJfDGQ5rFvUTkIhaRN+JmPAsm0yJBwfVF4rhSjKpLKZ/sjQIgfqmm3Ix81wMSR5wkKgjUB9cb2tgZdbQFqQcAQplIHZj2mQgL+wv7o5zUormWZkt5IhEVcK7LAqjUaKFPGwi5cf1atTaEZhcH1EZWs/+8OQNoBJ+kELG4SUrl0MQkl+3q4m/wK5SmBAHNw17sVtddV+FBUZeuMxB5AVx5nE8hBDjd9TuiIEQH/JC1ekU6adLjjnDpIKOXalT7f2UJRCH1QpOb11CNWsYnP36z95hTIaJP50DDEhoRm34p/jGfPObupJcIrpP+4pjUStnjehypDUQPxYbJCRY4Xqivf/rUk5VRpeCC3/av1dRmzpb7Dsb0yxQ/hOQQN5Ag5yZE2akXY9I/DWb3uSPpnWtav+azykPcgzGyikJFLsB1ZzGctUpgeaUlFdfHPvTQpbQgPdJwgjOYuSjOQJRSM/7csGVWmHQdullDdGgLCFHCipV1hreWiJkhrzgj+c1FG922I8BnJR0VUdFu0bmuL8CXY8w4dl2qkKiSSQWVEytyQODlPRjVOdugAAvw1wQ2OAtlzQdS9foN7lAMVBTFKK1vuhyEbrfrweXVQ/MdZgtZvNxEtB/twqySAafYM72eUBzQGQydygB5bGWhdg69Cmv54flqy1AoQ4fpR21B8KE6K7bGSmtOUoaaN/tIBOwAGeM02rfaYhVdZQZgb4lsF4zxN0Ks33kZDBlGHXaKI0laNG29BLKJhj39RxdFUS1/YEYjYFpYwGfUqM5gk7EhWUgWBRSMx6jfZUShW68O9Q3iQ7WyP3DyBaQlAgovWnrGTPcT/teNV699YaY+GdtTKF1TOpNwX2NkkdKVq7UempID6fdVKE9jxKKhZtmLqKQmbUE0+mBrx5Ce3XAr4QK20d1iVpw93FrRg2at+/DYJ5BaXUFKBf5R2ZPRHU8M4EZ0+1qkeaThXJCs6aroUgSfu4BpgnR/rqiHBPGNdgNL63olyBUOWigebg/QJSqdFT+bphEkMT9MEzc5RlVgaWx+gqzA0tnc5OgQHjc7WJaanKmqs7a3usHL2O/9ExQjbXiCjpGoxdDm7ipQXG9wcnmDk5ai3N7pCBYaNkFJX3J6h42l3ZBQ4ABMgAigAGCLhRMACEEEQAJYQkmRRGMACEwABhCNTuhOIiFAbwU=",
+  "gas": "2000000",
+  "gasPrice": "10000",
+  "hash": "ytUbghWZ46sWDkmZYaItUEnbcATbpJ8xtM9J8v1dt70=",
+  "stake": {
+    "amount": "100000000000000"
+  }
+}
+Transaction successfully broadcasted
+````
 ### `tx transferFromXMSS`
 
 ```

diff --git a/docs/Node/node-install.md b/docs/Node/node-install.md
@@ -24,91 +24,68 @@ import TabItem from '@theme/TabItem';
 :::caution DOCUMENT STATUS 
 <span>This document is in: <b>{frontMatter.docstatus}</b> status and needs additional input!</span>
 
-- Need install instructions for MacOS
-- Need install instruction for Windows
+- Need install instructions for other OS's
 :::
 
-
-Installation instructions for The QRL POS Project Zond node installation. This document covers getting started installing the Zond node software and will allow interaction with the Zond blockchain, as well as additional tools.
-
 :::danger
 These instructions will change frequently as we develop the node software. Check back often as these will be kept up to date until the final solution is in place.
 :::
 
-
-## Development Install
-
-
-To install the development node used for initial testing and development of both the POS network and QRVM smart contracts. Follow these directions to install the node locally.
+This document covers getting started installing the Zond node software and will allow interaction with the Zond blockchain.
 
 
 ### Prerequisite
 
-- GO is installed
-- Remove any previous node installation files `~/.zond`
+- Go version 1.18.6 or greater is installed `go version`
 - Ensure the local copy of the Zond github repo has the latest code
-- Bootstrap files are the latest
 
 :::info Minimum Node Hardware Requirements
 There are some basic requirements that must be met to run a Zond node *(Yet to be defined)*. See the [Zond Node Requirements](node-requirements) documentation for more info.
 :::
 
 
-### BootStrap Files
+## Zond Node Installation
 
-Bootstrap files are generated during the genesis of the DEVNET and will need to be copied into your local node in order to sync with the public network. We do this now due to the frequent changes being released during development. This will not be needed for production.
+Follow the directions below to get started running a Zond POS Node.
 
-The latest Bootstrap files can be downloaded here [zond-docs.theqrl.org/node/bootstrap-devnet.zip](https://zond-docs.theqrl.org/node/bootstrap-devnet.zip) or following the installation directions below.
+<Tabs
+    defaultValue="ubuntu"
+    groupId="os"
+    values={[
+        {label: 'Ubuntu', value: 'ubuntu'},
+        {label: 'MacOS', value: 'macos'},
+        {label: 'Windows', value: 'windows'},
+    ]}>
 
-####  Bootstrap Directory Tree
+<TabItem value="ubuntu">
 
-```bash 
-~/Downloads/bootstrap-devnet/
-├── block
-│   └── genesis
-│       └── devnet
-│           ├── genesis.yml
-│           └── prestate.yml
-└── config
-    └── config.go
+Installation instructions for the Zond Node on Ubuntu.
 
-```
+##### Requirements
 
-### Development Install 
+- `build-essential` is installed including `gcc`
 
-```bash
-# Remove any old installs and download the Zond node software into users home directory 
-rm -rf ~/.zond
-rm -rf ~/zond
-rm -rf ~/Downloads/bootstrap-devnet 
-rm -rf ~/Downloads/bootstrap-devnet.zip
+#### Install Steps
 
 
+```bash
+sudo apt update
+sudo apt install build-essential
+
 # clone the zond repo, grabbing the latest code
 git clone https://github.com/theqrl/zond ~/zond
 
-# Download the bootstrap files and unzip
-wget https://zond-docs.theqrl.org/node/bootstrap-devnet.zip -O ~/Downloads/bootstrap-devnet.zip
-unzip ~/Downloads/bootstrap-devnet.zip -d ~/Downloads/
-
-# Copy the genesis files and configuration into the correct directories
-cp -r ~/Downloads/bootstrap-devnet/block/genesis/devnet ~/zond/block/genesis/
-cp ~/Downloads/bootstrap-devnet/config/config.go ~/zond/config/config.go
-
-## Update the PeerList: configuration with foundation peer address
-#  In config/config.go update PeerList 
-#  from:
-        PeerList:                []string{},
-#  to:
-        PeerList:                []string{"/ip4/45.76.43.83/tcp/15005/p2p/QmU6Uo93bSgU7bA8bkbdNhSfbmp7S5XJEcSqgrdLzH6ksT"},
-
 # Build the node
 cd zond
 go build ~/zond/cmd/zond-cli
 go build ./cmd/gzond
 ````
 
-### Development Install Script
+:::tip 
+This is the recommended installation method, and most common way to run a Zond Node.
+:::
+
+#### Install Script
 
 For a simple, no fuss node install use the script Jack provided us. The code can be found here [github.com/jackalyst/zond-init](https://github.com/jackalyst/zond-init).
 
@@ -136,61 +113,6 @@ It is important to read and understand what a script is doing on your machine be
 There will be a few questions to answer, select (Y)es to each and there will be a running node in a screen session. `screen -r` to access it or see the logs in the `~/.zond` directory `tail -f ~/.zond/zond-daemon.log` 
 
 
-## Zond Node Installation
-
-Follow the directions below to get started running a Zond POS Node.
-
-<Tabs
-    defaultValue="ubuntu"
-    groupId="os"
-    values={[
-        {label: 'Ubuntu', value: 'ubuntu'},
-        {label: 'MacOS', value: 'macos'},
-        {label: 'Windows', value: 'windows'},
-    ]}>
-
-<TabItem value="ubuntu">
-
-#### Zond Ubuntu Installation
-Installation instructions for the Zond Node on Ubuntu.
-
-Tested in the latest LTS version `Ubuntu 20.04`
-
-```bash
-rm -rf ~/.zond
-rm -rf ~/zond
-rm -rf ~/Downloads/bootstrap-devnet 
-rm -rf ~/Downloads/bootstrap-devnet.zip
-
-
-# clone the zond repo, grabbing the latest code
-git clone https://github.com/theqrl/zond ~/zond
-
-# Download the bootstrap files and unzip
-wget https://zond-docs.theqrl.org/node/bootstrap-devnet.zip -O ~/Downloads/bootstrap-devnet.zip
-unzip ~/Downloads/bootstrap-devnet.zip -d ~/Downloads/
-
-# Copy the genesis files and configuration into the correct directories
-cp -r ~/Downloads/bootstrap-devnet/block/genesis/devnet ~/zond/block/genesis/
-cp ~/Downloads/bootstrap-devnet/config/config.go ~/zond/config/config.go
-
-## Update the PeerList: configuration with foundation peer address
-#  In config/config.go update PeerList 
-#  from:
-        PeerList:                []string{},
-#  to:
-        PeerList:                []string{"/ip4/45.76.43.83/tcp/15005/p2p/QmU6Uo93bSgU7bA8bkbdNhSfbmp7S5XJEcSqgrdLzH6ksT"},
-
-# Build the node
-cd zond
-go build ~/zond/cmd/zond-cli
-go build ./cmd/gzond
-````
-
-:::tip 
-This is the recommended installation method, and most common way to run a Zond Node.
-:::
-
 </TabItem>
 <TabItem value="macos">
 

diff --git a/docs/Node/node-staking.md b/docs/Node/node-staking.md
@@ -69,24 +69,28 @@ The following things are required to begin the staking process. Follow the instr
 - Zond Dilithium Address in a wallet.json file with $$10,000 \text{QRL}$$ in that Dilithium Address address 
 
 :::note
-See the [zond-cli wallet documentation](/wallet/zond-cli/node-cli-wallet#generate-new-dilithium-address)
+See the [zond-cli wallet documentation](/wallet/node/node-cli-wallet#generate-new-dilithium-address)
 :::
 
 ### Generate Stake TX
 
 
-With the Zond Node installed, and a fully funded dilithium address, generate the `dilithiul_keys` file to use for staking and broadcast the staking transaction.
+With the Zond Node installed, and a fully funded dilithium address, generate the `dilithium_keys` file to use for staking and broadcast the staking transaction.
 
 
 :::info
 This command expects there is a wallet.json file in the current directory. Use the `wallet-file` flag to specify another location.
 ::: 
 
 ```bash
-./zond/zond-cli tx stake --account-index 1 --amount 10000000000000 --gas 1000 --gas-price 0 --nonce 0 --broadcast --remote-addr 45.76.43.83:19009 --output ~/.zond/dilithium_keys
+./zond/zond-cli tx stake --account-index 1 --amount 10000000000000 --gas 1000 --gas-price 0 --nonce 0 --broadcast --remote-addr 45.76.43.83:19009
 ```
 
-This will broadcast the stake transaction and output a `dilithium_keys` file into the root `~/.zond/` directory using the wallet address at index 1. Amount is given in shor.
+This will broadcast the stake transaction and output a `dilithium_keys` file into the current directory the command was issued. Move this file to the root node  directory `~/.zond/dilithium_keys`
+
+- Amount is given in shor.
+- `remote_addr` is only needed if you are not running a local node, instead using a remote node for the transaction
+
 
 :::note
 Find the address index using the `./zond-cli wallet list` command. [More information can be found here](node/node-cli#wallet-list)

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -25,16 +25,14 @@ import CodeBlock from '@theme/CodeBlock';
 
 :::caution DOCUMENT STATUS 
 <span>This document is in: <b>{frontMatter.docstatus}</b> status and needs additional input!</span>
+
+- POS explainer, including cryptography used and any special considerations to be highlighted.
 :::
 
 
 Welcome to the Quantum Resistant Ledger Zond documentation! This is a work in progress and will be improved as we build project Zond. Ensure
 
 
-:::caution INFO NEEDED
-<span>POS explainer, including cryptography used and any special considerations to be highlighted.</span>
-:::
-
 
 
 ### The QRL Mission