-### Mina zkApp CLI
+To stay up to date with zkApps and o1js, follow the [What's New in o1js](https://blog.o1labs.org/search?q=o1js) monthly updates.
-- [Scaffold projects and files](/zkapps/how-to-write-a-zkapp)
-- [Example projects](/zkapps/how-to-write-a-zkapp#option-a-start-with-an-example-recommended)
-- [Deployment](/zkapps/how-to-deploy-a-zkapp)
-- [Create a project with an accompanying UI](/zkapps/how-to-write-a-zkapp-ui) — SvelteKit, NextJS, or NuxtJS
+Check out the [o1js roadmap](https://o1labs.notion.site/o1js-Roadmap-858b056c4efe4e7a8c42371d9e54848b?pvs=4).
-To install the Mina zkApp CLI:
-```sh
-npm install -g zkapp-cli
-```
-
-To view all of the commands and start building, run `zk --help`.
-
-### o1js
-
-- [Built-in data types](/zkapps/how-to-write-a-zkapp#built-in-data-types) — Field, Bool, UInt32, UInt64, PublicKey, PrivateKey, Signature, Group, Scalar, and CircuitString
-- [Custom data types](/zkapps/how-to-write-a-zkapp#custom-data-types) — a.k.a. Struct
-- [Composability](/zkapps/how-to-write-a-zkapp#composing-zkapps)
-- [Recursion](/zkapps/o1js/recursion) — a.k.a. ZkProgram
-- [Events](/zkapps/o1js/events) — writing events and [reading them from an archive node](/zkapps/o1js/fetch-events-and-actions)
-- [Actions & reducer](/zkapps/o1js/actions-and-reducer)
-- [Encryption & decryption](/zkapps/o1js-reference/modules/Encryption) — using Mina’s curves
-- [Merkle tree](/zkapps/o1js/merkle-tree)
-- [Custom tokens](/zkapps/o1js/custom-tokens)
-- [Using on-chain values](/zkapps/o1js/on-chain-values) — a.k.a. protocol & account preconditions
-- [Local blockchain](/zkapps/o1js-reference/modules/Mina#localblockchain)
-- [And more...](/zkapps/o1js-reference)
-
-### Mina zkApp CLI
-
-- [Third-party fee payer accounts for deployment transactions](https://github.com/o1-labs/zkapp-cli/issues/129) can be used across multiple projects
-
-### Data Availability
-
-- [On-chain state](/zkapps/how-to-write-a-zkapp#on-chain-state) — 8 x 32 bytes of arbitrary data per zkApp account
-- [Off-chain storage](/zkapps/tutorials/offchain-storage) — for Merkle tree data; see Tutorial 6
-
-### Other
-
-- [Oracles](/zkapps/tutorials/oracle)
-
-## Next
-
-### o1js
-
-- Remove need for a dev to use a service worker for their UI — ETA H1 2023
-- [Reduce KB file size, for aspects needed for UIs](https://github.com/o1-labs/o1js/issues/610) — ETA H1 2023
-- Improve error messages — ETA H1 2023
-
-### Data Availability
-
-- Off-chain storage for Merkle tree data with better guarantees — WIP; two teams awarded grants by Mina Foundation
-
-### Other
-
-- Archive Node API — Phase I; ETA Q1 2023
-
-## Later
-
-### o1js
-
-- [Dynamic array access](https://github.com/o1-labs/o1js/issues/90) — awaiting support in proof system for extended lookup tables
-- [Dynamic-length strings](https://github.com/o1-labs/o1js/issues/730) — awaiting dynamic array access
-- [JSON parsing](https://github.com/o1-labs/o1js/issues/91) — awaiting dynamic-length strings
-- [secp256k1](https://github.com/o1-labs/o1js/issues/61) — awaiting support in Kimchi
-- [keccak256](https://github.com/o1-labs/o1js/issues/62) — awaiting support in Kimchi
-- [ECDSA](https://github.com/o1-labs/o1js/issues/732) — awaiting support in Kimchi
-- [sha256](https://github.com/o1-labs/o1js/issues/731) — awaiting support in Kimchi
-
-### Other
-
-- Archive Node API — Phase II; for serverless hosts!
-- zkOracles — with robust privacy guarantees
diff --git a/docs/zkapps/tutorials/01-hello-world.mdx b/docs/zkapps/tutorials/01-hello-world.mdx
index e5e6d898d..941d729d5 100644
--- a/docs/zkapps/tutorials/01-hello-world.mdx
+++ b/docs/zkapps/tutorials/01-hello-world.mdx
@@ -302,19 +302,15 @@ For this tutorial, the `import` statement brings in items from `o1js` that you u
```ts src/main.ts
1 import { Square } from './Square.js';
2 import {
-3 isReady,
-4 shutdown,
-5 Field,
-6 Mina,
-7 PrivateKey,
-8 AccountUpdate,
-9 } from 'o1js';
+3 Field,
+4 Mina,
+5 PrivateKey,
+6 AccountUpdate,
+7 } from 'o1js';
```
These import items are:
-- `isReady`: An asynchronous promise that resolves when o1js is loaded and ready. This field is required because o1js contains WebAssembly (Wasm).
-- `shutdown`: A function that closes the program.
- `Field`: The same o1js unsigned integer type that you learned earlier.
- `Mina`: A local Mina blockchain to deploy the smart contract to so you can interact with it as a user would.
- `PrivateKey`: A class with functions for manipulating private keys.
@@ -327,20 +323,12 @@ Using a local blockchain speeds up development and tests the behavior of your sm
To initialize your local blockchain, add the following code from the [main.ts](https://github.com/o1-labs/docs2/blob/main/examples/zkapps/01-hello-world/src/main.ts) example file to `src/main.ts`:
```ts src/main.ts
-11 await isReady;
-12
-13 console.log('o1js loaded');
-14
-15 const useProof = false;
-16
-17 const Local = Mina.LocalBlockchain({ proofsEnabled: useProof });
-18 Mina.setActiveInstance(Local);
-19 const { privateKey: deployerKey, publicKey: deployerAccount } = Local.testAccounts[0];
-20 const { privateKey: senderKey, publicKey: senderAccount } = Local.testAccounts[1];
-21
-22 console.log('Shutting down');
-23
-24 await shutdown();
+ 9 const useProof = false;
+10
+11 const Local = Mina.LocalBlockchain({ proofsEnabled: useProof });
+12 Mina.setActiveInstance(Local);
+13 const { privateKey: deployerKey, publicKey: deployerAccount } = Local.testAccounts[0];
+14 const { privateKey: senderKey, publicKey: senderAccount } = Local.testAccounts[1];
```
This local blockchain also provides pre-funded accounts. These lines create local test accounts with test MINA to use for this tutorial:
@@ -411,12 +399,6 @@ Comments break down each stage:
36 // get the initial state of Square after deployment
37 const num0 = zkAppInstance.num.get();
38 console.log('state after init:', num0.toString());
-39
-40 // ----------------------------------------------------
-41
-42 console.log('Shutting down')
-43
-44 await shutdown();
```
Try running this command again:
@@ -453,12 +435,6 @@ To update your local zkApp account with a transaction, add the following code to
47
48 const num1 = zkAppInstance.num.get();
49 console.log('state after txn1:', num1.toString());
-50
-51 // ----------------------------------------------------
-52
-53 console.log('Shutting down');
-54
-55 await shutdown();
```
This code creates a new transaction that attempts to update the field to the value `9`. Because of the rules in the `update()` function that is called on the smart contract, this command succeeds when you run it again:
@@ -496,12 +472,6 @@ To test a failure, update the state to 75 in `zkAppInstance.update(Field(75))`:
61 }
62 const num2 = zkAppInstance.num.get();
63 console.log('state after txn2:', num2.toString());
-64
-65 // ----------------------------------------------------
-66
-67 console.log('Shutting down');
-68
-69 await shutdown();
```
Try running this command again:
@@ -538,12 +508,6 @@ And finally, be sure to change your `main.ts` file to include the correct update
72
73 const num3 = zkAppInstance.num.get();
74 console.log('state after txn3:', num3.toString());
-75
-76 // ----------------------------------------------------
-77
-78 console.log('Shutting down');
-79
-80 await shutdown();
```
Run this command again:
diff --git a/docs/zkapps/tutorials/09-recursion.mdx b/docs/zkapps/tutorials/09-recursion.mdx
index 06c848a8b..bb59dedd7 100644
--- a/docs/zkapps/tutorials/09-recursion.mdx
+++ b/docs/zkapps/tutorials/09-recursion.mdx
@@ -64,8 +64,9 @@ To create a ZkProgram, start with the `init()` method.
- The first argument of a ZkProgram method is always the state of the ZkProgram, named `publicInput` since it is public.
```typescript
-const Add = Experimental.ZkProgram({
- publicInput: Field,
+const Add = ZkProgram({
+ name: 'add-example',
+ publicInputType: Field,
methods: {
init: {
@@ -263,8 +264,9 @@ class RollupState extends Struct({
...
}
-const Rollup = Experimental.ZkProgram({
- publicInput: RollupState,
+const Rollup = ZkProgram({
+ name: "rollup-example",
+ publicInputType: Field,
methods: {
oneStep: {
diff --git a/docs/zkapps/tutorials/10-account-updates.mdx b/docs/zkapps/tutorials/10-account-updates.mdx
index 743534e06..84426541d 100644
--- a/docs/zkapps/tutorials/10-account-updates.mdx
+++ b/docs/zkapps/tutorials/10-account-updates.mdx
@@ -107,7 +107,7 @@ This zkApp has methods that call other methods to let you explore the impacts to
deploy(args: DeployArgs) {
super.deploy(args);
- this.setPermissions({
+ this.account.permissions.set({
...Permissions.default(),
setDelegate: Permissions.proof(),
setPermissions: Permissions.proof(),
diff --git a/docs/zkapps/tutorials/index.mdx b/docs/zkapps/tutorials/index.mdx
index c6e8ddf28..2001df90f 100644
--- a/docs/zkapps/tutorials/index.mdx
+++ b/docs/zkapps/tutorials/index.mdx
@@ -29,16 +29,16 @@ To meet other developers building zkApps with o1js, participate in the [#zkapps-
Each tutorial has been tested with the latest versions:
-- [Mina zkApp CLI](https://github.com/o1-labs/zkapp-cli)
+- [zkApp CLI](https://github.com/o1-labs/zkapp-cli)
- [o1js](https://www.npmjs.com/package/o1js)
- o1js is automatically included when you create a project using the Mina zkApp CLI.
+ o1js is automatically included when you create a project using the zkApp CLI.
- Other dependencies as noted.
-### Install the Mina zkApp CLI
+### Install the zkApp CLI
-To install the Mina zkApp CLI:
+To install the zkApp CLI:
```sh
$ npm install -g zkapp-cli
diff --git a/docs/zkapps/tutorials/interacting-with-zkapps-server-side.mdx b/docs/zkapps/tutorials/interacting-with-zkapps-server-side.mdx
index 853d700bb..88ad19906 100644
--- a/docs/zkapps/tutorials/interacting-with-zkapps-server-side.mdx
+++ b/docs/zkapps/tutorials/interacting-with-zkapps-server-side.mdx
@@ -48,20 +48,8 @@ Open up `main.ts` in a text editor. You can find the complete source for this [h
To start, let's add the imports and o1js setup:
```ts
- 1 import { Square } from './Square.js';
- 2 import { isReady, shutdown, Mina, PrivateKey } from 'o1js';
- 3
- 4 await isReady;
- 5
- 6 console.log('o1js loaded');
- 7
- 8 // ----------------------------------------------------
- 9
- 10 // ----------------------------------------------------
- 11
- 12 console.log('Shutting down');
- 13
- 14 await shutdown();
+ 1 import { Square } from './Square.js';
+ 2 import { Mina, PrivateKey } from 'o1js';
```
So far nothing new - but now, let's add connecting to Berkeley:
@@ -100,7 +88,7 @@ Now, to finish setting up our code, let's add to our `main.ts`:
```ts
...
- 2 import { isReady, shutdown, Mina, PrivateKey } from 'o1js';
+ 2 import { Mina, PrivateKey } from 'o1js';
3
4 import fs from 'fs';
5
@@ -147,7 +135,6 @@ In main, we will import and use the `loopUntilAccountExists()` function from `ut
4 import fs from 'fs';
5 import { loopUntilAccountExists } from './utils.js';
6
- 7 await isReady;
...
33 // ----------------------------------------------------
34
diff --git a/examples/zkapps/01-hello-world/.gitignore b/examples/zkapps/01-hello-world/.gitignore
index dd87e2d73..b7dab5e9c 100644
--- a/examples/zkapps/01-hello-world/.gitignore
+++ b/examples/zkapps/01-hello-world/.gitignore
@@ -1,2 +1,2 @@
node_modules
-build
+build
\ No newline at end of file
diff --git a/examples/zkapps/01-hello-world/src/main.ts b/examples/zkapps/01-hello-world/src/main.ts
index 7c2d00094..e7e49b7e6 100644
--- a/examples/zkapps/01-hello-world/src/main.ts
+++ b/examples/zkapps/01-hello-world/src/main.ts
@@ -1,17 +1,11 @@
import { Square } from './Square.js';
import {
- isReady,
- shutdown,
Field,
Mina,
PrivateKey,
AccountUpdate,
} from 'o1js';
-await isReady;
-
-console.log('o1js loaded');
-
const useProof = false;
const Local = Mina.LocalBlockchain({ proofsEnabled: useProof });
@@ -76,5 +70,3 @@ console.log('state after txn3:', num3.toString());
// ----------------------------------------------------
console.log('Shutting down');
-
-await shutdown();
diff --git a/examples/zkapps/02-private-inputs-and-hash-functions/.gitignore b/examples/zkapps/02-private-inputs-and-hash-functions/.gitignore
index e0ff9109d..7b92547c2 100644
--- a/examples/zkapps/02-private-inputs-and-hash-functions/.gitignore
+++ b/examples/zkapps/02-private-inputs-and-hash-functions/.gitignore
@@ -1,6 +1,7 @@
# NodeJS
node_modules
build
+package-lock.json
coverage
# Editor
diff --git a/examples/zkapps/02-private-inputs-and-hash-functions/src/main.ts b/examples/zkapps/02-private-inputs-and-hash-functions/src/main.ts
index 10da0178c..9d0dec2cc 100644
--- a/examples/zkapps/02-private-inputs-and-hash-functions/src/main.ts
+++ b/examples/zkapps/02-private-inputs-and-hash-functions/src/main.ts
@@ -1,16 +1,11 @@
import { IncrementSecret } from './IncrementSecret.js';
import {
- isReady,
- shutdown,
Field,
Mina,
PrivateKey,
AccountUpdate,
} from 'o1js';
-await isReady;
-
-console.log('o1js loaded');
const useProof = false;
@@ -52,9 +47,3 @@ await txn1.sign([senderKey]).send();
const num1 = zkAppInstance.x.get();
console.log('state after txn1:', num1.toString());
-
-// ----------------------------------------------------
-
-console.log('Shutting down');
-
-await shutdown();
diff --git a/examples/zkapps/05-common-types-and-functions/src/main.ts b/examples/zkapps/05-common-types-and-functions/src/main.ts
index 02b3a4862..b32e13045 100644
--- a/examples/zkapps/05-common-types-and-functions/src/main.ts
+++ b/examples/zkapps/05-common-types-and-functions/src/main.ts
@@ -1,7 +1,5 @@
import {
Mina,
- isReady,
- shutdown,
UInt32,
UInt64,
Int64,
@@ -23,8 +21,6 @@ import {
import { LedgerContract } from './LedgerContract.js';
import { BasicMerkleTreeContract } from './BasicMerkleTreeContract.js';
-await isReady;
-
// --------------------------------------
console.log('--------------------------------------');
@@ -389,7 +385,3 @@ const value = Field(50);
map.set(key, value);
console.log(`value for key ${key}: ${map.get(key)}`);
-
-// --------------------------------------
-
-await shutdown();
diff --git a/examples/zkapps/06-offchain-storage/ui/pages/_app.page.tsx b/examples/zkapps/06-offchain-storage/ui/pages/_app.page.tsx
deleted file mode 100644
index 7a61a383c..000000000
--- a/examples/zkapps/06-offchain-storage/ui/pages/_app.page.tsx
+++ /dev/null
@@ -1,281 +0,0 @@
-import '../styles/globals.css';
-import React, { useEffect, useState } from 'react';
-import './reactCOIServiceWorker';
-
-import ZkappWorkerClient from './zkappWorkerClient';
-
-import {
- PublicKey,
- PrivateKey,
- Field,
- CircuitString,
- Character,
- Group,
-} from 'o1js';
-
-const transactionFee = 100_000_000;
-
-const useLocalTestInstance = true;
-
-export default function App() {
- let [state, setState] = useState({
- zkappWorkerClient: null as null | ZkappWorkerClient,
- hasBeenSetup: false,
- accountExists: false,
- currentMessages: null as null | Map
- Get started by editing{' '}
- pages/index.tsx
-
Find in-depth information about Next.js features and API.
- - - -Learn about Next.js in an interactive course with quizzes!
- - - -Discover and deploy boilerplate example Next.js projects.
- - - -- Instantly deploy your Next.js site to a public URL with Vercel. -
- -