Skip to main content

Farmer (Non-Cluster)

warning

This guide was created for Autonomys Taurus Testnet and will be updated once mainnet is launched.

Prerequisites​

You should already have a Node running, as the Farmer must connect to the Node

System Requirements​

Download Farmer Executables​

Organization​

Create a folder labeled 'autonomys' in the home directory, with a subfolder for the Farmer

mkdir -p ~/autonomys/farmer

Download the Latest version​

Currently, the Taurus (testnet) network is the best option to run your Farmer on. Navigate to the Subspace Releases page and look for the entry with the Latest tag. Then identify the correct file to download under the "Assets" section. Make sure to click "show more assets" at the bottom if the correct file is not showing.

  • For Ubuntu with non-ARM Intel Skylake/AMD Ryzen processes you will want to download the file that starts with subspace-farmer-ubuntu-x86_64
  • For Ubuntu with non-ARM CPUs that were released before Skylake/Ryzen CPUs and after ~2009 download the file that starts with subspace-farmer-ubuntu-v2
  • For Ubuntu with ARM CPUs download the version that starts with subspace-node-ubuntu-aarch64
  • For all other Ubuntu setups you will need to manually compile your executables which falls outside the scope of this wiki.

Once the appropriate asset has been identified, right click and copy the link. The latest version at the time of this wiki is subspace-farmer-ubuntu-x86_64-skylake-taurus-2024-oct-24`

Use wget to download the asset to the Node folder

wget -P ~/autonomys/farmer https://github.com/autonomys/subspace/releases/download/taurus-2024-oct-24/subspace-farmer-ubuntu-x86_64-skylake-taurus-2024-oct-24

Make it executable

chmod +x ~/autonomys/farmer/subspace-farmer-ubuntu-x86_64-skylake-taurus-2024-oct-24

Identify Farmer Disks​

Make note of the mount point and size in GiB for each disk that will be added as a farmer

df --block-size=G

Launch the Farmer​

Prepare the Command​

Then prepare the command to run the Farmer

./subspace-farmer-ubuntu-x86_64-skylake-taurus-2024-oct-24 \
  farm \
  --reward-address <YOUR_REWARD_ADDRESS> \
  --prometheus-listen-on 127.0.0.1:9081 \
  path=/media/autonomys/farm-42k42,size=100GiB \
  path=/media/autonomys/farm-e96fg,size=200GiB | tee -a ~/autonomys/farmer/farmer-logs.log

Make sure to update:

  1. The reward address
  2. The farmer disks

Additional Parameters​

If your Node is located on another PC you must specify the IP of the Node. This is done by adding another parameter:

--node-rpc-url ws://<NODE IP>:9944

Replace the <NODE IP> with the internal IP of the Node. This can be determined by running ip a on the Node PC.

Post Launch​

Once launched, the farmer will perform some initial actions such as benchmarking the disks. When complete, the piece cache will begin to sync. You may not notice plotting begin until after the piece cache is fully synced which can take some time depending on how large the cache is (default is 1% of the total disk space).

If your GPU meets the requirements, it will be automatically detected and utilized. The CPU plotter will be disabled if a GPU is detected as running both CPU and GPU plotting will likely result in slower plotting overall.

Tips and Tricks​

Using a Deployment Script​

To make life easier, a simple shell script can be used. Start by opening up the script in the farmer directory with nano

nano ~/autonomys/farmer/farmer.sh

Then paste in the following script - making sure to update the executable

#!/bin/bash

# Variables
FARMER_EXEC="$HOME/autonomys/farmer/subspace-farmer-ubuntu-x86_64-skylake-taurus-2024-oct-24"
LOG_LOCATION="$HOME/autonomys/farmer/farmer-logs.log"

# Specify the reward address
REWARD_ADDRESS="<YOUR_REWARD_ADDRESS>"

# List of paths with sizes
PATHS=(
    "path=/media/autonomys/farm-42k42,size=100GiB"
    "path=/media/autonomys/farm-e96fg,size=200GiB"
    # Add more paths as needed
)

# Build the command with the reward address
COMMAND="$FARMER_EXEC farm --reward-address $REWARD_ADDRESS --prometheus-listen-on 127.0.0.1:9081"

# Loop through the PATHS array and add each path to the command
for PATH_ARG in "${PATHS[@]}"; do
    COMMAND+=" $PATH_ARG"
done

# Run the command with tee to log output and display it on screen
echo "Starting farmer with the following command:"
echo "$COMMAND | tee -a $LOG_LOCATION"
$COMMAND | tee -a "$LOG_LOCATION"

Make the file executable

chmod +x ~/autonomys/farmer.sh

Run the Farmer

~/autonomys/farmer/farmer.sh

Make sure to update the FARMER_EXEC, REWARD_ADDRESS, PATHS, etc.. This makes it a lot easier to deploy and manage your Farmer and Farms.

Using TMUX to Persist Your Session​

As you may have noticed, closing your Farmer will exit the Farmer and stop it from farming. You can create a session with TMUX to persist the session even if you close it. Ubuntu typically has TMUX installed, if needed, install it via apt

sudo apt install tmux

Then create a new session called 'farmer'

tmux new -s farmer

Then execute your script inside the TMUX session

~/autonomys/farmer/farmer.sh

To exit the TMUX session without closing it detach from it with CTRL + b and then d for detach. The SSH session can now be safely disconnected and the TMUX session will persist. To confirm, log back into the session

tmux attach -t farmer

If the session name is forgotten, all sessions can be listed

tmux ls