Welcome to the Tezos Developer Documentation!¶
The Project¶
Tezos is a distributed consensus platform with meta-consensus capability. Tezos not only comes to consensus about the state of its ledger, like Bitcoin or Ethereum. It also attempts to come to consensus about how the protocol and the nodes should adapt and upgrade. The website https://tezos.com/ contains more information about the project.
Octez¶
Octez is an implementation of Tezos software, including a node, a client, a baker, an accuser, and other tools, distributed with the Tezos economic protocols of Mainnet for convenience. This implementation is available at https://gitlab.com/tezos/tezos. The source code is placed under the MIT Open Source License.
The current release of Octez is Version 15.1.
This website¶
This website (https://tezos.gitlab.io/) provides online developer documentation. This documentation is about Octez, although it also documents Tezos in general.
The developer documentation is automatically generated from the master branch of the above repository.
The Community¶
The website of the Tezos Foundation.
Tezos sub-reddit is an important meeting point of the community.
Several community-built block explorers are available:
https://tzkt.io (Baking focused explorer)
https://arronax.io (Analytics-oriented explorer)
https://baking-bad.org (Baking rewards tracker)
https://better-call.dev (Smart contracts explorer)
A few community-run websites collect useful Tezos links:
More resources can be found in the Technical Support page.
The Networks¶
Mainnet¶
The Tezos network is the current incarnation of the Tezos blockchain. It runs with real tez that have been allocated to the donors of July 2017 ICO (see Getting keys for fundraiser accounts).
The Tezos network has been live and open since June 30th 2018.
All the instructions in this documentation are valid for Mainnet however we strongly encourage users to first try all the introduction tutorials on some test network to familiarize themselves without risks.
Test Networks¶
There are several test networks for the Tezos blockchain with a faucet to obtain free tez (see Faucets). These networks are intended for developers wanting to test their software before going to beta and for users who want to familiarize themselves with Tezos before using their real tez.
See the list of test networks in test network.
Getting started¶
The best place to start exploring the project is following the How Tos in the introduction.
Introduction tutorials:
User documentation:
Shell doc:
- Tezos Software Architecture
- The validation subsystem
- The Prevalidator
- The storage layer
- Synchronisation heuristic
- The peer-to-peer layer
- P2P message format
- Block header (shell)
- fitness.elem
- Operation (shell)
- Block_header (alpha-specific)
- Operation (alpha-specific)
- bls_signature_prefix (33 bytes, 8-bit tag)
- public_key_hash (21 bytes, 8-bit tag)
- N.t
- X_2
- X_3
- X_1
- X_6
- X_4
- X_7
- X_0
- Z.t
- X_10
- X_9
- alpha.michelson.v1.primitives (Enumeration: unsigned 8-bit integer):
- micheline.alpha.michelson_v1.expression (Determined from data, 8-bit tag)
- alpha.contract_id (22 bytes, 8-bit tag)
- X_13 (Determined from data, 8-bit tag)
- X_8
- X_14
- X_17
- X_18
- X_20
- X_21 (Determined from data, 8-bit tag)
- X_22 (Determined from data, 8-bit tag)
- X_23
- X_24 (Determined from data, 8-bit tag)
- X_19
- X_25
- X_27 (Enumeration: unsigned 8-bit integer):
- X_29 (Determined from data, 8-bit tag)
- X_28
- X_30
- X_32 (Determined from data, 8-bit tag)
- X_33
- X_35 (Determined from data, 8-bit tag)
- X_34
- public_key (Determined from data, 8-bit tag)
- alpha.contract_id.originated (22 bytes, 8-bit tag)
- alpha.scripted.contracts
- alpha.entrypoint (Determined from data, 8-bit tag)
- X_36
- X_37
- alpha.inlined.preendorsement.contents (43 bytes, 8-bit tag)
- alpha.inlined.preendorsement
- fitness.elem
- alpha.block_header.alpha.full_header
- alpha.inlined.endorsement_mempool.contents (43 bytes, 8-bit tag)
- alpha.inlined.endorsement
- alpha.operation.alpha.contents_or_signature_prefix (Determined from data, 8-bit tag)
- Protocol Environment
- Micheline
- Command Line Interface
- RPCs - Reference
Kathmandu Protocol doc:
- The economic protocol
- Overview of the economic protocol
- Proof-of-stake
- Randomness generation
- The consensus algorithm
- The Amendment (and Voting) Process
- Michelson: the language of Smart Contracts in Tezos
- Time-lock
- Sapling integration
- Liquidity Baking
- Global Constants
- Token transfers and balance updates
- Prechecking of manager operations
- Transaction Rollups
- Protocol Plugins
- Contract events
- Blocks and Operations
- Validation and Application
- Glossary
- Command Line Interface
- RPCs - Reference
Lima Protocol doc:
- The economic protocol
- Overview of the economic protocol
- Proof-of-stake
- Randomness generation
- The consensus algorithm
- The Amendment (and Voting) Process
- Michelson: the language of Smart Contracts in Tezos
- Time-lock
- Sapling integration
- Liquidity Baking
- Global Constants
- Token transfers and balance updates
- Prechecking of manager operations
- Transaction Rollups
- Protocol Plugins
- Contract events
- Blocks and Operations
- Validation and Application
- Glossary
- Command Line Interface
- RPCs - Reference
Alpha Development Protocol doc:
- The economic protocol
- Overview of the economic protocol
- Proof-of-stake
- Randomness generation
- The consensus algorithm
- The Amendment (and Voting) Process
- Michelson: the language of Smart Contracts in Tezos
- Time-lock
- Sapling integration
- Liquidity Baking
- Global Constants
- Token transfers and balance updates
- Prechecking of manager operations
- Transaction Rollups
- Smart Optimistic Rollups
- Protocol Plugins
- Contract events
- Blocks and Operations
- Validation and Application
- Glossary
- Command Line Interface
- RPCs - Reference
Developer Tutorials:
- JSON/RPC interface
- Encodings
- The
data_encodinglibrary - Merkle Proof Encoding Formats
- Generalized Algebraic Data Types (GADTs)
- The Error Monad
- The
cliclibrary - Michelson Anti-Patterns
- Adding a new instruction to Michelson language
- How to start reading protocol Alpha
- Protocol Release Checklist
- How to Freeze Protocols
- Update Manifest
- Remove Accuser, Baker
- Remove Protocol Tests
- Remove
lib_delegate - Remove Protocol Tests From Tezt
- Remove Testnet From
bin_node - Remove Protocol From Python Tests of Current Protocol
- Remove RW Commands From
lib_client_commands - Remove Mempool Protocol Plugins
- Remove Old Docker-Compose Files
- Add an Entry in
CHANGES.rst
- Adding a new protocol environment
- Using The Event Logging Framework
- Testing in Tezos
- Profiling the Tezos node
- Benchmarking with Snoop
- How to contribute to Octez
- Octez Merge Team
- Coding guidelines
- Scope of the Octez repository
- Time measurement PPX
- Octez Metrics
- The documentation subsystem
Protocols:
- Protocol versioning
- Protocol 003_PsddFKi3
- Protocol Athens
- Protocol Babylon
- Protocol Carthage
- Protocol Delphi
- Protocol Edo
- Protocol Florence
- Protocol Granada
- Protocol Hangzhou
- Protocol Ithaca
- Protocol Jakarta
- Protocol Kathmandu
- Protocol Lima
- Protocol Alpha
- New Environment Version (V8)
- Michelson opcodes for logical operations on bytes
- Smart Contract Optimistic Rollups (ongoing)
- Zero Knowledge Rollups (ongoing)
- Data Availability Layer (ongoing)
- Breaking Changes
- RPC Changes
- Operation receipts
- Cryptography
- Bug Fixes
- 15s Block Times (MR !7017)
- Minor Changes
- Internal