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

CIP: Protocol Parameters #45

Merged
merged 7 commits into from
Jan 31, 2021
Merged

CIP: Protocol Parameters #45

merged 7 commits into from
Jan 31, 2021

Conversation

kevinhammond
Copy link
Contributor

This was suggested by the QuantStamp Auditors. The idea is to provide a base CIP that we should use as the root of all future protocol parameter changes (including the forthcoming change to the k parameter).

I have checked the original draft with Jared Corduan (IOHK Ledger team lead) and Duncan Coutts, and I have uploaded it to the Cardano Forum. There have been 48 views, but no comments so far. I will continue to monitor this for community comments, but since it is not proposing any changes, I would expect discussion to be fairly minimal.

Copy link
Contributor

@crptmppt crptmppt left a comment

Choose a reason for hiding this comment

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

Thanks for this PR @kevinhammond - looks like a very useful CIP to add - tentatively added for review next CIP Editors meeting on Dec 8.

CIP-Draft-Initial-Params/Initial.md Outdated Show resolved Hide resolved
@@ -0,0 +1,172 @@
## Preamble
Copy link
Collaborator

Choose a reason for hiding this comment

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

No need to explicitly add a "preamble" header


## Specification

The initial protocol parameters are given below (in JSON format):
Copy link
Member

Choose a reason for hiding this comment

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

Maybe add a clear disclaimer that the values below may not reflect the current mainnet values (as for k for example).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've included the changes, so I don't think a disclaimer is needed now. However, someone will need to maintain it!

CIP-Draft-Initial-Params/Initial.md Outdated Show resolved Hide resolved
* License: <abbreviation for approved license(s)>
* License-Code: <abbreviation for code under different approved license(s)>
* Post-History: <dates of postings to Cardano Dev Forum, or link to thread>
* Requires: <CIP number(s)>
Copy link
Collaborator

Choose a reason for hiding this comment

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

You can remove these unused fields

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK

You can remove these unused fields

OK

Copy link
Contributor

@dcoutts dcoutts left a comment

Choose a reason for hiding this comment

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

LGTM.

I've double-checked the params match the initial Shelley ones (both updateable and non-updateable).

We should add a paragraph somewhere to say how to propose updated param values: as new CIPs not as edits to this CIP. The rationale being that CIPs are proposals, and there can be many conflicting ones, and they may or may not be adopted. This CIP should remain informational on what the initial and current params are, and ideally the history of changes.

1. Removed CIP preamble as requested by Sebastien

2. Added section on how to update the parameters in future, as requested by the committee.
Copy link
Contributor Author

@kevinhammond kevinhammond left a comment

Choose a reason for hiding this comment

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

LGTM.

I've double-checked the params match the initial Shelley ones (both updateable and non-updateable).

We should add a paragraph somewhere to say how to propose updated param values: as new CIPs not as edits to this CIP. The rationale being that CIPs are proposals, and there can be many conflicting ones, and they may or may not be adopted. This CIP should remain informational on what the initial and current params are, and ideally the history of changes.

Added a paragraph at the start. I propose to leave the committee to adjust the text as needed.

* License: <abbreviation for approved license(s)>
* License-Code: <abbreviation for code under different approved license(s)>
* Post-History: <dates of postings to Cardano Dev Forum, or link to thread>
* Requires: <CIP number(s)>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK

You can remove these unused fields

OK

Fixed table formatting in change paragraph.
Copy link
Contributor

@crptmppt crptmppt left a comment

Choose a reason for hiding this comment

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

Thanks for using the proper file naming conv. to align with existing CIPs..
File content also needs header - for proper structure see the template in root dir or check into CIP1.

@kevinhammond
Copy link
Contributor Author

Thanks for using the proper file naming conv. to align with existing CIPs..
File content also needs header - for proper structure see the template in root dir or check into CIP1.

OK. I was asked to remove the header I thought... I'll add it back

Added back header
@kevinhammond
Copy link
Contributor Author

Added back the header. I don't know the CIP number, of course - someone else will need to add that. Likewise comments if there is a URI that should be referred to.

@kevinhammond kevinhammond changed the title added CIP for initial parameters CIP: Protocol Parameters Jan 29, 2021
@crptmppt
Copy link
Contributor

Minor reservations about jumping directly as "Active" - should be merged shortly once consensus is reached (status might be tweaked)

setting next available non-reserved number, moving status to 'Draft' (internal discussion happening)
Copy link
Contributor

@crptmppt crptmppt left a comment

Choose a reason for hiding this comment

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

agreed to merge last meeting, minor details to be addressed to follow on (Status)

CIP moved to proper dir
@crptmppt crptmppt merged commit 54579a5 into cardano-foundation:master Jan 31, 2021
KtorZ added a commit that referenced this pull request Jun 7, 2022
* Create 2022-05-24.md

* Update 2022-05-24.md

* Update 2022-05-24.md

* Update 2022-05-24.md

* Update BiweeklyMeetings/2022-05-24.md

Co-authored-by: Robert Phair <rphair@cosd.com>

* Update BiweeklyMeetings/2022-05-24.md

Co-authored-by: Robert Phair <rphair@cosd.com>

* Update BiweeklyMeetings/2022-05-24.md

Co-authored-by: Robert Phair <rphair@cosd.com>

* Update 2022-05-24.md

* Update BiweeklyMeetings/2022-05-24.md

* Update BiweeklyMeetings/2022-05-24.md

* Update BiweeklyMeetings/2022-05-24.md

* Update BiweeklyMeetings/2022-05-24.md

* Update BiweeklyMeetings/2022-05-24.md

* Update BiweeklyMeetings/2022-05-24.md

* Update BiweeklyMeetings/2022-05-24.md

* Update BiweeklyMeetings/2022-05-24.md

* Update BiweeklyMeetings/2022-05-24.md

Co-authored-by: Robert Phair <rphair@cosd.com>
Co-authored-by: Matthias Benkort <5680256+KtorZ@users.noreply.github.com>
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.

5 participants