Skip to content

Teranode Documentation

Index

Tutorials

Development Tutorials

Miner Tutorials

How-to Guides

Development

  1. Running Services Locally
  2. Using the Makefile
  3. Running Tests
  4. Setting Up Automated Test Environment
  5. Generating Protobuf Files
  6. Adding new Protobuf Services
  7. Configuring gRPC Logging
  8. Kubernetes - Remote Debugging Guide
  9. Developer's Guide to Teranode-CLI

Miners

Docker Compose Setup

  1. Installation Guide
  2. Starting and Stopping Teranode
  3. Configuration Guide
  4. Update Procedures
  5. Troubleshooting Guide
  6. Security Best Practices

Kubernetes Deployment

  1. Installation with Kubernetes Operator
  2. Starting and Stopping Teranode
  3. Configuration Guide
  4. Update Procedures
  5. Backup Procedures
  6. Troubleshooting Guide
  7. Security Best Practices

Common Tasks

  1. Interacting with Asset Server
  2. Interacting with RPC Service
  3. Interacting with the FSM via RPC
  4. Interacting with the Teranode CLI
  5. Managing Disk Space
  6. Aerospike Configuration Considerations
  7. How To Reset Teranode
  8. Blockchain Synchronization

Key Topics

Introduction

Architecture

Core Services

Overlay Services

Infrastructure Components

Additional Topics

Reference

Service Documentation

Store Documentation

Data Model

API Documentation

Additional Reference

Additional Resources

  1. Glossary
  2. Contributing to Teranode
  3. License Information

Conclusion

Teranode represents a significant advancement in blockchain infrastructure, designed to provide a scalable, reliable, and high-performance foundation for the Bitcoin SV network. This documentation serves as a comprehensive resource for developers, miners, and other stakeholders involved with Teranode implementation and operation.

By leveraging a microservices architecture and modern technologies, Teranode addresses the challenges of building a truly scalable blockchain system. Whether you're developing against Teranode, operating mining infrastructure, or simply exploring its architecture, this documentation provides the necessary guidance to understand and utilize the platform effectively.

We encourage you to explore the various sections of this documentation based on your specific needs and to contribute to the ongoing development and improvement of Teranode.

Copyright 2025 BSV Association.

Licensed under the Open BSV License Version 5; you may not use this software except in compliance with the License. You may obtain a copy of the License at

https://github.com/bitcoin-sv/teranode/blob/main/LICENSE

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.