Skip to content

coset-io/plonky3-python-notebook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Plonky3 Python Notebook

The Plonky3 Python Notebook is an educational resource designed to demystify the inner workings of the Plonky3 proof system. By leveraging interactive Python notebooks, this project provides a hands-on approach to understanding the technical principles behind Plonky3, making advanced zero-knowledge (ZK) technology more accessible to developers and enthusiasts.

Overview

Plonky3 is a modular toolkit developed by Polygon for building succinct proof systems, such as PLONK and STARKs. It enables developers to create customized zkVMs and zkEVMs tailored to specific use cases, optimizing for speed, proof size, and other performance metrics.

The Plonky3 Python Notebook aims to:

  • Educate: Provide comprehensive explanations of the core concepts and components of the Plonky3 proof system.

  • Demonstrate: Offer interactive code examples that illustrate how Plonky3 operates under the hood.

  • Empower: Equip developers with the knowledge to implement and utilize Plonky3 in their own projects.

Features

  • Interactive Learning: Utilizes Jupyter Notebooks to combine explanatory text, live code, and visualizations, facilitating an engaging learning experience.

  • Comprehensive Coverage: Covers various aspects of Plonky3, including polynomial commitment schemes, field arithmetic, and proof generation.

Getting Started

To begin exploring the Plonky3 Python Notebook:

  1. Clone the Repository:

    git clone https://github.com/Antalpha-Labs/plonky3-python-notebook.git
  2. Navigate to the Project Directory:

    cd plonky3-python-notebook
  3. Install Dependencies:

    Ensure you have Jupyter Notebook installed. You can install it using pip:

    pip install notebook
  4. Launch Jupyter Notebook:

    jupyter notebook
  5. Open the Notebook:

    In the Jupyter interface, open the plonky3_notebook.ipynb file to start learning.

Prerequisites

A basic understanding of Python programming and familiarity with cryptographic concepts will be beneficial for users of this notebook.

Contributing

Contributions to enhance the educational content, fix issues, or expand the scope of the notebook are welcome. Please fork the repository, create a new branch for your changes, and submit a pull request for review.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgments

This project is supported by zkBankai’s grant program.

For more information on Plonky3 and its applications, refer to the official Polygon Plonky3 repository.

About

A python notebook to explain how Plonky3 underlying works

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published