Skip to content

DIRECTORY_STRUCTURE.md

Latest commit

 

History

History
38 lines (36 loc) · 1.85 KB

DIRECTORY_STRUCTURE.md

File metadata and controls

38 lines (36 loc) · 1.85 KB

The structure of the repository

This document describes the file-structure of the repository, and what roles various files play.

  • rfcs/ This directory contains all accepted RFCs (or "requests for comments") made according to the RFC process
  • docs/ Documentation for the code and processes for contributing are here.
  • src/ All code, both application and library code, is in this directory.
    • *.opam These files are needed for our dune build system. There must be one for each library in lib. When you create a library lib/foo_lib with a dune file giving the library's name as foo_lib, you must create a foo_lib.opam file.
    • config.mlh This file defines some constants for the ocaml preprocessor we use.
    • external/
      • Local copies of external libraries which we've had to make some tweaks to.
    • lib/ Libraries powering coda. The libraries here basically fall into two categories.
      1. General purpose data-types and functionality. This includes snarky, fold_lib, vrf_lib, sgn, and others.
      2. Application specific functionality, structured as a library. This includes syncable_ledger, staged_ledger, transaction_snark, and others.
    • app/ Applications live here.
      • cli/ This is the coda client/daemon. It is what you use to run a staker, a snarker, or a simple client for sending and receiving transactions.
      • website/ The Coda Protocol website.
      • reformat/ This program runs ocamlformat on most of the files in the source tree, with a few exceptions.
      • logproc/ This utility reads from stdin and can filter and pretty print the log messages emitted by the coda daemon.
      • kademlia-haskell/ This is a simple wrapper around a Haskell implementation of the kademlia DHT.