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: mit
• Created: 2021-02-09T23:46:23.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-23T14:19:57.000Z (3 months ago)
• Last Synced: 2024-10-23T15:48:38.955Z (3 months ago)
• Language: TypeScript
• Homepage: https://wizard.openzeppelin.com
• Size: 3.66 MB
• Stars: 247
• Watchers: 16
• Forks: 136
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• best-of-crypto - GitHub - 29% open · ⏱️ 22.05.2024): (Smart Contract Platforms)

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)

[![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/)

## Development

Install dependencies with `yarn install`.

`packages/core` contains the code generation logic for Solidity.

`packages/core-cairo` contains the code generation logic for Cairo.

`packages/ui` is the interface built in Svelte. `yarn dev` spins up a local server to develop the UI.

You'll need to supply your own environment variables if you want to enable Wizard AI Assistant (OPENAI_API_KEY) and/or logging (REDIS_URL, REDIS_TOKEN).

## 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 Cairo, use the `data-lang` attribute: ``.

## API

The following describes how to use the Contracts Wizard programmatic API in your own applications.

- [Contracts Wizard API for Solidity](packages/core/README.md)

- [Contracts Wizard API for Cairo](packages/core-cairo/README.md)