Appearance

Setting Up Your Node ​

The xosd executable serves as the core software component for operating XOS network nodes. Through proper deployment and configuration of xosd, you'll be able to connect to the network, maintain blockchain synchronization, and potentially engage in consensus validation. Below are detailed instructions for setting up your node environment.

Deployment Options ​

Multiple approaches exist for deploying the xosd software. Select the implementation strategy that aligns with your technical proficiency and requirements.

Option 1: Pre-built Binary Deployment ​

For rapid deployment, utilize the pre-compiled binaries available for your operating system platform.

System Requirements ​

  • Verify that your hardware meets the minimum specifications outlined in the system requirements documentation.

Installation Process ​

  1. Acquire the Latest Release

Navigate to the official repository's release section and download the appropriate binary package for your operating system architecture:

bash
# AMD64 Architecture:
wget https://github.com/xos-labs/node/releases/download/v0.5.2/node_0.5.2_Linux_amd64.tar.gz

# ARM64 Architecture:
wget https://github.com/xos-labs/node/releases/download/v0.5.2/node_0.5.2_Linux_arm64.tar.gz
bash
# AMD64 Architecture:
curl -LO https://github.com/xos-labs/node/releases/download/v0.5.2/node_0.5.2_Darwin_amd64.tar.gz

# ARM64 Architecture:
curl -LO https://github.com/xos-labs/node/releases/download/v0.5.2/node_0.5.2_Darwin_arm64.tar.gz
powershell
# AMD64 Architecture:
curl -LO https://github.com/xos-labs/node/releases/download/v0.5.2/node_0.5.2_Windows_amd64.zip
  1. Decompress the Package

Extract the contents of the downloaded archive:

bash
tar -xzf node_0.5.2_Linux_amd64.tar.gz
bash
tar -xzf node_0.5.2_Darwin_amd64.tar.gz
powershell
Expand-Archive -Path node_0.5.2_Windows_amd64.zip -DestinationPath .\node
  1. Install to System Path

Place the extracted xosd binary in a directory included in your system's PATH:

bash
sudo mv ./bin/xosd /usr/local/bin/
bash
sudo mv ./bin/xosd /usr/local/bin/
powershell
mkdir -Force "C:\Program Files\XOS"
Move-Item -Path ".\node\xosd.exe" -Destination "C:\Program Files\XOS"
$env:Path += ";C:\Program Files\XOS"
  1. Configure Execution Permissions
bash
chmod +x /usr/local/bin/xosd
which xosd
bash
chmod +x /usr/local/bin/xosd
which xosd
powershell
# Windows does not require explicit permission configuration.
# Verify binary accessibility in your PATH with:
where.exe xosd

Upon initial execution, configuration directories will be created at ~/.xosd (Linux/macOS) or %USERPROFILE%\.xosd (Windows).

  1. Validate Installation

Confirm successful installation by checking the software version:

bash
xosd version
bash
xosd version
powershell
xosd.exe version

Expected output should display v0.5.2 or your installed version.

  1. Further Configuration

Proceed with node configuration according to your deployment requirements.

Option 2: Compilation from Source ​

This approach is recommended for developers requiring customization options or access to the latest codebase.

Development Prerequisites ​

  • Development environment with go v1.23.4, make, and gcc installed.

Dependency Setup ​

bash
# Install development tools:
sudo apt-get update
sudo apt-get install build-essential

# Install Go programming language:
sudo rm -rf /usr/local/go
wget https://go.dev/dl/go1.23.4.linux-amd64.tar.gz
sudo tar -C /usr/local -xzf go1.23.4.linux-amd64.tar.gz
echo 'export PATH=$PATH:/usr/local/go/bin' >> ~/.profile
source ~/.profile
go version
bash
# Install development tools:
brew install make gcc

# Install Go programming language:
rm -rf /usr/local/go
curl -LO https://go.dev/dl/go1.23.4.darwin-amd64.tar.gz
sudo tar -C /usr/local -xzf go1.23.4.darwin-amd64.tar.gz
echo 'export PATH=$PATH:/usr/local/go/bin' >> ~/.zshrc
source ~/.zshrc
go version
powershell
# Install development tools:
choco install make mingw

# Install Go programming language:
curl -LO https://go.dev/dl/go1.23.4.windows-amd64.msi
Start-Process msiexec.exe -Wait -ArgumentList '/I go1.23.4.windows-amd64.msi /quiet'
go version

Compilation Process ​

  1. Retrieve Source Code:
bash
git clone https://github.com/xos-labs/node.git
  1. Navigate to Source Directory:
bash
cd node
  1. Compile Source Code:
bash
make build
  1. Locate Compiled Binaries: Upon successful compilation, executable files will be available in the build directory.