forked from o1-labs/docs2
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request o1-labs#989 from o1-labs/feat/o1js-vs-protokit
zkApps development frameworks.
- Loading branch information
Showing
3 changed files
with
86 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
--- | ||
title: zkApps Development Frameworks | ||
sidebar_label: zkApps Development Frameworks | ||
hide_title: true | ||
description: zkApps (zero knowledge apps) are Mina Protocol smart contracts powered by zero knowledge proofs, specifically using zk-SNARKs. | ||
keywords: | ||
- zkapps | ||
- mina protocol | ||
- smart contracts | ||
- zero knowledge proofs | ||
- off-chain execution | ||
- typescript | ||
- quickstart zkapps | ||
- o1js | ||
- protokit | ||
--- | ||
|
||
# zkApps Development Frameworks | ||
|
||
Developers building `zkApps` in the `Mina ecosystem` can leverage a variety of specialized frameworks, each tailored to optimize different types of solutions. | ||
This documentation selection ensures that you can select the most suitable framework to meet the unique demands of your project. | ||
Explore the options below to find the perfect fit for your development needs. | ||
|
||
If you are unsure about any of the information presented here and need guidance on choosing the most suitable framework for you, drop by [Discord](https://discord.gg/minaprotocol) and let us help! | ||
|
||
## [o1js](/zkapps/o1js) | ||
|
||
`o1js` is the framework used for building `zkApps` on the `Mina L1` and new infrastructure such as `rollups`. | ||
o1js is Typescript based for ease of use, comes with a host of built-in features, is extensible to suit various use cases, and takes full advantage of the unique aspects of the Mina protocol. | ||
|
||
o1js is also the `zkDSL` used for: | ||
|
||
- Writing general-purpose `zk circuits`. | ||
- Constructing `new primitives` and `data structures`. | ||
|
||
There are some key considerations when choosing to build a zkApp with o1js on Mina L1: | ||
|
||
- zkApps are subject to protocol throughput limitations. | ||
- At present, zkApps that require support for multiple concurrent users require specific architecture to avoid race conditions: | ||
- Where more than the eight on-chain field elements are required to manage state, and access to that state is not shared, the experimental `Off-chain Storage API` will suffice. | ||
- Where `concurrent` access to `shared state` is required, this architecture is available "**out of the box**", when using the `Protokit` framework to build your zkApp as an zkApp-chain (L2). | ||
|
||
Start here: | ||
|
||
- [Developer documentation](/zkapps/o1js) | ||
- [o1js repository](https://github.com/o1-labs/o1js) | ||
- [Discord](https://discord.gg/minaprotocol) | ||
|
||
## [Protokit](https://protokit.dev/) | ||
|
||
`Protokit` is a powerful framework designed to build `ZK appchains` and smart contracts that are user-facing, privacy-preserving, interoperable. | ||
It offers a familiar developer experience similar to `Solidity dApps`, making it easier and intuitive for developers to leverage ZK in their blockchain solutions. | ||
|
||
It provides a full set of tools necessary for: | ||
|
||
- zkApps that require `high throughput` or multiple `concurrent` users. | ||
- zkApps that require `shared` or `global` state access. | ||
- Developers familiar with execution environments such as `EVM`. | ||
- Developers who wish to leverage the `modular architecture` of Protokit. | ||
|
||
Start here: | ||
|
||
- [Developer documentation](https://github.com/proto-kit) | ||
- [Protokit repository](https://github.com/proto-kit) | ||
- [Starter Kit](https://github.com/proto-kit/starter-kit) | ||
- [Discord](https://discord.gg/AMGnGAxsKp) | ||
|
||
## Framework comparison | ||
|
||
|| o1js SmartContract | Protokit | | ||
|--|--|--| | ||
|**Production readiness**|v1.0 released, internal audit complete, 3rd party audit in progress.|Not production ready - work in progress. Unaudited. Testnet deployments available.| | ||
|**Censorship resistance**|Decentralized and censorship resistant.|Censorship resistance via hybrid sequencing model.| | ||
|**Support for multi-user apps**|Many multi-user use cases require sophisticated architecture and are limited by L1 throughput.|Capable of handling higher throughput and multiple concurrent users, thanks to Protokit's modular sequencer.| | ||
|**Execution environment**|Proving off-chain, verification on-chain, transaction ordering possible on-chain.|Hybrid execution model, both on-chain (sequencer) and off-chain thanks to recursive zk-proofs, verification on-chain (MINA L1).| | ||
|**DX**|New programming model, distinct from traditional web3.0 development.|Module oriented app-chain development, similiar to Substrate Pallets, Cosmos SDK Modules or EVM smart contracts.| | ||
|**Composability**|Fully composable. Contracts can call other contracts directly within a single transaction.|Protokit supports bi-directional L2 ↔ L1 messaging out of the box.| |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters