https://github.com/openzeppelin/contracts-wizard

Interactive smart contract generator based on OpenZeppelin Contracts.
https://github.com/openzeppelin/contracts-wizard

Last synced: 2 months ago
JSON representation

Interactive smart contract generator based on OpenZeppelin Contracts.

• Host: GitHub
• URL: https://github.com/openzeppelin/contracts-wizard
• Owner: OpenZeppelin
• License: agpl-3.0
• Created: 2021-02-09T23:46:23.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2025-11-28T19:09:10.000Z (5 months ago)
• Last Synced: 2025-11-29T13:25:59.588Z (5 months ago)
• Language: TypeScript
• Homepage: https://wizard.openzeppelin.com
• Size: 8.34 MB
• Stars: 289
• Watchers: 14
• Forks: 183
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: FUNDING.json
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Notice: NOTICE

Awesome Lists containing this project

README

          
# [OpenZeppelin Contracts Wizard](https://wizard.openzeppelin.com)

[![Solidity NPM Package](https://img.shields.io/npm/v/@openzeppelin/wizard?color=%234e5de4&label=%40openzeppelin%2Fwizard)](https://www.npmjs.com/package/@openzeppelin/wizard)

[![Cairo NPM Package](https://img.shields.io/npm/v/@openzeppelin/wizard-cairo?color=%23e55233&label=%40openzeppelin%2Fwizard-cairo)](https://www.npmjs.com/package/@openzeppelin/wizard-cairo)

[![Stellar NPM Package](https://img.shields.io/npm/v/@openzeppelin/wizard-stellar?color=%23e55233&label=%40openzeppelin%2Fwizard-stellar)](https://www.npmjs.com/package/@openzeppelin/wizard-stellar)

[![Stylus NPM Package](https://img.shields.io/npm/v/@openzeppelin/wizard-stylus?color=%23e55233&label=%40openzeppelin%2Fwizard-stylus)](https://www.npmjs.com/package/@openzeppelin/wizard-stylus)

[![Uniswap Hooks NPM Package](https://img.shields.io/npm/v/@openzeppelin/wizard-uniswap-hooks?color=%23e55233&label=%40openzeppelin%2Fwizard-uniswap-hooks)](https://www.npmjs.com/package/@openzeppelin/wizard-uniswap-hooks)

[![Contracts MCP NPM Package](https://img.shields.io/npm/v/@openzeppelin/contracts-mcp?label=%40openzeppelin%2Fcontracts-mcp)](https://www.npmjs.com/package/@openzeppelin/contracts-mcp)

[![Netlify Status](https://api.netlify.com/api/v1/badges/ca9b53e1-44eb-410d-aac7-31b2f5399b68/deploy-status)](https://app.netlify.com/sites/openzeppelin-contracts-wizard/deploys)

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.

[![](./screenshot.png)](https://wizard.openzeppelin.com)

## Usage

Use the Contracts Wizard at https://wizard.openzeppelin.com

## MCP Servers

MCP Servers allow AI agents to generate smart contracts with the same options as the Contracts Wizard.

For local installation, see the [Contracts MCP Server](packages/mcp/README.md) package.  

For a hosted version, see [OpenZeppelin MCP Servers](https://mcp.openzeppelin.com).

## TypeScript API

You can use the programmatic TypeScript API to generate contracts from your own applications.

View the API documentation for each smart contract language:

- [Solidity](packages/core/solidity/README.md)

- [Cairo](packages/core/cairo/README.md)

- [Stellar](packages/core/stellar/README.md)

- [Stylus](packages/core/stylus/README.md)

## Embedding

To embed Contracts Wizard on your site, first include the script tag:

```html

```

Then place `` in the body where you want Contracts Wizard to load.

Optionally focus on specific tab with the `data-tab` attribute as in ``.

For languages other than Solidity, use the `data-lang` attribute, for example: ``.

## Contributing

We welcome contributions from the community! Here's how you can get involved:

1. Fork the repository

2. Create your feature branch

3. Commit your changes

4. Push to the branch

5. Create a Pull Request

If you are looking for a good place to start, find a good first issue [here](https://github.com/openzeppelin/contracts-wizard/issues?q=is%3Aissue%20is%3Aopen%20label%3A%22good%20first%20issue%22), or [open an issue](https://github.com/OpenZeppelin/contracts-wizard/issues/new) for a bug report or feature request.

You can find more details in our [Contributing](CONTRIBUTING.md) guide.

## License

This project is licensed under the GNU Affero General Public License v3.0 - see the [LICENSE](LICENSE) file for details.