exSat Network
  • ๐Ÿ”—Important Links
  • ๐ŸŒŒOur Approach
    • What is exSat
      • exSatโ€™s Docking Layer Approach
      • The Paradigm Shift of the Bitcoin Economic Ecosystem
      • Challenges Addressed by exSat
    • Architecture
      • Data Consensus Protocol
        • Network launch phases
        • Decentralized UTXO index
        • Synchronizers and Validators
        • Hybrid Consensus Mechanism
        • Decentralized execution
      • Decentralized Asset Custody (Coming soon)
      • Enhancing the Bitcoin Ecosystem with Smart Contract Capabilities
      • Expanding Possibilities with Rollups
    • $XSAT Tokenomics
      • Total Supply and Issuance
      • Rewards to Synchronizers and Validators
  • ๐Ÿ› ๏ธGuides of Data Consensus
    • Quick Start
    • UTXO Initialization
      • Data preparation
      • Analysis on the UTXO data tobe uploaded
      • Verify the data uploaded to exSat
    • Run a Sychronizer
      • Requirements for Synchronizers
      • Rewards for synchronizers
      • Run as Synchronizer
        • Run from source code
        • Run with Docker
    • Run a BTC Validator
      • Requirements and rewards for BTC Validators
      • Run as BTC validator
        • Run from source code
        • Run with docker
    • Run a XSAT Validator
      • Run as XSAT Validator
        • Run from source code
        • Run with docker
      • Run multiple XSAT Validators
    • Others
      • Operation references
        • Preparation Before You Start
          • Account Preparation
          • Run a BTC node
          • Environment requirements
          • Prerequisites
        • Synchronizer operations
          • Create New Synchronizer Account
          • Synchronizer Registration
          • Execute the synchronizer client
          • Revote For Consensus
          • Change Reward Address
          • Check and claim rewards for synchronizer
          • Update to new Docker version for Synchronizer
        • Validator operations
          • Create New BTC Validator Account
          • Create New XSAT Validator Account
          • Stake for Validator and claim rewards
          • Change Stake Address
          • Change Commission Address
          • Change Commission Ratio
          • Configure Display Information for Your Validator Account
          • Execute the validator client
          • Update to new Docker version for Validator
        • Common operations
          • Import from seed phrase
          • Import from Private Key
          • Set BTC RPC Node
          • Refill BTC for Gas Fees
          • Export private key
          • Remove Your Account
          • Upgrade to new version
          • View Logs
          • Environment variables
  • ๐Ÿ‘จโ€๐Ÿ’ปDeveloper Guides
    • Quick Start
    • Native Layer Developer Guides
      • exSat consensus contracts
        • Pool Register Contract
        • UTXO Management Contract
        • Reward Distribution Contract
        • Block Consensus Contract
        • Block Synchronization Contract
        • Validator Management Contract
        • Staking Contract
      • Run exSat native layer RPC Node
  • ๐Ÿ–ฅ๏ธUser Guides
    • Wallet Setup
    • Bridge Your Assets
    • Earn Rewards via BTC Staking
    • Explore Our Ecosystem
  • Popular Token Contract Addresses
  • ๐Ÿ“šReference
  • ๐Ÿ“ฆCutodian Guides
  • ๐Ÿ”Security Reports
    • Audit Report From Blocksec
  • ๐Ÿ”กTerms and Conditions
    • Terms Of Service
    • Privacy Policy
  • ๐ŸŽPR & Press
  • โ˜Ž๏ธContact US
Powered by GitBook
On this page
  • Running from source code
  • Node.js
  • Git
  • Yarn
  • Running with Docker
  1. Guides of Data Consensus
  2. Others
  3. Operation references
  4. Preparation Before You Start

Prerequisites

Some commands may need the root account permission to execute, please use sudo as needed, or just start the client as root:

sudo -i

Running from source code

If you wish to run the client from source code, please install the following dependences.

Node.js

Running the Client requires installing Node.js.

Check if Node.js is Installed

Open a terminal window.

To check if Node.js is installed, run the following command:

node -v

If Node.js is installed, the terminal will display the version number, such as v20.15.1.

  1. If Node.js is installed, ensure that the version is 20.15.1 or higher.

  2. If the installed version is lower than 20.15.1 or it is not installed, proceed to the installation below.

Install Node.js Version 20.15.1

To install Node.js version 20.15.1, first ensure your system is updated:

sudo apt update

Install Node.js from the NodeSource repository:

curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt install -y nodejs

Verify the installation by checking the Node.js version again:

node -v

This should return v20.15.1 or a higher version if installed successfully.

Git

Check if Git is Installed

To check if Git is installed, run the following command in the terminal:

git --version

If Git is installed, the terminal will display the version number, such as git version 2.25.1.

Install Git if Not Installed

If Git is not installed, you can install it by running the following commands:

sudo apt update
sudo apt install -y git

Verify the installation by checking the Git version:

git --version

This should return the version number of Git, confirming the installation.

โ€‹

Yarn

Check if Yarn is Installed

Open a terminal window.

Check if Yarn is installed by running:

yarn -v

Install Yarn if Not Installed

If Yarn is not installed, add the Yarn repository and install it:

npm install -g yarn

Verify the installation by checking the Yarn version:

yarn -v

By following these steps, you will ensure that both Node.js (version 20.15.1 or higher) ,Git and Yarn are installed and properly configured on your system.

Running with Docker

If you wish to run the client with docker, please install docker.

  1. Download and Run the Official Installation Script

    Docker provides a convenient installation script that you can download and run with the following commands:

    curl -fsSL https://get.docker.com -o get-docker.sh
    sh get-docker.sh
  2. Verify the Docker Installation

    Check the Docker version to confirm that the installation was successful:

    docker --version
PreviousEnvironment requirementsNextSynchronizer operations

Last updated 6 months ago

๐Ÿ› ๏ธ