Contracts Wizard README
The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the Contracts Wizard listing page.
OpenZeppelin Contracts Wizard
Contracts Wizard is a web application to interactively build a contract out of components from OpenZeppelin Contracts. Select the kind of contract that you want, set your parameters and desired features, and the Wizard will generate all of the code necessary. The resulting code is ready to be compiled and deployed, or it can serve as a starting point and customized further with application specific logic.
Usage
Use the Contracts Wizard at https://wizard.openzeppelin.com
CLI
Generate contracts from the command line. See the CLI package.
MCP Servers
Allow AI agents to generate contracts. See the MCP package for local installation, or OpenZeppelin MCP Servers for a hosted version.
TypeScript API
Generate contracts programmatically from your own applications.
View the API documentation for each smart contract language:
Embedding
To embed Contracts Wizard on your site, first include the script tag:
Then place <oz-wizard></oz-wizard> in the body where you want Contracts Wizard to load.
Optionally focus on specific tab with the data-tab attribute as in <oz-wizard data-tab="ERC721"></oz-wizard>.
For languages other than Solidity, use the data-lang attribute, for example: <oz-wizard data-lang="cairo"></oz-wizard>.
Contributing
We welcome contributions from the community! Here's how you can get involved:
- Fork the repository
- Create your feature branch
- Commit your changes
- Push to the branch
- Create a Pull Request
If you are looking for a good place to start, find a good first issue here, or open an issue for a bug report or feature request.
You can find more details in our Contributing guide.
License
This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE file for details.