Maintaining

As with any smart-contract blockchain platform, Octez is a quite complex software system, at the crossroad of several domains including distributed systems, cryptography, programming languages, and applied formal methods. Additionally, the specific evolution features of Tezos, enabling powerful online governance, imply an extra infrastructure meta-layer and an orthogonal versioning scheme for protocols, and hence, more complex maintenance procedures.

The following howtos are intended to facilitate different maintenance tasks by providing detailed guides to platform developers, but are also potentially interesting for other actors in the ecosystem (communication, management, etc.).

• How to start reading protocol Alpha
  • The TEZOS_PROTOCOL structure
  • The big abstraction barrier: Alpha_context
  • Below the Alpha_context
  • Above the Alpha_context
• Adding a new instruction to Michelson language
  • Michelson primitives
  • Michelson types
  • Internal representation (IR)
  • The translator
  • The interpreter
  • The Gas model
  • Documentation
• Protocol Proposals
  • Developing a Protocol Proposal
  • Releasing a Protocol Proposal
  • Validation via on-chain governance
  • Activation
  • Issues and mitigations
• How to Freeze Protocols
  • Update Manifest
  • Remove Accuser, Baker and Protocol-Specific Libraries
  • Remove Protocol Tests
  • Remove Per-Protocol Devtools Files
  • Disable the Mempool Protocol Plugin
  • Disable Protocol Tests in Tezt
  • Remove the Protocol’s Testnet Configuration
  • Update the Profiler Patches
  • Remove RW Commands From lib_client_commands
  • Remove Old Docker-Compose Files
  • Add an Entry in CHANGES.rst
• Adding a new protocol environment
  • Bootstrap
  • Activating the environment
  • Making changes in the environment
• RPC How-To
  • How to declare a service
  • How to register services by declaring a directory
  • How to serve a directory
  • How to call RPCs
  • How to register an RPC in the protocol