Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into review/lightnet.
Browse files Browse the repository at this point in the history
  • Loading branch information
shimkiv committed May 16, 2024
2 parents 5e18192 + 3c625aa commit f4a9948
Show file tree
Hide file tree
Showing 313 changed files with 5,161 additions and 34,241 deletions.
2 changes: 1 addition & 1 deletion docs/about-mina/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The Mina node is written in OCaml. You don't need to know OCaml to write smart c

Mina's zero knowledge smart contracts (zkApps) are written in TypeScript.

See [How to write a zkApp](/zkapps/how-to-write-a-zkapp).
See [How to write a zkApp](/zkapps/writing-a-zkapp/introduction-to-zkapps/how-to-write-a-zkapp).

### How large is the Mina Blockchain?

Expand Down
2 changes: 1 addition & 1 deletion docs/about-mina/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Learn more in this video about [zero knowledge proofs](about-mina/what-are-zero-

Mina's zero knowledge smart contracts are referred to as zkApps. zkApps provide powerful and unique characteristics such as unlimited off-chain execution, privacy for private data inputs that are never seen by the blockchain, the ability to write smart contracts in TypeScript, and more.

See [zkApps Overview](/zkapps).
See [zkApps Overview](/zkapps/writing-a-zkapp/introduction-to-zkapps).

## How does consensus work on Mina?

Expand Down
2 changes: 1 addition & 1 deletion docs/exchange-operators/rosetta/samples/requests.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ All possible operation types are available on the `network/options` endpoint. Th

### Layout of the transfer transaction

In Mina, each operation represents an [Account Update](/zkapps/o1js/interact-with-mina#account-updates). Therefore, a MINA token transfer transaction is represented by three Account Updates:
In Mina, each operation represents an [Account Update](/zkapps/writing-a-zkapp/introduction-to-zkapps/interact-with-mina#account-updates). Therefore, a MINA token transfer transaction is represented by three Account Updates:
- for decreasing fee payer account balance (the fee payer's account is the same as the sender's)
- for decreasing sender account balance
- for increasing receiver account balance
Expand Down
14 changes: 7 additions & 7 deletions docs/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ A consensus constant `k` is the point at which chain [reorganizations](#reorgani

## foreign field

A finite field different from the native field of the proof system. [Foreign Field Arithmetic](/zkapps/o1js/foreign-fields) lets you perform algorithms that connect your zkApp with the outside world of cryptography.
A finite field different from the native field of the proof system. [Foreign Field Arithmetic](/zkapps/o1js/ecdsa) lets you perform algorithms that connect your zkApp with the outside world of cryptography.

### full node

Expand Down Expand Up @@ -261,11 +261,11 @@ Mina uses this peer-to-peer networking library to provide things like message br

### Lightnet

A lightweight Mina network in a single Docker container. [Lightnet](/zkapps/testing-zkapps-lightnet) is a resource-efficient solution with fast startup and syncing times that lets you test your zkApp locally on an accurate representation of Mina blockchain before you test with a live network.
A lightweight Mina network in a single Docker container. [Lightnet](zkapps/writing-a-zkapp/introduction-to-zkapps/testing-zkapps-lightnet) is a resource-efficient solution with fast startup and syncing times that lets you test your zkApp locally on an accurate representation of Mina blockchain before you test with a live network.

### lightweight Mina Explorer

Provided in Lightnet, a lightweight Mina Explorer lets you monitor transactions on your local network. See [Testing zkApps with Lightnet](/zkapps/testing-zkapps-lightnet#lightweight-mina-explorer).
Provided in Lightnet, a lightweight Mina Explorer lets you monitor transactions on your local network. See [Testing zkApps with Lightnet](zkapps/writing-a-zkapp/introduction-to-zkapps/testing-zkapps-lightnet#lightweight-mina-explorer).

## M

Expand Down Expand Up @@ -311,7 +311,7 @@ A [full node](#full-node) in the Mina protocol that does not participate in cons

### non-upgradeable

If the verification key cannot be changed, a zkApp smart contract is considered non-upgradeable. You can make a smart contract upgradeable or not upgradeable using [permissions](/zkapps/o1js/permissions#upgradeability-of-smart-contracts).
If the verification key cannot be changed, a zkApp smart contract is considered non-upgradeable. You can make a smart contract upgradeable or not upgradeable using [permissions](/zkapps/writing-a-zkapp/feature-overview/permissions#upgradeability-of-smart-contracts).

### nonce

Expand Down Expand Up @@ -471,7 +471,7 @@ Short for digital signature, a way to establish authenticity or ownership of dig

### simulated local blockchain

The local testing blockchain you use in the first phase of testing. Using a simulated local blockchain speeds up development and tests the behavior of your smart contract locally. See [Testing zkApps Locally](/zkapps/testing-zkapps-locally) and get step-by-steps guidance in [Tutorial 1: Hello World](/zkapps/tutorials/hello-world#simulated-local-blockchain).
The local testing blockchain you use in the first phase of testing. Using a simulated local blockchain speeds up development and tests the behavior of your smart contract locally. See [Testing zkApps Locally](zkapps/writing-a-zkapp/introduction-to-zkapps/testing-zkapps-locally) and get step-by-steps guidance in [Tutorial 1: Hello World](/zkapps/tutorials/hello-world#simulated-local-blockchain).

### slot

Expand Down Expand Up @@ -543,7 +543,7 @@ An instance of a blockchain used for testing and experimenting where MINA tokens

### time-locked accounts

An account with a non-vested amount of tokens that cannot be moved until a specific condition has been met, like a number of blocks that has been produced. See [Time-Locked Accounts](/zkapps/o1js/time-locked-accounts).
An account with a non-vested amount of tokens that cannot be moved until a specific condition has been met, like a number of blocks that has been produced. See [Time-Locked Accounts](/zkapps/writing-a-zkapp/feature-overview/time-locked-accounts).

### tMINA

Expand Down Expand Up @@ -597,7 +597,7 @@ A proof by which one party (a prover) can prove to another party (a verifier) th

### zkApps

Zero knowledge apps ([zkApps](/zkapps)) are Mina Protocol's smart contracts powered by zero-knowledge proofs, specifically using zk-SNARKs. zkApps provide powerful and unique characteristics such as unlimited off-chain execution, privacy for private data inputs that are never seen by the blockchain, the ability to write smart contracts in TypeScript, and more. The easiest way to write zk programs is using [o1js](https://www.npmjs.com/package/o1js).
Zero knowledge apps ([zkApps](/zkapps/writing-a-zkapp/introduction-to-zkapps)) are Mina Protocol's smart contracts powered by zero-knowledge proofs, specifically using zk-SNARKs. zkApps provide powerful and unique characteristics such as unlimited off-chain execution, privacy for private data inputs that are never seen by the blockchain, the ability to write smart contracts in TypeScript, and more. The easiest way to write zk programs is using [o1js](https://www.npmjs.com/package/o1js).

### zkApp CLI

Expand Down
2 changes: 1 addition & 1 deletion docs/node-operators/archive-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ For some use cases, it is useful to maintain this historical data on an archive

:::tip

A zkApp can retrieve events and actions from one or more Mina archive nodes. If your smart contract needs to fetch events and actions from an archive node, see [How to Fetch Events and Actions](../zkapps/o1js/fetch-events-and-actions).
A zkApp can retrieve events and actions from one or more Mina archive nodes. If your smart contract needs to fetch events and actions from an archive node, see [How to Fetch Events and Actions](/zkapps/writing-a-zkapp/feature-overview/fetch-events-and-actions).

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/participate/grants-and-programs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The Mina community offers various programs to promote growth of the Mina ecosyst

O(1) Labs, a Mina ecosystem partner, created and runs the zkApps Builders Program (ZBP), a 12-week online program to support developers who are interested in building zkApps-related projects.

The goal of the program is to provide direct access to the O(1) Labs team to support developers as they build their zkApp project and to gather feedback for improving [o1js](/zkapps/o1js-reference) and [zkApps](/zkapps). You can read more about the projects that came out of [ZBP cohort 1 (Spring 2022)](https://minaprotocol.com/blog/zkapps-builders-program-spring-2022-wrapup).
The goal of the program is to provide direct access to the O(1) Labs team to support developers as they build their zkApp project and to gather feedback for improving [o1js](/zkapps/o1js-reference) and [zkApps](/zkapps/writing-a-zkapp/introduction-to-zkapps). You can read more about the projects that came out of [ZBP cohort 1 (Spring 2022)](https://minaprotocol.com/blog/zkapps-builders-program-spring-2022-wrapup).

[Sign up to get notified](https://forms.gle/HWcqjj4RuCBFUAU18) when future ZBP cohort applications open.

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/zkapps/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Use the `requireSignature` command. See the [requireSignature](/zkapps/o1js-refe

### How do I configure who has the authority to interact and make changes to a specific part of an account?

Permissions determine who has the authority to interact and make changes to a specific part of a smart contract. See [Permissions](https://docs.minaprotocol.com/zkapps/o1js/permissions).
Permissions determine who has the authority to interact and make changes to a specific part of a smart contract. See [Permissions](https://docs.minaprotocol.com/zkapps/writing-a-zkapp/feature-overview/permissions).

### How are proofs generated in the Mina Protocol?

Expand Down
9 changes: 6 additions & 3 deletions docs/zkapps/o1js-reference/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ The easiest way to write zk programs is using o1js.

o1js is a TypeScript library for [zk-SNARKs](https://minaprotocol.com/blog/what-are-zk-snarks) and zkApps. You can use o1js to write zk smart contracts based on zero-knowledge proofs for the Mina Protocol.

o1js is automatically included when you create a project using the [zkApp CLI](https://www.npmjs.com/package/zkapp-cli).
o1js is automatically included when you create a project using the [Mina zkApp CLI](https://www.npmjs.com/package/zkapp-cli).

## Learn More

- To learn more about developing zkApps, see the [zkApp Developers](https://docs.minaprotocol.com/zkapps) docs.
- To learn more about developing zkApps, see the [zkApp Developers](https://docs.minaprotocol.com/zkapps/writing-a-zkapp/introduction-to-zkapps) docs.

- For guided steps building and using zkApps, see the [zkApp Developers Tutorials](https://docs.minaprotocol.com/zkapps/tutorials/hello-world).

Expand Down Expand Up @@ -78,7 +78,7 @@ To include your package, see [Creating high-quality community packages](https://
| [AccountUpdateForest](classes/AccountUpdateForest.mdx) | Class which represents a forest (list of trees) of account updates, |
| [AccountUpdateTree](classes/AccountUpdateTree.mdx) | Class which represents a tree of account updates, |
| [AlmostForeignField](classes/AlmostForeignField.mdx) | - |
| [BaseMerkleWitness](classes/BaseMerkleWitness.mdx) | The [BaseMerkleWitness](classes/BaseMerkleWitness.mdx) class defines a circuit-compatible base class for [Merkle Witness'](https://computersciencewiki.org/index.php/Merkle_proof). |
| [BaseMerkleWitness](classes/BaseMerkleWitness.mdx) | The [BaseMerkleWitness](classes/BaseMerkleWitness.mdx) class defines a circuit-compatible base class for [Merkle Witness](https://computersciencewiki.org/index.php/Merkle_proof). |
| [Bool](classes/Bool.mdx) | A boolean value. You can use it like this: |
| [CanonicalForeignField](classes/CanonicalForeignField.mdx) | - |
| [Character](classes/Character.mdx) | - |
Expand All @@ -103,6 +103,7 @@ To include your package, see [Creating high-quality community packages](https://
| [Packed](classes/Packed.mdx) | `Packed<T>` is a "packed" representation of any type `T`. |
| [PrivateKey](classes/PrivateKey.mdx) | A signing key. You can generate one via [PrivateKey.random](classes/PrivateKey.mdx#random). |
| [Proof](classes/Proof.mdx) | - |
| [ProofBase](classes/ProofBase.mdx) | - |
| [PublicKey](classes/PublicKey.mdx) | A public key, which is also an address on the Mina network. |
| [Scalar](classes/Scalar.mdx) | Represents a [Scalar](classes/Scalar.mdx). |
| [SelfProof](classes/SelfProof.mdx) | - |
Expand Down Expand Up @@ -135,6 +136,7 @@ To include your package, see [Creating high-quality community packages](https://
| [JsonProof](type-aliases/JsonProof.mdx) | - |
| [MerkleListBase](type-aliases/MerkleListBase.mdx) | Common base type for [MerkleList](classes/MerkleList.mdx) and [MerkleListIterator](classes/MerkleListIterator.mdx) |
| [MerkleListIteratorBase](type-aliases/MerkleListIteratorBase.mdx) | - |
| [Option](type-aliases/Option.mdx) | - |
| [Provable](type-aliases/Provable.mdx) | `Provable<T>` is the general interface for provable types in o1js. |
| [ProvableExtended](type-aliases/ProvableExtended.mdx) | - |
| [ProvableHashable](type-aliases/ProvableHashable.mdx) | - |
Expand Down Expand Up @@ -174,6 +176,7 @@ To include your package, see [Creating high-quality community packages](https://
| [ConstantField](functions/ConstantField.mdx) | - |
| [MerkleListBase](functions/MerkleListBase.mdx) | - |
| [MerkleWitness](functions/MerkleWitness.mdx) | Returns a circuit-compatible Witness for a specific Tree height. |
| [Option](functions/Option.mdx) | Define an optional version of a provable type. |
| [Reducer](functions/Reducer.mdx) | - |
| [State](functions/State.mdx) | - |
| [Struct](functions/Struct.mdx) | `Struct` lets you declare composite types for use in o1js circuits. |
Expand Down
Loading

0 comments on commit f4a9948

Please sign in to comment.