Welcome to the Hyperware Book

This book is the comprehensive technical guide for developers building on Hyperware. Hyperware is AI and Dapp development infrastructure designed for building at lightspeed. It provides a "batteries included" framework to simplify the creation and deployment of decentralized applications, including those that leverage AI.

At its core, Hyperware enables you to write, run, and distribute software from privately held personal nodes. The system is composed of a Rust kernel, Wasm processes, and an on-chain namespace called Hypermap, which collectively handle networking, identity, data persistence, and global state.

Key Sections of the Documentation

This guide is organized into several major sections to help you find the information you need:

• Getting Started: The perfect place to begin. It includes a Quick Start guide, an Introduction to core concepts, and Installation instructions.

• System Components: A deeper dive into the architecture of Hyperware, describing processes, the networking protocol, the HTTP server and client, file and database systems, and more.

• Process Standard Library: An introduction to the process_lib, a standard library that makes writing Rust applications on Hyperware simple and efficient.

• Kit: Development Toolkit: A reference for kit, the command-line interface (CLI) toolkit designed to make developing on Hyperware ergonomic and straightforward.

• Tutorials and Guides:

  • My First Hyperware Application: A step-by-step tutorial to set up your environment, learn the kit tools, and build and deploy your first application from the ground up.
  • In-Depth Guide: Chess App: A more advanced guide that walks through building a simple, complete chess application on Hyperware.

• Cookbook: A collection of practical, bite-sized recipes and how-to guides for common programming techniques and patterns you'll encounter while developing for Hyperware.

• API Reference: Detailed documentation on the Hyperware runtime module APIs. Note that for most use cases, it's recommended to use the higher-level functions provided in the Process Standard Library.

• Hosted Nodes User Guide: A guide for developers using the hosted node service provided by Sybil Technologies, including how to manage your node and use kit with it remotely.

• Audits and Security: Information regarding security audits of the Hyperware stack.

• Glossary: A helpful reference that defines the various technical terms used throughout the Hyperware ecosystem.

Happy building!