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

Document the meaning of writeset and commit evidence #3602

Closed
letmaik opened this issue Feb 25, 2022 · 2 comments
Closed

Document the meaning of writeset and commit evidence #3602

letmaik opened this issue Feb 25, 2022 · 2 comments
Assignees
Labels
2.0.x Short-term improvements to 2.0 documentation enhancement

Comments

@letmaik
Copy link
Member

letmaik commented Feb 25, 2022

Those should be documented since they are exposed in receipts.

@achamayou
Copy link
Member

achamayou commented Feb 27, 2022

Also:

  • Receipt architecture page, motivating the high-level goals, linking to Audit and Use Apps pages
  • Use Apps: cover receipts as service signatures with optional user claims
  • Add detail about cert, identity of signer
  • Make explicit the requirement to have the service identity
  • Add a commented sample use of custom claims in the JS logging app, showing how to expose the log message directly in the receipt
  • Audit: cover receipts as audit elements, potentially to be combined with a ledger, move to first position
  • Add a commented sample use of a receipt with a ledger or online service to detect and blame a malicious catastrophic recovery (equivalent to the next item)
  • Add a commented sample use of a receipt + ledger to check for inclusion

@achamayou
Copy link
Member

Started under https://github.com/achamayou/CCF/tree/receipt_doc_changes, will tick off as PR'ed.

@achamayou achamayou added the 2.0.x Short-term improvements to 2.0 label May 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.0.x Short-term improvements to 2.0 documentation enhancement
Projects
None yet
Development

No branches or pull requests

2 participants