OpenZeppelin Contracts MCP Server

import { contractExactRequiredKeys, type AiFunctionDefinition } from '../types/function-definition.ts'; import { cairoAlphaSharedFunctionDefinition } from './cairo-alpha-shared.ts'; import { addFunctionPropertiesFrom } from './shared.ts'; import { cairoPrompts, cairoERC20Descriptions, cairoERC721Descriptions, cairoERC1155Descriptions, cairoAccountDescriptions, cairoGovernorDescriptions, cairoMultisigDescriptions, cairoVestingDescriptions, } from '../../../../common/src/ai/descriptions/cairo.ts'; import { enumValues, extractStringEnumValues } from '../types/helpers.ts'; import type { ClockMode, QuorumMode, TimelockOptions, VotesOptions } from '../../../../core/cairo_alpha/dist/governor'; import type { VestingSchedule } from '../../../../core/cairo_alpha/dist/vesting'; import type { Account } from '../../../../core/cairo_alpha/dist/account'; export const cairoAlphaERC20AIFunctionDefinition = { name: 'ERC20', description: cairoPrompts.ERC20, parameters: { type: 'object', properties: { ...addFunctionPropertiesFrom(cairoAlphaSharedFunctionDefinition, [ 'name', 'symbol', 'burnable', 'pausable', 'mintable', 'access', 'upgradeable', 'info', 'macros', 'appName', 'appVersion', ]), decimals: { type: 'string', description: cairoERC20Descriptions.decimals, }, premint: { type: 'string', description: cairoERC20Descriptions.premint, }, votes: { type: 'boolean', description: cairoERC20Descriptions.votes, }, }, required: contractExactRequiredKeys<'cairoAlpha', 'ERC20'>()(['name', 'symbol']), additionalProperties: false, }, } as const satisfies AiFunctionDefinition<'cairoAlpha', 'ERC20'>; export const cairoAlphaERC721AIFunctionDefinition = { name: 'ERC721', description: cairoPrompts.ERC721, parameters: { type: 'object', properties: { ...addFunctionPropertiesFrom(cairoAlphaSharedFunctionDefinition, [ 'name', 'symbol', 'access', 'burnable', 'pausable', 'mintable', 'upgradeable', 'info', 'macros', 'royaltyInfo', 'appName', 'appVersion', ]), baseUri: { type: 'string', description: cairoERC721Descriptions.baseUri }, enumerable: { type: 'boolean', description: cairoERC721Descriptions.enumerable, }, votes: { type: 'boolean', description: cairoERC721Descriptions.votes, }, }, required: contractExactRequiredKeys<'cairoAlpha', 'ERC721'>()(['name', 'symbol']), additionalProperties: false, }, } as const satisfies AiFunctionDefinition<'cairoAlpha', 'ERC721'>; export const cairoAlphaERC1155AIFunctionDefinition = { name: 'ERC1155', description: cairoPrompts.ERC1155, parameters: { type: 'object', properties: { ...addFunctionPropertiesFrom(cairoAlphaSharedFunctionDefinition, [ 'name', 'burnable', 'pausable', 'mintable', 'access', 'upgradeable', 'info', 'macros', 'royaltyInfo', ]), baseUri: { type: 'string', description: cairoERC1155Descriptions.baseUri, }, updatableUri: { type: 'boolean', description: cairoERC1155Descriptions.updatableUri, }, }, required: contractExactRequiredKeys<'cairoAlpha', 'ERC1155'>()(['name', 'baseUri']), additionalProperties: false, }, } as const satisfies AiFunctionDefinition<'cairoAlpha', 'ERC1155'>; export const cairoAlphaGovernorAIFunctionDefinition = { name: 'Governor', description: cairoPrompts.Governor, parameters: { type: 'object', properties: { ...addFunctionPropertiesFrom(cairoAlphaSharedFunctionDefinition, [ 'name', 'upgradeable', 'info', 'macros', 'appName', 'appVersion', ]), delay: { type: 'string', description: cairoGovernorDescriptions.delay, }, period: { type: 'string', description: cairoGovernorDescriptions.period, }, proposalThreshold: { type: 'string', description: cairoGovernorDescriptions.proposalThreshold, }, decimals: { type: 'number', description: cairoGovernorDescriptions.decimals, }, quorumMode: { type: 'string', enum: enumValues<QuorumMode>()(['percent', 'absolute']), description: cairoGovernorDescriptions.quorumMode, }, quorumPercent: { type: 'number', description: cairoGovernorDescriptions.quorumPercent, }, quorumAbsolute: { type: 'string', description: cairoGovernorDescriptions.quorumAbsolute, }, votes: { type: 'string', enum: enumValues<VotesOptions>()(['erc20votes', 'erc721votes']), description: cairoGovernorDescriptions.votes, }, clockMode: { type: 'string', enum: enumValues<ClockMode>()(['timestamp']), description: cairoGovernorDescriptions.clockMode, }, timelock: { anyOf: [ { type: 'boolean', enum: [false] }, { type: 'string', enum: extractStringEnumValues<TimelockOptions>()(['openzeppelin']) }, ], description: cairoGovernorDescriptions.timelock, }, settings: { type: 'boolean', description: cairoGovernorDescriptions.settings, }, }, required: contractExactRequiredKeys<'cairoAlpha', 'Governor'>()(['name', 'delay', 'period']), additionalProperties: false, }, } as const satisfies AiFunctionDefinition<'cairoAlpha', 'Governor'>; export const cairoAlphaVestingAIFunctionDefinition = { name: 'Vesting', description: cairoPrompts.Vesting, parameters: { type: 'object', properties: { ...addFunctionPropertiesFrom(cairoAlphaSharedFunctionDefinition, ['name', 'info', 'macros']), startDate: { type: 'string', description: cairoVestingDescriptions.startDate, }, duration: { type: 'string', description: cairoVestingDescriptions.duration, }, cliffDuration: { type: 'string', description: cairoVestingDescriptions.cliffDuration, }, schedule: { type: 'string', enum: enumValues<VestingSchedule>()(['linear', 'custom']), description: cairoVestingDescriptions.schedule, }, }, required: contractExactRequiredKeys<'cairoAlpha', 'Vesting'>()([ 'name', 'schedule', 'cliffDuration', 'duration', 'startDate', ]), additionalProperties: false, }, } as const satisfies AiFunctionDefinition<'cairoAlpha', 'Vesting'>; export const cairoAlphaAccountAIFunctionDefinition = { name: 'Account', description: cairoPrompts.Account, parameters: { type: 'object', properties: { ...addFunctionPropertiesFrom(cairoAlphaSharedFunctionDefinition, ['name', 'upgradeable', 'info', 'macros']), type: { type: 'string', enum: enumValues<Account>()(['stark', 'eth']), description: cairoAccountDescriptions.type, }, declare: { type: 'boolean', description: cairoAccountDescriptions.declare, }, deploy: { type: 'boolean', description: cairoAccountDescriptions.deploy }, pubkey: { type: 'boolean', description: cairoAccountDescriptions.pubkey }, outsideExecution: { type: 'boolean', description: cairoAccountDescriptions.outsideExecution, }, }, required: contractExactRequiredKeys<'cairoAlpha', 'Account'>()(['name', 'type']), additionalProperties: false, }, } as const satisfies AiFunctionDefinition<'cairoAlpha', 'Account'>; export const cairoAlphaMultisigAIFunctionDefinition = { name: 'Multisig', description: cairoPrompts.Multisig, parameters: { type: 'object', properties: { ...addFunctionPropertiesFrom(cairoAlphaSharedFunctionDefinition, ['name', 'upgradeable', 'info', 'macros']), quorum: { type: 'string', description: cairoMultisigDescriptions.quorum, }, }, required: contractExactRequiredKeys<'cairoAlpha', 'Multisig'>()(['name', 'quorum']), additionalProperties: false, }, } as const satisfies AiFunctionDefinition<'cairoAlpha', 'Multisig'>; export const cairoAlphaCustomAIFunctionDefinition = { name: 'Custom', description: cairoPrompts.Custom, parameters: { type: 'object', properties: { ...addFunctionPropertiesFrom(cairoAlphaSharedFunctionDefinition, [ 'name', 'pausable', 'access', 'upgradeable', 'info', 'macros', ]), }, required: contractExactRequiredKeys<'cairoAlpha', 'Custom'>()(['name']), additionalProperties: false, }, } as const satisfies AiFunctionDefinition<'cairoAlpha', 'Custom'>;