Update zkapp-development-frameworks.mdx #1072
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,68 +15,214 @@ keywords: | |
| - protokit | ||
| --- | ||
|
|
||
|
|
||
| # zkApp Development Frameworks | ||
|
|
||
| Applications on Mina are called zkApps, and they come in a wide range of forms, including DeFi, games, state bridges, and more. However, due to Mina’s client execution model, the developer experience differs somewhat from that of other blockchain networks, such as Ethereum. | ||
|
|
||
| Developers build zkApps with **o1js**. Developers can either use o1js directly or use o1js with **Protokit**, a framework built on top of o1js. Both options offer the full benefits of Mina’s verifiable, privacy-preserving zero knowledge proofs, but offer different tradeoffs between developer experience, performance, and decentralization. | ||
|
There was a problem hiding this comment.
Do they actually? Natively, afaik Protokit executes business logic on a server/"on-chain" - away from the client - this would render privacy-preserving not true in the default case There was a problem hiding this comment. An example from the protokit docs: @runtimeModule()
export class Balances extends RuntimeModule<Record<string, never>> {
@state() public balances = StateMap.from(PublicKey, UInt64);
@runtimeMethod()
public mint(canMintProof: CanMintProof, amount: UInt64) {
canMintProof.verify();
this.balances.set(address, amount);
}
}Seems like using a proof input would be a valid way of preserving privacy on protokit. There was a problem hiding this comment. That's not the default tho whereas with o1js it is, because everything happens locally on the clients machine There was a problem hiding this comment. There's a difference between opt-in and opt-out so this needs to be highlighted |
||
|
|
||
| <table> | ||
| <tr> | ||
| <td>Info | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td>Please note that **Protokit is in alpha**, and settlement support with reorgs is still in progress. | ||
| <p> | ||
|
|
||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
|
|
||
| This page provides a guide to choosing the best approach for your zkApp development - o1js directly or Protokit on top of o1js. | ||
|
|
||
| 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! | ||
|
|
||
|
|
||
| ## Choosing a framework | ||
|
|
||
| Developers can build zkApps either directly with **o1js**, or with **o1js** + **Protokit**. | ||
|
|
||
| Protokit is built on top of o1js and simplifies the development of **zkApps with concurrent users requiring a shared state**, such as DEXes or games. Protokit is recommended for most developers. | ||
|
There was a problem hiding this comment.
|
||
|
|
||
| O1js is the best way to write **custom zero knowledge circuits** and construct low-level primitives on Mina, such as an NFT standard or a zkML library. | ||
|
|
||
|
|
||
|
|
||
| <table> | ||
| <tr> | ||
| <td>Info | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td>For developers coming from the Ethereum ecosystem, think of zkApps like smart contracts that can be verified off-chain. | ||
|
There was a problem hiding this comment. zkApps aren't verified off-chain, they are proven off-chain and verified on-chain |
||
| <p> | ||
| This enables Mina to employ a client execution model, which gives Mina its scalability and privacy properties, but it can make it difficult to develop applications with concurrent users requiring a shared state. Protokit builds on top of o1js to solve these concurrency challenges. | ||
|
|
||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
|
|
||
|
|
||
| ## Protokit[](https://docs.minaprotocol.com/zkapps/zkapp-development-frameworks#protokit) | ||
|
|
||
|
|
||
| Protokit is designed for **zkApps with concurrent users requiring a shared state**, for example DEXes and most games. In addition to this Protokit provides an integrated verifiable data storage solution that further simplifies the developer experience compared to o1js. | ||
|
|
||
| Protokit can operate in two modes: Based Sequencing and Hybrid Sequencing. | ||
|
|
||
| In **Based Sequencing mode**, Protokit sends all transactions to the Mina L1, providing the decentralization guarantees of the L1, but limited to the L1’s throughput and latency. Based Sequencing mode is best for zkApps where censorship resistance and liveness are more important than the additional performance benefits. | ||
|
|
||
| In **Hybrid Sequencing mode**, Protokit runs an off-chain sequencer with off-chain data availability, providing higher throughput and lower latency than the Mina L1 but at the expense of decentralization. Hybrid Sequencing mode is best for zkApps where performance is critical. | ||
|
|
||
| **Important:** Users of a zkApp in Hybrid Sequencing mode can always **submit transactions directly to the L1**, for example, to withdraw funds (in case the zkApp sequencer is unavailable) but it does rely on the Protokit’s data availability (DA). Solutions are in the works for DA guarantees even in Hybrid Sequencing mode so that developers can get higher throughput and latency while retaining censorship resistance and liveness guarantees. | ||
|
|
||
| Start developing zkApps with Protokit here: | ||
|
|
||
|
|
||
|
|
||
| * [Developer documentation](https://protokit.dev/docs/what-is-protokit) | ||
| * [Protokit repository](https://github.com/proto-kit) | ||
| * [Starter Kit](https://github.com/proto-kit/starter-kit) | ||
|
|
||
|
|
||
| ## o1js[](https://docs.minaprotocol.com/zkapps/zkapp-development-frameworks#o1js) | ||
|
|
||
| [o1js](https://docs.minaprotocol.com/zkapps/o1js) is the best way to author **highly-optimized ZK circuits and primitives**, but it does not provide an easy-to-use solution for managing a shared global state. | ||
|
There was a problem hiding this comment.
There was a problem hiding this comment. o1js is also the only way to interfact directly with the protocol, its "not just" a tool for primitives There was a problem hiding this comment. I don't think we should highlight offchain state as a serious way to handle app state until it's out of the experimental namespace. I don't think we should make casual references to things in the docs until we're ready to stand behind them 100%. |
||
|
|
||
| o1js can be used directly on the Mina L1, and is thus limited by the L1’s throughput and latency, but maintains strong decentralization guarantees. | ||
|
There was a problem hiding this comment. I don't think this is a good way to phrase this. o1js is a tool that lets you build whatever on top of Mina, you can build your own app-specific rollups that would not be limited by the L1s throughput. |
||
|
|
||
|
|
||
| <table> | ||
| <tr> | ||
| <td>Info | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Did you know?</strong> zkApps written directly with o1js can orchestrate concurrent users requiring shared state using Mina L1’s <a href="https://docs.minaprotocol.com/zkapps/writing-a-zkapp/feature-overview/actions-and-reducer">Actions & Reducer</a>, but it requires significant development to orchestrate Action & Reducers. At its core, Protokit is a framework for orchestrating the Mina L1 Actions & Reducers out of the box. | ||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
|
|
||
| Start developing zkApps with o1js here: | ||
|
|
||
|
|
||
|
|
||
| * [Developer documentation](https://docs.minaprotocol.com/zkapps/o1js) | ||
| * [o1js repository](https://github.com/o1-labs/o1js) | ||
| * [Discord](https://discord.gg/minaprotocol) | ||
|
|
||
|
|
||
| ## Choosing between Protokit and o1js | ||
|
|
||
| **Still can’t decide between Protokit and o1js?** | ||
|
|
||
| This section provides a simple decision tree x`and comparison table to help zkApp developers choose which framework to use. | ||
|
|
||
|
|
||
|  | ||
|
|
||
| Are you developing a zkApp with concurrent users requiring a shared state? | ||
|
There was a problem hiding this comment. I am not a fan of this decision tree. It ignores many details and will, imo in most cases, point developers to the wrong tools. We should educate devs on the benefits of both options, instead of assuming their use cases will just fit into one of two buckets |
||
| 1. Yes - Protokit | ||
| 1. Are you willing to trade off L1 censorship resistance and liveness guarantees for high throughput and low latency?* | ||
| 1. Yes - Hybrid mode | ||
| 2. No - Based mode | ||
| 2. No - o1js | ||
|
There was a problem hiding this comment. Existence of |
||
| *Solutions are in the works for DA guarantees even in Hybrid Sequencing mode so that developers can get higher throughput and latency while retaining censorship resistance and liveness guarantees. | ||
|
|
||
|
|
||
|
|
||
| <table> | ||
| <tr> | ||
| <td> | ||
| </td> | ||
| <td><strong>Protokit Hybrid</strong> | ||
| </td> | ||
| <td><strong>Protokit Based</strong> | ||
| </td> | ||
| <td><strong>o1js</strong> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Concurrency</strong> | ||
| </td> | ||
| <td>✅ | ||
| </td> | ||
| <td>✅ | ||
| </td> | ||
| <td>🟡 | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Shared State</strong> | ||
| </td> | ||
| <td>✅ | ||
| </td> | ||
| <td>✅ | ||
| </td> | ||
| <td>🟡 | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Throughput</strong> | ||
| </td> | ||
| <td>✅ | ||
| </td> | ||
| <td>🟡 | ||
| </td> | ||
| <td>🟡 | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Latency</strong> | ||
| </td> | ||
| <td>✅ | ||
| </td> | ||
| <td>🟡 | ||
| </td> | ||
| <td>🟡 | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Censorship Resistance</strong> | ||
| </td> | ||
| <td>🟡 | ||
| </td> | ||
| <td>✅ | ||
| </td> | ||
| <td>✅ | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Liveness</strong> | ||
| </td> | ||
| <td>🟡 | ||
| </td> | ||
| <td>✅ | ||
| </td> | ||
| <td>✅ | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Security</strong> | ||
| </td> | ||
| <td>✅ | ||
| </td> | ||
| <td>✅ | ||
| </td> | ||
| <td>✅ | ||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
|
|
||
| **Understanding the performance vs. centralization tradeoff** | ||
|
|
||
| Protokit includes an off-chain sequencer and off-chain storage. If one or the other becomes inaccessible, users may find they can no longer access the zkApp including any tokens they may have in the zkApp. | ||
|
|
||
| If the Protokit instance’s sequencer is unavailable but the storage is still accessible, users may submit transactions (e.g. withdrawals) directly to the Mina L1. | ||
|
|
||
| If the Protokit instance’s storage is inaccessible, users will not be able to submit transactions to the Mina L1 and their tokens may be locked until the storage can be recovered. | ||
|
|
||
| Solutions are in the works for DA guarantees even in Hybrid Sequencing mode so that developers can get higher throughput and latency while retaining censorship resistance and liveness guarantees. | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: "client side execution model"