framework icon indicating copy to clipboard operation
framework copied to clipboard


npm version Documentation PRs Welcome

Protokit

Welcome to the Protokit repository, a protocol development framework for privacy enabled application chains.

Protokit enables developers to build zero-knowledge, interoperable and privacy preserving application chains with a minimal learning curve.

It is powered by Mina as the settlement and bridging layer and uses o1js, the zkDSL built for Mina and Kimchi, it's proof system.

πŸ“– Documentation

Find the documentation for protokit on our website

⚑ Features

  • πŸ”— Powered by Mina
  • πŸ” Privacy Enabled
  • ♾️ Succinct zkVM
  • πŸ–₯️ Supercharged DevX
  • πŸ”§ Modular and highly customizable

πŸ“œ Other repositories

  • Starter kit: Our starter kit, which serves as a starting point for any new protokit projects.
  • Private Airdrop Workshop: Sources for the workshop we held, that showcases protokit and its features.

▢️ Quickstart

The fastest way to start building with Protokit is to use the starter kit. The starter kit provides a monorepo aimed at kickstarting application chain development using the Protokit framework.

Install dependencies

Before you can start building with Protokit, you need to install the following dependencies:

Clone the starter kit

# Clone the starter kit
git clone https://github.com/proto-kit/starter-kit my-chain
cd my-chain

# Ensure you're on the right nodejs version and install dependnecies
nvm use
pnpm install

Run the tests

# run and watch tests for the `chain` package
pnpm run test --filter=chain -- --watchAll

Visit the starter kit for more.

πŸ“š License

This project is under the Apache License 2.0.

See LICENSE for more information.