Skip to content

Latest commit

 

History

History
91 lines (54 loc) · 4.04 KB

README.md

File metadata and controls

91 lines (54 loc) · 4.04 KB
Raw

ZK Multiverse: Embark on a Cryptographic Adventure

image

Welcome to ZK Multiverse, where learning cryptography becomes an exciting journey through a universe filled with challenges, puzzles, and practical applications. This web game is designed to help developers master the art of building zk circuits using Circom or Noir while understanding the underlying cryptography and mathematical principles.

Why ZK Multiverse?

Cryptography can be daunting, especially when most of the available resources focus on theoretical concepts with little emphasis on hands-on practice. ZK Multiverse aims to change that by providing an engaging and interactive learning environment.

The Problem We Are Solving:

  1. Too Much Theory, Not Enough Practice: Cryptography is often surrounded by complex theories with few practical examples. ZK Multiverse bridges this gap by offering practical, real-world scenarios where you can apply what you’ve learned.

  2. Information Overload: With so many cryptographic concepts and resources available, it’s easy for developers to get sidetracked or overwhelmed. ZK Multiverse guides you through a curated learning path, ensuring you stay focused and gain the essential skills needed to excel in zero-knowledge proof development.

What You’ll Learn

  • Zero-Knowledge Circuits: Gain practical experience in building zk circuits using Circom or Noir.
  • Cryptography Fundamentals: Understand the basics of cryptography, including essential concepts like encryption, decryption, hashing, and more.
  • Mathematical Foundations: Dive into the mathematical principles that underpin cryptographic techniques, with hands-on exercises to solidify your knowledge.

How It Works

  1. Interactive Challenges: Complete various challenges that simulate real-world cryptographic problems. Each challenge is designed to help you apply your knowledge in a practical context.

  2. Guided Learning Path: Follow a structured path that gradually increases in difficulty, ensuring you build your skills step-by-step without feeling overwhelmed.

  3. Fun and Engaging: ZK Multiverse transforms learning into an adventure, making the process enjoyable and memorable.

Getting Started

To get started with ZK Multiverse, follow the steps below:

  1. Clone the Repository: Begin your journey by cloning this repository to your local machine.

    git clone https://github.com/yourusername/zk-multiverse.git
cd zk-multiverse```

  2. Install Dependencies: Install the required dependencies to run the game.

    yarn install

  3. Run a Local Network: Start a local Ethereum network using Hardhat in the first terminal.

    yarn chain

  4. Deploy the Test Contract: Deploy a test smart contract to the local network in a second terminal.

    yarn deploy

  5. Start Your NextJS App: Launch the NextJS app in a third terminal.

    yarn start

    Visit your app on: `http://localhost:3000\`. You can interact with your smart contract using the `Debug Contracts` page.

  6. Run Smart Contract Tests: Test your smart contracts using Hardhat.

 yarn hardhat:test

Contributing

We welcome contributions! Whether you’re adding new challenges, improving the existing codebase, or suggesting new features, your input is valuable.

  1. Fork the Repository: Create a fork of the repository on GitHub.

  2. Create a Feature Branch: Work on your feature in a new branch.

   git checkout -b feature-name
  1. Submit a Pull Request: Once your feature is complete, submit a pull request for review.

Pitch for the PSE Core Program 2024 - Costa Rica 🇨🇷

Video Slides