From a4285d521ca1a6e966112f60978db92e9521cc24 Mon Sep 17 00:00:00 2001 From: POPPIN-FUMI Date: Thu, 12 Sep 2024 21:24:53 +0200 Subject: [PATCH] add youtube --- README.md | 220 +++++++----------- .../articles/doc/en/quickstart/solv-swap.md | 2 + .../articles/doc/en/quickstart/start-solv.md | 71 +++--- .../articles/doc/ja/quickstart/solv-swap.md | 2 + 4 files changed, 123 insertions(+), 172 deletions(-) diff --git a/README.md b/README.md index 589e47b..9dd2131 100755 --- a/README.md +++ b/README.md @@ -23,180 +23,121 @@ ## CLI Tool for Managing Solana Validators - "solv" -The utility tool for Solana Validators +Documentation: [https://solv.epics.dev/](https://solv.epics.dev/) -solv is an open-source tool designed to simplify the setup and operation of Solana validators and RPC nodes. +By using solv, setting up a Solana validator node server becomes much easier. This powerful tool simplifies blockchain operations and allows you to start a Solana validator with just a single command. -Documentation: [https://solv.epics.dev/](https://solv.epics.dev/) +By eliminating the complexity of setting up and managing a validator, solv opens the door for more individuals to participate in the blockchain network, making the Solana ecosystem more accessible. + +Whether you're an experienced developer or a blockchain enthusiast venturing into the world of validators, solv provides a solution for simple and fast setup. + +Dive into the world of Solana, explore the capabilities of solv, and become a part of the blockchain revolution with minimal effort and maximum efficiency. ## 📖 Server Spec +- Linux Ubuntu 20.04 LTS - Linux Ubuntu 22.04 LTS - Linux Ubuntu 24.04 LTS ## Solana Validator Setup -Login in to your Validator server by ssh and run the following command. +When you run the `solv setup` command, a prompt like the following will appear. +Select the network, node type, and either RPC type or validator type. -```bash -bash -c "$(curl -sSfL "https://solv-storage.validators.solutions/install")" -cd ~ && source ~/.profile -solv setup -``` +Example: For an RPC node + +![](https://storage.googleapis.com/epics-bucket/solv/assets/setup-rpc.png) -![](https://storage.googleapis.com/zenn-user-upload/949db29fc401-20240131.png) +Example: For a Validator -- Choose Network -- Choose Node Type -- Choose RPC Type or Validator Type +![](https://storage.googleapis.com/epics-bucket/solv/assets/setup-jito-v.png) -Then prompt will ask you for the initial setup. +For the validator type, you can also set options like commission here. -After startup, the snapshot download will start automatically. -The Solana validator will start 🎊 +Once the setup is complete, the snapshot download will automatically begin, +and your Solana validator will start 🎊 -[![solv](https://storage.googleapis.com/epics-bucket/Validator/solv-install-top.gif)](https://youtu.be/rY4bajhRJgw) +If the snapshot download doesn't complete, press Ctrl + C to stop, +and then run the `solv restart --rm` command again. -If your node does not start, you can try the following command. +Starting a new Solana validator can take anywhere from several minutes to several hours. +You can check the logs using the following command: ```bash -solv restart --rm +solv log ``` -This will remove the snapshot and restart the Solana Validator from the new snapshot. -If snapshot download freezes, you can try Ctrl + C. -Then setup will continue. - -## New Features - solv v4.5.0 Release - -- `solv setup` command is now more user-friendly -- `solv swap` command is now available -- `solv jupiter` command is now available -- `solv relayer` command is now available -- `solv get ip` command is now available -- `solv scp` command is now improved with new options -- `solv balance` alias command `solv b` is now available -- `solv monitor` alias command `solv m` is now available -- `solv catchup` alias command `solv c` is now available -- `solv rm:snapshot` removes all the `/mnt/ledger` and `/mnt/accounts` directories -- `solv restart --rm` command uses `solv rm:snapshot` command above and restarts the validator - -## Changes - -`solv.config.json` file is now updated with new fields. -But this will be deprecated in the future. - -Now new config is migrating to `solv4.config.json` file. - -Please update your config file to `solv4.config.json` file. +or ```bash -solv update --config +solv m ``` -## Bug Fixes - -- `solv switch` command now works as expected. -- `bigint` warning message is now resolved. - -## What is solv MEV Mode? - -solv MEV Mode is a feature designed to automate the maintenance of your Solana validator by regularly checking and updating the Solana/solv status and version. - -## How it works - -- solv epochTimer: This function will be set as a cron job to automatically monitor the health status of your validator and perform updates as needed. - -- Automatic Restarts: If necessary, solv epochTimer will restart the validator to ensure optimal performance. - -## solv epochTimer Monitors: - -epochTimer will monitor the following aspects of your validator: - -### Check Validator Account Balance - -- Send a notification if the balance is less than 0.5 SOL. +`m` is an alias for the `monitor` command. -### Check Validator Health Status +※`solv monitor` does not work until the snapshot download is complete. -- Send a notification if the validator is not voting or is delinquent. +## solv setup Options -### Check Solana/solv Version Update +solv setup command has the following options: -- Send a notification if the Solana/solv version is not up-to-date. -- Update the Solana/solv version automatically. -- Restart validator if it is required. -- Send a notification after the Solana/solv version update. - -### Auto Harvest (Mainnet Only) - -- Withdraw the rewards from vote account to the authority account. -- Calculate the balance needed for the next epoch. -- Transfer the balance from the validator account to the authority account. -- Convert SOL to LST(Liquid Staking Token) and send it to the harvest account. +``` +solv setup --help +Usage: solv setup [options] -By implementing solv MEV mode, you can maintain high security, ensure optimal performance, and enjoy the convenience of automated updates and reward management. +Setup Solana Validator -## How to use solv mev mode? +Options: + --vote Setup Vote Account (default: false) + --key Setup Validator Keypairs (default: false) + --relayer Setup Jito Relayer (default: false) + --jupiter Setup Jupiter Swap API (default: false) + --skip-init-config Skip Initial Config (default: false) + --migrate-config Migrate Config (default: false) + --skip-mount Skip Mount (default: false) + -h, --help Display help for command +``` -Run the following command: +## Start Solana Validator ```bash -solv mev -? Do you want to enable solv MEV Mode?(You can change it again) (y/N) -? Do you want to enable AUTO UPDATE? (Recommended) (y/N) -? Do you want to enable AUTO RESTART? (Recommended) (y/N) -※ Please turn off if you are using no-downtime migration. -? Enter your Discord Webhook URL (https://discord.com/api/webhooks/1234) +$ solv start ``` -1. Enable solv MEV Mode. -2. Enable AUTO UPDATE. -3. Enable AUTO RESTART. - -※ Please turn off if you are using no-downtime migration. - -※ No-downtime migration requires spare server and manual restart. +## Stop Solana Validator -4. Enter your Discord Webhook URL. - -※ You can receive notifications about the Solana/solv version update. - -5. Enter RPC URL (Mainnet Only) -6. Enter Harvest Account (Mainnet Only) - -※ Please DO NOT keep harvest account in the validator node. - -## How to disable solv mev mode? +```bash +$ solv stop +``` -Run the following command: +## Monitor Solana Validator ```bash -solv mev -? Do you want to enable solv MEV Mode?(You can change it again) (y/N) n -✅ Cron Job successfully removed. +$ solv monitor ``` -## Run solv Server CLI - from your validator server +## Solana Validator Status ```bash -solv s +$ solv status ``` -![solv s](https://storage.googleapis.com/epics-bucket/solv/assets/solv-s.png) - ## Solana Validator Logs ```bash -solv log +$ solv log ``` -or +## Show Solana Balance and Keypairs + +```bash +$ solv balance +``` -Show only error logs +## Show Solana Validator Catchup Status ```bash -solv log -e +$ solv catchup ``` ## Show Solana Validator Config @@ -204,39 +145,34 @@ solv log -e This command will show your all config paths which are used by solana validator. ```bash -solv config +$ solv config ``` -## Solana Delegation Program - -https://solana.org/delegation-program - ## solv CLI ```bash -solv --help +$ solv --help Usage: solv [options] [command] -💎 Solana Validator All-in-One CLI 💎 +🪄 solv - Solana Validator Tool ✨ Options: - -V Output the current version - -h, --help Display help for solv commands + -V Display version + -h, --help Display help for command Commands: - server|s Open solv Dashboard start Start Solana Validator restart [options] Restart Solana Validator stop Stop Solana Validator - status Show Solana Validator Status - update|u [options] Update Solana Validator Version + status Check Solana Validator Status + update|u [options] Update Command log|l [options] tail logs - install|i [options] Install/Update Solana Version - stake [options] Solana Delegate Stake - unstake Solana Delegate Stake - get Get Solana Validator Info Commands - scp Download/Upload Solana Validator Keypairs - cron Run Schedule Tasks + install|i [options] Install Solana Client + stake [options] Stake SOL + unstake Unstake SOL + get Get Solana Validator's Information + scp Scp Commands + cron Cron Job Commands setup [options] Setup Solana Validator balance|bal [options] Show Keypairs Balance mtr Mount Reload Command @@ -257,15 +193,21 @@ Commands: monitor|m Monitor Solana Node catchup|c Check Solana Catchup Status config Show Solv Config - help [cmd] Display help for solv commands + help [cmd] Display help for command ``` ## Website Validators Solutions: https://validators.solutions + Validator DAO: https://dao.validators.solutions + elSOL: https://elsol.app/ +## Solana Token Swap - "solv swap" + +https://youtu.be/51c7BzvcBjk + ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/EpicsDAO/solv This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. diff --git a/website/solv-doc/articles/doc/en/quickstart/solv-swap.md b/website/solv-doc/articles/doc/en/quickstart/solv-swap.md index 535cca0..ba6bfea 100644 --- a/website/solv-doc/articles/doc/en/quickstart/solv-swap.md +++ b/website/solv-doc/articles/doc/en/quickstart/solv-swap.md @@ -4,6 +4,8 @@ title: solv SWAP Command description: Quickstart for open-source Solana Validator tool solv - SWAP Command --- +https://youtu.be/51c7BzvcBjk + The solv swap command is a tool that allows you to swap Solana tokens and SPL tokens in a simple and intuitive way. You can select tokens interactively and execute swaps, or complete swaps quickly using a one-liner command, making token swap operations easy to integrate into your programs. diff --git a/website/solv-doc/articles/doc/en/quickstart/start-solv.md b/website/solv-doc/articles/doc/en/quickstart/start-solv.md index 1520051..5f32a00 100644 --- a/website/solv-doc/articles/doc/en/quickstart/start-solv.md +++ b/website/solv-doc/articles/doc/en/quickstart/start-solv.md @@ -58,9 +58,9 @@ solv m ※`solv monitor` does not work until the snapshot download is complete. -## solv setup のオプション +## solv setup Options -solv setup のオプションを使用して、特定の機能を有効にすることができます。 +solv setup command has the following options: ``` solv setup --help @@ -135,41 +135,46 @@ $ solv config $ solv --help Usage: solv [options] [command] -💎 Solana Validator All-in-One CLI 💎 +🪄 solv - Solana Validator Tool ✨ Options: - -V Output the current version - -h, --help Display help for solv commands + -V Display version + -h, --help Display help for command Commands: - server|s Open solv Dashboard - start Start Solana Validator - restart [options] Restart Solana Validator - stop Stop Solana Validator - status Show Solana Validator Status - update|u [options] Update Solana Validator Version - log|l [options] tail logs - install|i [options] Install/Update Solana Version - stake Solana Delegate Stake - unstake Solana Delegate Stake - get Get Solana Validator Info Commands - scp Download/Upload Solana Validator Keypairs - cron Run Schedule Tasks - setup [options] Setup Solana Validator - client|c Open solv Client Dashboard - balance|bal Show Keypairs Balance - mtr Mount Reload Command - disks Show unmounted disks - relayer Jiro Relayer Commands - rm:log Remove Logs - rm:snapshot Remove Snapshot - withdraw Withdraw SOL from Vote Account to Authority Account - login Login to Validatoors Cloud - change Change Identity of Validator to New Validator - monitor|m Monitor Solana Node - catchup|ca Check Solana Catchup Status - config Show Solv Config - help [cmd] Display help for solv commands + start Start Solana Validator + restart [options] Restart Solana Validator + stop Stop Solana Validator + status Check Solana Validator Status + update|u [options] Update Command + log|l [options] tail logs + install|i [options] Install Solana Client + stake [options] Stake SOL + unstake Unstake SOL + get Get Solana Validator's Information + scp Scp Commands + cron Cron Job Commands + setup [options] Setup Solana Validator + balance|bal [options] Show Keypairs Balance + mtr Mount Reload Command + disks Show unmounted disks + relayer Jito Relayer Commands + transfer|tr [options] Transfer Solana Tokens/SPL Tokens + withdraw [options] Withdraw SOL from Vote Account to Authority Account + harvest|hv Harvest SOL from Validator Account to Authority Account + mev Enable MEV Mode + df Disk Free Command + swap [options] Swap tokens + epochTimer Check Solana Epoch Timer + switch [options] Switch Validator Identity with No Downtime + jupiter Jupiter API Commands + rm:log Remove Logs + rm:snapshot Remove Snapshot + create:snapshot Create Snapshot + monitor|m Monitor Solana Node + catchup|c Check Solana Catchup Status + config Show Solv Config + help [cmd] Display help for command ``` ### Solana Foudation Delegation Program diff --git a/website/solv-doc/articles/doc/ja/quickstart/solv-swap.md b/website/solv-doc/articles/doc/ja/quickstart/solv-swap.md index 4f65ba9..e260470 100644 --- a/website/solv-doc/articles/doc/ja/quickstart/solv-swap.md +++ b/website/solv-doc/articles/doc/ja/quickstart/solv-swap.md @@ -4,6 +4,8 @@ title: solv SWAP コマンド description: オープンソースのSolana バリデーター向けツールsolvのクイックスタート - SWAP コマンド --- +https://youtu.be/Q_Yzd8sE7eY + solv swap コマンドは、Solana トークンおよび SPL トークンのスワップをシンプルかつ直感的に行うことができるツールです。 対話形式でトークンを選択してスワップを実行したり、ワンライナーコマンドで素早くスワップを完了させることが可能で、 プログラムによるトークンのスワップ操作を簡便に実現します。