Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sonicfromnewyoke/solana-rpc

Configure a slightly more performant Solana RPC than a regular one
https://github.com/sonicfromnewyoke/solana-rpc

rpc solana

Last synced: 27 days ago
JSON representation

Configure a slightly more performant Solana RPC than a regular one

Awesome Lists containing this project

README 

        
Solana RPC



> [!NOTE]

> This repo contains steps to configure a **slightly** more performant RPC than a **regular** one



## 🤖 Server



### Requirements



[Solana Hardware Compatibility List](https://solanahcl.org/) can be found here



- **CPU**

  - `2.8GHz` base clock speed, or faster

  - `16` cores / `32` threads, or more

  - SHA extensions instruction support

  - AMD Gen 3 or newer

  - Intel Ice Lake or newer

  - Higher clock speed is preferable over more cores

  - AVX2 instruction support (to use official release binaries, self-compile otherwise)

  - Support for AVX512f is helpful

- **RAM** 

  - `256GB` or more (for account indexes)

  - Error Correction Code (ECC) memory is suggested

  - Motherboard with 512GB capacity suggested

- **Disk**

  - **Accounts:** `500GB`, or larger. High TBW (Total Bytes Written)

  - **Ledger:** `1TB` or larger. High TBW suggested

  - **Snapshots:** `250GB` or larger. High TBW suggested

  - **OS:** (Optional) `500GB`, or larger. SATA OK



Consider a larger ledger disk if longer transaction history is required



> [!CAUTION]

> Accounts and ledger **should not be** stored on the same disk



### Sol User



Create a new Ubuntu user, named `sol`, for running the validator:



```bash

sudo adduser sol

```



It is a best practice to always run your validator as a non-root user, like the `sol` user we just created.



### Ports Opening



Note: RPC port remains closed, only SSH and gossip ports are opened.



For new machines with UFW disabled:



1. Add OpenSSH first to prevent lockout if you don't have password access

2. Open required ports

3. Close RPC port



```bash

sudo ufw enable



sudo ufw allow 22/tcp

sudo ufw allow 8000:8020/tcp

sudo ufw allow 8000:8020/udp



sudo ufw deny 8899/tcp

sudo ufw deny 8899/udp



sudo ufw reload

```



### Hard Drive Setup



On your Ubuntu computer make sure that you have at least `2TB` of disk space mounted. You can check disk space using the `df` command:



```bash

df -h

```



To see the hard disk devices that you have available, use the list block devices command:



```bash

lsblk -f

```



#### Drive Formatting: Ledger



Assuming you have an nvme drive that is not formatted, you will have to format the drive and then mount it.



For example, if your computer has a device located at `/dev/nvme0n1`, then you can format the drive with the command:



```bash

sudo mkfs -t xfs /dev/nvme0n1

```

For your computer, the device name and location may be different.



Next, check that you now have a UUID for that device:



```bash

lsblk -f

```



In the fourth column, next to your device name, you should see a string of letters and numbers that look like this: `6abd1aa5-8422-4b18-8058-11f821fd3967`. That is the UUID for the device



#### Mounting Your Drive: Ledger



So far we have created a formatted drive, but you do not have access to it until you mount it. Make a directory for mounting your drive:



```bash

sudo mkdir -p /mnt/ledger

```



Next, change the ownership of the directory to your sol user:



```bash

sudo chown -R sol:sol /mnt/ledger

```



Now you can mount the drive:



```bash

sudo mount -o noatime /dev/nvme0n1 /mnt/ledger

```



#### Formatting And Mounting Drive: AccountsDB



You will also want to mount the accounts db on a separate hard drive. The process will be similar to the ledger example above.



Assuming you have device at `/dev/nvme1n1`, format the device and verify it exists:



```bash

sudo mkfs -t xfs /dev/nvme1n1

```



Then verify the UUID for the device exists:



```bash

lsblk -f

```



Create a directory for mounting:



```bash

sudo mkdir -p /mnt/accounts

```



Change the ownership of that directory:



```bash

sudo chown -R sol:sol /mnt/accounts

```



And lastly, mount the drive:



```bash

sudo mount -o noatime  /dev/nvme1n1 /mnt/accounts

```



#### Modify fstab



```bash

sudo vi /etc/fstab

```



should contains something similar



```

# /etc/fstab: static file system information.

#

# Use 'blkid' to print the universally unique identifier for a

# device; this may be used with UUID= as a more robust way to name devices

# that works even if disks are added and removed. See fstab(5).

#

#                



...



UUID="03477038-6fa7-4de3-9ca6-4b0aef52bf42" /mnt/ledger xfs defaults,noatime 0 2

UUID="68ff3738-f9f7-4423-a24c-68d989a2e496" /mnt/accounts xfs defaults,noatime 0 2

```



## 🌵 Agave Client



### Install rustc, cargo and rustfmt



```bash

curl https://sh.rustup.rs -sSf | sh

source $HOME/.cargo/env

rustup component add rustfmt

```



When building the master branch, please make sure you are using the latest stable rust version by running:



```bash

rustup update

```



you may need to install libssl-dev, pkg-config, zlib1g-dev, protobuf etc.



```bash

sudo apt-get update

sudo apt-get install libssl-dev libudev-dev pkg-config zlib1g-dev llvm clang cmake make libprotobuf-dev protobuf-compiler lld

```



### Download the source code



```bash

git clone https://github.com/anza-xyz/agave.git

cd agave



# let's asume we would like to build v2.1.7 of validator

export TAG="v2.1.7" 

git switch tags/$TAG --detach

```



### Build



```bash

export RUSTFLAGS="-C link-arg=-fuse-ld=lld -C target-cpu=native -C opt-level=3"

./scripts/cargo-install-all.sh .

export PATH=$PWD/bin:$PATH

```



## 🦾 System Tuning



### Set CPU Governor to `Performance`



```bash

echo "performance" | tee /sys/devices/system/cpu/cpu*/cpufreq/scaling_governor

```



### Sysctl Tuning



```bash

sudo bash -c "cat >/etc/sysctl.d/21-agave-validator.conf </etc/security/limits.d/90-solana-nofiles.conf < [!NOTE]

> Many thanks for that guide to [ax | 1000x.sh](https://discord.com/channels/428295358100013066/811317327609856081/1257995317190852651)



find out the nearest available core. in most cases, it's core 2 (cores 0 and 1 are often used by the kernel). if you have more cores, you can choose another available nearest core.



#### Know your topology



```bash

lstopo

```



check your cores and hyperthreads

look at the "cores" table to find your core and its hyperthread. for example, if you choose core 2, its hyperthread might be 26 (in my case)



```bash

lscpu --all -e

```



the easiest way to find the hyperthread for eg core 2:



```bash

cat /sys/devices/system/cpu/cpu2/topology/thread_siblings_list

```



#### Isolate the core and its hyperthread



in my case the hyperthread for core 2 is 26

`/etc/default/grub` (dont forget to run update-grub and reboot afterwards) 



```

GRUB_CMDLINE_LINUX_DEFAULT="quiet amd_pstate=passive nohz_full=2,26 isolcpus=domain,managed_irq,2,26 irqaffinity=0-1,3-25,27-47"

```



> [!NOTE]

> - `nohz_full=2,26` enables full dynamic ticks for core 2 and its hyperthread 26 to reducing overhead and latency.

> - `isolcpus=domain,managed_irq,2,26` isolates core 2 and hyperthread 26 from the general scheduler

> - `irqaffinity=0-1,3-25,27-47` directs interrupts away from core 2 and hyperthread 26 



#### Set the poh thread to core 2



add the cli to your validator



```

...

--experimental-poh-pinned-cpu-core 2 \ 

...

```



there is a bug with core_affinity if you isolate your cores: [link](https://github.com/anza-xyz/agave/issues/1968)



you can take my bash script to identify the pid of solpohtickprod and set it to eg. core 2



```bash

#!/bin/bash



# main pid of agave-validator

agave_pid=$(pgrep -f "^agave-validator --identity")

if [ -z "$agave_pid" ]; then

    logger "set_affinity: agave_validator_404"

    exit 1

fi



# find thread id

thread_pid=$(ps -T -p $agave_pid -o spid,comm | grep 'solPohTickProd' | awk '{print $1}')

if [ -z "$thread_pid" ]; then

    logger "set_affinity: solPohTickProd_404"

    exit 1

fi



current_affinity=$(taskset -cp $thread_pid 2>&1 | awk '{print $NF}')

if [ "$current_affinity" == "2" ]; then

    logger "set_affinity: solPohTickProd_already_set"

    exit 1

else

    # set poh to cpu2

    sudo taskset -cp 2 $thread_pid

    logger "set_affinity: set_done"

     # $thread_pid

fi

```



## 🚀 Validator Startup



```bash

mkdir -p /home/sol/bin

touch /home/sol/bin/validator.sh

chmod +x /home/sol/bin/validator.sh

```



Next, open the [`validator.sh`](./validator.sh) file for editing:



```bash

vi /home/sol/bin/validator.sh

```

Then



```bash

chmod +x /home/sol/bin/validator.sh

```



### Create a System Service



You can use the [`sol.service`](./sol.service) from this repo or `sudo vi /etc/systemd/system/sol.service` and paste



```ini

[Unit]

Description=Solana Validator

After=network.target

StartLimitIntervalSec=0



[Service]

Type=simple

Restart=always

RestartSec=1

LimitNOFILE=2000000

LogRateLimitIntervalSec=0

User=sol

Environment="PATH=/home/sol/agave/bin"

Environment=SOLANA_METRICS_CONFIG=host=https://metrics.solana.com:8086,db=mainnet-beta,u=mainnet-beta_write,p=password

ExecStart=/home/sol/bin/validator.sh



[Install]

WantedBy=multi-user.target

```



### Setup log rotation



You can use the [`logrotate.sol`](./logrotate.sol) from this repo run the next commands



```bash

cat > logrotate.sol <