OpenZeppelin Contracts Wizard is an interactive web application and TypeScript API for generating smart contracts using components from the OpenZeppelin Contracts library. It targets developers seeking to quickly scaffold secure, customizable smart contracts for various blockchains, simplifying the creation process by offering a guided, parameter-driven approach.

How It Works

The Wizard provides a user-friendly interface to select contract types, configure parameters, and enable desired features. It then generates the necessary Solidity, Cairo, Stellar, or Stylus code, leveraging OpenZeppelin's battle-tested contract components. This approach ensures security best practices are incorporated from the outset and allows for rapid prototyping and customization.

Quick Start & Requirements

• Web Application: Access the interactive generator at https://wizard.openzeppelin.com.
• TypeScript API: Programmatic contract generation is available via a TypeScript API. Documentation for Solidity, Cairo, Stellar, and Stylus APIs can be found within the repository.
• MCP Servers: For AI agent integration, hosted and local MCP Server options are available.

Highlighted Details

• Interactive generation of Solidity, Cairo, Stellar, and Stylus smart contracts.
• Programmatic TypeScript API for custom application integration.
• Embeddable web component for seamless integration into other websites.
• Built upon the widely-used and audited OpenZeppelin Contracts library.

Maintenance & Community

The project is maintained by OpenZeppelin. Contribution guidelines are provided, encouraging community involvement through pull requests and issue reporting.

Licensing & Compatibility

Licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). This is a strong copyleft license, meaning derivative works must also be open-sourced under the same license. Compatibility with closed-source projects may be restricted due to the AGPL-3.0's requirements.

Limitations & Caveats

The AGPL-3.0 license requires that any modifications or derivative works, including those served over a network, must be made available under the same license. This may impact its suitability for proprietary or closed-source commercial applications.