cairo-governor
Generate governance contract source code for DAOs or decentralized systems using ERC20 or ERC721 voting tokens. Customize parameters like voting delays, periods, quorum modes, and timelocks. Output formatted in Markdown for immediate use.
Instructions
Make a contract to implement governance, such as for a DAO.
Returns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| appName | No | Required when votes is enabled, for hashing and signing typed structured data. Name for domain separator implementing SNIP12Metadata trait. Prevents two applications from producing the same hash. | |
| appVersion | No | Required when votes is enabled, for hashing and signing typed structured data. Version for domain separator implementing SNIP12Metadata trait. Prevents two versions of the same application from producing the same hash. | |
| clockMode | No | The clock mode used by the voting token. For now, only timestamp mode where the token uses voting durations expressed as timestamps is supported. For Governor, this must be chosen to match what the ERC20 or ERC721 voting token uses. | |
| decimals | No | The number of decimals to use for the contract, default is 18 for ERC20Votes and 0 for ERC721Votes (because it does not apply to ERC721Votes). | |
| delay | Yes | The delay since proposal is created until voting starts, in readable date time format matching /^(\d+(?:\.\d+)?) +(second|minute|hour|day|week|month|year)s?$/, default is "1 day". | |
| info | No | Metadata about the contract and author | |
| name | Yes | The name of the contract | |
| period | Yes | The length of period during which people can cast their vote, in readable date time format matching /^(\d+(?:\.\d+)?) +(second|minute|hour|day|week|month|year)s?$/, default is "1 week". | |
| proposalThreshold | No | Minimum number of votes an account must have to create a proposal, default is 0. | |
| quorumAbsolute | No | The absolute quorum required, in cases of quorumMode equals absolute. | |
| quorumMode | No | The type of quorum mode to use, either by percentage or absolute value. | |
| quorumPercent | No | The percent required, in cases of quorumMode equals percent. | |
| settings | No | Whether to allow governance to update voting settings (delay, period, proposal threshold). | |
| timelock | No | Whether to add a delay to actions taken by the Governor. Gives users time to exit the system if they disagree with governance decisions. If "openzeppelin", Module compatible with OpenZeppelin's TimelockController. | |
| upgradeable | No | Whether the smart contract is upgradeable. | |
| votes | No | The type of voting to use. Either erc20votes, meaning voting power with a votes-enabled ERC20 token. Either erc721votes, meaning voting power with a votes-enabled ERC721 token. Voters can entrust their voting power to a delegate. |
Implementation Reference
- Handler function that constructs GovernorOptions from input parameters and generates Cairo Governor contract code using governor.print(opts) from @openzeppelin/wizard-cairo.async ({ name, delay, period, votes, clockMode, timelock, decimals, proposalThreshold, quorumMode, quorumPercent, quorumAbsolute, settings, upgradeable, appName, appVersion, info, }) => { const opts: GovernorOptions = { name, delay, period, votes, clockMode, timelock, decimals, proposalThreshold, quorumMode, quorumPercent, quorumAbsolute, settings, upgradeable, appName, appVersion, info, }; return { content: [ { type: 'text', text: safePrintCairoCodeBlock(() => governor.print(opts)), }, ], }; },
- Zod schema defining the input parameters and validation for the cairo-governor tool, matching GovernorOptions type.export const governorSchema = { name: z.string().describe(commonDescriptions.name), delay: z.string().describe(cairoGovernorDescriptions.delay), period: z.string().describe(cairoGovernorDescriptions.period), votes: z.enum(['erc20votes', 'erc721votes']).optional().describe(cairoGovernorDescriptions.votes), clockMode: z.enum(['timestamp']).optional().describe(cairoGovernorDescriptions.clockMode), timelock: z .union([z.literal(false), z.literal('openzeppelin')]) .optional() .describe(cairoGovernorDescriptions.timelock), decimals: z.number().optional().describe(cairoGovernorDescriptions.decimals), proposalThreshold: z.string().optional().describe(cairoGovernorDescriptions.proposalThreshold), quorumMode: z.enum(['percent', 'absolute']).optional().describe(cairoGovernorDescriptions.quorumMode), quorumPercent: z.number().optional().describe(cairoGovernorDescriptions.quorumPercent), quorumAbsolute: z.string().optional().describe(cairoGovernorDescriptions.quorumAbsolute), settings: z.boolean().optional().describe(cairoGovernorDescriptions.settings), upgradeable: commonSchema.upgradeable, appName: z.string().optional().describe(cairoCommonDescriptions.appName), appVersion: z.string().optional().describe(cairoCommonDescriptions.appVersion), info: commonSchema.info, } as const satisfies z.ZodRawShape;
- packages/mcp/src/cairo/tools/governor.ts:8-59 (registration)Registers the 'cairo-governor' tool on the MCP server with name, prompt, schema, and handler function.export function registerCairoGovernor(server: McpServer): RegisteredTool { return server.tool( 'cairo-governor', makeDetailedPrompt(cairoPrompts.Governor), governorSchema, async ({ name, delay, period, votes, clockMode, timelock, decimals, proposalThreshold, quorumMode, quorumPercent, quorumAbsolute, settings, upgradeable, appName, appVersion, info, }) => { const opts: GovernorOptions = { name, delay, period, votes, clockMode, timelock, decimals, proposalThreshold, quorumMode, quorumPercent, quorumAbsolute, settings, upgradeable, appName, appVersion, info, }; return { content: [ { type: 'text', text: safePrintCairoCodeBlock(() => governor.print(opts)), }, ], }; }, ); }
- packages/mcp/src/cairo/tools.ts:30-34 (registration)Top-level registration function for all Cairo tools, including cairo-governor via registerCairoGovernor.export function registerCairoTools(server: McpServer) { Object.values(getRegisterFunctions(server)).forEach(registerTool => { registerTool(server); }); }