Installation Guide

Getting Started

This section provides installation instructions for running an OP_NET node. OP_NET is designed for cross-platform compatibility and supports most operating systems.

The OP_NET node source code is available on GitHub at https://github.com/btc-vision/opnet-node.

Hardware Recommendations

Installation

Automated Installation

OP_NET provides an automated setup script for quick installation on Ubuntu based systems. To use the script, run the following command:

bash

curl -fsSL https://autosetup.opnet.org/autoconfig.sh -o autoconfig.sh && sudo -E bash autoconfig.sh

Manual Installation

For users who prefer not to use the automated Ubuntu installation script or are running a different operating system, the following steps outline the manual installation process.

1. Prerequisites

Install all required prerequisites:

Node.js version 24.x or higher: Download from the Node.js website.
git: Download the latest version from the git website.
Bitcoin Node: A fully synced Bitcoin Core node with RPC access. Refer to the BitcoinCore website for detailed installation procedure.
MongoDB 8.0 or higher: Download from the MongoDB website.

Rust programming language:

For Linux or macOS:

bash

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

For Windows: Download the installer from the Rust website.

2. Clone the repository

bash

git clone https://github.com/btc-vision/opnet-node.git

3. Navigate to the repository directory

bash

cd opnet-node

4. Potential Issues

Warning

If you have Python 3.12 installed, you may encounter issues. Install setuptools before proceeding to step 5.

bash

py -3 -m pip install setuptools

5. Install the project dependencies

bash

npm install

6. Configure the node

Adjust the variables in the configuration file located in the config/ directory to suit your needs. Refer to the configuration section for detailed configuration options.

7. Start the node

bash

npm start