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

[draft] Constitution Tech CIP #9

Closed
wants to merge 6 commits into from
Closed

Conversation

Ryun1
Copy link
Owner

@Ryun1 Ryun1 commented Mar 22, 2024

Copy link

@daniellestanko daniellestanko left a comment

Choose a reason for hiding this comment

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

Added some suggested changes and some questions.

cip-constitution-tech/README.md Show resolved Hide resolved
cip-constitution-tech/README.md Show resolved Hide resolved
cip-constitution-tech/README.md Show resolved Hide resolved

Rich text formatting greatly enhances the readability of text, especially in large complex documents.
Without the ability to format text, it could easily become cumbersome to read, negatively effecting the accessability of the Cardano constitution.

Choose a reason for hiding this comment

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

We might want to think about addressing different languages here - since the constitution is likely to use English as the standard, and translations (especially automatic) could change the meaning of the constitution. Is something like a universal warning about the translation issue appropriate here?

Copy link
Owner Author

Choose a reason for hiding this comment

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

that is a great point, we should consider this
im unsure the best approach for this

Copy link
Owner Author

Choose a reason for hiding this comment

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

Added to Open Questions section


### File Type
// todo - any suggestions?

Choose a reason for hiding this comment

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

for the purpose of hashing, should a .txt file type be mandated to ensure there's no metadata included in the hash? We've also talked about the concern of special characters - I think this needs further conversation, but might be worthwhile to consider.

Copy link
Owner Author

Choose a reason for hiding this comment

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

to me a .txt sounds fine, I left it open incase other people had strong feelings for a specific format

When supplying a constitution hash digest to chain, the algorithm used MUST be Blake2b-256.
Before creating a hash digest the constitution plain text must be in its raw un-rendered format.

- add a way to change algorithm?

Choose a reason for hiding this comment

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

While I agree that a standard algorithm is likely best, to address making changes, we might be able to require that the algorithm is specified in the constitution update governance action, and therefore any of a set (that might be specified here?) could be used.

Copy link
Owner Author

Choose a reason for hiding this comment

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

the algorithm is specified in the constitution update governance action

This would make it tricky to be able to discover the current hash algorithm

cip-constitution-tech/README.md Show resolved Hide resolved
cip-constitution-tech/README.md Outdated Show resolved Hide resolved
cip-constitution-tech/README.md Outdated Show resolved Hide resolved
cip-constitution-tech/README.md Show resolved Hide resolved
@Ryun1 Ryun1 closed this Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants