Configure Velas CLI
The Velas cli includes
set configuration commands to automatically
--url argument for cli commands. For example:
While this section demonstrates how to connect to the Devnet cluster, the steps are similar for the other Velas Clusters.
Confirm The Cluster Is Reachable
Before attaching a validator node, sanity check that the cluster is accessible to your machine by fetching the transaction count:
Confirm your Installation
Try running following command to join the gossip network and view all the other nodes in the cluster:
If your machine has a GPU with CUDA installed (Linux-only currently), include
--cuda argument to
When your validator is started look for the following log message to indicate
that CUDA is enabled:
"[<timestamp> solana::validator] CUDA is enabled"
The Velas repo includes a daemon to adjust system settings to optimize performance (namely by increasing the OS UDP buffer limits, and scheduling PoH with realtime policy).
The daemon (
solana-sys-tuner) is included in the Velas binary release. Restart
it, before restarting your validator, after each software upgrade to ensure that
the latest recommended settings are applied.
To run it:
If you would prefer to manage system settings on your own, you may do so with the following commands.
Increase UDP buffers
Increased memory mapped files limit
[Service] section of your systemd service file, if you use one,
otherwise add it to
Create an identity keypair for your validator by running:
The identity public key can now be viewed by running:
Note: The "validator-keypair.json” file is also your (ed25519) private key.
Paper Wallet identity
You can create a paper wallet for your identity file instead of writing the keypair file to disk with:
The corresponding identity public key can now be viewed by running:
and then entering your seed phrase.
See Paper Wallet Usage for more info.
You can generate a custom vanity keypair using solana-keygen. For instance:
Depending on the string requested, it may take days to find a match...
Your validator identity keypair uniquely identifies your validator within the network. It is crucial to back-up this information.
If you don’t back up this information, you WILL NOT BE ABLE TO RECOVER YOUR VALIDATOR if you lose access to it. If this happens, YOU WILL LOSE YOUR ALLOCATION OF SOL TOO.
To back-up your validator identify keypair, back-up your "validator-keypair.json” file or your seed phrase to a secure location.
More Velas CLI Configuration
Now that you have a keypair, set the velas configuration to use your validator keypair for all following commands:
You should see the following output:
Airdrop & Check Validator Balance
Airdrop yourself some VLX to get started:
Note that airdrops are only available on bootstrap node at Devnet.
To view your current balance:
Or to see in finer detail:
Create Vote Account
If you haven’t already done so, create a vote-account keypair and create the vote account on the network. If you have completed this step, you should see the “vote-account-keypair.json” in your Velas runtime directory:
The following command can be used to create your vote account on the blockchain with all the default options:
Read more about creating and managing a vote account.
If you know and trust other validator nodes, you can specify this on the command line with the
velas-validator. You can specify multiple ones by repeating the argument
--trusted-validator <PUBKEY1> --trusted-validator <PUBKEY2>.
This has two effects, one is when the validator is booting with
--no-untrusted-rpc, it will only ask that set of
trusted nodes for downloading genesis and snapshot data. Another is that in combination with the
it will monitor the merkle root hash of the entire accounts state of other trusted nodes on gossip and if the hashes produce any mismatch,
the validator will halt the node to prevent the validator from voting or processing potentially incorrect state values. At the moment, the slot that
the validator publishes the hash on is tied to the snapshot interval. For the feature to be effective, all validators in the trusted
set should be set to the same snapshot interval value or multiples of the same.
It is highly recommended you use these options to prevent malicious snapshot state download or account state divergence.
Connect Your Validator
Connect to the cluster by running:
Lastly, to configure log rotation, please run the following:
To force validator logging to the console add a
--log - argument, otherwise
the validator will automatically log to a file.
Note: You can use a paper wallet seed phrase for your
--vote-accountkeypairs. To use these, pass the respective argument as
velas-validator --identity ASK ... --vote-account ASK ...and you will be prompted to enter your seed phrases and optional passphrase.
Confirm your validator connected to the network by opening a new terminal and running:
If your validator is connected, its public key and IP address will appear in the list.
Controlling local network port allocation
By default the validator will dynamically select available network ports in the
8000-10000 range, and may be overridden with
velas-validator --dynamic-port-range 11000-11010 ... will restrict
the validator to ports 11000-11010.
Limiting ledger size to conserve disk space
--limit-ledger-size argument will instruct the validator to only retain the
last couple hours of ledger. To retain the full ledger, simply remove that arg.
Running the validator as a systemd unit is one easy way to manage running in the background.
Assuming you have a user called
vel on your machine, create the file
/etc/systemd/system/vel.service with the following:
/home/vel/bin/validator.sh to include the desired
velas-validator command-line. Ensure that the 'exec' command is used to start the validator process
(i.e. "exec velas-validator ..."). This is important because without it, logrotate will end up killing the validator every time the logs are rotated.
Ensure that running
/home/vel/bin/validator.sh manually starts the validator as expected. Don't forget to mark it executable with
chmod +x /home/vel/bin/validator.sh
Start the service with:
Log output tuning
The messages that a validator emits to the log can be controlled by the
RUST_LOG environment variable. Details can by found in the documentation for the
env_logger Rust crate.
Note that if logging output is reduced, this may make it difficult to debug issues encountered later. Should support be sought from the team, any changes will need to be reverted and the issue reproduced before help can be provided.
The validator log file, as specified by
--log ~/velas-validator.log, can get very large over time and it's recommended that log rotation be configured.
The validator will re-open its when it receives the
USR1 signal, which is the basic primitive that enables log rotation.
If the validator is being started by a wrapper shell script, it is important to launch the process with
exec velas-validator ...) when using logrotate. This will prevent the
USR1 signal from being sent to the script's process instead of the validator's, which will kill them both.
An example setup for the
logrotate, which assumes that the validator is running as a systemd service called
and writes a log file at /home/vel/velas-validator.log:
As mentioned earlier, be sure that if you use logrotate, any script you create which starts the velas validator process uses "exec" to do so (example: "exec velas-validator ..."); otherwise, when logrotate sends its signal to the validator, the enclosing script will die and take the validator process with it.
Disable port checks to speed up restarts
Once your validator is operating normally, you can reduce the time it takes to restart your validator by adding
--no-port-check flag to your
Using a ramdisk with spill-over into swap for the accounts database to reduce SSD wear
If your machine has plenty of RAM, a tmpfs ramdisk (tmpfs) may be used to hold the accounts database.
When using tmpfs it's essential to also configure swap on your machine as well to avoid running out of tmpfs space periodically.
A 300GB tmpfs partition is recommended, with an accompanying 250GB swap partition.
sudo mkdir /mnt/velas-accounts
- Add a 300GB tmpfs parition by adding a new line containing
tmpfs /mnt/velas-accounts tmpfs rw,size=300G,user=vel 0 0to
/etc/fstab(assuming your validator is running under the user "vel"). CAREFUL: If you incorrectly edit /etc/fstab your machine may no longer boot
- Create at least 250GB of swap space
- Choose a device to use in place of
SWAPDEVfor the remainder of these instructions. Ideally select a free disk partition of 250GB or greater on a fast disk. If one is not available, create a swap file with
sudo dd if=/dev/zero of=/swapfile bs=1MiB count=250KiB, set its permissions with
sudo chmod 0600 /swapfileand use
SWAPDEVfor the remainder of these instructions
- Format the device for usage as swap with
sudo mkswap SWAPDEV
- Add the swap file to
/etc/fstabwith a new line containing
SWAPDEV swap swap defaults 0 0
- Enable swap with
sudo swapon -aand mount the tmpfs with
sudo mount /mnt/velas-accounts/
- Confirm swap is active with
free -gand the tmpfs is mounted with
Now add the
--accounts /mnt/velas-accounts argument to your
velas-validator command-line arguments and restart the validator.
As the number of populated accounts on the cluster grows, account-data RPC requests that scan the entire account set -- like
getProgramAccounts and SPL-token-specific requests
-- may perform poorly. If your validator needs to support any of these requests, you can use the
--account-index parameter to activate one
or more in-memory account indexes that significantly improve RPC performance by indexing accounts by the key field. Currently supports the following parameter values:
program-id: each account indexed by its owning program; used by
spl-token-mint: each SPL token account indexed by its token Mint; used by getTokenAccountsByDelegate, and getTokenLargestAccounts
spl-token-owner: each SPL token account indexed by the token-owner address; used by getTokenAccountsByOwner, and
getProgramAccountsrequests that include an spl-token-owner filter.