Hyperledger Avalon Documentation

Introduction

• README. Overview of Avalon and its source code
• FAQ. Frequently-asked questions with answers about Avalon
  • Glossary
  • Videos
• Avalon Proposal. Avalon Proposal, initial members, motivation, and proposed solutions (2019)
• "Ecosystem Support for EEA Trusted Compute Specification v1.0 Improves Blockchain Privacy and Scalability". Introductory blog by Michael Reed (2019)
• Introduction to Hyperledger Avalon video (20:24)

Community

• Project Wiki
• RocketChat
• Email list
• JIRA feature & bug tracking

Tutorial

• Workload Application Tutorial
• Example Applications

Source Code

• Avalon source code repository, https://github.com/hyperledger/avalon
• Building source code
• Example Avalon applications
• Contributing source code

SDK Reference Manual

The Avalon SDK Reference Manual is generated with Doxygen. To generate the Reference Manual, type the following:

cd $TCF_HOME/docs # this directory
sudo apt-get update
sudo apt-get install -y make doxygen texlive-full graphviz
make

Documentation generated will be here:

• $TCF_HOME/docs/refman/html/HTML documentation
• $TCF_HOME/docs/refman/man/man3man page documentation
• $TCF_HOME/docs/refman/latexLaTeX documentation
• $TCF_HOME/docs/refman/refman.pdfPDF documentation (generated from LaTex)

Reference

• Hyperledger Avalon Architecture Overview. Overview of Avalon architecture by Eugene Yarmosh (2020)
• Off-Chain Trusted Compute Specification defined by Enterprise Ethereum Alliance (EEA) Task Force
• Cryptography. Cryptographic primitives used, libraries used, and implementation