PackagesContracts WizardIntroduction

Midnight Contracts Wizard

A CLI tool to create new Midnight contracts projects with selected smart contracts.

Overview

The Midnight Contracts Wizard is an interactive command-line tool that helps you quickly scaffold new Midnight smart contract projects. With a simple interactive interface, you can select from multiple pre-built contract templates and generate a complete project structure ready for development.

What’s Included

  • Interactive CLI - Select which contracts to include through an easy-to-use interface
  • Multiple Contract Types - Choose from Tokenization, Staking, Identity, Oracle, and Lending & Borrowing contracts
  • Complete Setup - Automatically generates package.json, tsconfig, and build scripts
  • Ready to Use - All necessary files for compilation and build included
  • Self-Contained - All contract templates included, no external dependencies required

Quick Installation

  • npm:
npm install @meshsdk/midnight-contracts-wizard
  • yarn:
yarn add @meshsdk/midnight-contracts-wizard

Getting Started

  1. Installation - Install the CLI tool
  2. Usage - Learn how to use the interactive wizard
  3. Available Contracts - Explore the contract templates
  4. Project Structure - Understanding generated projects

Key Features

  • Zero-knowledge contracts - Pre-built ZK circuit implementations
  • Privacy-focused - All contracts designed with privacy in mind
  • Production-ready - Battle-tested contract templates
  • TypeScript support - Full type safety and IntelliSense
  • Quick setup - Get started in minutes

Start building your Midnight smart contracts today! Explore the sections below to get started.