GridRustyKaspa

Overview

GridRustyKaspa is a comprehensive project that provides a full implementation of the Kaspa blockchain, along with associated tools and utilities. This repository includes everything needed to run a Kaspa node, manage wallets, mine Kaspa, and interact with the blockchain through various services. It also supports deploying these components on the ThreeFold Grid using .flist files.

Table of Contents

1. Introduction
2. Building the Docker Image
3. Running the Docker Container
4. Configuration Files
5. Documentation
6. Exposed Ports
7. Logs and Monitoring
8. Converting Docker Image to .flist
9. Troubleshooting
10. Contributing
11. License

Introduction

GridRustyKaspa aims to provide a robust and scalable implementation of the Kaspa blockchain. This project includes the following components:

• Kaspad: The core node implementation for the Kaspa blockchain.
• Kaspa Wallet: A command-line tool for managing Kaspa wallets.
• Kaspa Miner: A tool for mining Kaspa cryptocurrency.
• Rothschild: Utility for managing and monitoring Kaspa node operations.
• Simpa: Simulation and testing tool for the Kaspa network.
• Basic HTTP Server: Serves static content for the web wallet interface.
• Avahi Daemon: Facilitates service discovery on a local network.

Building the Docker Image

To build the Docker image, navigate to the root directory of the GridRustyKaspa repository and run the following command:

docker build -t gridrustykaspa .

This command will create a Docker image named gridrustykaspa.

Running the Docker Container

To run the Docker container, use the following command:

docker run --privileged -d -p 80:80 -p 16110:16110 -p 16111:16111 -p 22:22 gridrustykaspa

This command will start the container in detached mode, mapping the necessary ports.

Configuration Files

The repository includes several configuration files for different components:

• avahi-daemon.conf: Configuration for the Avahi daemon.
• kaspa.service: Systemd service file for running the Kaspa node.
• ssh-init.sh: Script to initialize the SSH server.
• monitor.sh: Script to monitor services.

Documentation

Detailed documentation for each component and process is available in the docs/ directory:

• Avahi Daemon
• Basic HTTP Server
• Conversion to .flist
• Dockerfile
• Kaspad
• Kaspa Miner
• Kaspa Wallet
• Rothschild
• Services
• Simpa
• SSH
• Zinit

Exposed Ports

• 16110: Kaspa node peer-to-peer communication.
• 16111: Kaspa node RPC server.
• 22: SSH server.
• 80: HTTP server for the web wallet interface.
• 4000: Custom application port (if needed).

Logs and Monitoring

Logs for services managed by Zinit are stored in the /var/log directory. To view the logs, use the following command:

tail -f /var/log/<service-name>.log

Converting Docker Image to .flist

To convert the Docker image to a .flist file for deployment on the ThreeFold Grid, follow the detailed instructions in the Conversion Guide.

Troubleshooting

Common issues and solutions are documented in the Troubleshooting Guide.

Contributing

We welcome contributions to the GridRustyKaspa project. Please refer to the Contributing Guide for more details.