-
Notifications
You must be signed in to change notification settings - Fork 23
Protocol (Executable) Proposal Template
CPSTL edited this page Mar 7, 2023
·
3 revisions
GP#: <# to be assigned>
Title: <GP title>
Author(s): <list of authors' names and/or Twitter/GitHub handles>
Type: Protocol Proposal
Status: <Assigned by Forum moderators >
Date Proposed: <yyyy-mm-dd>
Date Ratified: <yyyy-mm-dd>- A list of supporting materials referenced by this GP.
- A description of what the Governance Proposal (GP) is focused on in 30 words maximum.
- A description of what the Governance Proposal (GP) is focused on.
- A short description of the motivation behind the proposed technical feature, solution, or upgrade.
Describe the details of the proposed technical solution. The specification should be detailed enough to allow an implementation to begin as well as testing. The specification for technical GPs must include the following components:
- The final code that could be used directly in the on-chain vote to execute the GP.
- For the implementation or testing of the proposed code.
- This section is to include or (proactively document) any security-relevant design information, potential failure modes, implementation details, and important discussions related to the proposed change.
- This section is to include the process for reviewing and auditing the code. If there are no audits available yet, describe the plan for it. A Protocol proposal should NOT move to a final vote without being reviewed/audited. Therefore, it is recommended to be as detailed as possible in this section.
- Clearly outline the next steps for this proposal. This includes a recommended review period for the technical solution, what voting “yes” and “no” entails, and what the outcome and next steps would be if the proposal were to pass the Off-Chain Poll and On-Chain Vote.
-
For example:
- Discuss this proposal on the forum and discord.
- Implement a poll on this proposal on Snapshot.
- If passed: This proposal will move to an audit review period.
- A code review process will take X and should not be moved to an On-Chain vote before it has been deemed safe.
- Implemented a vote on this proposal on the Governance Dashboard
- If passed: This proposal will be executed and the following will be implemented to the governed Protocol.
Council Wiki
Technical Guides
- Getting Started
- Council Deployment Guide
- Reference UI Deployment Guide (GitHub Pages)
- How to Create Your Own Voting Vault with Council
- SDK Guide: Using Typescript to interact with Council Contracts
- Contributors Guide
Video Tutorials
- Council UI Overview
- Deploying the Council UI to Github Pages
- Get Started with the Council SDK
- Extending the SDK
Governance Proposal Framework
- Governance Proposal Framework Template
- DAO (Social) Proposal Template
- Protocol (Executable) Proposal Template
Smart Contract Documentation
- Overview
- Core Voting
- Voting Vaults Overview
- Voting Vault Example: Locking Vault
- Voting Vault Example: Vesting Vault
- Voting Vault Example: Governance Steering Council (GSC)
- Possible Voting Vaults Examples
- Timelock
- Treasury
- Spender
- Optimistic Grants
- Optimistic Rewards
- Simple Proxy
Glossaries
Security and Audits