Skip to content

ValidatorsDAO/slv

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SLV Follow @slvSOLANA

Everything you need for Solana development is here💃

Launch validators, RPCs, and dApps at blazing speed⚡️

Powered By Solana

SLV Official Documentation

Doc Link: https://slv.dev/

The Toolkit for Solana Devs

SLV is a toolkit for Solana developers. It provides a set of tools to help developers build, test, and deploy Solana Validators and Solana-based applications.

In the newly revamped slv, you can complete all configurations from a remote machine—no more direct node logins required. This approach ensures that only essential packages are installed on the node, leaving behind no unnecessary clutter. We’ve also introduced Ansible Playbooks & Jinja Template for Linux configuration, allowing us to manage and migrate multiple validators with greater efficiency and security.

Additionally, the new slv always uses a dummy key (an invalid key named “unstaked-identity.json”) for its initial startup. Once you confirm everything is running smoothly, you simply set the actual Identity and switch to the active key. Following this consistent flow helps prevent double votes and ensures you’re prepared in case the node ever becomes unreachable.

We’ll continue to provide method documentation along the way, and we look forward to your ongoing support!

Validators DAO Discord

Dependencies

OS

MacOS or Linux

※ Please use WSL2 for Windows users.

Download WSL2 For Windows 10 https://docs.microsoft.com/en-us/windows/wsl/install

Libraries

Installation & Validator Launch

Install slv CLI

curl -fsSL https://storage.slv.dev/slv/install | sh
slv validator init
slv validator deploy

Usage

slv v --help

New Features - Solana RPC Init & Deploy (Geyser Yellowstone gRPC Plugin)

Now you can deploy Solana RPC nodes with SLV. This feature includes the ability to deploy Geyser gRPC Plugin.

slv rpc init

New Features - Solana Validator Init & Deploy Mainnet Available

Now you can deploy Solana Mainnet Validators with SLV.

slv v init
? Select Solana Network (testnet)
  testnet
❯ mainnet

New Features - Jito Relayer Init & Deploy

Now you can deploy Jito Relayer with SLV.

slv v setup:relayer

New Features - Jupiter Self-Hosted SWAP Init & Deploy

Now you can deploy Jupiter Self-Host ed SWAP with SLV.

slv r setup:jupiter

Introducing SLV Metal – Optimized Bare Metal for Solana Nodes ⚡️

SLV Metal is a high-performance bare metal server designed specifically for Solana nodes. Choosing the right server for Solana can be challenging, so we provide a curated list of fully optimized servers.

From hardware specs to network performance and Linux configuration, everything is fine-tuned for maximum efficiency. With SLV Metal, you can deploy Solana nodes in just a few commands.

slv metal list
? 🛡️ Select SLV BareMetal Type (validator)
❯ 🧪 For Solana Testnet Validator
  💰 For Solana Mainnet Validator
  ⚡️ RPC - For Solana RPC Node
  📦 APP - For Trade Bot, DApp and More!

Deploy Solana Validator Testnet with Firedancer

You must have Ubuntu 24.04 LTS clean installed on your server.

This command will prompt you to provide necessary information to deploy.

New slv Deployment is always use unstaked-keypair.json for the identity key. This is the best practice to avoid double voting, and etc.

So Please make sure to set the authorized identity key with slv v set:identity after the deployment.

Input Server's Default Username

Most of the time, the default username is ubuntu.

slv v init
? What's the user for the server? (ubuntu) › ubuntu

Input Server's IP Address

Input the IP address of the server.

? What's the IP address of the server? ›

Set RSA Key for SSH

※ Please set the path to your RSA key. The default path is ~/.ssh/id_rsa.

? What's the path to your RSA key? (~/.ssh/id_rsa) › ~/.ssh/id_rsa
🔍 Checking SSH connection...
✔︎ SSH connection succeeded

Then slv will check the connection to the server. If the connection is successful, the next step will be prompted.

Set the solv user password

Please set the password for the solv user of the server.

8 characters or more, including numbers, uppercase and lowercase letters

? Please enter your password › *********
? Please confirm your password › *********
✔︎ Password saved to ~/.slv/config.pwd.yml

Encrypted password will be saved to ~/.slv/config.pwd.yml.

Select the Solana Network

Select the Solana Network you want to deploy. ※ Currently, only the testnet is supported.

? Select Solana Network (testnet)
❯ testnet
  mainnet

Generate or Set the Solana Validator Identity

You can generate a new identity key or set an existing identity key. This example shows how to set an existing identity key.

? Do you want to create a new identity key now? (Y/n) › No
? Please Enter Your Identity Public Key › EjDwu2Czy8eWEYRuNwtjniYks47Du3KNJ6JY9rs3aFSV
⚠️ Please place your identity key in 
        
  ~/.slv/keys/EjDwu2Czy8eWEYRuNwtjniYks47Du3KNJ6JY9rs3aFSV.json
.
.
✔︎ Success
✔ Inventory updated to ~/.slv/inventory.testnet.validators.yml
✔ Successfully created solv user on x.x.x.x

Please place your identity key in ~/.slv/keys/<your-pubkey>.json. Then, slv will create solv user with your password.

Generate or Set the Solana Vote Account

You can generate a new vote account key or set an existing vote account key. This example shows how to set an existing vote account key.

? Do you want to create a new vote account key now? (Y/n) › No
? Please Enter Your Vote Account Public Key > <your-vote-account>
⚠️ Please place your voteAccount pubkey in 
        
  ~/.slv/keys/<your-vote-account>.json

Please place your vote account key in ~/.slv/keys/<your-vote-account>.json.

Set Your Authority Public Key

Please input your authority public key. This key is used to withdraw rewards from the vote account.

? Please Enter Your Vote Account's Authority Key › <your-authority-pubkey>
✔︎ Validator testnet config saved to ~/.slv/inventory.testnet.validators.yml

Now you can deploy with:

$ slv v deploy -n testnet

Now your configuration is saved to ~/.slv/inventory.testnet.validators.yml.

Deploy the Solana Validator

Once you confirm the configuration, the deployment will start.

slv v deploy -n testnet -p EjDwu2Czy8eWEYRuNwtjniYks47Du3KNJ6JY9rs3aFSV
Your Testnet Validators Settings:
┌────────────────┬──────────────────────────────────────────────┐
│ Identity Key   │ EjDwu2Czy8eWEYRuNwtjniYks47Du3KNJ6JY9rs3aFSV │
├────────────────┼──────────────────────────────────────────────┤
│ Vote Key       │ EwoVPLUhdhm722e7QWk8GMQ43917qRXiC9HFyefEMiSV │
├────────────────┼──────────────────────────────────────────────┤
│ Authority Key  │ EcT4NsMPwxanusdy3dza5nznqwuKo9Pz3GzW5GPD32SV │
├────────────────┼──────────────────────────────────────────────┤
│ IP             │ x.x.x.x                                      │
├────────────────┼──────────────────────────────────────────────┤
│ Validator Type │ firedancer                                   │
├────────────────┼──────────────────────────────────────────────┤
│ Version        │ 0.406.20113                                  │
└────────────────┴──────────────────────────────────────────────┘
? Do you want to continue? (Y/n) › Yes

It's done! Your Solana Validator is now deployed. It will take some time to catch up with the Solana network.

Next, You need to change the identity key from the unstaked key to the authorized identity key.

Change the Identity Key from Unstaked Key to Authorized Identity Key

After the deployment, you need to change the identity key from the unstaked key

to the authorized identity key.

slv v set:identity -n testnet --pubkey <your-identity-pubkey>

Then, the identity key will be changed to the authorized identity key. This command will stop firedancer, change the identity key, and restart the firedancer.

※ No downtime Migration is not available with Firedancer yet. We will updated as soon as it's available.

Restart Firedancer

If you have any issues with the validator, you can restart the firedancer with the following command.

If you use the --rm option, the validator will be stopped and removed ledger and snapshot dirs, and Download Snapshot with the snapshot finder and start the validator.

slv v restart -n testnet --pubkey <your-identity-pubkey>

Update slv

If you want to update the slv template, you can use the following command.

slv upgrade

slv Validator Commands

Usage:   slv  
Version: 0.8.0

Description:

  slv is a Toolkit for Solana Developers

Options:

  -h, --help     - Show this help.                            
  -V, --version  - Show the version number for this program.  
  -P, --print    - Print slv ASCII Art                        

Commands:

  upgrade       - Upgrade slv to the latest version                                
  bot, b        - Manage Solana gRPC Geyser Client                                 
  app           - Manage Solana Applications                                       
  validator, v  - Manage Solana Validator Nodes                                    
  rpc, r        - Manage Solana RPC Nodes                                          
  cloud, c      - Manage Solana Cloud-based Applications                           
  swap, s       - Manage Solana Swap                                               
  metal, m      - 🚀 SLV BareMetal: High-Performance Servers Built for Solana Nodes
  signup        - Signup to SLV using Discord                                      
  login         - Login to SLV using Discord                                       
  check         - Check RPC and gRPC endpoints

Community Support

If you have any questions or need help, please join our Discord community.

Validators DAO Discord

Roadmap

  • Add slv validator init for Solana Validator Deploy (in progress)
  • Add slv rpc init for Solana RPC Build (in progress)
  • Add CI/CD pipeline (Github Actions) for slv Release
  • [] Add slv bot for gRPC Geyser Client (in progress)
  • [] Add slv swap for Solana Token Swap (in progress)
  • [] Add slv cloud for configuring Solana App on Cloud (in progress)
  • [] Add slv app for Solana App Development (in progress)
  • Add test for keeping the codebase stable (in progress)

For Developers

Install Deno

curl -fsSL https://deno.land/install.sh | sh

Run slv CLI

git clone https://github.com/ValidatorsDAO/slv.git
deno task dev --help

Run Build

deno task build

Run Test

deno test -A

Release Process

SLV uses GitHub Actions for automated releases. The process is as follows:

  1. Update the version in cmn/constants/version.ts
  2. Create and push a tag with the new version (e.g., v0.6.1)
  3. GitHub Actions will automatically:
    • Run tests
    • Update all version references
    • Build the binaries
    • Upload artifacts to storage
    • Create a GitHub release

For heavy compilation tasks, SLV can use a remote build server:

  1. Set up a Ubuntu 24.04 LTS server
  2. Configure the server in ansible/inventory.yml
  3. Use the remote build workflow:
    # Manually trigger the workflow
    gh workflow run slv-remote-build.yml -f version=0.6.1
    
    # Or push a tag
    git tag v0.6.1
    git push origin v0.6.1

See the ansible/README.md file for more details on remote builds. Improvements are always welcome!

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ValidatorsDAO/slv This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Dependencies for Development

  • deno 2.x.x

License

The package is available as open source under the terms of the Apache-2.0 License.

Code of Conduct

Everyone interacting in the SLV project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.