Introduction

Welcome to the utility cook guide!

The target audience of this guide are developers of node itself. If you are a user of unc-node (either a contract developer, or validator running a node), please refer to the user docs at https://docs.xyz666.org.

This guide is built with mdBook from sources in the utility repository. You can edit it by pressing the "edit" icon in the top right corner, we welcome all contributions. The guide is hosted at https://docs.github.io/utility/.

The guide is organized as a collection of loosely coupled chapters -- you don't need to read them in order, feel free to peruse the TOC, and focus on the interesting bits. The chapters are classified into three parts:

  • Architecture talks about how the code works. So, for example, if you are interested in how a transaction flows through the system, look there!
  • Finally, the Misc part holds various assorted bits and pieces. We are trying to bias ourselves towards writing more docs, so, if you want to document something and it doesn't cleanly map to a category above, just put it in misc!

If you are unsure, start with Overview and then read Run a Node