cairo-erc1155
Generate ERC-1155 token contracts with configurable features like burnable, pausable, mintable, royalty, and access control options.
Instructions
Make a non-fungible token per the ERC-1155 standard.
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 |
|---|---|---|---|
| name | Yes | The name of the contract | |
| baseUri | Yes | The location of the metadata for the token. Clients will replace any instance of {id} in this string with the tokenId. | |
| burnable | No | Whether token holders will be able to destroy their tokens | |
| pausable | No | Whether privileged accounts will be able to pause specifically marked functionality. Useful for emergency response. | |
| mintable | No | Whether privileged accounts will be able to create more supply or emit more tokens | |
| updatableUri | No | Whether privileged accounts will be able to set a new URI for all token types. | |
| royaltyInfo | No | Provides information for how much royalty is owed and to whom, based on a sale price. Follows ERC-2981 standard. | |
| access | No | The type of access control to provision. Ownable is a simple mechanism with a single account authorized for all privileged actions. Roles is a flexible mechanism with a separate role for each privileged action. A role can have many authorized accounts. | |
| upgradeable | No | Whether the smart contract is upgradeable. | |
| info | No | Metadata about the contract and author |
Implementation Reference
- packages/mcp/src/cairo/tools/erc1155.ts:8-36 (registration)Function that registers the 'cairo-erc1155' tool on the MCP server, specifying name, prompt, schema, and handler.export function registerCairoERC1155(server: McpServer): RegisteredTool { return server.tool( 'cairo-erc1155', makeDetailedPrompt(cairoPrompts.ERC1155), erc1155Schema, async ({ name, baseUri, burnable, pausable, mintable, updatableUri, royaltyInfo, access, upgradeable, info }) => { const opts: ERC1155Options = { name, baseUri, burnable, pausable, mintable, updatableUri, royaltyInfo, access, upgradeable, info, }; return { content: [ { type: 'text', text: safePrintCairoCodeBlock(() => erc1155.print(opts)), }, ], }; }, ); }
- Handler function that constructs ERC1155Options from input params and generates Cairo code using erc1155.print from OpenZeppelin wizard-cairo.async ({ name, baseUri, burnable, pausable, mintable, updatableUri, royaltyInfo, access, upgradeable, info }) => { const opts: ERC1155Options = { name, baseUri, burnable, pausable, mintable, updatableUri, royaltyInfo, access, upgradeable, info, }; return { content: [ { type: 'text', text: safePrintCairoCodeBlock(() => erc1155.print(opts)), }, ], }; },
- Zod schema defining the input parameters for the cairo-erc1155 tool, including name, baseUri, flags for features like burnable, pausable, etc.export const erc1155Schema = { name: z.string().describe(commonDescriptions.name), baseUri: z.string().describe(cairoERC1155Descriptions.baseUri), burnable: z.boolean().optional().describe(commonDescriptions.burnable), pausable: z.boolean().optional().describe(commonDescriptions.pausable), mintable: z.boolean().optional().describe(commonDescriptions.mintable), updatableUri: z.boolean().optional().describe(cairoERC1155Descriptions.updatableUri), royaltyInfo: z .object({ enabled: z.boolean().describe(cairoRoyaltyInfoDescriptions.enabled), defaultRoyaltyFraction: z.string().describe(cairoRoyaltyInfoDescriptions.defaultRoyaltyFraction), feeDenominator: z.string().describe(cairoRoyaltyInfoDescriptions.feeDenominator), }) .optional() .describe(cairoCommonDescriptions.royaltyInfo), ...commonSchema, } as const satisfies z.ZodRawShape;