diff --git a/docs/00-intro.md b/docs/00-intro.md index 9a040d8..dcd2588 100644 --- a/docs/00-intro.md +++ b/docs/00-intro.md @@ -2,11 +2,11 @@ title: Welcome --- -# Welcome to the Documentation... + ![Stereum Ethereum Node Setup & Manager](../static/img/branding/stereum-social-card.png) -## ...and thank you for choosing Stereum 🍄 +# Welcome to the Documentation and thank you for choosing Stereum We're thrilled to have you onboard and are confident that Stereum will enhance your experience with Ethereum. This documentation is designed to provide you with all the necessary information to successfully utilize Stereum for managing Ethereum nodes. @@ -14,9 +14,12 @@ Whether you're new to Stereum or looking to dive deeper into its features, you'r ### What You Will Find Here -- **Technical Details**: Dive into the technicalities of Stereum. - **Detailed Setup Guides**: Step-by-step tutorials for straightforward node setup and operations. + - **Vanilla Staking**: [Go to guide](../docs/03-installation/02-use-case-guides/03-node-operator/lido/03-lido-csm.md) + - **Lido Community Staking Module(CSM)**: [Go to guide](../docs/installation/tutorial-guides/node-operation/lido/lido-csm) + - **Node Operation Protocols**: [Go to guide](../docs/category/node-operation-protocols) - **Best Practices**: Tips and tricks for optimal node performance and security. +- **Technical Details**: Dive into the technicalities of Stereum. - **Troubleshooting**: Solutions to common issues and how to seek further assistance. - **Glossary**: Get familiar with common terms and concepts in Ethereum and Stereum with our glossary. - **Community Contributions**: Learn from the wealth of knowledge shared by our community. @@ -28,8 +31,9 @@ Stereum simplifies the complexity of running Ethereum nodes, making it accessibl The Stereum project thrives on community feedback and contributions. We welcome you to join our efforts in making Ethereum more decentralized and accessible: - **Stereum Websites**: - - [stereum.com](https://stereum.com/) - - [stereum.net](https://stereum.net/) + - [stereum.com](https://stereum.com/?utm_source=stereum-documentation&utm_medium=intro-link&utm_id=0) + - [stereum.net](https://stereum.net/?utm_source=stereum-documentation&utm_medium=intro-link&utm_id=0) + - [stereumplus.com](https://stereumplus.com/?utm_source=stereum-documentation&utm_medium=intro-link&utm_id=0) - **GitHub Repository**: [stereum-dev/ethereum-node](https://github.com/stereum-dev/ethereum-node) - **Discord Server**: [Stereum Server](https://discord.gg/DzAwgnSXtB) diff --git a/docs/02-guides/00-prerequisites/00-prerequisites-hardware-requirements.md b/docs/01-prerequisites/00-prerequisites-hardware-requirements.md similarity index 100% rename from docs/02-guides/00-prerequisites/00-prerequisites-hardware-requirements.md rename to docs/01-prerequisites/00-prerequisites-hardware-requirements.md diff --git a/docs/01-prerequisites/01-prerequisites-server-setup.md b/docs/01-prerequisites/01-prerequisites-server-setup.md new file mode 100644 index 0000000..c397d71 --- /dev/null +++ b/docs/01-prerequisites/01-prerequisites-server-setup.md @@ -0,0 +1,203 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + +# Intial Node Server Setup + +## Cloud Server Setup + + + + + + ### Get started with [StereumPlus](https://stereumplus.com/) + + #### Step 1 + Begin by clicking **"Buy Server"** in the top menu to start your journey toward becoming a node runner with StereumPlus. + + ![Step 1 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP1.png) + + #### Step 2 + Select your preferred **provider** from the dropdown list. This step ensures you choose a service suited to your blockchain needs. + + ![Step 2 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP2.png) + + #### Step 3 + Choose a **plan** based on your server requirements. Compare the options for cores, RAM, and storage to pick what fits best. + + ![Step 3 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP3.png) + + #### Step 4 + Enter a unique **server name** to identify your node and click "Continue" to proceed. + + ![Step 4 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP4.png) + + #### Step 5 + Review your selected plan details, including price and specifications. Once satisfied, click **"Subscribe"** to continue. + + ![Step 5 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP5.png) + + ### Payment Process + + #### Step 6 + Select your preferred **cryptocurrency** (e.g., Ethereum, USDC, or USDT) for payment, then click **"Choose"**. + + ![Step 6 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP6.png) + + #### Step 7 + A wallet address and payment amount will appear. Use the **QR code** or copy the wallet address to initiate the transaction. + + ![Step 7 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP7.png) + + #### Step 8 + Open your crypto wallet, select **"Send"**, and paste the wallet address provided by StereumPlus. + + ![Step 8 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP8.png) + + #### Step 9 + Copy the wallet address displayed on the StereumPlus payment page to ensure it matches what you paste into your crypto wallet. + + ![Step 9 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP9.png) + + #### Step 10 + Enter the exact amount shown on the payment screen in your wallet and confirm the transaction. + + ![Step 10 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP10.png) + + ### Verification and Final Steps + + #### Step 11 + After initiating the transaction, confirm the payment in your crypto wallet. Review the transaction details and finalize the payment by clicking "Confirm" in your wallet interface. + + ![Step 11 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP11.png) + + #### Step 12 + Once the payment is sent, return to the Stereum payment screen and click "Click here after payment" to confirm and finalize the payment process. + + ![Step 12 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP12.png) + + #### Step 13 + Congrats! This indicates the payment was processed successfully, and your server is being set up. Click on "My Servers" to proceed. + + ![Step 13 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP13.png) + + #### Step 14 + In the My Servers section, you can view your active servers. Verify that your new Ethereum node server is listed and ready to be used. + + ![Step 14 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP14.png) + + #### Step 15 + You will receive your **server login credentials** via email. Use the provided information to log in securely. + + ![Step 15 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP15.png) + + #### Step 16 + Open the Stereum Launcher, input the **IP address, username, and password**, and log in to your server to access it. + + ![Step 16 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP16.png) + + #### Step 17 + Upon first login, you'll be prompted to change your password. Choose a secure password and save it securely. + + ![Step 17 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP17.png) + + + + +## Local Server Setup + +### Create a Bootable USB Stick {#create-bootable-usb} + + + + + + 1. Visit the Ubuntu Server download page: [Ubuntu Server](https://ubuntu.com/download/server). Click on the version labeled 'Ubuntu Server 22.04 LTS' to download it. + + ![Server Setup Step 1 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_1.png) + + 2. Download Rufus to create a bootable USB drive from this page: [Rufus](https://rufus.ie/). + + ![Server Setup Step 2 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_2.png) + + 3. Open Rufus once it has downloaded. + + ![Server Setup Step 3 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_3.png) + + 4. Insert your USB stick (minimum 4 GB) into the computer. Rufus should detect your USB stick automatically. If it doesn't appear, select it manually from the 'Device' dropdown menu in Rufus. + + ![Server Setup Step 4 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_4.png) + + 5. In Rufus, next to 'Boot selection', click on the 'SELECT' button. Navigate to where you saved your Ubuntu Server download (the ISO file) and select it. + + ![Server Setup Step 5 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_5.png) + + 6. Leave all other settings in Rufus at their default values. Press 'START' to begin creating your bootable USB. + + ![Server Setup Step 6 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_6.png) + + 7. A warning may pop up about Rufus changing the ISO image mode. Confirm that you want to continue in 'ISO Image mode' by clicking 'OK'. + + ![Server Setup Step 7 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_7.png) + + 8. The creation of the bootable USB will begin. This process may take around 10 minutes, depending on your computer's capabilities. + + ![Server Setup Step 8 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_8.png) + + 9. Once Rufus confirms that the process is complete, you can close Rufus and remove your USB stick. + + ![Server Setup Step 9 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_9.png) + + 10. Your Ubuntu Server bootable USB stick is now ready. Move on to the server setup by following the guide in Part 2 below. + + ![Server Setup Step 10 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_10.png) + + + + + + 1. Go to the Ubuntu Server download page: [Ubuntu Server](https://ubuntu.com/download/server) and download the version labeled 'Ubuntu Server 22.04 LTS'. + 2. Insert the USB stick into your Mac. Check that it has at least 2 GB of space available. + 3. Open the 'Disk Utility' application found in the 'Utilities' folder within your 'Applications' folder. + 4. In 'Disk Utility', select your USB stick from the devices listed on the left, then click on the 'Erase' button at the top of the window. + 5. Name your USB stick something memorable, select 'Mac OS Extended (Journaled)' as the format, and then click 'Erase' to start the process. + 6. Once the erasure is complete, close 'Disk Utility'. + 7. Open the 'Terminal' application, also found in the 'Utilities' folder. + 8. Convert your downloaded ISO file to an IMG format by typing the following command in Terminal: `hdiutil convert -format UDRW -o /path/to/your_new.img /path/to/downloaded.iso`. Replace '/path/to/your_new.img' and '/path/to/downloaded.iso' with the actual paths to where you want the new IMG file saved and where your downloaded ISO file is located. + 9. Find the device identifier for your USB stick by typing `diskutil list` in Terminal. + 10. Unmount your USB device with: `diskutil unmountDisk /dev/diskN`. Replace 'diskN' with the identifier from step 9. + 11. Write the IMG file to your USB stick with the following command: `sudo dd if=/path/to/your_new.img of=/dev/rdiskN bs=1m`. Again, replace '/path/to/your_new.img' and '/dev/rdiskN' with the appropriate paths and identifiers. + 12. When the process is complete, you can remove your USB stick. + 13. Your bootable USB stick with Ubuntu Server is ready. Proceed to the next setup phase in Part 2 below. + + + + + ToDo: Detailed instructions for creating a bootable USB stick on Linux will be added here. + + + + + +### Booting from USB and Installing Ubuntu {#booting-and-installing} + +1. With the machine off, insert your bootable USB. +2. Turn on the machine and immediately press the F11/F12 or Delete key to open the boot menu. +3. Choose your USB as the primary boot option and save your changes. +4. At the Ubuntu boot screen, select 'Try to install Ubuntu Server'. +5. Follow the on-screen instructions to set your language, keyboard layout, and network settings. +6. Accept all defaults for proxy and mirror settings. +7. Verify that the displayed storage matches your server's specs before continuing with the installation. +8. Complete the forms for server name, username, and password. Skip Ubuntu Pro upgrade and additional snaps installation. +9. After installation, select 'Reboot Now'. Once rebooted, use `hostname -i` to note your server's IP address. + diff --git a/docs/02-guides/00-prerequisites/02-prerequisites-server-configuration.md b/docs/01-prerequisites/02-prerequisites-server-configuration.md similarity index 100% rename from docs/02-guides/00-prerequisites/02-prerequisites-server-configuration.md rename to docs/01-prerequisites/02-prerequisites-server-configuration.md diff --git a/docs/02-guides/00-prerequisites/_category_.json b/docs/01-prerequisites/_category_.json similarity index 100% rename from docs/02-guides/00-prerequisites/_category_.json rename to docs/01-prerequisites/_category_.json diff --git a/docs/02-guides/00-prerequisites/01-prerequisites-server-setup.md b/docs/02-guides/00-prerequisites/01-prerequisites-server-setup.md deleted file mode 100644 index db52811..0000000 --- a/docs/02-guides/00-prerequisites/01-prerequisites-server-setup.md +++ /dev/null @@ -1,99 +0,0 @@ -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - - -# Intial Node Server Setup - -## Ubuntu Server Setup - -### Create a Bootable USB Stick {#create-bootable-usb} - - - - - - 1. Visit the Ubuntu Server download page: [Ubuntu Server](https://ubuntu.com/download/server). Click on the version labeled 'Ubuntu Server 22.04 LTS' to download it. - - ![Server Setup Step 1 Screenshot](../../../static/screenshots/guides/server-setup-windows/serverprep_1.png) - - 2. Download Rufus to create a bootable USB drive from this page: [Rufus](https://rufus.ie/). - - ![Server Setup Step 2 Screenshot](../../../static/screenshots/guides/server-setup-windows/serverprep_2.png) - - 3. Open Rufus once it has downloaded. - - ![Server Setup Step 3 Screenshot](../../../static/screenshots/guides/server-setup-windows/serverprep_3.png) - - 4. Insert your USB stick (minimum 4 GB) into the computer. Rufus should detect your USB stick automatically. If it doesn't appear, select it manually from the 'Device' dropdown menu in Rufus. - - ![Server Setup Step 4 Screenshot](../../../static/screenshots/guides/server-setup-windows/serverprep_4.png) - - 5. In Rufus, next to 'Boot selection', click on the 'SELECT' button. Navigate to where you saved your Ubuntu Server download (the ISO file) and select it. - - ![Server Setup Step 5 Screenshot](../../../static/screenshots/guides/server-setup-windows/serverprep_5.png) - - 6. Leave all other settings in Rufus at their default values. Press 'START' to begin creating your bootable USB. - - ![Server Setup Step 6 Screenshot](../../../static/screenshots/guides/server-setup-windows/serverprep_6.png) - - 7. A warning may pop up about Rufus changing the ISO image mode. Confirm that you want to continue in 'ISO Image mode' by clicking 'OK'. - - ![Server Setup Step 7 Screenshot](../../../static/screenshots/guides/server-setup-windows/serverprep_7.png) - - 8. The creation of the bootable USB will begin. This process may take around 10 minutes, depending on your computer's capabilities. - - ![Server Setup Step 8 Screenshot](../../../static/screenshots/guides/server-setup-windows/serverprep_8.png) - - 9. Once Rufus confirms that the process is complete, you can close Rufus and remove your USB stick. - - ![Server Setup Step 9 Screenshot](../../../static/screenshots/guides/server-setup-windows/serverprep_9.png) - - 10. Your Ubuntu Server bootable USB stick is now ready. Move on to the server setup by following the guide in Part 2 below. - - ![Server Setup Step 10 Screenshot](../../../static/screenshots/guides/server-setup-windows/serverprep_10.png) - - - - - - 1. Go to the Ubuntu Server download page: [Ubuntu Server](https://ubuntu.com/download/server) and download the version labeled 'Ubuntu Server 22.04 LTS'. - 2. Insert the USB stick into your Mac. Check that it has at least 2 GB of space available. - 3. Open the 'Disk Utility' application found in the 'Utilities' folder within your 'Applications' folder. - 4. In 'Disk Utility', select your USB stick from the devices listed on the left, then click on the 'Erase' button at the top of the window. - 5. Name your USB stick something memorable, select 'Mac OS Extended (Journaled)' as the format, and then click 'Erase' to start the process. - 6. Once the erasure is complete, close 'Disk Utility'. - 7. Open the 'Terminal' application, also found in the 'Utilities' folder. - 8. Convert your downloaded ISO file to an IMG format by typing the following command in Terminal: `hdiutil convert -format UDRW -o /path/to/your_new.img /path/to/downloaded.iso`. Replace '/path/to/your_new.img' and '/path/to/downloaded.iso' with the actual paths to where you want the new IMG file saved and where your downloaded ISO file is located. - 9. Find the device identifier for your USB stick by typing `diskutil list` in Terminal. - 10. Unmount your USB device with: `diskutil unmountDisk /dev/diskN`. Replace 'diskN' with the identifier from step 9. - 11. Write the IMG file to your USB stick with the following command: `sudo dd if=/path/to/your_new.img of=/dev/rdiskN bs=1m`. Again, replace '/path/to/your_new.img' and '/dev/rdiskN' with the appropriate paths and identifiers. - 12. When the process is complete, you can remove your USB stick. - 13. Your bootable USB stick with Ubuntu Server is ready. Proceed to the next setup phase in Part 2 below. - - - - - ToDo: Detailed instructions for creating a bootable USB stick on Linux will be added here. - - - - - -### Booting from USB and Installing Ubuntu {#booting-and-installing} - -1. With the machine off, insert your bootable USB. -2. Turn on the machine and immediately press the F11/F12 or Delete key to open the boot menu. -3. Choose your USB as the primary boot option and save your changes. -4. At the Ubuntu boot screen, select 'Try to install Ubuntu Server'. -5. Follow the on-screen instructions to set your language, keyboard layout, and network settings. -6. Accept all defaults for proxy and mirror settings. -7. Verify that the displayed storage matches your server's specs before continuing with the installation. -8. Complete the forms for server name, username, and password. Skip Ubuntu Pro upgrade and additional snaps installation. -9. After installation, select 'Reboot Now'. Once rebooted, use `hostname -i` to note your server's IP address. - diff --git a/docs/02-guides/02-installation/01-use-case-guides/_category_.json b/docs/02-guides/02-installation/01-use-case-guides/_category_.json deleted file mode 100644 index ca82ef5..0000000 --- a/docs/02-guides/02-installation/01-use-case-guides/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Use Case Guides", - "position": 2, - "link": { - "type": "generated-index" - } -} diff --git a/docs/02-guides/04-operation/exit-keys.md b/docs/02-guides/04-operation/exit-keys.md deleted file mode 100644 index 4c9eed8..0000000 --- a/docs/02-guides/04-operation/exit-keys.md +++ /dev/null @@ -1 +0,0 @@ -# Exit Keys \ No newline at end of file diff --git a/docs/02-guides/02-installation/01-use-case-guides/01-staking/00-ethereum/01-ethereum-solo-staking.md b/docs/02-installation/00-tutorial-guides/01-staking/00-ethereum/01-ethereum-solo-staking.md similarity index 68% rename from docs/02-guides/02-installation/01-use-case-guides/01-staking/00-ethereum/01-ethereum-solo-staking.md rename to docs/02-installation/00-tutorial-guides/01-staking/00-ethereum/01-ethereum-solo-staking.md index 5b00422..4153f56 100644 --- a/docs/02-guides/02-installation/01-use-case-guides/01-staking/00-ethereum/01-ethereum-solo-staking.md +++ b/docs/02-installation/00-tutorial-guides/01-staking/00-ethereum/01-ethereum-solo-staking.md @@ -5,242 +5,242 @@ ### Step 1 To begin setting up your server for crypto transactions with Stereum, start by logging into your server management system. Enter the server's IP address, username, and password, then proceed to log in. This step is critical for establishing a secure connection to your server where the node will be installed. -![Step 1 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-1.png) +![Step 1 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-1.png) ### Step 2 Once logged in, navigate to the server configuration dashboard. Look for the "One Click Installation" option which is recommended for beginners due to its simplicity and automated setup process. Select this to initiate the installation of your node with minimal hassle. -![Step 2 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-2.png) +![Step 2 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-2.png) ### Step 3 In the one-click installation section, choose your use case and network. For this guide, select the "Staking" option to participate in blockchain validation and earning rewards. From the network dropdown, pick an Ethereum testnet like Holesky. -![Step 3 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-3.png) +![Step 3 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-3.png) ### Step 4 Ensure you set the appropriate data path for your server by selecting the right storage volume. This step affects your node's performance and stability. When setting up your node, try to alternate between different execution and consensus clients to optimize performance and network resilience. Set the installation directory, usually `/opt/stereum`, to keep your services well-organized for easy management. -![Step 4 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-4.png) +![Step 4 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-4.png) ### Step 5 The next step involves setting the synchronization method for your node clients. The recommended 'Checkpoint Sync' method allows a quicker synchronization with the blockchain by starting from a known good state. Choose a trusted source for your checkpoint, which will influence the integrity and reliability of your node's data. -![Step 5 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-5.png) +![Step 5 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-5.png) ### Step 6 Finally, you’ll confirm the installation paths for each component you’re setting up on your server. This summary screen lists all the chosen services with their respective categories and installation paths, ensuring you have a clear overview of where each service will reside on the server. It’s important to verify that each path is correct to prevent any future operational issues. -![Step 6 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-6.png) +![Step 6 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-6.png) ### Step 7 Continue & wait for the installation to complete. This process might take some time depending on the server and network conditions. -![Step 7 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-7.png) +![Step 7 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-7.png) ### Step 8 After completing the initial setup, you will be directed to the node page. Here, monitor the status indicators next to each client, which will initially appear as small red dots. These dots will turn green once the clients are successfully turned on. When this happens, proceed by clicking on the "Control" tab to manage your settings further. -![Step 8 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-8.png) +![Step 8 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-8.png) ### Step 9 On the "Control" page, keep an eye on the synchronization status of both blockchain clients. Typically, the Consensus Client synchronization completes before the Execution Client's process starts. It's important to allow both clients to fully synchronize to ensure your node operates correctly within the network. -![Step 9 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-9.png) +![Step 9 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-9.png) ## Part 2 / 5 | Validor Key Deposit Preparation ### Step 10 Navigate to the Ethereum Launchpad website [https://launchpad.ethereum.org](https://launchpad.ethereum.org), which is the official portal for becoming an Ethereum validator. You can visit either the general launchpad or the Holesky testnet launchpad, based on your requirements. Click on "Become a Validator" to start the process of setting up and registering your node as a validator. -![Step 10 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-10.png) +![Step 10 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-10.png) ### Step 11 Carefully read through the advisory information provided on the launchpad site. -![Step 11 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-11.png) +![Step 11 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-11.png) ### Step 12 These pages contain crucial details about the responsibilities and requirements of running a validator node, such as the Proof of Stake mechanism, deposits, and key management. Understanding these points is essential before you proceed. -![Step 12 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-12.png) +![Step 12 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-12.png) ### Step 13 Choose any of the Execution Clients listed, such as Geth or Nethermind, to process validator deposits. -![Step 13 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-13.png) +![Step 13 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-13.png) ### Step 14 Similarly, select any Consensus Client like Lighthouse or Prysm. -![Step 14 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-14.png) +![Step 14 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-14.png) ### Step 15 Decide on the number of validators you wish to operate. Input this number into the designated field. -![Step 15 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-15.png) +![Step 15 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-15.png) ### Step 16 Begin by selecting the operating system you're using to generate validator keys, as this will determine the appropriate version of the key generation tool for your setup. -![Step 16 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-16.png) +![Step 16 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-16.png) ### Step 17 For a user-friendly experience, opt for the Wagyu Key Gen application. This graphical user interface (GUI) tool, developed by the ETH Staker community, simplifies the key generation process. Though other options are available, Wagyu is highly recommended for its ease of use. After clicking on "DOWNLOAD FROM GITHUB," locate and download the Wagyu version that corresponds to your operating system. -![Step 17 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-17.png) +![Step 17 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-17.png) ### Step 18 Return to the staking launchpad page and confirm that you've securely stored your validator keys and written down your mnemonic phrase by checking the box. This step is essential for ensuring the security and recoverability of your staking operation. After confirming, click "CONTINUE" to proceed with the setup process. -![Step 18 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-18.png) +![Step 18 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-18.png) ## Part 3 / 5 | Validator Key Generation ### Step 19 Once the Wagyu download is complete, launch the application. Before generating keys, switch to the network you plan to use by clicking the network selector. For enhanced security, disconnect from the internet while you generate your validator keys, as this step involves sensitive information that should remain private. -![Step 19 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-19.png) +![Step 19 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-19.png) ### Step 20 Read the information provided within the Wagyu Key Gen application carefully. When ready, initiate the creation of your secret recovery phrase by clicking "Create" and then "CREATE NEW SECRET RECOVERY PHRASE." -![Step 20 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-20.png) +![Step 20 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-20.png) ### Step 21 Securely record your Secret Recovery Phrase. It's vital to back it up accurately and in the correct order, as it is the only way to recover your funds if needed. The best practice for keeping this phrase secure is to write it down on paper and store it in a safe place. Remember, the security of your funds is as reliable as your backup. -![Step 21 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-21.png) +![Step 21 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-21.png) ### Step 22 After backing up your Secret Recovery Phrase, re-enter it in the Wagyu Key Gen tool to verify its accuracy. Click "Check" to confirm you've recorded it correctly, ensuring you can access your funds when necessary. -![Step 22 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-22.png) +![Step 22 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-22.png) ### Step 23 Enter how many validator keys you'd like to create and set a strong password for them. This password will be used to secure your validator keys, so make it complex and keep it safe. -![Step 23 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-23.png) +![Step 23 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-23.png) ### Step 24 If you want to set an Ethereum Withdrawal Address, enter it now. This is where your funds will be sent when you perform a withdrawal. It's optional at this stage but remember that the address must be under your control and can be linked to your secret recovery phrase later if not provided now. -![Step 24 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-24.png) +![Step 24 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-24.png) ### Step 25 Retype your password to confirm it. Make sure you re-enter the same password you chose for your validator keys. This step is crucial for the security of your keys and will be needed every time you perform important operations with your validator. -![Step 25 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-25.png) +![Step 25 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-25.png) ### Step 26 Click on "Browse" to open Windows Explorer and navigate to the folder where you want to save your validator key(s). It's important to choose a secure and backed-up location because these keys will control your validator. Once you've selected the folder, verify that the path is correct and click "Create" to generate your keys. -![Step 26 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-26.png) +![Step 26 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-26.png) ### Step 27 Allow some time for the Wagyu application to generate your secret recovery phrase. It's essential to wait until the process is complete, which may take up to 30 seconds or more, depending on the number of keys. -![Step 27 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-27.png) +![Step 27 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-27.png) ### Step 28 Once your keys are generated, a screen will confirm that the keys are successfully created and saved to the specified directory. Review the information to ensure all is in order, then you can close the Wagyu application. -![Step 28 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-28.png) +![Step 28 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-28.png) ## Part 4 / 5 | Validator Key Deposit ### Step 29 Revisit the Ethereum staking launchpad webpage where you initially started the validator setup process. -![Step 29 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-29.png) +![Step 29 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-29.png) ### Step 30 On the launchpad site, click on the area indicated to "Drag File To Upload or Browse" and select the "Deposit_Data_[TIMESTAMP].json" file that was generated earlier. This file contains the public key associated with your validator and is required to proceed with the staking process on the launchpad. After selecting the file, click "Continue". -![Step 30 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-30.png) +![Step 30 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-30.png) ### Step 31 You will be prompted to connect an Ethereum wallet, such as Metamask. This is necessary to make the deposit for your validator. Follow the instructions to securely connect your wallet to the staking launchpad. Once connected, you will be able to proceed with the deposit transaction. -![Step 31 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-31.png) +![Step 31 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-31.png) ### Step 32 Confirm that your Ethereum wallet is connected to the correct network and that you have enough Testnet ETH to cover the transaction gas fee. -![Step 32 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-32.png) +![Step 32 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-32.png) ### Step 33 Carefully read the summary page, which will show the number of validators you are setting up and the total amount of Testnet ETH required. -![Step 33 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-33.png) +![Step 33 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-33.png) ### Step 34 Check all the necessary boxes to acknowledge the risks and affirm that you understand the transaction is not reversible. -![Step 34 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-34.png) +![Step 34 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-34.png) ### Step 35 Ensure Ethereum wallet shows as connected on the launchpad site. Confirm your network and balance are correct, as these are required for making the validator deposit. -![Step 35 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-35.png) +![Step 35 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-35.png) ### Step 36 Click on "Send Deposit" to initiate the deposit of your ETH. Confirm the transaction in your MetaMask wallet. Ensure you have sufficient balance to cover the deposit and the associated gas fees. After reviewing the transaction details, click "Confirm" to proceed. -![Step 36 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-36.png) +![Step 36 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-36.png) ### Step 37 After the deposit, monitor the status of your validator key. It will join a queue before it is activated. To check the status, visit one of the provided beacon chain explorers (beaconcha.in or holesky.beaconcha.in) and enter your validator public key to track the activation process. -![Step 37 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-37.png) +![Step 37 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-37.png) ## Part 5 / 5 | Validator Key Import & Further Configuration ### Step 38 Open the Stereum application and log into your server. Navigate to the "Staking" section. To import your validator key, click on the 'Click or Drag to Insert Key' area or simply drag and drop your validator key file onto it. -![Step 38 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-38.png) +![Step 38 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-38.png) ### Step 39 Once you click or drag to insert the key, a file explorer will open. Navigate to the location of your validator key files, select them, and choose the validator client (like Lighthouse, Prysm, etc.) that you want to import your keys into. This is where you specify which client will manage your validator duties. -![Step 39 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-39.png) +![Step 39 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-39.png) ### Step 40 A dialogue will appear asking if you want to import with a Slashing Protection Database. Choose "No" if you have not previously imported these keys into a different client or if this is your initial setup. Click "Import" to proceed with importing your validator key without the Slashing Protection Database. This will initiate the import process for your validator key into the client. -![Step 40 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-40.png) +![Step 40 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-40.png) ### Step 41 Enter the password you created for your validator keys during their generation phase. -![Step 41 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-41.png) +![Step 41 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-41.png) ### Step 42 After entering your password and confirming the action, wait for the Stereum system to import your validator keys. This process will integrate your keys with the client and prepare it for staking operations. -![Step 42 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-42.png) +![Step 42 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-42.png) ### Step 43 Wait for the import process to complete. The interface will indicate when the validator key has been successfully imported into Stereum. -![Step 43 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-43.png) +![Step 43 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-43.png) ### Step 44 To set up block rewards, navigate to the "Node" tab and access the settings of your Validator Client. -![Step 44 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-44.png) +![Step 44 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-44.png) ### Step 45 Find the "Default Fee Recipient" section and click the pencil icon to edit the address to which block rewards will be sent. -![Step 45 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-45.png) +![Step 45 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-45.png) ### Step 46 After entering your chosen address, confirm and apply the changes by clicking "Confirm & Restart." Your Validator Client will restart to apply these settings. If it does not automatically restart, do it manually. -![Step 46 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-46.png) +![Step 46 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-46.png) ### Step 47 Once your node is fully synchronized with the network and your validator key has been processed through the deposit queue, you will begin to perform attestation duties. This signals that you are actively participating in the network and can start earning rewards. -![Step 47 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-47.png) +![Step 47 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-47.png) diff --git a/docs/02-guides/02-installation/01-use-case-guides/01-staking/00-ethereum/02-ethereum-solo-staking-on-ARM.md b/docs/02-installation/00-tutorial-guides/01-staking/00-ethereum/02-ethereum-solo-staking-on-ARM.md similarity index 100% rename from docs/02-guides/02-installation/01-use-case-guides/01-staking/00-ethereum/02-ethereum-solo-staking-on-ARM.md rename to docs/02-installation/00-tutorial-guides/01-staking/00-ethereum/02-ethereum-solo-staking-on-ARM.md diff --git a/docs/02-guides/02-installation/01-use-case-guides/01-staking/00-ethereum/03-ethereum-solo-staking-with-mev-boost.md b/docs/02-installation/00-tutorial-guides/01-staking/00-ethereum/03-ethereum-solo-staking-with-mev-boost.md similarity index 67% rename from docs/02-guides/02-installation/01-use-case-guides/01-staking/00-ethereum/03-ethereum-solo-staking-with-mev-boost.md rename to docs/02-installation/00-tutorial-guides/01-staking/00-ethereum/03-ethereum-solo-staking-with-mev-boost.md index 5a4c025..978eadc 100644 --- a/docs/02-guides/02-installation/01-use-case-guides/01-staking/00-ethereum/03-ethereum-solo-staking-with-mev-boost.md +++ b/docs/02-installation/00-tutorial-guides/01-staking/00-ethereum/03-ethereum-solo-staking-with-mev-boost.md @@ -5,256 +5,256 @@ ### Step 1 To begin setting up your server for crypto transactions with Stereum, start by logging into your server management system. Enter the server's IP address, username, and password, then proceed to log in. This step is critical for establishing a secure connection to your server where the node will be installed. -![Step 1 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-1.png) +![Step 1 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-1.png) ### Step 2 Once logged in, navigate to the server configuration dashboard. Look for the "One Click Installation" option which is recommended for beginners due to its simplicity and automated setup process. Select this to initiate the installation of your node with minimal hassle. -![Step 2 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-2.png) +![Step 2 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-2.png) ### Step 3 In the one-click installation section, choose your use case and network. For this guide, select the "MEV Boosting Staking" option to maximize rewards through this feature. From the network dropdown, pick an Ethereum testnet like Holesky. -![Step 3 Screenshot](../../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-3.png) +![Step 3 Screenshot](../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-3.png) ### Step 4 Ensure you set the appropriate data path for your server by selecting the right storage volume. This step affects your node's performance and stability. For consensus any client works well. Set the installation directory, usually `/opt/stereum`, to keep your services well-organized for easy management. -![Step 4 Screenshot](../../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-4.png) +![Step 4 Screenshot](../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-4.png) ### Step 5 Choose a block relay for MEV boosting by selecting one from the available options, such as Titan Relay or Flashbots. Move the selected relay to the "Used Block Relays" section by clicking the arrow button. -![Step 5 Screenshot](../../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-5.png) +![Step 5 Screenshot](../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-5.png) ### Step 6 After selecting the appropriate block relay, proceed to the next step by clicking on "Next". -![Step 6 Screenshot](../../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-6.png) +![Step 6 Screenshot](../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-6.png) ### Step 7 The next step involves setting the synchronization method for your node clients. The recommended 'Checkpoint Sync' method allows a quicker synchronization with the blockchain by starting from a known good state. Choose a trusted source for your checkpoint, which will influence the integrity and reliability of your node's data. -![Step 7 Screenshot](../../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-7.png) +![Step 7 Screenshot](../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-7.png) ### Step 8 Finally, you’ll confirm the installation paths for each component you’re setting up on your server. This summary screen lists all the chosen services with their respective categories and installation paths, ensuring you have a clear overview of where each service will reside on the server. It’s important to verify that each path is correct to prevent any future operational issues. -![Step 8 Screenshot](../../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-8.png) +![Step 8 Screenshot](../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-8.png) ### Step 9 Continue & wait for the installation to complete. This process might take some time depending on the server and network conditions. -![Step 9 Screenshot](../../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-9.png) +![Step 9 Screenshot](../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-9.png) ### Step 10 After completing the initial setup, you will be directed to the node page. Here, monitor the status indicators next to each client, which will initially appear as small red dots. These dots will turn green once the clients are successfully turned on. When this happens, proceed by clicking on the "Control" tab to manage your settings further. -![Step 10 Screenshot](../../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-10.png) +![Step 10 Screenshot](../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-10.png) ### Step 11 On the "Control" page, keep an eye on the synchronization status of both blockchain clients. Typically, the Consensus Client synchronization completes before the Execution Client's process starts. It's important to allow both clients to fully synchronize to ensure your node operates correctly within the network. -![Step 11 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-9.png) +![Step 11 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-9.png) ## Part 2 / 5 | Validor Key Deposit Preparation ### Step 11 Navigate to the Ethereum Launchpad website [https://launchpad.ethereum.org](https://launchpad.ethereum.org), which is the official portal for becoming an Ethereum validator. You can visit either the general launchpad or the Holesky testnet launchpad, based on your requirements. Click on "Become a Validator" to start the process of setting up and registering your node as a validator. -![Step 11 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-10.png) +![Step 11 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-10.png) ### Step 12 Carefully read through the advisory information provided on the launchpad site. -![Step 12 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-11.png) +![Step 12 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-11.png) ### Step 13 These pages contain crucial details about the responsibilities and requirements of running a validator node, such as the Proof of Stake mechanism, deposits, and key management. Understanding these points is essential before you proceed. -![Step 13 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-12.png) +![Step 13 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-12.png) ### Step 14 Choose any of the Execution Clients listed, such as Geth or Nethermind, to process validator deposits. -![Step 14 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-13.png) +![Step 14 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-13.png) ### Step 15 Similarly, select any Consensus Client like Lighthouse or Prysm. -![Step 15 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-14.png) +![Step 15 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-14.png) ### Step 16 Decide on the number of validators you wish to operate. Input this number into the designated field. -![Step 16 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-15.png) +![Step 16 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-15.png) ### Step 17 Begin by selecting the operating system you're using to generate validator keys, as this will determine the appropriate version of the key generation tool for your setup. -![Step 17 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-16.png) +![Step 17 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-16.png) ### Step 18 Return to the staking launchpad page and confirm that you've securely stored your validator keys and written down your mnemonic phrase by checking the box. This step is essential for ensuring the security and recoverability of your staking operation. After confirming, click "CONTINUE" to proceed with the setup process. -![Step 19 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-18.png) +![Step 19 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-18.png) ## Part 3 / 5 | Validator Key Generation ### Step 19 For a user-friendly experience, opt for the Wagyu Key Gen application. This graphical user interface (GUI) tool, developed by the ETH Staker community, simplifies the key generation process. Though other options are available, Wagyu is highly recommended for its ease of use. After clicking on "DOWNLOAD FROM GITHUB," locate and download the Wagyu version that corresponds to your operating system. -![Step 18 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-17.png) +![Step 18 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-17.png) ### Step 20 Once the Wagyu download is complete, launch the application. Before generating keys, switch to the network you plan to use by clicking the network selector. For enhanced security, disconnect from the internet while you generate your validator keys, as this step involves sensitive information that should remain private. -![Step 20 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-19.png) +![Step 20 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-19.png) ### Step 21 Read the information provided within the Wagyu Key Gen application carefully. When ready, initiate the creation of your secret recovery phrase by clicking "Create" and then "CREATE NEW SECRET RECOVERY PHRASE." -![Step 21 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-20.png) +![Step 21 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-20.png) ### Step 22 Securely record your Secret Recovery Phrase. It's vital to back it up accurately and in the correct order, as it is the only way to recover your funds if needed. The best practice for keeping this phrase secure is to write it down on paper and store it in a safe place. Remember, the security of your funds is as reliable as your backup. -![Step 22 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-21.png) +![Step 22 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-21.png) ### Step 23 After backing up your Secret Recovery Phrase, re-enter it in the Wagyu Key Gen tool to verify its accuracy. Click "Check" to confirm you've recorded it correctly, ensuring you can access your funds when necessary. -![Step 23 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-22.png) +![Step 23 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-22.png) ### Step 24 Enter how many validator keys you'd like to create and set a strong password for them. This password will be used to secure your validator keys, so make it complex and keep it safe. -![Step 24 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-23.png) +![Step 24 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-23.png) ### Step 25 If you want to set an Ethereum Withdrawal Address, enter it now. This is where your funds will be sent when you perform a withdrawal. It's optional at this stage but remember that the address must be under your control and can be linked to your secret recovery phrase later if not provided now. -![Step 25 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-24.png) +![Step 25 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-24.png) ### Step 26 Retype your password to confirm it. Make sure you re-enter the same password you chose for your validator keys. This step is crucial for the security of your keys and will be needed every time you perform important operations with your validator. -![Step 26 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-25.png) +![Step 26 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-25.png) ### Step 27 Click on "Browse" to open Windows Explorer and navigate to the folder where you want to save your validator key(s). It's important to choose a secure and backed-up location because these keys will control your validator. Once you've selected the folder, verify that the path is correct and click "Create" to generate your keys. -![Step 27 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-26.png) +![Step 27 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-26.png) ### Step 28 Allow some time for the Wagyu application to generate your secret recovery phrase. It's essential to wait until the process is complete, which may take up to 30 seconds or more, depending on the number of keys. -![Step 28 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-27.png) +![Step 28 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-27.png) ### Step 29 Once your keys are generated, a screen will confirm that the keys are successfully created and saved to the specified directory. Review the information to ensure all is in order, then you can close the Wagyu application. -![Step 29 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-28.png) +![Step 29 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-28.png) ## Part 4 / 5 | Validator Key Deposit ### Step 30 Revisit the Ethereum staking launchpad webpage where you initially started the validator setup process. -![Step 30 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-29.png) +![Step 30 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-29.png) ### Step 31 On the launchpad site, click on the area indicated to "Drag File To Upload or Browse" and select the "Deposit_Data_[TIMESTAMP].json" file that was generated earlier. This file contains the public key associated with your validator and is required to proceed with the staking process on the launchpad. After selecting the file, click "Continue". -![Step 31 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-30.png) +![Step 31 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-30.png) ### Step 32 You will be prompted to connect an Ethereum wallet, such as Metamask. This is necessary to make the deposit for your validator. Follow the instructions to securely connect your wallet to the staking launchpad. Once connected, you will be able to proceed with the deposit transaction. -![Step 32 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-31.png) +![Step 32 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-31.png) ### Step 33 Confirm that your MetaMask wallet is connected to the correct network and that you have enough Testnet ETH to cover the transaction gas fee. -![Step 33 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-32.png) +![Step 33 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-32.png) ### Step 34 Carefully read the summary page, which will show the number of validators you are setting up and the total amount of Testnet ETH required. -![Step 34 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-33.png) +![Step 34 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-33.png) ### Step 35 Check all the necessary boxes to acknowledge the risks and affirm that you understand the transaction is not reversible. -![Step 35 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-34.png) +![Step 35 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-34.png) ### Step 36 Ensure Metamask wallet shows as connected on the launchpad site. Confirm your network and balance are correct, as these are required for making the validator deposit. -![Step 36 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-35.png) +![Step 36 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-35.png) ### Step 37 Click on "Send Deposit" to initiate the deposit of your ETH. Confirm the transaction in your MetaMask wallet. Ensure you have sufficient balance to cover the deposit and the associated gas fees. After reviewing the transaction details, click "Confirm" to proceed. -![Step 37 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-36.png) +![Step 37 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-36.png) ### Step 38 After the deposit, monitor the status of your validator key. It will join a queue before it is activated. To check the status, visit one of the provided beacon chain explorers (beaconcha.in,, or holesky.beaconcha.in) and enter your validator public key to track the activation process. -![Step 38 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-37.png) +![Step 38 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-37.png) ## Part 5 / 5 | Validator Key Import & Further Configuration ### Step 39 Open the Stereum application and log into your server. Navigate to the "Staking" section. To import your validator key, click on the 'Click or Drag to Insert Key' area or simply drag and drop your validator key file onto it. -![Step 39 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-38.png) +![Step 39 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-38.png) ### Step 40 Once you click or drag to insert the key, a file explorer will open. Navigate to the location of your validator key files, select them, and choose the validator client (like Lighthouse, Prysm, etc.) that you want to import your keys into. This is where you specify which client will manage your validator duties. -![Step 40 Screenshot](../../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-40.png) +![Step 40 Screenshot](../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-40.png) ### Step 41 A dialogue will appear asking if you want to import with a Slashing Protection Database. Choose "No" if you have not previously imported these keys into a different client or if this is your initial setup. Click "Import" to proceed with importing your validator key without the Slashing Protection Database. This will initiate the import process for your validator key into the client. -![Step 41 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-40.png) +![Step 41 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-40.png) ### Step 42 Enter the password you created for your validator keys during their generation phase. -![Step 42 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-41.png) +![Step 42 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-41.png) ### Step 43 After entering your password and confirming the action, wait for the Stereum system to import your validator keys. This process will integrate your keys with the client and prepare it for staking operations. -![Step 43 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-42.png) +![Step 43 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-42.png) ### Step 44 Wait for the import process to complete. The interface will indicate when the validator key has been successfully imported into Stereum. -![Step 44 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-43.png) +![Step 44 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-43.png) ### Step 45 To set up block rewards, navigate to the "Node" tab and access the settings of your Validator Client. -![Step 45 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-44.png) +![Step 45 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-44.png) ### Step 46 Find the "Default Fee Recipient" section and click the pencil icon to edit the address to which block rewards will be sent. -![Step 46 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-45.png) +![Step 46 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-45.png) ### Step 47 After entering your chosen address, confirm and apply the changes by clicking "Confirm & Restart." Your Validator Client will restart to apply these settings. If it does not automatically restart, do it manually. -![Step 47 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-46.png) +![Step 47 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-46.png) ### Step 48 Once your node is fully synchronized with the network and your validator key has been processed through the deposit queue, you will begin to perform attestation duties. This signals that you are actively participating in the network and can start earning rewards. -![Step 48 Screenshot](../../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-47.png) +![Step 48 Screenshot](../../../../../static/screenshots/guides/ethereum-solo-staking/ethereum-solo-staking-47.png) @@ -264,10 +264,10 @@ Once your node is fully synchronized with the network and your validator key has Go back to your node page and choose the Flashbots MEV Boost symbol to proceed. -![Step 48 Screenshot](../../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-49.png) +![Step 48 Screenshot](../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-49.png) ### Change Relays To change or add new block relays, select from the available options displayed on the list. -![Step 48 Screenshot](../../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-50.png) \ No newline at end of file +![Step 48 Screenshot](../../../../../static/screenshots/guides/mev-boosted-staking/mev-boosted-staking-50.png) \ No newline at end of file diff --git a/docs/02-guides/02-installation/01-use-case-guides/01-staking/00-ethereum/04-obol-clustered-ethereum-solo-staking.md b/docs/02-installation/00-tutorial-guides/01-staking/00-ethereum/04-obol-clustered-ethereum-solo-staking.md similarity index 100% rename from docs/02-guides/02-installation/01-use-case-guides/01-staking/00-ethereum/04-obol-clustered-ethereum-solo-staking.md rename to docs/02-installation/00-tutorial-guides/01-staking/00-ethereum/04-obol-clustered-ethereum-solo-staking.md diff --git a/docs/02-guides/02-installation/01-use-case-guides/01-staking/00-ethereum/_category_.json b/docs/02-installation/00-tutorial-guides/01-staking/00-ethereum/_category_.json similarity index 69% rename from docs/02-guides/02-installation/01-use-case-guides/01-staking/00-ethereum/_category_.json rename to docs/02-installation/00-tutorial-guides/01-staking/00-ethereum/_category_.json index 9411367..251927b 100644 --- a/docs/02-guides/02-installation/01-use-case-guides/01-staking/00-ethereum/_category_.json +++ b/docs/02-installation/00-tutorial-guides/01-staking/00-ethereum/_category_.json @@ -1,5 +1,5 @@ { - "label": "Ethereum", + "label": "Ethereum Setup", "position": 1, "link": { "type": "generated-index" diff --git a/docs/02-guides/02-installation/01-use-case-guides/01-staking/01-gnosis/01-gnosis-staking.md b/docs/02-installation/00-tutorial-guides/01-staking/01-gnosis/01-gnosis-staking.md similarity index 100% rename from docs/02-guides/02-installation/01-use-case-guides/01-staking/01-gnosis/01-gnosis-staking.md rename to docs/02-installation/00-tutorial-guides/01-staking/01-gnosis/01-gnosis-staking.md diff --git a/docs/02-guides/02-installation/01-use-case-guides/01-staking/01-gnosis/_category_.json b/docs/02-installation/00-tutorial-guides/01-staking/01-gnosis/_category_.json similarity index 71% rename from docs/02-guides/02-installation/01-use-case-guides/01-staking/01-gnosis/_category_.json rename to docs/02-installation/00-tutorial-guides/01-staking/01-gnosis/_category_.json index 0fa275b..4fad09b 100644 --- a/docs/02-guides/02-installation/01-use-case-guides/01-staking/01-gnosis/_category_.json +++ b/docs/02-installation/00-tutorial-guides/01-staking/01-gnosis/_category_.json @@ -1,5 +1,5 @@ { - "label": "Gnosis", + "label": "Gnosis Setup", "position": 2, "link": { "type": "generated-index" diff --git a/docs/02-guides/02-installation/01-use-case-guides/01-staking/_category_.json b/docs/02-installation/00-tutorial-guides/01-staking/_category_.json similarity index 100% rename from docs/02-guides/02-installation/01-use-case-guides/01-staking/_category_.json rename to docs/02-installation/00-tutorial-guides/01-staking/_category_.json diff --git a/docs/02-guides/02-installation/01-use-case-guides/02-blockchain-data/01-installation-archive-node.md b/docs/02-installation/00-tutorial-guides/02-blockchain-data/01-installation-archive-node.md similarity index 100% rename from docs/02-guides/02-installation/01-use-case-guides/02-blockchain-data/01-installation-archive-node.md rename to docs/02-installation/00-tutorial-guides/02-blockchain-data/01-installation-archive-node.md diff --git a/docs/02-guides/02-installation/01-use-case-guides/02-blockchain-data/02-rpc-connection.md b/docs/02-installation/00-tutorial-guides/02-blockchain-data/02-rpc-connection.md similarity index 100% rename from docs/02-guides/02-installation/01-use-case-guides/02-blockchain-data/02-rpc-connection.md rename to docs/02-installation/00-tutorial-guides/02-blockchain-data/02-rpc-connection.md diff --git a/docs/02-guides/02-installation/01-use-case-guides/02-blockchain-data/_category_.json b/docs/02-installation/00-tutorial-guides/02-blockchain-data/_category_.json similarity index 63% rename from docs/02-guides/02-installation/01-use-case-guides/02-blockchain-data/_category_.json rename to docs/02-installation/00-tutorial-guides/02-blockchain-data/_category_.json index b9a31ba..c812b0b 100644 --- a/docs/02-guides/02-installation/01-use-case-guides/02-blockchain-data/_category_.json +++ b/docs/02-installation/00-tutorial-guides/02-blockchain-data/_category_.json @@ -1,5 +1,5 @@ { - "label": "Blockchain Data", + "label": "RPC/Data API/Websockets", "position": 2, "link": { "type": "generated-index" diff --git a/docs/02-guides/02-installation/01-use-case-guides/03-node-operator/lido/01-lido-sdvtm-obol.md b/docs/02-installation/00-tutorial-guides/03-node-operation/01_lido/01-lido-sdvtm-obol.md similarity index 100% rename from docs/02-guides/02-installation/01-use-case-guides/03-node-operator/lido/01-lido-sdvtm-obol.md rename to docs/02-installation/00-tutorial-guides/03-node-operation/01_lido/01-lido-sdvtm-obol.md diff --git a/docs/02-guides/02-installation/01-use-case-guides/03-node-operator/lido/02-lido-sdvtm-ssv.md b/docs/02-installation/00-tutorial-guides/03-node-operation/01_lido/02-lido-sdvtm-ssv.md similarity index 85% rename from docs/02-guides/02-installation/01-use-case-guides/03-node-operator/lido/02-lido-sdvtm-ssv.md rename to docs/02-installation/00-tutorial-guides/03-node-operation/01_lido/02-lido-sdvtm-ssv.md index aca9a92..a94e688 100644 --- a/docs/02-guides/02-installation/01-use-case-guides/03-node-operator/lido/02-lido-sdvtm-ssv.md +++ b/docs/02-installation/00-tutorial-guides/03-node-operation/01_lido/02-lido-sdvtm-ssv.md @@ -54,73 +54,73 @@ On the "Control" page, keep an eye on the synchronization status of both blockch Click on the SSV Network icon located at the top of the interface to access specific network features. -![Step 11 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-10.png) +![Step 11 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-10.png) ### Step 12: Generate Encrypted Operator Key Pair In the SSV Network options, click "Generate" on the "Generate Encrypted Pair" section to secure your operator node with an encrypted key pair. -![Step 12 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-11.png) +![Step 12 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-11.png) ### Step 13: Set Operator Password Enter a strong password to encrypt your operator key pair, then click "Generate". Download the backup of the encryption details for safekeeping. -![Step 13 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-12.png) +![Step 13 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-12.png) ### Step 14: Enter and Confirm Your Password After setting your password for the encrypted operator key, click "Confirm" to secure the encryption settings and safeguard your key. -![Step 14 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-13.png) +![Step 14 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-13.png) ### Step 15: Confirm Warning Acknowledge the warning by clicking "Confirm" to ensure that you have noted your password and understand the importance of keeping your backup secure. -![Step 15 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-14.png) +![Step 15 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-14.png) ### Step 16: Download Backup Download a backup of the generated private key and password you used for encryption. This file should be kept in a safe location as it is critical for recovery and security. -![Step 16 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-15.png) +![Step 16 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-15.png) ### Step 17: Join as Operator Once on the SSV Network website, click the "Join As Operator" button to participate as an operator, which involves managing validators and contributing to network operations. -![Step 17 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-18.png) +![Step 17 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-18.png) ### Step 18: Register as an Operator After clicking "Join As Operator", select "Register Operator" to proceed with the registration process. This involves providing necessary details and your operator key to officially register as an operator on the network. -![Step 18 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-19.png) +![Step 18 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-19.png) ### Step 19: Approve Connection On the SSV Network site, approve the connection request, which allows the site to interact with your digital wallet (for example MetaMask) for necessary transactions and authorizations. -![Step 19 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-20.png) +![Step 19 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-20.png) ### Step 20: Unlock Your Ethereum Wallet Unlock the Ethereum wallet of your choice by entering your password to authorize further operations and validate your identity as part of the operator registration process. -![Step 20 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-21.png) +![Step 20 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-21.png) ### Step 21: Connect to Your Ethereum Wallet Finally, in your Ethereum wallet (for example, MetaMask), select the specific account you wish to use for the SSV Network operations and click "Connect" to establish the connection and complete the setup. -![Step 21 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-22.png) +![Step 21 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-22.png) ### Step 22: Paste Your Public Operator Key Copy your Public Operator Key from the Stereum app and paste it into the field shown in your browser. This key allows you to be uniquely identified within the network, enabling other validators to select you as their operator. -![Step 22 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-23.png) +![Step 22 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-23.png) ### Step 23: Set Operator Fee @@ -138,7 +138,7 @@ A confirmation request will appear in your Ethereum wallet of choice, for exampl Once confirmed, you will see a transaction hash. You can click on this hash to view the transaction details on Etherscan or another blockchain explorer. -![Step 26 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-27.png) +![Step 26 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-27.png) ## Permissioned Operator Configuration diff --git a/docs/02-guides/02-installation/01-use-case-guides/03-node-operator/lido/03-lido-csm.md b/docs/02-installation/00-tutorial-guides/03-node-operation/01_lido/03-lido-csm.md similarity index 58% rename from docs/02-guides/02-installation/01-use-case-guides/03-node-operator/lido/03-lido-csm.md rename to docs/02-installation/00-tutorial-guides/03-node-operation/01_lido/03-lido-csm.md index c09756e..99c8a1e 100644 --- a/docs/02-guides/02-installation/01-use-case-guides/03-node-operator/lido/03-lido-csm.md +++ b/docs/02-installation/00-tutorial-guides/03-node-operation/01_lido/03-lido-csm.md @@ -4,42 +4,42 @@ ### Step 1 To begin setting up your server for crypto transactions with Stereum, start by logging into your server management system. Enter the server's IP address, username, and password, then proceed to log in. This step is critical for establishing a secure connection to your server where the node will be installed. -![Step 1 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-1.png) +![Step 1 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-1.png) ### Step 2 Once logged in, navigate to the server configuration dashboard. Look for the "One Click Installation" option which is recommended for beginners due to its simplicity and automated setup process. Select this to initiate the installation of your node with minimal hassle. -![Step 2 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-2.png) +![Step 2 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-2.png) ### Step 3 In the one-click installation section, choose your use case and network. For this guide, select the "CSM Node Operator" option to participate in blockchain validation and earning rewards. From the network dropdown, pick an Ethereum testnet like Holesky. -![Step 3 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-3.png) +![Step 3 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-3.png) ### Step 4 Ensure you set the appropriate data path for your server by selecting the right storage volume. This step affects your node's performance and stability. When setting up your node, try to alternate between different execution and consensus clients to optimize performance and network resilience. Set the installation directory, usually `/opt/stereum`, to keep your services well-organized for easy management. -![Step 4 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-4.png) +![Step 4 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-4.png) ### Step 5 The next step involves setting the synchronization method for your node clients. The recommended 'Checkpoint Sync' method allows a quicker synchronization with the blockchain by starting from a known good state. Choose a trusted source for your checkpoint, which will influence the integrity and reliability of your node's data. -![Step 5 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-5.png) +![Step 6 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-6.png) ### Step 6 -Choose from a range of block relays available for your node. Each relay offers different performance characteristics and geographical distribution. Select the block relays that best fit your operational requirements and expected validator performance. +Keep the relay selection as is, as these are the necessary relays mandated to run Lido CSM. -![Step 6 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-6.png) +![Step 5 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-5.png) ### Step 7 Finally, you’ll confirm the installation paths for each component you’re setting up on your server. This summary screen lists all the chosen services with their respective categories and installation paths, ensuring you have a clear overview of where each service will reside on the server. It’s important to verify that each path is correct to prevent any future operational issues. -![Step 7 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-7.png) +![Step 7 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-7.png) ### Step 8 Continue & wait for the installation to complete. This process might take some time depending on the server and network conditions. -![Step 8 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-8.png) +![Step 8 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-8.png) ## Part 2 / 4 Validator Key Generation @@ -47,130 +47,146 @@ Continue & wait for the installation to complete. This process might take some t ### Step 9 Read the information provided within the Wagyu Key Gen application carefully. When ready, initiate the creation of your secret recovery phrase by clicking "CREATE NEW SECRET RECOVERY PHRASE." -![Step 10 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-9.png) +![Step 10 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-9.png) ### Step 10 Securely record your Secret Recovery Phrase. It's vital to back it up accurately and in the correct order, as it is the only way to recover your funds if needed. The best practice for keeping this phrase secure is to write it down on paper and store it in a safe place. Remember, the security of your funds is as reliable as your backup. -![Step 11 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-10.png) +![Step 11 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-10.png) ### Step 11 After backing up your Secret Recovery Phrase, re-enter it in the Wagyu Key Gen tool to verify its accuracy. Click "Check" to confirm you've recorded it correctly, ensuring you can access your funds when necessary. -![Step 12 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-11.png) +![Step 12 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-11.png) ### Step 12 Enter how many validator keys you'd like to create and set a strong password for them. This password will be used to secure your validator keys, so make it complex and keep it safe. -![Step 13 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-22.png) +![Step 13 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-22.png) ### Step 13 -Now for the Withdrawal Address, enter the Withdrawal adress of the Lido Holesky CSM Smart Contract (Withdrawal: 0xF0179dEC45a37423EAD4FaD5fCb136197872EAd9). You can find it under this link: https://dvt-homestaker.stakesaurus.com/bonded-validators-setup/lido-csm/generating-csm-keystores. +Now for the Withdrawal Address, enter the Withdrawal adress of the Lido Holesky CSM Smart Contract (Mainnet: 0xB9D7934878B5FB9610B3fE8A5e441e8fad7E293f | Holesky Testnet: 0xF0179dEC45a37423EAD4FaD5fCb136197872EAd9). You can find it under this link: https://dvt-homestaker.stakesaurus.com/bonded-validators-setup/lido-csm/generating-csm-keystores. -![Step 14 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-13.png) +![Step 14 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-13.png) ### Step 14 Retype your password to confirm it. Make sure you re-enter the same password you chose for your validator keys. This step is crucial for the security of your keys and will be needed every time you perform important operations with your validator. -![Step 15 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-14.png) +![Step 15 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-14.png) ### Step 15 Click on "Browse" to open Windows Explorer and navigate to the folder where you want to save your validator key(s). It's important to choose a secure and backed-up location because these keys will control your validator. Once you've selected the folder, verify that the path is correct and click "Create" to generate your keys. -![Step 16 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-15.png) +![Step 16 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-15.png) ### Step 16 Once your keys are generated, a screen will confirm that the keys are successfully created and saved to the specified directory. Review the information to ensure all is in order, then you can close the Wagyu application. -![Step 18 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-16.png) +![Step 18 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-16.png) ## Part 3 / 4 Lido CSM Node Operator registration ### Step 17 -Acces the following link: https://csm.testnet.fi/. To participate as a Node Operator in the Community Staking Module, begin by clicking the I am a Node Operator button on the Lido CSM portal. This selection marks your intent to manage and operate nodes within the Lido on Ethereum protocol. +Visit: [CSM - Mainnet](https://csm.lido.fi/?ref=stereum) [CSM - Holesky Testnet](https://csm.testnet.fi/?ref=stereum) to access the page. To participate as a Node Operator in the Community Staking Module, begin by clicking the I am a Node Operator button on the Lido CSM portal. This selection marks your intent to manage and operate nodes within the Lido on Ethereum protocol. -![Step 19 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-17.png) +![Step 19 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-17.png) ### Step 18 Next, connect your wallet to the platform. You can use MetaMask, Ledger, or any other supported wallets by selecting them from the list. This is crucial for transaction approvals and interactions on the network. -![Step 20 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-18.png) +![Step 20 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-18.png) ### Step 19 Choose the amount of ETH you wish to bond and upload the corresponding deposit data. Ensure you have the JSON file (the deposit data file from Wagyu Key Gen tool) ready as it contains necessary details for the bonding process. Click Submit to proceed. -![Step 21 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-20.png) +![Step 21 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-20.png) ### Step 20 After submitting your bond, a confirmation dialogue will appear in your Ethereum wallet of choice, e.g., MetaMask. Review the transaction details thoroughly, then click Confirm to finalize your bond. -![Step 23 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-21.png) +![Step 23 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-21.png) ### Step 21 Wait for the transaction to process. This may take some time depending on network conditions. Meanwhile you can check the status of your transaction on: https://etherscan.io/ -![Step 24 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-23.png) +![Step 24 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-23.png) ### Step 22 Finally, verify the status of the key deposited for you. -![Step 25 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-24.png) - +![Step 25 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-24.png) ### Step 23 When you imported, now you can setup the Validator Ejector service correctly. Enter the settings of the service and put in your operator ID from the Lido dashboard -![Step 25.1 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-25.1.png) +![Step 25.1 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-25.1.png) + +### Step 24 +Navigate to the Node page and locate the CSM Monitoring service. Click on the settings icon to open its configuration panel. + +![Step 26 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-24.1.png) + +### Step 25 +In the configuration panel, enable Expert Mode and find the NO_ID field. Enter your Operator ID and confirm the changes. + +![Step 27 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-25.2.png) ## Part 4 / 4 Validator Key Import -### Step 24 +### Step 26 In Stereum, after completing the initial setup, you will be directed to the node page. Here, you can view and manage your node's configuration. Click on the "Open" button next to the setup you wish to configure or review. -![Step 26 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-25.png) +![Step 26 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-25.png) -### Step 25 +### Step 27 Once you've opened the node configuration and can view all three clients, proceed by clicking on the settings button for the validator client. This will allow you to adjust or verify specific settings for your validator operations. -![Step 27 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-26.png) +![Step 27 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-26.png) ### Step 26 -Before restarting your node, recall that you will have to use a designated fee recipient address (0xE73a3602b99f1f913e72F8bdcBC235e206794Ac8) as a CSM operator, which is a key configuration for receiving transaction fees. You can find the necessary details on setting this up at Lido's specific guidance page: https://dvt-homestaker.stakesaurus.com/bonded-validators-setup/lido-csm/running-a-separate-vc-service#configure-the-separate-vc-service. After updating this setting in your node configuration, click on the Confirm & Restart button to apply the new configurations and restart the node. +Before restarting your node, recall that you will have to use a designated fee recipient address (Mainnet: 0x388C818CA8B9251b393131C08a736A67ccB19297 | Holesky Testnet: 0xE73a3602b99f1f913e72F8bdcBC235e206794Ac8) as a CSM operator, which is a key configuration for receiving transaction fees. As Stereum should automatically set this, make sure to check this setting in your validator client configuration for the right address. -![Step 28 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-27.png) +![Step 28 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-27.png) -### Step 27 +### Step 29 Once the validator client restarts, navigate to the Staking tab. Here, you can begin the process of inserting your validator key by clicking on the Click or Drag to Insert Key area. -![Step 29 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-28.png) +![Step 29 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-28.png) -### Step 28 +### Step 30 Select and import the validator key you have generated with the Wagyu generator. Ensure you choose the correct file that corresponds with your validator client settings. -![Step 30 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-29.png) +![Step 30 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-29.png) -### Step 29 +### Step 31 Approve the validator client you will use by selecting it. -![Step 31 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-30.png) +![Step 31 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-30.png) -### Step 30 +### Step 32 After selecting the validator key, you will be prompted to enter the password that you set up during the key generation in Wagyu. Input your password to authenticate and finalize the import process. -![Step 32 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-31.png) +![Step 32 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-31.png) -### Step 31 +### Step 33 After importing your validator key, a confirmation screen will appear. If Doppelgänger Protection is enabled, you'll have the option to import with a Slashing Protection Database. Select 'Yes' to proceed with enhanced security measures or 'No' if you choose to bypass this step. Finally, click 'Import' to complete the setup of your validator key. -![Step 33 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-32.png) +![Step 33 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-32.png) -### Step 32 +### Step 34 After selecting the "Import" option, you should see a confirmation that the validator key has been successfully imported. This will confirm the validator key's registration in the system. -![Step 34 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-34.png) +![Step 34 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-34.png) -### Step 33 +### Step 35 Once the key is imported, navigate to the "Staking" tab. You should see the validator key appear under the node tab, indicating that the system recognizes your validator. -![Step 35 Screenshot](../../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-33.png) +![Step 35 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-33.png) + +### Step 36 +Navigate to the Control page and open the dropdown menu. Select Lido CSM Operator to access the monitoring service dashboard. + +![Step 36 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-35.png) + +![Step 37 Screenshot](../../../../../static/screenshots/guides/lido-csm-operator/lido-csm-36.png) diff --git a/docs/02-installation/00-tutorial-guides/03-node-operation/01_lido/_category_.json b/docs/02-installation/00-tutorial-guides/03-node-operation/01_lido/_category_.json new file mode 100644 index 0000000..31675d4 --- /dev/null +++ b/docs/02-installation/00-tutorial-guides/03-node-operation/01_lido/_category_.json @@ -0,0 +1,6 @@ +{ + "label": "Lido Node Operation", + "link": { + "type": "generated-index" + } +} diff --git a/docs/02-installation/00-tutorial-guides/03-node-operation/02_obol/01-obol-network-node-operator.md b/docs/02-installation/00-tutorial-guides/03-node-operation/02_obol/01-obol-network-node-operator.md new file mode 100644 index 0000000..c6a0f04 --- /dev/null +++ b/docs/02-installation/00-tutorial-guides/03-node-operation/02_obol/01-obol-network-node-operator.md @@ -0,0 +1,154 @@ +# SSV Network Node Operator Guide + +## Part 1 / 2 | SSV Network Node Setup + +### Step 1: Server Login +Open your server management dashboard to log in. Provide the server name, IP address, username, and password, or connect using an SSH key if configured. + +![Step 1 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-1.png) + +### Step 2: Initiate One-Click Installation +Navigate to the "One Click Installation" feature in the welcome area, specifically designed to simplify the installation process for beginners. + +![Step 2 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-2.png) + +### Step 3: Select the Network +Choose the appropriate network for your needs. For testing and development purposes, select "Holesky Testnet" by clicking on the "SSV Network" icon. For operating the node with real funds, select "Ethereum Mainnet" to ensure robust security and operational reliability. + +![Step 3 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-3.png) + +### Step 4: Configure Installation Path +Enter the correct installation path in the 'Installation Path' input field on your local server. Make sure to use the correct storage volume to prevent data issues. + +![Step 4 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-4.png) + +### Step 5: Sync Settings +Change to "Checkpoint Sync" under sync options to decrease synchronization times. Select from the available checkpoints to reduce the sync period by days. + +![Step 5 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-5.png) + +### Step 6: Complete Installation +Review your settings, then proceed with the installation by clicking 'Next'. The installation will continue, and you can track the progress on your dashboard. + +![Step 6 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-6.png) + +### Step 7: Await Installation Completion +After setting your configurations, allow the installation to complete. + +![Step 7 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-7.png) + +### Step 8: Node Initialization +Once the initial setup finishes, you will land on the node page. Watch for the status indicators of each client; they must turn green from red, indicating they are active and running. Proceed to the "Control" tab once all clients are active. + +![Step 8 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-8.png) + +### Step 9: Synchronize Clients +Wait for the synchronization of both the Execution and Consensus clients. Typically, the Consensus Client synchronization completes before the Execution Client starts its process. + +![Step 9 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-9.png) + +### Step 10: Access SSV Network Features +Click on the SSV Network icon located at the top of the interface to access specific network features. + +![Step 10 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-10.png) + +### Step 11: Generate Encrypted Operator Key Pair +In the SSV Network options, click "Generate" on the "Generate Encrypted Pair" section to secure your operator node with an encrypted key pair. + +![Step 11 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-11.png) + +### Step 12: Set Operator Password +Enter a strong password to encrypt your operator key pair, then click "Generate". Download the backup of the encryption details for safekeeping. + +![Step 12 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-12.png) + +### Step 13: Enter and Confirm Your Password +After setting your password for the encrypted operator key, click "Confirm" to secure the encryption settings and safeguard your key. + +![Step 13 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-13.png) + +### Step 14: Confirm Warning +Acknowledge the warning by clicking "Confirm" to ensure that you have noted your password and understand the importance of keeping your backup secure. + +![Step 14 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-14.png) + +### Step 15: Download Backup +Download a backup of the generated private key and password you used for encryption. This file should be kept in a safe location as it is critical for recovery and security. + +![Step 15 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-15.png) + +### Step 16: Copy Public Operator Key and Register +In the Operator Dashboard, click "Copy" to copy your public operator key to the clipboard. Then, click "Open in Browser" to navigate to the SSV network site where you can complete your registration as an operator. + +![Step 16 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-16.png) + +### Step 17: Press "Open in Browser" +Click the "Open in Browser" button on the Operator Dashboard interface to launch the web browser and direct it to the SSV Network website. + +![Step 17 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-17.png) + + + +## Part 2 / 2 | Operator Registration + + +### Step 18: Join as Operator +Once on the SSV Network website, click the "Join As Operator" button to participate as an operator, which involves managing validators and contributing to network operations. + +![Step 18 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-18.png) + +### Step 19: Register as an Operator +After clicking "Join As Operator", select "Register Operator" to proceed with the registration process. This involves providing necessary details and your operator key to officially register as an operator on the network. + +![Step 19 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-19.png) + +### Step 20: Approve Connection +On the SSV Network site, approve the connection request which allows the site to interact with your digital wallet (for example MetaMask) for necessary transactions and authorizations. + +![Step 20 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-20.png) + +### Step 21: Unlock Your Ethereum Wallet +Unlock the Ethereum wallet of your choice by entering your password to authorize further operations and validate your identity as part of the operator registration process. + +![Step 21 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-21.png) + +### Step 22: Connect to Your Ethereum Wallet +Finally, in your Ethereum wallet (for example, MetaMask), select the specific account you wish to use for the SSV Network operations and click "Connect" to establish the connection and complete the setup. + +![Step 22 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-22.png) + +### Step 23: Paste Your Public Operator Key +Copy your Public Operator Key from the Stereum app and paste it into the field shown in your browser. This key allows you to be uniquely identified within the network, enabling other validators to select you as their operator. + +![Step 23 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-23.png) + +### Step 24: Set Operator Fee +Enter the annual fee in SSV tokens that you wish to charge validators for your services. This fee will be presented as an annual payment but is typically paid to operators continuously for each block processed. + +![Step 24 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-24.png) + +### Step 25: Confirm Operator Fee and Details +After setting your fee, you will see a summary of the transaction details. Verify the information, especially the operator key and the annual fee, then click "Register Operator" to proceed. + +![Step 25 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-25.png) + +### Step 26: Confirm Transaction in Ethereum Wallet +A confirmation request will appear in your Ethereum wallet of choice, for example, MetaMask. Review the transaction details, ensuring the fee and recipient details are correct, then confirm the transaction. + +![Step 26 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-26.png) + +### Step 27: Transaction Confirmed +Once confirmed, you will see a transaction hash. You can click on this hash to view the transaction details on Etherscan or another blockchain explorer. + +![Step 27 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-27.png) + +### Step 29: Welcome to the SSV Network +Congratulations! You are now an official operator on the SSV network. Your operator ID will be displayed, and you can now manage the validators associated with your node. + +![Step 29 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-28.png) + +### Step 30: Manage Operators +After registering, you can view and manage your operators in the dashboard. Here, you can see each operator's ID, status, performance over the last 30 days, balance, yearly fee, and the number of validators. You can add more operators by clicking "Add Operator". + +![Step 30 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-29.png) + diff --git a/docs/02-guides/02-installation/01-use-case-guides/03-node-operator/ssv-network/_category_.json b/docs/02-installation/00-tutorial-guides/03-node-operation/02_obol/_category_.json similarity index 61% rename from docs/02-guides/02-installation/01-use-case-guides/03-node-operator/ssv-network/_category_.json rename to docs/02-installation/00-tutorial-guides/03-node-operation/02_obol/_category_.json index 71819c9..55c06ee 100644 --- a/docs/02-guides/02-installation/01-use-case-guides/03-node-operator/ssv-network/_category_.json +++ b/docs/02-installation/00-tutorial-guides/03-node-operation/02_obol/_category_.json @@ -1,5 +1,5 @@ { - "label": "SSV Network", + "label": "Obol DVT Network", "link": { "type": "generated-index" } diff --git a/docs/02-guides/02-installation/01-use-case-guides/03-node-operator/ssv-network/01-ssv-network-node-operator.md b/docs/02-installation/00-tutorial-guides/03-node-operation/03_ssv-network/01-ssv-network-node-operator.md similarity index 63% rename from docs/02-guides/02-installation/01-use-case-guides/03-node-operator/ssv-network/01-ssv-network-node-operator.md rename to docs/02-installation/00-tutorial-guides/03-node-operation/03_ssv-network/01-ssv-network-node-operator.md index 81b8533..c6a0f04 100644 --- a/docs/02-guides/02-installation/01-use-case-guides/03-node-operator/ssv-network/01-ssv-network-node-operator.md +++ b/docs/02-installation/00-tutorial-guides/03-node-operation/03_ssv-network/01-ssv-network-node-operator.md @@ -5,87 +5,87 @@ ### Step 1: Server Login Open your server management dashboard to log in. Provide the server name, IP address, username, and password, or connect using an SSH key if configured. -![Step 1 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-1.png) +![Step 1 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-1.png) ### Step 2: Initiate One-Click Installation Navigate to the "One Click Installation" feature in the welcome area, specifically designed to simplify the installation process for beginners. -![Step 2 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-2.png) +![Step 2 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-2.png) ### Step 3: Select the Network Choose the appropriate network for your needs. For testing and development purposes, select "Holesky Testnet" by clicking on the "SSV Network" icon. For operating the node with real funds, select "Ethereum Mainnet" to ensure robust security and operational reliability. -![Step 3 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-3.png) +![Step 3 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-3.png) ### Step 4: Configure Installation Path Enter the correct installation path in the 'Installation Path' input field on your local server. Make sure to use the correct storage volume to prevent data issues. -![Step 4 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-4.png) +![Step 4 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-4.png) ### Step 5: Sync Settings Change to "Checkpoint Sync" under sync options to decrease synchronization times. Select from the available checkpoints to reduce the sync period by days. -![Step 5 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-5.png) +![Step 5 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-5.png) ### Step 6: Complete Installation Review your settings, then proceed with the installation by clicking 'Next'. The installation will continue, and you can track the progress on your dashboard. -![Step 6 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-6.png) +![Step 6 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-6.png) ### Step 7: Await Installation Completion After setting your configurations, allow the installation to complete. -![Step 7 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-7.png) +![Step 7 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-7.png) ### Step 8: Node Initialization Once the initial setup finishes, you will land on the node page. Watch for the status indicators of each client; they must turn green from red, indicating they are active and running. Proceed to the "Control" tab once all clients are active. -![Step 8 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-8.png) +![Step 8 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-8.png) ### Step 9: Synchronize Clients Wait for the synchronization of both the Execution and Consensus clients. Typically, the Consensus Client synchronization completes before the Execution Client starts its process. -![Step 9 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-9.png) +![Step 9 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-9.png) ### Step 10: Access SSV Network Features Click on the SSV Network icon located at the top of the interface to access specific network features. -![Step 10 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-10.png) +![Step 10 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-10.png) ### Step 11: Generate Encrypted Operator Key Pair In the SSV Network options, click "Generate" on the "Generate Encrypted Pair" section to secure your operator node with an encrypted key pair. -![Step 11 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-11.png) +![Step 11 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-11.png) ### Step 12: Set Operator Password Enter a strong password to encrypt your operator key pair, then click "Generate". Download the backup of the encryption details for safekeeping. -![Step 12 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-12.png) +![Step 12 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-12.png) ### Step 13: Enter and Confirm Your Password After setting your password for the encrypted operator key, click "Confirm" to secure the encryption settings and safeguard your key. -![Step 13 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-13.png) +![Step 13 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-13.png) ### Step 14: Confirm Warning Acknowledge the warning by clicking "Confirm" to ensure that you have noted your password and understand the importance of keeping your backup secure. -![Step 14 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-14.png) +![Step 14 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-14.png) ### Step 15: Download Backup Download a backup of the generated private key and password you used for encryption. This file should be kept in a safe location as it is critical for recovery and security. -![Step 15 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-15.png) +![Step 15 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-15.png) ### Step 16: Copy Public Operator Key and Register In the Operator Dashboard, click "Copy" to copy your public operator key to the clipboard. Then, click "Open in Browser" to navigate to the SSV network site where you can complete your registration as an operator. -![Step 16 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-16.png) +![Step 16 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-16.png) ### Step 17: Press "Open in Browser" Click the "Open in Browser" button on the Operator Dashboard interface to launch the web browser and direct it to the SSV Network website. -![Step 17 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-17.png) +![Step 17 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-17.png) @@ -95,60 +95,60 @@ Click the "Open in Browser" button on the Operator Dashboard interface to launch ### Step 18: Join as Operator Once on the SSV Network website, click the "Join As Operator" button to participate as an operator, which involves managing validators and contributing to network operations. -![Step 18 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-18.png) +![Step 18 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-18.png) ### Step 19: Register as an Operator After clicking "Join As Operator", select "Register Operator" to proceed with the registration process. This involves providing necessary details and your operator key to officially register as an operator on the network. -![Step 19 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-19.png) +![Step 19 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-19.png) ### Step 20: Approve Connection On the SSV Network site, approve the connection request which allows the site to interact with your digital wallet (for example MetaMask) for necessary transactions and authorizations. -![Step 20 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-20.png) +![Step 20 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-20.png) ### Step 21: Unlock Your Ethereum Wallet Unlock the Ethereum wallet of your choice by entering your password to authorize further operations and validate your identity as part of the operator registration process. -![Step 21 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-21.png) +![Step 21 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-21.png) ### Step 22: Connect to Your Ethereum Wallet Finally, in your Ethereum wallet (for example, MetaMask), select the specific account you wish to use for the SSV Network operations and click "Connect" to establish the connection and complete the setup. -![Step 22 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-22.png) +![Step 22 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-22.png) ### Step 23: Paste Your Public Operator Key Copy your Public Operator Key from the Stereum app and paste it into the field shown in your browser. This key allows you to be uniquely identified within the network, enabling other validators to select you as their operator. -![Step 23 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-23.png) +![Step 23 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-23.png) ### Step 24: Set Operator Fee Enter the annual fee in SSV tokens that you wish to charge validators for your services. This fee will be presented as an annual payment but is typically paid to operators continuously for each block processed. -![Step 24 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-24.png) +![Step 24 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-24.png) ### Step 25: Confirm Operator Fee and Details After setting your fee, you will see a summary of the transaction details. Verify the information, especially the operator key and the annual fee, then click "Register Operator" to proceed. -![Step 25 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-25.png) +![Step 25 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-25.png) ### Step 26: Confirm Transaction in Ethereum Wallet A confirmation request will appear in your Ethereum wallet of choice, for example, MetaMask. Review the transaction details, ensuring the fee and recipient details are correct, then confirm the transaction. -![Step 26 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-26.png) +![Step 26 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-26.png) ### Step 27: Transaction Confirmed Once confirmed, you will see a transaction hash. You can click on this hash to view the transaction details on Etherscan or another blockchain explorer. -![Step 27 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-27.png) +![Step 27 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-27.png) ### Step 29: Welcome to the SSV Network Congratulations! You are now an official operator on the SSV network. Your operator ID will be displayed, and you can now manage the validators associated with your node. -![Step 29 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-28.png) +![Step 29 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-28.png) ### Step 30: Manage Operators After registering, you can view and manage your operators in the dashboard. Here, you can see each operator's ID, status, performance over the last 30 days, balance, yearly fee, and the number of validators. You can add more operators by clicking "Add Operator". -![Step 30 Screenshot](../../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-29.png) +![Step 30 Screenshot](../../../../../static/screenshots/guides/ssv-network-node-operator/ssv-network-node-operator-29.png) diff --git a/docs/02-guides/02-installation/01-use-case-guides/03-node-operator/lido/_category_.json b/docs/02-installation/00-tutorial-guides/03-node-operation/03_ssv-network/_category_.json similarity index 62% rename from docs/02-guides/02-installation/01-use-case-guides/03-node-operator/lido/_category_.json rename to docs/02-installation/00-tutorial-guides/03-node-operation/03_ssv-network/_category_.json index 9c39281..0249136 100644 --- a/docs/02-guides/02-installation/01-use-case-guides/03-node-operator/lido/_category_.json +++ b/docs/02-installation/00-tutorial-guides/03-node-operation/03_ssv-network/_category_.json @@ -1,5 +1,5 @@ { - "label": "Lido", + "label": "SSV DVT Network", "link": { "type": "generated-index" } diff --git a/docs/02-guides/02-installation/01-use-case-guides/03-node-operator/_category_.json b/docs/02-installation/00-tutorial-guides/03-node-operation/_category_.json similarity index 63% rename from docs/02-guides/02-installation/01-use-case-guides/03-node-operator/_category_.json rename to docs/02-installation/00-tutorial-guides/03-node-operation/_category_.json index 2fa981a..5a48b2d 100644 --- a/docs/02-guides/02-installation/01-use-case-guides/03-node-operator/_category_.json +++ b/docs/02-installation/00-tutorial-guides/03-node-operation/_category_.json @@ -1,5 +1,5 @@ { - "label": "Node Operator", + "label": "Node Operation Protocols", "position": 2, "link": { "type": "generated-index" diff --git a/docs/02-installation/00-tutorial-guides/_category_.json b/docs/02-installation/00-tutorial-guides/_category_.json new file mode 100644 index 0000000..f367819 --- /dev/null +++ b/docs/02-installation/00-tutorial-guides/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Tutorial Guides", + "position": 1, + "link": { + "type": "generated-index" + } +} diff --git a/docs/02-guides/02-installation/00-installation-options/01-one-click-installation.md b/docs/02-installation/01-installation-options/01-one-click-installation.md similarity index 89% rename from docs/02-guides/02-installation/00-installation-options/01-one-click-installation.md rename to docs/02-installation/01-installation-options/01-one-click-installation.md index 86ef427..3f97480 100644 --- a/docs/02-guides/02-installation/00-installation-options/01-one-click-installation.md +++ b/docs/02-installation/01-installation-options/01-one-click-installation.md @@ -18,28 +18,28 @@ The One Click Installation process for Stereum is designed to facilitate a seaml During the One-Click Installation process, you will choose your use case based on the available options: - **Staking (Ethereum)**: Set up a node designed for Ethereum staking purposes. - - [Ethereum Solo Staking Guide](../01-use-case-guides/01-staking/00-ethereum/01-ethereum-solo-staking.md) + - [Ethereum Solo Staking Guide](../02-use-case-guides/01-staking/00-ethereum/01-ethereum-solo-staking.md) - **Staking (Gnosis)**: Set up a node designed for Gnosis staking purposes. - - [Gnosis Staking Guide](../01-use-case-guides/01-staking/01-gnosis/01-gnosis-staking.md) + - [Gnosis Staking Guide](../02-use-case-guides/01-staking/01-gnosis/01-gnosis-staking.md) - **MEV-Boosted Staking (Ethereum)**: Configure a Ethereum node optimized for maximizing MEV (Miner Extractable Value) opportunities. - - [MEV-Boosted Guide](../01-use-case-guides/01-staking/00-ethereum/03-ethereum-solo-staking-with-mev-boost.md) + - [MEV-Boosted Guide](../02-use-case-guides/01-staking/00-ethereum/03-ethereum-solo-staking-with-mev-boost.md) - **SSV Network**: Deploy an SSV (Secret Shared Validators) network node. - - [SSV Network Guide](../01-use-case-guides/03-node-operator/ssv-network/01-ssv-network-node-operator.md) + - [SSV Network Guide](../02-use-case-guides/03-node-operator/ssv-network/01-ssv-network-node-operator.md) - **Archive**: Create an archive node that maintains the complete history of the Ethereum blockchain - **Guide is currently work in progress** - - [Archive Node Guide](../01-use-case-guides/02-blockchain-data/01-installation-archive-node.md) + - [Archive Node Guide](../02-use-case-guides/02-blockchain-data/01-installation-archive-node.md) - **Obol**: Install a node to participate in the Obol Network, designed for distributed validator technology - **Guide is currently work in progress** - - [Obol Network Guide](../01-use-case-guides/01-staking/00-ethereum/04-obol-clustered-ethereum-solo-staking.md) + - [Obol Network Guide](../02-use-case-guides/01-staking/00-ethereum/04-obol-clustered-ethereum-solo-staking.md) - **ARM**: Specialized installation for ARM architecture hardware, typically used for lower-power devices - **Guide is currently work in progress** - - [ARM Architecture Guide](../01-use-case-guides/01-staking/00-ethereum/02-ethereum-solo-staking-on-ARM.md) + - [ARM Architecture Guide](../02-use-case-guides/01-staking/00-ethereum/02-ethereum-solo-staking-on-ARM.md) - **Lido x Obol SDVTM (Testnet)**: Take part in the testnet & install a node that combines Lido and Obol technologies to decentralize the Staking Pool's Node Operator set. - - [Lido x Obol SDVTM Guide](../01-use-case-guides/03-node-operator/lido/01-lido-sdvtm-obol.md) + - [Lido x Obol SDVTM Guide](../02-use-case-guides/03-node-operator/lido/01-lido-sdvtm-obol.md) After selecting your use case and pressing `Start`, a random client selection will be taken to serve your use case. diff --git a/docs/02-guides/02-installation/00-installation-options/02-custom-installation.md b/docs/02-installation/01-installation-options/02-custom-installation.md similarity index 100% rename from docs/02-guides/02-installation/00-installation-options/02-custom-installation.md rename to docs/02-installation/01-installation-options/02-custom-installation.md diff --git a/docs/02-guides/02-installation/00-installation-options/03-config-import.md b/docs/02-installation/01-installation-options/03-config-import.md similarity index 100% rename from docs/02-guides/02-installation/00-installation-options/03-config-import.md rename to docs/02-installation/01-installation-options/03-config-import.md diff --git a/docs/02-guides/02-installation/00-installation-options/_category_.json b/docs/02-installation/01-installation-options/_category_.json similarity index 83% rename from docs/02-guides/02-installation/00-installation-options/_category_.json rename to docs/02-installation/01-installation-options/_category_.json index ebd8628..2c29e02 100644 --- a/docs/02-guides/02-installation/00-installation-options/_category_.json +++ b/docs/02-installation/01-installation-options/_category_.json @@ -1,6 +1,6 @@ { "label": "Installation Options", - "position": 1, + "position": 2, "link": { "type": "generated-index" } diff --git a/docs/02-guides/01-node-server-management.md b/docs/02-installation/02-node-server-management.md similarity index 92% rename from docs/02-guides/01-node-server-management.md rename to docs/02-installation/02-node-server-management.md index 37b423c..c397c6f 100644 --- a/docs/02-guides/01-node-server-management.md +++ b/docs/02-installation/02-node-server-management.md @@ -66,19 +66,19 @@ When you launch Stereum, the main window is split into two panels: When you start Stereum for the first time or to set up a new node, you'll encounter the Welcome Screen, which presents you with three primary installation options: -### [One Click Installation](docs/02-guides/02-installation/00-installation-options/01-one-click-installation.md) +### [One Click Installation](../03-installation/01-installation-options/01-one-click-installation.md) - This option is designed for users who want a quick and hassle-free node setup. - It will install a preset of the Stereum server with default settings, which are suitable for most users. - To proceed with this installation, simply click the `One Click Installation` button, and follow the prompts to select your desired options and configurations. -### [Custom Installation](docs/02-guides/02-installation/00-installation-options/02-custom-installation.md) +### [Custom Installation](../03-installation/01-installation-options/02-custom-installation.md) - For users with specific requirements or those who wish to configure advanced settings. - Custom Installation allows you to select different components, configure network settings, and set up monitoring tools according to your preferences. - To start, click on `Custom Installation`. After installation, you can customize the node settings via the "Edit Node" page. -### [Config Import](docs/02-guides/02-installation/00-installation-options/03-config-import.md) +### [Config Import](../03-installation/01-installation-options/03-config-import.md) - If you have a pre-existing configuration file from another Stereum setup, you can import it to replicate the same settings. - This is ideal when moving to a new machine or restoring a setup. diff --git a/docs/02-guides/02-installation/_category_.json b/docs/02-installation/_category_.json similarity index 100% rename from docs/02-guides/02-installation/_category_.json rename to docs/02-installation/_category_.json diff --git a/docs/02-guides/03-configuration/_category_.json b/docs/03-configuration/_category_.json similarity index 100% rename from docs/02-guides/03-configuration/_category_.json rename to docs/03-configuration/_category_.json diff --git a/docs/02-guides/03-configuration/block-fee-recipient.md b/docs/03-configuration/block-fee-recipient.md similarity index 100% rename from docs/02-guides/03-configuration/block-fee-recipient.md rename to docs/03-configuration/block-fee-recipient.md diff --git a/docs/02-guides/03-configuration/block-graffiti.md b/docs/03-configuration/block-graffiti.md similarity index 100% rename from docs/02-guides/03-configuration/block-graffiti.md rename to docs/03-configuration/block-graffiti.md diff --git a/docs/02-guides/03-configuration/doppelganger-protection.md b/docs/03-configuration/doppelganger-protection.md similarity index 84% rename from docs/02-guides/03-configuration/doppelganger-protection.md rename to docs/03-configuration/doppelganger-protection.md index ed43059..3a80681 100644 --- a/docs/02-guides/03-configuration/doppelganger-protection.md +++ b/docs/03-configuration/doppelganger-protection.md @@ -6,7 +6,7 @@ title: Doppelganger Protection ## What is Doppelganger Protection? -Doppelganger Protection is a critical security feature in the Ethereum staking ecosystem. It helps to prevent a situation where a validator might inadvertently be running in two different places simultaneously. This scenario is a [slashable offense](../../04-glossary/slashing.md) and leads to serious penalties for the validator in the form of a loss of staked ETH. The Doppelganger protection mechanism ensures that only one instance of a validator is active at any given time, safeguarding the validator’s operations and maintaining network integrity. +Doppelganger Protection is a critical security feature in the Ethereum staking ecosystem. It helps to prevent a situation where a validator might inadvertently be running in two different places simultaneously. This scenario is a [slashable offense](../07-glossary/slashing.md) and leads to serious penalties for the validator in the form of a loss of staked ETH. The Doppelganger protection mechanism ensures that only one instance of a validator is active at any given time, safeguarding the validator’s operations and maintaining network integrity. ## How Does Doppelganger Protection Work? diff --git a/docs/02-guides/03-configuration/node-auto-update.md b/docs/03-configuration/node-auto-update.md similarity index 100% rename from docs/02-guides/03-configuration/node-auto-update.md rename to docs/03-configuration/node-auto-update.md diff --git a/docs/05-contribution/01-contribute.md b/docs/05-contribution/01-contribute.md deleted file mode 100644 index 04624a1..0000000 --- a/docs/05-contribution/01-contribute.md +++ /dev/null @@ -1,3 +0,0 @@ -# Contribute - -Thank you for your interest in Stereum! \ No newline at end of file diff --git a/docs/02-guides/04-operation/_category_.json b/docs/05-operation/_category_.json similarity index 82% rename from docs/02-guides/04-operation/_category_.json rename to docs/05-operation/_category_.json index 8fead88..ae16668 100644 --- a/docs/02-guides/04-operation/_category_.json +++ b/docs/05-operation/_category_.json @@ -1,6 +1,6 @@ { "label": "Node Operation", - "position": 4, + "position": 5, "link": { "type": "generated-index" } diff --git a/docs/02-guides/04-operation/client-switch.md b/docs/05-operation/client-switch.md similarity index 100% rename from docs/02-guides/04-operation/client-switch.md rename to docs/05-operation/client-switch.md diff --git a/docs/02-guides/04-operation/deleting-keys.md b/docs/05-operation/deleting-keys.md similarity index 100% rename from docs/02-guides/04-operation/deleting-keys.md rename to docs/05-operation/deleting-keys.md diff --git a/docs/05-operation/exit-keys.md b/docs/05-operation/exit-keys.md new file mode 100644 index 0000000..d05d3f7 --- /dev/null +++ b/docs/05-operation/exit-keys.md @@ -0,0 +1,54 @@ +# Exit Keys + +## Exit an individual key + +1. Enter the Staking page in Stereum +2. Locate the individual key you want to Exit, on the right you will find multiple buttons. +3. Click "Exit & Withdrawal" button among them - if you need guidance, you can check the tooltips at the bottom. + +![ExitAndWithdrawal1](../../static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-1.png) + +4. A modal will pop up, read the text that points out the irreversibility of the process + +![ExitAndWithdrawal2](../../static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-2.png) + +5. Confirm via checkbox that you read the text and aware of the consequences + +![ExitAndWithdrawal3](../../static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-3.png) + +6. Click Withdraw & Exit + +![ExitAndWithdrawal4](../../static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-4.png) + +7. When the process ends, your Exit Message will be signed and broadcasted over the Ethereum network. + +![ExitAndWithdrawal5](../../static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-5.png) + +8. From there on onwards, you should be able to see the exited status for you validator key on f.e. beaconcha.in + + +## Exit all keys from a validator client + +1. Enter the Staking page in Stereum +2. Make sure you have selected the correct validator client (if you should run multiple on one server) +3. Locate the validator client command to "Withdraw & Exit All Keys" and click it + +![ExitAndWithdrawalMulti1](../../static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-multi-1.png) + +4. A modal will pop up, read the text that points out the irreversibility of the process + +![ExitAndWithdrawalMulti2](../../static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-2.png) + +5. Confirm via checkbox that you read the text and aware of the consequences + +![ExitAndWithdrawalMulti3](../../static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-3.png) + +6. Click Withdraw & Exit + +![ExitAndWithdrawalMulti4](../../static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-4.png) + +7. When the process ends, your Exit Message will be signed and broadcasted over the Ethereum network. + +![ExitAndWithdrawalMulti5](../../static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-5.png) + +8. From there on onwards, you should be able to see the exited status for you validator key on f.e. beaconcha.in diff --git a/docs/02-guides/04-operation/migrate-keys.md b/docs/05-operation/migrate-keys.md similarity index 100% rename from docs/02-guides/04-operation/migrate-keys.md rename to docs/05-operation/migrate-keys.md diff --git a/docs/02-guides/04-operation/network-switch.md b/docs/05-operation/network-switch.md similarity index 100% rename from docs/02-guides/04-operation/network-switch.md rename to docs/05-operation/network-switch.md diff --git a/docs/05-operation/rpc-dataAPI-endpoint.md b/docs/05-operation/rpc-dataAPI-endpoint.md new file mode 100644 index 0000000..c2c0a2c --- /dev/null +++ b/docs/05-operation/rpc-dataAPI-endpoint.md @@ -0,0 +1,51 @@ +# RPC / Data API Endpoint + +### Step 1 +To begin, launch the Stereum application and access the Server Management screen. Enter your server name, IP address, SSH port, username, and password, then click LOGIN to connect securely to your node. + +![Step 1 Screenshot](../../static/screenshots/guides/RPC-Data-API-Setup/RPC1.png) + +### Step 2 +When prompted to change your password, enter a new secure password and click SUBMIT to continue. + +![Step 2 Screenshot](../../static/screenshots/guides/RPC-Data-API-Setup/RPC2.png) + +### Step 3 +On the welcome screen, select 1 Click Installation for a fast and beginner-friendly setup process. + +![Step 3 Screenshot](../../static/screenshots/guides/RPC-Data-API-Setup/RPC3.png) + +### Step 4 +Choose your preferred use case such as Archive or Staking, then select a network from the dropdown. + +![Step 4 Screenshot](../../static/screenshots/guides/RPC-Data-API-Setup/RPC4.png) + +### Step 5 +Select which Execution and Consensus clients you want to use. It's recommended to diversify your clients to help the network’s resilience—try switching from default clients for better decentralization. + +![Step 5 Screenshot](../../static/screenshots/guides/RPC-Data-API-Setup/RPC5.png) + +### Step 6 +Here just click next, as both clients are receiving the full blockchain data set with the Genesis Sync option. + +![Step 6 Screenshot](../../static/screenshots/guides/RPC-Data-API-Setup/RPC6.png) + +### Step 7 +Finally, you’ll confirm the installation paths for each component you’re setting up on your server. This summary screen lists all the chosen services with their respective categories and installation paths, ensuring you have a clear overview of where each service will reside on the server. It’s important to verify that each path is correct to prevent any future operational issues. + +![Step 7 Screenshot](../../static/screenshots/guides/RPC-Data-API-Setup/RPC7.png) + +### Step 8 +Allow Stereum to finish configuring your setup, including services, syncing, and system checks. Wait until the process completes automatically. + +![Step 8 Screenshot](../../static/screenshots/guides/RPC-Data-API-Setup/RPC8.png) + +### Step 9 +Go to the Control tab and click on the RPC box to view your node's endpoints. Make sure both RPC and Data API endpoints are marked as OPEN and copy them for use. + +![Step 9 Screenshot](../../static/screenshots/guides/RPC-Data-API-Setup/RPC9.png) + +### Step 10 +Use these endpoints in your applications or scripts to interact with the node. For example, call the Data API or use the RPC endpoint with a method like getInfo. + +![Step 10 Screenshot](../../static/screenshots/guides/RPC-Data-API-Setup/RPC10.png) diff --git a/docs/02-guides/04-operation/updating-node.md b/docs/05-operation/updating-node.md similarity index 100% rename from docs/02-guides/04-operation/updating-node.md rename to docs/05-operation/updating-node.md diff --git a/docs/01-technical/00-technical-overview.md b/docs/05-technical/00-technical-overview.md similarity index 100% rename from docs/01-technical/00-technical-overview.md rename to docs/05-technical/00-technical-overview.md diff --git a/docs/01-technical/01-security.md b/docs/05-technical/01-security.md similarity index 100% rename from docs/01-technical/01-security.md rename to docs/05-technical/01-security.md diff --git a/docs/01-technical/02-launcher-logs.md b/docs/05-technical/02-launcher-logs.md similarity index 100% rename from docs/01-technical/02-launcher-logs.md rename to docs/05-technical/02-launcher-logs.md diff --git a/docs/01-technical/03-release-management.md b/docs/05-technical/03-release-management.md similarity index 100% rename from docs/01-technical/03-release-management.md rename to docs/05-technical/03-release-management.md diff --git a/docs/01-technical/04-plugin-integration.md b/docs/05-technical/04-plugin-integration.md similarity index 100% rename from docs/01-technical/04-plugin-integration.md rename to docs/05-technical/04-plugin-integration.md diff --git a/docs/01-technical/05-client-options.md b/docs/05-technical/05-client-options.md similarity index 100% rename from docs/01-technical/05-client-options.md rename to docs/05-technical/05-client-options.md diff --git a/docs/01-technical/_category_.json b/docs/05-technical/_category_.json similarity index 70% rename from docs/01-technical/_category_.json rename to docs/05-technical/_category_.json index 66f0fb4..ee790d1 100644 --- a/docs/01-technical/_category_.json +++ b/docs/05-technical/_category_.json @@ -1,6 +1,6 @@ { - "label": "Technical", - "position": 1, + "label": "Technical Details", + "position": 5, "link": { "type": "generated-index", "description": "Learn the most important technical concepts." diff --git a/docs/03-troubleshooting/01-faq.md b/docs/06-troubleshooting/01-faq.md similarity index 89% rename from docs/03-troubleshooting/01-faq.md rename to docs/06-troubleshooting/01-faq.md index e945693..d2b4bdb 100644 --- a/docs/03-troubleshooting/01-faq.md +++ b/docs/06-troubleshooting/01-faq.md @@ -11,4 +11,4 @@ You can find this information here: [Launcher Logs](../01-technical/02-launcher- ### How do I securely migrate keys? -You can find a simple manual to follow here: [Migrate Keys](../02-guides/04-operation/migrate-keys.md) \ No newline at end of file +You can find a simple manual to follow here: [Migrate Keys](../05-operation/migrate-keys.md) \ No newline at end of file diff --git a/docs/03-troubleshooting/_category_.json b/docs/06-troubleshooting/_category_.json similarity index 87% rename from docs/03-troubleshooting/_category_.json rename to docs/06-troubleshooting/_category_.json index 7add796..25a1cd9 100644 --- a/docs/03-troubleshooting/_category_.json +++ b/docs/06-troubleshooting/_category_.json @@ -1,6 +1,6 @@ { "label": "Troubleshooting", - "position": 3, + "position": 6, "link": { "type": "generated-index", "description": "Troubleshooting & FAQ" diff --git a/docs/04-glossary/_category_.json b/docs/07-glossary/_category_.json similarity index 86% rename from docs/04-glossary/_category_.json rename to docs/07-glossary/_category_.json index a976d94..a03fc20 100644 --- a/docs/04-glossary/_category_.json +++ b/docs/07-glossary/_category_.json @@ -1,6 +1,6 @@ { "label": "Glossary", - "position": 4, + "position": 7, "link": { "type": "generated-index", "description": "Glossaries" diff --git a/docs/04-glossary/activation-queue.md b/docs/07-glossary/activation-queue.md similarity index 100% rename from docs/04-glossary/activation-queue.md rename to docs/07-glossary/activation-queue.md diff --git a/docs/04-glossary/address.md b/docs/07-glossary/address.md similarity index 100% rename from docs/04-glossary/address.md rename to docs/07-glossary/address.md diff --git a/docs/04-glossary/attestation-rewards.md b/docs/07-glossary/attestation-rewards.md similarity index 100% rename from docs/04-glossary/attestation-rewards.md rename to docs/07-glossary/attestation-rewards.md diff --git a/docs/04-glossary/attestation.md b/docs/07-glossary/attestation.md similarity index 100% rename from docs/04-glossary/attestation.md rename to docs/07-glossary/attestation.md diff --git a/docs/04-glossary/base-fee.md b/docs/07-glossary/base-fee.md similarity index 100% rename from docs/04-glossary/base-fee.md rename to docs/07-glossary/base-fee.md diff --git a/docs/04-glossary/block-proposal-rewards.md b/docs/07-glossary/block-proposal-rewards.md similarity index 100% rename from docs/04-glossary/block-proposal-rewards.md rename to docs/07-glossary/block-proposal-rewards.md diff --git a/docs/04-glossary/block.md b/docs/07-glossary/block.md similarity index 100% rename from docs/04-glossary/block.md rename to docs/07-glossary/block.md diff --git a/docs/04-glossary/consensus-client.md b/docs/07-glossary/consensus-client.md similarity index 100% rename from docs/04-glossary/consensus-client.md rename to docs/07-glossary/consensus-client.md diff --git a/docs/04-glossary/consensus-layer.md b/docs/07-glossary/consensus-layer.md similarity index 100% rename from docs/04-glossary/consensus-layer.md rename to docs/07-glossary/consensus-layer.md diff --git a/docs/04-glossary/consensus.md b/docs/07-glossary/consensus.md similarity index 100% rename from docs/04-glossary/consensus.md rename to docs/07-glossary/consensus.md diff --git a/docs/04-glossary/epoch.md b/docs/07-glossary/epoch.md similarity index 100% rename from docs/04-glossary/epoch.md rename to docs/07-glossary/epoch.md diff --git a/docs/04-glossary/eth.md b/docs/07-glossary/eth.md similarity index 100% rename from docs/04-glossary/eth.md rename to docs/07-glossary/eth.md diff --git a/docs/04-glossary/ethereum-node.md b/docs/07-glossary/ethereum-node.md similarity index 100% rename from docs/04-glossary/ethereum-node.md rename to docs/07-glossary/ethereum-node.md diff --git a/docs/04-glossary/ethereum-staking-penalties.md b/docs/07-glossary/ethereum-staking-penalties.md similarity index 100% rename from docs/04-glossary/ethereum-staking-penalties.md rename to docs/07-glossary/ethereum-staking-penalties.md diff --git a/docs/04-glossary/ethereum-staking-rewards.md b/docs/07-glossary/ethereum-staking-rewards.md similarity index 100% rename from docs/04-glossary/ethereum-staking-rewards.md rename to docs/07-glossary/ethereum-staking-rewards.md diff --git a/docs/04-glossary/ethereum.md b/docs/07-glossary/ethereum.md similarity index 100% rename from docs/04-glossary/ethereum.md rename to docs/07-glossary/ethereum.md diff --git a/docs/04-glossary/execution-client.md b/docs/07-glossary/execution-client.md similarity index 100% rename from docs/04-glossary/execution-client.md rename to docs/07-glossary/execution-client.md diff --git a/docs/04-glossary/execution-layer.md b/docs/07-glossary/execution-layer.md similarity index 100% rename from docs/04-glossary/execution-layer.md rename to docs/07-glossary/execution-layer.md diff --git a/docs/04-glossary/exit-and-withdrawal.md b/docs/07-glossary/exit-and-withdrawal.md similarity index 100% rename from docs/04-glossary/exit-and-withdrawal.md rename to docs/07-glossary/exit-and-withdrawal.md diff --git a/docs/04-glossary/fork.md b/docs/07-glossary/fork.md similarity index 100% rename from docs/04-glossary/fork.md rename to docs/07-glossary/fork.md diff --git a/docs/04-glossary/full-withdrawal.md b/docs/07-glossary/full-withdrawal.md similarity index 100% rename from docs/04-glossary/full-withdrawal.md rename to docs/07-glossary/full-withdrawal.md diff --git a/docs/04-glossary/gas.md b/docs/07-glossary/gas.md similarity index 100% rename from docs/04-glossary/gas.md rename to docs/07-glossary/gas.md diff --git a/docs/04-glossary/gnosis-node.md b/docs/07-glossary/gnosis-node.md similarity index 100% rename from docs/04-glossary/gnosis-node.md rename to docs/07-glossary/gnosis-node.md diff --git a/docs/04-glossary/gnosis-staking-penalties.md b/docs/07-glossary/gnosis-staking-penalties.md similarity index 100% rename from docs/04-glossary/gnosis-staking-penalties.md rename to docs/07-glossary/gnosis-staking-penalties.md diff --git a/docs/04-glossary/gnosis-staking-rewards.md b/docs/07-glossary/gnosis-staking-rewards.md similarity index 100% rename from docs/04-glossary/gnosis-staking-rewards.md rename to docs/07-glossary/gnosis-staking-rewards.md diff --git a/docs/04-glossary/gnosis.md b/docs/07-glossary/gnosis.md similarity index 100% rename from docs/04-glossary/gnosis.md rename to docs/07-glossary/gnosis.md diff --git a/docs/04-glossary/gwei.md b/docs/07-glossary/gwei.md similarity index 100% rename from docs/04-glossary/gwei.md rename to docs/07-glossary/gwei.md diff --git a/docs/04-glossary/inactivity-leak.md b/docs/07-glossary/inactivity-leak.md similarity index 100% rename from docs/04-glossary/inactivity-leak.md rename to docs/07-glossary/inactivity-leak.md diff --git a/docs/04-glossary/max-priority-fee.md b/docs/07-glossary/max-priority-fee.md similarity index 100% rename from docs/04-glossary/max-priority-fee.md rename to docs/07-glossary/max-priority-fee.md diff --git a/docs/04-glossary/mev-boost.md b/docs/07-glossary/mev-boost.md similarity index 100% rename from docs/04-glossary/mev-boost.md rename to docs/07-glossary/mev-boost.md diff --git a/docs/04-glossary/mev.md b/docs/07-glossary/mev.md similarity index 100% rename from docs/04-glossary/mev.md rename to docs/07-glossary/mev.md diff --git a/docs/04-glossary/non-finality.md b/docs/07-glossary/non-finality.md similarity index 100% rename from docs/04-glossary/non-finality.md rename to docs/07-glossary/non-finality.md diff --git a/docs/04-glossary/partial-withdrawal.md b/docs/07-glossary/partial-withdrawal.md similarity index 100% rename from docs/04-glossary/partial-withdrawal.md rename to docs/07-glossary/partial-withdrawal.md diff --git a/docs/04-glossary/priority-fee.md b/docs/07-glossary/priority-fee.md similarity index 100% rename from docs/04-glossary/priority-fee.md rename to docs/07-glossary/priority-fee.md diff --git a/docs/04-glossary/private-key.md b/docs/07-glossary/private-key.md similarity index 100% rename from docs/04-glossary/private-key.md rename to docs/07-glossary/private-key.md diff --git a/docs/04-glossary/public-key.md b/docs/07-glossary/public-key.md similarity index 100% rename from docs/04-glossary/public-key.md rename to docs/07-glossary/public-key.md diff --git a/docs/04-glossary/secret-shared-validator.md b/docs/07-glossary/secret-shared-validator.md similarity index 100% rename from docs/04-glossary/secret-shared-validator.md rename to docs/07-glossary/secret-shared-validator.md diff --git a/docs/04-glossary/seed-phrase.md b/docs/07-glossary/seed-phrase.md similarity index 100% rename from docs/04-glossary/seed-phrase.md rename to docs/07-glossary/seed-phrase.md diff --git a/docs/04-glossary/sharding.md b/docs/07-glossary/sharding.md similarity index 100% rename from docs/04-glossary/sharding.md rename to docs/07-glossary/sharding.md diff --git a/docs/04-glossary/slashing.md b/docs/07-glossary/slashing.md similarity index 100% rename from docs/04-glossary/slashing.md rename to docs/07-glossary/slashing.md diff --git a/docs/04-glossary/slot.md b/docs/07-glossary/slot.md similarity index 100% rename from docs/04-glossary/slot.md rename to docs/07-glossary/slot.md diff --git a/docs/04-glossary/smart contract.md b/docs/07-glossary/smart contract.md similarity index 100% rename from docs/04-glossary/smart contract.md rename to docs/07-glossary/smart contract.md diff --git a/docs/04-glossary/staking.md b/docs/07-glossary/staking.md similarity index 100% rename from docs/04-glossary/staking.md rename to docs/07-glossary/staking.md diff --git a/docs/04-glossary/sync-committee-rewards.md b/docs/07-glossary/sync-committee-rewards.md similarity index 100% rename from docs/04-glossary/sync-committee-rewards.md rename to docs/07-glossary/sync-committee-rewards.md diff --git a/docs/04-glossary/sync-committee.md b/docs/07-glossary/sync-committee.md similarity index 100% rename from docs/04-glossary/sync-committee.md rename to docs/07-glossary/sync-committee.md diff --git a/docs/04-glossary/transaction.md b/docs/07-glossary/transaction.md similarity index 100% rename from docs/04-glossary/transaction.md rename to docs/07-glossary/transaction.md diff --git a/docs/04-glossary/validator-account.md b/docs/07-glossary/validator-account.md similarity index 100% rename from docs/04-glossary/validator-account.md rename to docs/07-glossary/validator-account.md diff --git a/docs/04-glossary/validator-client.md b/docs/07-glossary/validator-client.md similarity index 100% rename from docs/04-glossary/validator-client.md rename to docs/07-glossary/validator-client.md diff --git a/docs/04-glossary/validator-key-deposit.md b/docs/07-glossary/validator-key-deposit.md similarity index 100% rename from docs/04-glossary/validator-key-deposit.md rename to docs/07-glossary/validator-key-deposit.md diff --git a/docs/04-glossary/validator-key.md b/docs/07-glossary/validator-key.md similarity index 100% rename from docs/04-glossary/validator-key.md rename to docs/07-glossary/validator-key.md diff --git a/docs/04-glossary/validator.md b/docs/07-glossary/validator.md similarity index 100% rename from docs/04-glossary/validator.md rename to docs/07-glossary/validator.md diff --git a/docs/04-glossary/wei.md b/docs/07-glossary/wei.md similarity index 100% rename from docs/04-glossary/wei.md rename to docs/07-glossary/wei.md diff --git a/docs/08-contribution/01-contribute.md b/docs/08-contribution/01-contribute.md new file mode 100644 index 0000000..44ada92 --- /dev/null +++ b/docs/08-contribution/01-contribute.md @@ -0,0 +1,25 @@ +# Contribute to Stereum 🚀 + +Thank you for your interest in contributing to Stereum — we’re excited to have you here! + +We welcome your ideas, improvements, and pull requests with open arms. Whether it’s fixing a typo, improving a guide, or adding new features — every contribution counts. + +### Perks of contributing: ✨ + +- Earn a POAP (Proof of Attendance Protocol) to recognize your valuable input. + +- Your contributions may be used to help verify you as a solo validator in the upcoming Lido CSM V2. + +- Be part of an open-source community working at the forefront of Ethereum infrastructure. + +### Ready to contribute? 🔧 + +- Fork the repo. + +- Make your changes. + +- Submit a pull request. + +- We’ll carefully review it and follow up with feedback or a merge. + +Let’s build the future of staking infrastructure — together. \ No newline at end of file diff --git a/docs/05-contribution/02-donate.md b/docs/08-contribution/02-donate.md similarity index 92% rename from docs/05-contribution/02-donate.md rename to docs/08-contribution/02-donate.md index 3ada79e..86768c8 100644 --- a/docs/05-contribution/02-donate.md +++ b/docs/08-contribution/02-donate.md @@ -1,4 +1,4 @@ -# Donate +# Donate to Stereum 🙏 - You can donate to the Stereum project by sending some ETH to `stereum.eth` - We also regularly are part of [Gitcoin](https://www.gitcoin.co/) rounds, where your donation will have [additionaly impact](https://checker.gitcoin.co/public/project/show/stereum-ethereum-node-installer-manager) through quadratic funding! \ No newline at end of file diff --git a/docs/05-contribution/_category_.json b/docs/08-contribution/_category_.json similarity index 86% rename from docs/05-contribution/_category_.json rename to docs/08-contribution/_category_.json index ed49e68..dc063ad 100644 --- a/docs/05-contribution/_category_.json +++ b/docs/08-contribution/_category_.json @@ -1,6 +1,6 @@ { "label": "Contribution", - "position": 5, + "position": 9, "link": { "type": "generated-index", "description": "Glossaries" diff --git a/docs/07-support.md b/docs/09-support.md similarity index 100% rename from docs/07-support.md rename to docs/09-support.md diff --git a/docs/06-further-ressources.md b/docs/10-further-ressources.md similarity index 100% rename from docs/06-further-ressources.md rename to docs/10-further-ressources.md diff --git a/docs/02-guides/_category_.json b/docs/_category_.json similarity index 100% rename from docs/02-guides/_category_.json rename to docs/_category_.json diff --git a/static/img/branding/stereum-social-card.png b/static/img/branding/stereum-social-card.png index 3581ae2..d41d866 100644 Binary files a/static/img/branding/stereum-social-card.png and b/static/img/branding/stereum-social-card.png differ diff --git a/static/screenshots/guides/RPC-Data-API-Setup/RPC1.png b/static/screenshots/guides/RPC-Data-API-Setup/RPC1.png new file mode 100644 index 0000000..cf82466 Binary files /dev/null and b/static/screenshots/guides/RPC-Data-API-Setup/RPC1.png differ diff --git a/static/screenshots/guides/RPC-Data-API-Setup/RPC10.png b/static/screenshots/guides/RPC-Data-API-Setup/RPC10.png new file mode 100644 index 0000000..ab81bd7 Binary files /dev/null and b/static/screenshots/guides/RPC-Data-API-Setup/RPC10.png differ diff --git a/static/screenshots/guides/RPC-Data-API-Setup/RPC2.png b/static/screenshots/guides/RPC-Data-API-Setup/RPC2.png new file mode 100644 index 0000000..f29939e Binary files /dev/null and b/static/screenshots/guides/RPC-Data-API-Setup/RPC2.png differ diff --git a/static/screenshots/guides/RPC-Data-API-Setup/RPC3.png b/static/screenshots/guides/RPC-Data-API-Setup/RPC3.png new file mode 100644 index 0000000..fb7c245 Binary files /dev/null and b/static/screenshots/guides/RPC-Data-API-Setup/RPC3.png differ diff --git a/static/screenshots/guides/RPC-Data-API-Setup/RPC4.png b/static/screenshots/guides/RPC-Data-API-Setup/RPC4.png new file mode 100644 index 0000000..898e0df Binary files /dev/null and b/static/screenshots/guides/RPC-Data-API-Setup/RPC4.png differ diff --git a/static/screenshots/guides/RPC-Data-API-Setup/RPC5.png b/static/screenshots/guides/RPC-Data-API-Setup/RPC5.png new file mode 100644 index 0000000..5293526 Binary files /dev/null and b/static/screenshots/guides/RPC-Data-API-Setup/RPC5.png differ diff --git a/static/screenshots/guides/RPC-Data-API-Setup/RPC6.png b/static/screenshots/guides/RPC-Data-API-Setup/RPC6.png new file mode 100644 index 0000000..8ea308a Binary files /dev/null and b/static/screenshots/guides/RPC-Data-API-Setup/RPC6.png differ diff --git a/static/screenshots/guides/RPC-Data-API-Setup/RPC7.png b/static/screenshots/guides/RPC-Data-API-Setup/RPC7.png new file mode 100644 index 0000000..d7af0b5 Binary files /dev/null and b/static/screenshots/guides/RPC-Data-API-Setup/RPC7.png differ diff --git a/static/screenshots/guides/RPC-Data-API-Setup/RPC8.png b/static/screenshots/guides/RPC-Data-API-Setup/RPC8.png new file mode 100644 index 0000000..b7daaf9 Binary files /dev/null and b/static/screenshots/guides/RPC-Data-API-Setup/RPC8.png differ diff --git a/static/screenshots/guides/RPC-Data-API-Setup/RPC9.png b/static/screenshots/guides/RPC-Data-API-Setup/RPC9.png new file mode 100644 index 0000000..57e57a0 Binary files /dev/null and b/static/screenshots/guides/RPC-Data-API-Setup/RPC9.png differ diff --git a/static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-1.png b/static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-1.png new file mode 100644 index 0000000..fbc08b3 Binary files /dev/null and b/static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-1.png differ diff --git a/static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-2.png b/static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-2.png new file mode 100644 index 0000000..b497d78 Binary files /dev/null and b/static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-2.png differ diff --git a/static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-3.png b/static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-3.png new file mode 100644 index 0000000..3d73f81 Binary files /dev/null and b/static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-3.png differ diff --git a/static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-4.png b/static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-4.png new file mode 100644 index 0000000..a988689 Binary files /dev/null and b/static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-4.png differ diff --git a/static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-5.png b/static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-5.png new file mode 100644 index 0000000..510dc9d Binary files /dev/null and b/static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-individual-5.png differ diff --git a/static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-multi-1.png b/static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-multi-1.png new file mode 100644 index 0000000..1af80b7 Binary files /dev/null and b/static/screenshots/guides/exit-and-withdrawal-key/exit-and-withdrawal-key-multi-1.png differ diff --git a/static/screenshots/guides/lido-csm-operator/lido-csm-24.1.png b/static/screenshots/guides/lido-csm-operator/lido-csm-24.1.png new file mode 100644 index 0000000..76b952c Binary files /dev/null and b/static/screenshots/guides/lido-csm-operator/lido-csm-24.1.png differ diff --git a/static/screenshots/guides/lido-csm-operator/lido-csm-25.2.png b/static/screenshots/guides/lido-csm-operator/lido-csm-25.2.png new file mode 100644 index 0000000..011ba2c Binary files /dev/null and b/static/screenshots/guides/lido-csm-operator/lido-csm-25.2.png differ diff --git a/static/screenshots/guides/lido-csm-operator/lido-csm-35.png b/static/screenshots/guides/lido-csm-operator/lido-csm-35.png new file mode 100644 index 0000000..3c1211e Binary files /dev/null and b/static/screenshots/guides/lido-csm-operator/lido-csm-35.png differ diff --git a/static/screenshots/guides/lido-csm-operator/lido-csm-36.png b/static/screenshots/guides/lido-csm-operator/lido-csm-36.png new file mode 100644 index 0000000..e1c7f86 Binary files /dev/null and b/static/screenshots/guides/lido-csm-operator/lido-csm-36.png differ diff --git a/static/screenshots/guides/stereumplus/order-process/SP1.png b/static/screenshots/guides/stereumplus/order-process/SP1.png new file mode 100644 index 0000000..90b5683 Binary files /dev/null and b/static/screenshots/guides/stereumplus/order-process/SP1.png differ diff --git a/static/screenshots/guides/stereumplus/order-process/SP10.png b/static/screenshots/guides/stereumplus/order-process/SP10.png new file mode 100644 index 0000000..a75b174 Binary files /dev/null and b/static/screenshots/guides/stereumplus/order-process/SP10.png differ diff --git a/static/screenshots/guides/stereumplus/order-process/SP11.png b/static/screenshots/guides/stereumplus/order-process/SP11.png new file mode 100644 index 0000000..ec17f15 Binary files /dev/null and b/static/screenshots/guides/stereumplus/order-process/SP11.png differ diff --git a/static/screenshots/guides/stereumplus/order-process/SP12.png b/static/screenshots/guides/stereumplus/order-process/SP12.png new file mode 100644 index 0000000..cfd74c8 Binary files /dev/null and b/static/screenshots/guides/stereumplus/order-process/SP12.png differ diff --git a/static/screenshots/guides/stereumplus/order-process/SP13.png b/static/screenshots/guides/stereumplus/order-process/SP13.png new file mode 100644 index 0000000..fee98ef Binary files /dev/null and b/static/screenshots/guides/stereumplus/order-process/SP13.png differ diff --git a/static/screenshots/guides/stereumplus/order-process/SP14.png b/static/screenshots/guides/stereumplus/order-process/SP14.png new file mode 100644 index 0000000..7242153 Binary files /dev/null and b/static/screenshots/guides/stereumplus/order-process/SP14.png differ diff --git a/static/screenshots/guides/stereumplus/order-process/SP15.png b/static/screenshots/guides/stereumplus/order-process/SP15.png new file mode 100644 index 0000000..7818f32 Binary files /dev/null and b/static/screenshots/guides/stereumplus/order-process/SP15.png differ diff --git a/static/screenshots/guides/stereumplus/order-process/SP16.png b/static/screenshots/guides/stereumplus/order-process/SP16.png new file mode 100644 index 0000000..5d073a6 Binary files /dev/null and b/static/screenshots/guides/stereumplus/order-process/SP16.png differ diff --git a/static/screenshots/guides/stereumplus/order-process/SP17.png b/static/screenshots/guides/stereumplus/order-process/SP17.png new file mode 100644 index 0000000..5fce5a9 Binary files /dev/null and b/static/screenshots/guides/stereumplus/order-process/SP17.png differ diff --git a/static/screenshots/guides/stereumplus/order-process/SP2.png b/static/screenshots/guides/stereumplus/order-process/SP2.png new file mode 100644 index 0000000..1d6b6bd Binary files /dev/null and b/static/screenshots/guides/stereumplus/order-process/SP2.png differ diff --git a/static/screenshots/guides/stereumplus/order-process/SP3.png b/static/screenshots/guides/stereumplus/order-process/SP3.png new file mode 100644 index 0000000..bc2eb37 Binary files /dev/null and b/static/screenshots/guides/stereumplus/order-process/SP3.png differ diff --git a/static/screenshots/guides/stereumplus/order-process/SP4.png b/static/screenshots/guides/stereumplus/order-process/SP4.png new file mode 100644 index 0000000..39bb739 Binary files /dev/null and b/static/screenshots/guides/stereumplus/order-process/SP4.png differ diff --git a/static/screenshots/guides/stereumplus/order-process/SP5.png b/static/screenshots/guides/stereumplus/order-process/SP5.png new file mode 100644 index 0000000..46c13ab Binary files /dev/null and b/static/screenshots/guides/stereumplus/order-process/SP5.png differ diff --git a/static/screenshots/guides/stereumplus/order-process/SP6.png b/static/screenshots/guides/stereumplus/order-process/SP6.png new file mode 100644 index 0000000..36bcf57 Binary files /dev/null and b/static/screenshots/guides/stereumplus/order-process/SP6.png differ diff --git a/static/screenshots/guides/stereumplus/order-process/SP7.png b/static/screenshots/guides/stereumplus/order-process/SP7.png new file mode 100644 index 0000000..670a66b Binary files /dev/null and b/static/screenshots/guides/stereumplus/order-process/SP7.png differ diff --git a/static/screenshots/guides/stereumplus/order-process/SP8.png b/static/screenshots/guides/stereumplus/order-process/SP8.png new file mode 100644 index 0000000..68216a0 Binary files /dev/null and b/static/screenshots/guides/stereumplus/order-process/SP8.png differ diff --git a/static/screenshots/guides/stereumplus/order-process/SP9.png b/static/screenshots/guides/stereumplus/order-process/SP9.png new file mode 100644 index 0000000..823da83 Binary files /dev/null and b/static/screenshots/guides/stereumplus/order-process/SP9.png differ