ivan-gavran / audit-celestia

Workspace set up for collaboration in the Celestia audit

visibility
PUBLIC

Audit Workspace of Informal Systems ⨯ Celestia

This repository is a workspace for Informal Systems and Celestia to collaborate on auditing the software developed by Celestia.

Usage and organization

The artifacts for each audit engagement are gathered in a subdirectory named after the year and quarter in which the audit was carried out.

These artifacts include:

• The artifacts generated in the course of the audit.
• The artifacts under audit, referenced as git submodules.

To clone just the artifacts Informal created during the audit

git clone [e-mail]:informalsystems/audit-Celestia.git

To clone all artifacts, including Interlay's source code at the relevant commits

git clone --recurse-submodules [e-mail]:informalsystems/audit-Celestia.git

To update the submodules if you've already cloned the repository

git submodule update --init --recursive

To add an artifact into an artifacts directory

From within an the artifacts subdirectory of an audit:

git submodule add https://github.com/Celestia/$PROJECT$
cd $PROJECT$
git checkout $TAG$

where $TAG$ is the tag or commit agreed to be under audit.

Then

cd .. # back into the workspace repository
git commit -m "pin client artifact $PROJECT$"

To update the report generation tooling

The report generation is also tracked as a git submodule (allowing us to share code between audit efforts, and update the templating logic in one place). To update, run

git submodule update --init --recursive