Please note that zkApp programmability is not yet available on Mina Mainnet, but zkApps can now be deployed to Berkeley Testnet.
Overview
What are zkApps?
zkApps (zero knowledge apps) are Mina Protocol smart contracts powered by zero knowledge proofs, specifically using zk-SNARKs.
zkApps use an off-chain execution and mostly off-chain state model. This allows for private computation and state that can be either private or public.
zkApps can perform arbitrarily-complex computations off chain while incurring only a flat fee to send the resulting zero-knowledge proof to the chain for verification of this computation, as opposed to other blockchains that run computations on chain and use a variable gas-fee based model.
Learn more on How zkApps Work.
TypeScript
zkApps are written in TypeScript.
TypeScript provides an easy, familiar language (JavaScript), but with type safety, making it easy to get started writing zkApps. If you're new to using TypeScript, check out this helpful 12-min introductory video TypeScript - The Basics.
To learn more, see How to Write a zkApp.
Quickstart
To get started, deploy a zkApp in 5 steps:
npm install -g zkapp-cli
to install the zkAPP CLI and make thezk
command available on your systemzk project <name>
cd <name>
zk config
Follow the command prompts to your configure your project's
config.json
file.
name:
berkeley
(name can be anything)Mina GraphQL API URL:
https://proxy.berkeley.minaexplorer.com/graphql
transaction fee:
0.1
Follow the prompts to request Testnet Mina (tMina) to fund your fee payer account. Click the URL in your terminal to request tMINA on your address. Wait ~3 minutes for the next block so you have enough tMINA to send your deploy transaction.
zk deploy berkeley
The project you just created contains an example smart contract named
Add.ts
that stores a number as on-chain state and adds2
to it whenever a transaction is received by the zkApp account.
You just deployed a zkApp!
Next, go further with Tutorial 1: Hello World.
Examples of zkApps
Play around with a few example zkApps to see what's possible:
Learn more
To learn more about developing zkApps, see how zkApps work, how to write a zkApp and zkApps for Ethereum Developers.
Try the zkApps tutorials to learn by doing!
Get help and join the community
Join the #zkapps-developers channel on Mina Protocol Discord. Participate and ask questions in zkApps Developers Office Hours.