solidity-erc20
Generate ERC-20 token contract source code with customizable features like burnable, mintable, pausable, voting, and upgradeability options.
Instructions
Make a fungible token per the ERC-20 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 | |
| symbol | Yes | The short symbol for the token | |
| 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. | |
| premint | No | The number of tokens to premint for the deployer. | |
| premintChainId | No | The chain ID of the network on which to premint tokens. | |
| mintable | No | Whether privileged accounts will be able to create more supply or emit more tokens | |
| callback | No | Whether to include support for code execution after transfers and approvals on recipient contracts in a single transaction. | |
| permit | No | Whether without paying gas, token holders will be able to allow third parties to transfer from their account. | |
| votes | No | Whether to keep track of historical balances for voting in on-chain governance. Voting durations can be expressed as block numbers or timestamps. | |
| flashmint | No | Whether to include built-in flash loans to allow lending tokens without requiring collateral as long as they're returned in the same transaction. | |
| crossChainBridging | No | Whether to allow authorized bridge contracts to mint and burn tokens for cross-chain transfers. Options are to use custom bridges on any chain, or the SuperchainERC20 standard with the predeployed SuperchainTokenBridge. The SuperchainERC20 feature is only available on chains in the Superchain, and requires deploying your contract to the same address on every chain in the Superchain. | |
| namespacePrefix | No | The prefix for ERC-7201 namespace identifiers. It should be derived from the project name or a unique naming convention specific to the project. Used only if the contract includes storage variables and upgradeability is enabled. Default is "myProject". | |
| 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. Managed enables a central contract to define a policy that allows certain callers to access certain functions. | |
| upgradeable | No | Whether the smart contract is upgradeable. Transparent uses more complex proxy with higher overhead, requires less changes in your contract. Can also be used with beacons. UUPS uses simpler proxy with less overhead, requires including extra code in your contract. Allows flexibility for authorizing upgrades. | |
| info | No | Metadata about the contract and author |
Implementation Reference
- Handler function that constructs ERC20Options and generates Solidity contract code using OpenZeppelin Wizard's erc20.print().
async ({ name, symbol, burnable, pausable, premint, premintChainId, mintable, callback, permit, votes, flashmint, crossChainBridging, access, upgradeable, info, }) => { const opts: ERC20Options = { name, symbol, burnable, pausable, premint, premintChainId, mintable, callback, permit, votes, flashmint, crossChainBridging, access, upgradeable, info, }; return { content: [ { type: 'text', text: safePrintSolidityCodeBlock(() => erc20.print(opts)), }, ], }; }, - Zod schema defining the input parameters for the solidity-erc20 tool, including options like name, symbol, burnable, etc.
export const erc20Schema = { name: z.string().describe(commonDescriptions.name), symbol: z.string().describe(commonDescriptions.symbol), burnable: z.boolean().optional().describe(commonDescriptions.burnable), pausable: z.boolean().optional().describe(commonDescriptions.pausable), premint: z.string().optional().describe(solidityERC20Descriptions.premint), premintChainId: z.string().optional().describe(solidityERC20Descriptions.premintChainId), mintable: z.boolean().optional().describe(commonDescriptions.mintable), callback: z.boolean().optional().describe(solidityERC20Descriptions.callback), permit: z.boolean().optional().describe(solidityERC20Descriptions.permit), votes: z.literal('blocknumber').or(z.literal('timestamp')).optional().describe(solidityERC20Descriptions.votes), flashmint: z.boolean().optional().describe(solidityERC20Descriptions.flashmint), crossChainBridging: z .literal('custom') .or(z.literal('superchain')) .optional() .describe(solidityERC20Descriptions.crossChainBridging), namespacePrefix: z.string().optional().describe(solidityCommonDescriptions.namespacePrefix), ...commonSchema, } as const satisfies z.ZodRawShape; - packages/mcp/src/solidity/tools/erc20.ts:8-57 (registration)Function that registers the 'solidity-erc20' tool with the MCP server, including name, prompt, schema, and handler.
export function registerSolidityERC20(server: McpServer): RegisteredTool { return server.tool( 'solidity-erc20', makeDetailedPrompt(solidityPrompts.ERC20), erc20Schema, async ({ name, symbol, burnable, pausable, premint, premintChainId, mintable, callback, permit, votes, flashmint, crossChainBridging, access, upgradeable, info, }) => { const opts: ERC20Options = { name, symbol, burnable, pausable, premint, premintChainId, mintable, callback, permit, votes, flashmint, crossChainBridging, access, upgradeable, info, }; return { content: [ { type: 'text', text: safePrintSolidityCodeBlock(() => erc20.print(opts)), }, ], }; }, ); }