solidity-rwa
Generate ERC-20 token contracts for real-world assets with configurable features like minting, pausing, voting, and cross-chain bridging. Returns source code in Markdown format.
Instructions
Make a real-world asset token that uses the ERC-20 standard. Experimental, some features are not audited and are subject to change.
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. | |
| info | No | Metadata about the contract and author | |
| restrictions | No | Whether to restrict certain users from transferring tokens, either via allowing or blocking them. This feature is experimental, not audited and is subject to change. | |
| freezable | No | Whether authorized accounts can freeze and unfreeze accounts for regulatory or security purposes. This feature is experimental, not audited and is subject to change. |
Implementation Reference
- Handler function that receives tool parameters, constructs StablecoinOptions, and returns Solidity code generated by OpenZeppelin's realWorldAsset.print() using safePrintSolidityCodeBlock.
async ({ name, symbol, burnable, pausable, premint, premintChainId, mintable, callback, permit, votes, flashmint, crossChainBridging, access, info, restrictions, freezable, }) => { const opts: StablecoinOptions = { name, symbol, burnable, pausable, premint, premintChainId, mintable, callback, permit, votes, flashmint, crossChainBridging, access, info, restrictions, freezable, }; return { content: [ { type: 'text', text: safePrintSolidityCodeBlock(() => realWorldAsset.print(opts)), }, ], }; }, - Zod schema definitions for stablecoin/RWA options. rwaSchema is exported as an alias to stablecoinSchema, which extends erc20Schema with restrictions and freezable options.
export const stablecoinSchema = { ...erc20SchemaOmitUpgradeable, restrictions: z .literal(false) .or(z.literal('allowlist')) .or(z.literal('blocklist')) .optional() .describe(solidityStablecoinDescriptions.restrictions), freezable: z.boolean().optional().describe(solidityStablecoinDescriptions.freezable), } as const satisfies z.ZodRawShape; export const rwaSchema = stablecoinSchema; - packages/mcp/src/solidity/tools/rwa.ts:8-59 (registration)Registers the 'solidity-rwa' MCP tool on the server, providing name, detailed prompt from solidityPrompts.RWA, rwaSchema for validation, and the handler function.
export function registerSolidityRWA(server: McpServer) { return server.tool( 'solidity-rwa', makeDetailedPrompt(solidityPrompts.RWA), rwaSchema, async ({ name, symbol, burnable, pausable, premint, premintChainId, mintable, callback, permit, votes, flashmint, crossChainBridging, access, info, restrictions, freezable, }) => { const opts: StablecoinOptions = { name, symbol, burnable, pausable, premint, premintChainId, mintable, callback, permit, votes, flashmint, crossChainBridging, access, info, restrictions, freezable, }; return { content: [ { type: 'text', text: safePrintSolidityCodeBlock(() => realWorldAsset.print(opts)), }, ], }; }, ); }