tezos.gitlab.io Open in urlscan Pro
35.185.44.232  Public Scan

Form analysis
1 forms found in the DOM

GET search.html

<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  <input type="text" name="q" placeholder="Search docs">
  <input type="hidden" name="check_keywords" value="yes">
  <input type="hidden" name="area" value="default">
</form>

Text Content

Starting from Octez release 15.0, the names of the Octez binaries start with
"octez-" and do not include any protocol number (e.g. "octez-client",
"octez-node", "octez-baker-PtKathma" instead of "tezos-client", "tezos-node",
"tezos-baker-015-PtKathma"). Occasionally, some legacy names ("tezos-*") may
still be used in the documentation.

Welcome to the Tezos Technical Documentation! — Tezos (master branch, 2023/01/15
06:47) documentation
master


Introduction

 * The Tezos blockchain
 * How to get Tezos
 * Getting started with Tezos
 * How to run Tezos
 * Test Networks
 * Installation troubleshooting
 * Technical Support

User doc

 * Versions
 * Setting up the client
 * Setting up the node
 * Proxy server
 * Multi-signature smart contracts
 * FA1.2 asset smart contracts
 * Logging
 * Various

Shell doc

 * Tezos Software Architecture
 * The Octez Shell
 * P2P message format
 * Command Line Interface
 * RPCs - Reference

Lima Protocol doc:

 * The economic protocol
 * Glossary
 * Command Line Interface
 * RPCs - Reference

Mumbai Protocol doc:

 * The economic protocol
 * Glossary
 * Command Line Interface
 * RPCs - Reference

Alpha Dev Protocol doc

 * The economic protocol
 * Glossary
 * Command Line Interface
 * RPCs - Reference

Developer doc

 * JSON/RPC interface
 * Michelson Anti-Patterns

Core Developer doc

 * Contributing
 * Programming tutorials
 * Testing in Tezos
 * Maintaining
 * Documenting
 * Core Development tools
 * Encodings
 * Merkle Proof Encoding Formats
 * Octez Metrics

Protocols

 * Protocol versioning
 * Protocol Lima
 * Protocol Mumbai
 * Protocol Alpha
 * Older Protocols

Releases

 * Release System
 * Version 15.1
 * Older Versions

APIs

 * Online OCaml Documentation
 * OpenAPI Specification
 * RPC Errors

Tezos
 * »
 * Welcome to the Tezos Technical Documentation!
 * View page source

--------------------------------------------------------------------------------


WELCOME TO THE TEZOS TECHNICAL DOCUMENTATION!¶

To start browsing, either follow one of the guided paths below, or directly pick
any topics in the documentation menu.

Never heard of Tezos? Let's get acquainted! (See more)

Tezos is a distributed consensus platform (a blockchain) with meta-consensus
capability.

This means that, unlike other blockchains like Bitcoin or Ethereum, Tezos comes
to consensus not only about the state of its ledger, but also about how the
protocol and the nodes should adapt and upgrade.

This is a fundamental design choice, allowing Tezos to be seamlessly upgradable
and continuosly evolving. Due to this feature, Tezos is built to last, and
always stay at the leading edge of blockchain technology.

To learn more about Tezos, its implementation, and its ecosystem, see The Tezos
blockchain.


Newcomer to Tezos? Come and participate! (See more)

Start participating to Tezos by following the Introduction section in the
documentation menu.

These tutorials explain:

 * how to get the latest release of Octez (a complete, open-source
   implementation of Tezos) in various forms,

 * how to start using Octez to join Tezos,

 * different ways to participate to the network,

and more.


Already a user? Here is everything you need to know. (See more)

If you already installed Octez and can participate in the Tezos blockchain, the
most useful resources are grouped in the User section in the documentation menu.
These pages:

 * present the key concepts and mechanisms for setting up Octez, including
   Setting up the client, Setting up the node, and so on;

 * empowers you to take advantage of Octez’ basic and more advanced features,
   such as Key Management, Multi-signature smart contracts, Logging, and much
   more.

If you intend to participate to Tezos not just as a mere user, but also as a
baker, you could also check more specialized resources such as the NL Knowledge
Center or Open Tezos.


Want to know how it works? It's no secret, let us explain! (See more)

If you want to know more about the Tezos technology, there are several sections
in the documentation presenting the main design principles of Tezos, and some
high-level implementation principles of Octez:

 * Section Shell introduces the common architectural principles of any Tezos
   implementation, mainly consisting of a “shell” and a “protocol”. It also
   presents in particular the architectural principles of the Octez
   implementation. A group of pages in this section detail some major subsystems
   of The Octez Shell.

 * Sections named <name> Protocol explain the design principles and the salient
   features of several Tezos protocols, current or upcoming, such as: the active
   protocol, a protocol proposal under development, and possibly some
   protocol(s) that are currently candidate(s) for future adoption.


Are you an application developer? Find how to program with Tezos. (See more)

Tezos is an open platform. As any programmable blockchain, its value lies in the
increasing base of smart contracts and distributed applications covering various
domains, but also in the tools that make the ecosystem easier to use and more
efficient, such as wallets, indexers, and many others.

For Tezos developers, this website mostly provides API documentation, but also
some guidelines, including:

 * A complete reference of Michelson: the language of Smart Contracts in Tezos

 * Important API concepts such as the JSON/RPC interface

 * API references such as RPCs - Reference, OpenAPI Specification, or RPC Errors

 * Guidelines for writing smart contracts, such as Michelson Anti-Patterns.

If you are looking for a more accessible and pedagogical exposition on how to
write smart contracts or Dapps, there are many great resources out there for
developing on Tezos, such as the Tezos Developer Portal and Open Tezos.


Are you a core developer? Here are the nuts and bolts! (See more)

The main focus of this technical documentation website is on resources for core
developers, that is, contributors to the Tezos platform, and in particular to
its Octez implementation.

Core developers can find a rich set of explanations, tutorials, and howtos,
mainly in the Core Developer section, including:

 * a tutorial on the various forms of contributing (How to contribute to Octez),
   and guidelines such as Coding guidelines

 * programming tutorials covering various libraries and frameworks specific to
   the Octez OCaml implementation, such as using Generalized Algebraic Data
   Types (GADTs), using The Error Monad, using The clic library, Using The Event
   Logging Framework, etc.

 * howtos for specific maintenance tasks such as Adding a new instruction to
   Michelson language, Adding a new protocol environment, or How to Freeze
   Protocols

 * a whole subsection on the various testing frameworks for Octez, explaining
   how to use them and how to add different kinds of tests

 * presentations of various tools for core developers, such as support for
   Profiling the Tezos node and Benchmarking with Snoop.

Core developers are also provided reference materials for internal APIs of
Octez, such as:

 * The API of OCaml libraries and modules reference

 * The P2P message format reference

 * The Merkle Proof Encoding Formats reference.













Next

--------------------------------------------------------------------------------

© Copyright 2018-2021, Nomadic Labs <contact@nomadic-labs.com>.

Built with Sphinx using a theme provided by Read the Docs.