Index

Introduction:

• How To Get Tezos
  • Build from Sources
  • Environment
  • Get the sources
  • Install OPAM (OCaml Package Manager)
  • Get the alphanet source code
  • Compile OPAM Switch and Build Dependencies
  • TL, DR Command List
  • Docker Images
• How To Use Tezos
  • The Binaries
  • The Manual Is Your Friend!!!!
  • The Tezos Node
  • Node Identity
  • Blockchain Data Storage
  • RPC (Remote Procedure Call) Interface
  • The Tezos Client
  • A Simple Wallet (Your Cryptographic Identity and Addresses)
  • Generating New Cryptographic Keys
  • Transactions
  • Verifying Your Operation Or Transaction Via The Receipt
  • Originated And Implicit Accounts (KT1 vs. tz1) And Smart Contract Beginnings
  • Storage and Gas Cost Model
  • Validation
  • It’s RPCs All The Way Down
• How To Run Tezos
  • Delegating Your XTZs
  • Originated Account Generation
  • Staking and Baking (Or Running A Delegate)
  • Register and check your rights
  • Baker
  • Endorser
  • Accuser
  • Deposits and over-delegation
  • Expected rights, deposits and rewards
  • Inactive delegates
  • Docker
• Various
  • Activate fundraiser account
  • Command line activation
  • Admin Client
  • Ledger Support
    • Ledger Manager
    • Tezos Wallet app
    • Tezos Baking app
  • Private node
  • Signer
    • Secure the connection
  • Use sandboxed mode
    • Run a sandboxed node
    • Use the sandboxed client
    • Tune protocol alpha parameters
  • Configuration options for the node
  • Environment for writing Michelson contracts
  • Debugging
• How to contribute
  • Introduction
  • Reporting issues
  • First steps
  • Where to start
  • Our git workflow
  • Code Review
    • Author Perspective
    • Reviewer Perspective
    • Practicalities : how to ask for a code review.
• Glossary
  • Tezos
  • Protocol alpha

White Docs:

• Tezos Software Architecture
  • The Big Picture
  • Software Architecture and Package Relashionships
    • Base and below
    • The Shell
    • The Economic Protocol Environment and Compiler
    • The Embedded Economic Protocols
    • The Client Library
    • Tests Packages
    • The Final Executables
• Michelson: the language of Smart Contracts in Tezos
  • Table of contents
  • I - Semantics
    • Rules form and selection
    • Recursive rules (big step form)
    • Format of patterns
    • Shortcuts
  • II - Introduction to the type system and notations
    • Type notations
    • Meta type variables
    • Typing rules
    • Side note
  • III - Core data types and notations
  • IV - Core instructions
    • Control structures
    • Stack operations
    • Generic comparison
  • V - Operations
    • Operations on booleans
    • Operations on integers and natural numbers
    • Operations on strings
    • Operations on pairs
    • Operations on sets
    • Operations on maps
    • Operations on big_maps
    • Operations on optional values
    • Operations on unions
    • Operations on lists
  • VI - Domain specific data types
  • VII - Domain specific operations
    • Operations on timestamps
    • Operations on Mutez
    • Operations on contracts
    • Special operations
    • Operations on bytes
    • Cryptographic primitives
  • VIII - Macros
    • Compare
    • Fail
    • Assertion Macros
    • Syntactic Conveniences
  • IX - Concrete syntax
    • Constants
    • Primitive applications
    • Sequences
    • Indentation
    • Differences with the formal notation
    • Main program structure
    • Comments
  • X - Annotations
    • Type Annotations
    • Variable Annotations
    • Field and Constructor Annotations
    • Syntax
    • Annotations and Macros
    • Automatic Variable and Field Annotations Inferring
    • Special Annotations
  • XI - JSON syntax
  • XII - Examples
    • Empty contract
    • Reservoir contract
    • Reservoir contract (variant with broker and status)
    • Forward contract
  • XII - Full grammar
  • XIII - Reference implementation
• Proof-Of-Stake in Tezos
  • Blocks
    • Shell header
    • Protocol header (for tezos.alpha):
    • Block size
  • Delegation
    • Delegates
    • Active and passive delegates
    • Rolls
    • Roll snapshots
  • Cycles
    • Security deposits
    • Baking rights
    • Endorsements
    • Fitness
    • Inflation
    • Random seed
  • Denunciations
• Liquid Proof-of-Stake - Jacob Arluck
• The Voting Process
  • Periods
  • Super-majority and Quorum
  • Operations
  • Client Commands
    • Submit proposals
    • Submit ballots
    • Other resources
• Amending Tezos – Jacob Arluck
  • Background
  • Proposal Period
  • Improving the Tezos Amendment Process
  • beginning
  • Delay activation of the amended protocol
  • Amendment RPCs
  • Conclusion
• The Peer-2-Peer Layer
  • General operation
    • I/O Scheduling
    • Encryption
    • Message queues
    • Pool of connections
  • Welcome worker
    • {Black, While, Grey}lists
  • Maintenance worker
• The validation subsystem
  • Validator
  • Prevalidator
  • Distributed DB

Protocol Updates & Amendments:

• Protocol 003_PsddFKi3
  • Description of the patch
    • Fix to prevent account creation spam
    • Error handling for nonce revelation
    • Add RPCs for voting
    • Correct accounting for approval voting
  • How to apply the patch
  • More details on fees and cost model
    • Protocol:
    • Baker
    • Node
  • FAQ
• Athens
• Arluck Athens

Developer Tutorials:

• JSON/RPC interface
• The data_encoding library
  • Examples/Tutorial
    • Encoding an integer
    • Encoding an object
    • Lists, arrays, and options
    • Union types
  • How the Dataencoding module works
• The Error Monad
  • Why you want the error monad
  • A simple version of the error monad
  • A slight improvement
  • Traces
  • A more descriptive message
  • Putting Lwt.t in the mix
  • The actual Tezos error monad
• Michelson Anti-Patterns
  • Refunding to a list of contracts
    • Possible issues:
    • Alternatives/Solutions:
  • Avoid batch operations when users can increase the size of the batch
    • Possible issues:
    • Alternatives/Solutions:
  • Signatures alone do not prevent replay attacks
    • Possible issues:
    • Alternatives/Solutions
    • Do not assume users will use a unique key for every smart contract
  • Storing/transferring private data
    • Possible Issues
    • Alternatives/Solutions
  • Not setting all state before a transfer
    • Possible Issues
    • Alternatives/Solutions
  • Do not store funds for others in spendable contracts
    • Possible Issues
    • Alternatives/Solutions
• How to start reading protocol Alpha
  • The TEZOS_PROTOCOL structure
  • The big abstraction barrier: Alpha_context
  • Below the Alpha_context
    • The *_repr modules
    • The Storage module and storage functors
    • The *_storage modules
  • Above the Alpha_context
    • Starting from Apply
    • Smart contracts
    • Protocol RPC API
• Economic protocol sandboxing
• Profiling the Tezos node
  • Memory profiling the OCaml heap
  • Memory profiling the C heap
  • Performance profiling

APIs:

• Online OCaml Documentation
• Command Line Interface
  • Client manual
  • Admin-client manual
  • Signer manual
  • Baker manual
  • Endorser manual
  • Accuser manual