Skip to content

README.md

Latest commit

 

History

History
32 lines (23 loc) · 863 Bytes

README.md

File metadata and controls

32 lines (23 loc) · 863 Bytes
Raw

Orcfax-publish

Notes for auditors

Only parts included in the scope can be found in:

  • Spec: ./docs/spec.md
  • On-chain code: ./aik

About / setup

This repo uses nix flakes and has a devshell. For non nix users, its key dependencies are aiken and deno.

Repo structure

The top level repo structure is as follows

.
├── aik            # on-chain code written in aiken
├── cli            # tools to manage deployments
├── docs           # spec and other documentation
├── flake.lock     #
├── flake.nix      #
├── kio            # kompact code (utils and shared code)
├── README.md      #
└── tx             # off-chain tx building code written with lucid

In addition, there are a couple of subdirs focused at producing standalone binaries. The components have their own READMEs.