Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: audit state of the doc + split/single doc #322

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

tchataigner
Copy link
Contributor

This PR updates our documentation to:

  • Have a clearer explanation of the different running modes for our proof servers and their actual impacts on each Light Clients.
  • Clearly state the current audit state of the code base for each Light Client

@tchataigner tchataigner force-pushed the docs/security-split-single-docs branch from 73c68f2 to e982e90 Compare November 13, 2024 11:14
## Codebase

Please note that the current code for the programs is not audited and should not be used in production.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there any plans for doing so?

security fixes and subsequent updates to both Sphinx and the Light Client, making them available as hotfixes.

In terms of Sphinx-specific changes that require special attention, here is a non-exhaustive list of Sphinx

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there any plans to audit this subset (deviation from SP1)?

Copy link
Contributor

@huitseeker huitseeker Nov 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At this stage, we are rebasing our work on a recent version of SP1 so as to minimize the delta, which seems the sensible prelude to such audit work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants