Skip to content

Commit e1e89d1

Browse files
authored
Merge branch 'main' into glossary-curves
2 parents f0316dd + bc03882 commit e1e89d1

File tree

89 files changed

+4828
-15108
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+4828
-15108
lines changed

algolia-config.json

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,28 @@
11
{
22
"index_name": "mina",
3-
"start_urls": ["https://docs.minaprotocol.com"],
3+
"start_urls": [
4+
{
5+
"url": "https://docs.minaprotocol.com"
6+
}
7+
],
48
"sitemap_urls": ["https://docs.minaprotocol.com/sitemap.xml"],
59
"sitemap_alternate_links": true,
610
"js_render": true,
7-
"stop_urls": ["/tests"],
11+
"js_wait": 1,
12+
"stop_urls": ["https://docs.minaprotocol.com/node-developers"],
13+
"selectors_exclude": ["footer"],
814
"selectors": {
915
"lvl0": {
10-
"selector": "(//ul[contains(@class,'menu__list')]//a[contains(@class, 'menu__link menu__link--sublist menu__link--active')]/text() | //nav[contains(@class, 'navbar')]//a[contains(@class, 'navbar__link--active')]/text())[last()]",
11-
"type": "xpath",
12-
"global": true,
13-
"default_value": "Documentation"
16+
"selector": "",
17+
"defaultValue": "Documentation"
1418
},
15-
"lvl1": "header h1",
16-
"lvl2": "article h2",
17-
"lvl3": "article h3",
18-
"lvl4": "article h4",
19-
"lvl5": "article h5, article td:first-child",
20-
"lvl6": "article h6",
21-
"text": "article p, article li, article td:last-child"
19+
"lvl1": "header h1, article h1, main h1, h1, head > title",
20+
"lvl2": "article h2, main h2, h2",
21+
"lvl3": "article h3, main h3, h3",
22+
"lvl4": "article h4, main h4, h4",
23+
"lvl5": "article h5, main h5, h5",
24+
"lvl6": "article h6, main h6, h6",
25+
"text": "article p, article li, main p, main li, p, li"
2226
},
2327
"strip_chars": " .,;:#",
2428
"custom_settings": {
@@ -31,6 +35,12 @@
3135
"url",
3236
"url_without_anchor",
3337
"type"
38+
],
39+
"synonyms": [
40+
["js", "javascript"],
41+
["ts", "typescript"],
42+
["es6", "ECMAScript6", "ECMAScript2015"],
43+
["zk", "zero-knowledge", "zero knoweldge"]
3444
]
3545
},
3646
"conversation_id": ["833762294"],

docs/about-mina/Advanced/cryptography.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/about-mina/consensus.mdx

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,31 @@
11
---
22
title: Consensus
3+
description: Mina Protocol uses a proof of stake (PoS) consensus mechanism called Ouroboros Samasika.
4+
keywords:
5+
- proof of stake (PoS)
6+
- Ouroboros Samasika
7+
- consensus mechanism
8+
- mina consensus
39
---
410

511
import ResponsiveVideo from '@site/src/components/common/ResponsiveVideo';
612

713
# Consensus
814

9-
Mina Protocol uses a proof-of-stake consensus mechanism called **Ouroboros Samasika**.
15+
Mina Protocol uses a proof of stake (PoS) consensus mechanism called _Ouroboros Samasika_.
1016

11-
Consensus is the process by which the network determines which information is retained in the blockchain. You can read about the difference between proof of stake (PoS) vs proof of work (PoW) consensus mechanisms in this blog post <a href="https://minaprotocol.com/blog/proof-of-work-vs-proof-of-stake">here</a>.
17+
Consensus is the process by which the network determines which information is retained in the blockchain. To learn more, see the [Proof-of-Work vs Proof-of-Stake](https://minaprotocol.com/blog/proof-of-work-vs-proof-of-stake) blog post.
1218

13-
Learn more about how Ouroboros Samasika works in this video:
19+
How Ouroboros Samasika works is explained in this video:
1420

1521
<ResponsiveVideo src="https://www.youtube.com/embed/NpjuGYcJICA" />
1622

17-
### Decentralization properties
18-
Based on Cardano’s PoS Ouroboros, Ouroboros Samisika is a secure PoS protocol with some strong decentralization properties:
23+
## Decentralization properties
24+
25+
Based on Cardano's PoS Ouroboros, Ouroboros Samisika is a secure PoS protocol with strong decentralization properties:
1926

2027
- Can resolve long-range forks without relying on third parties to provide history
21-
- **No staking minimum** — You can produce blocks and receive block rewards based on your % of the MINA staked on the network. Any user with any amount of MINA can receive these rewards.
22-
- **No slashing**the protocol does not need explicit slashing, since the protocol already enforces the required level of correctness.
28+
- **No staking minimum** — You can produce blocks and receive block rewards based on your percentage of MINA staked on the network. Any user with any amount of MINA can receive these rewards.
29+
- **No slashing**Mina protocol does not need explicit slashing, since the protocol already enforces the required level of correctness.
2330

24-
Learn about <a href="https://minaprotocol.com/blog/how-ouroboros-samasika-upholds-minas-goals-of-decentralization"> how Ouroboros Samasika upholds Mina’s goals of decentralization</a>.
31+
See [How Ouroboros Samasika upholds Mina's goals of decentralization](https://minaprotocol.com/blog/how-ouroboros-samasika-upholds-minas-goals-of-decentralization).

docs/about-mina/faq.mdx

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
---
22
title: Mina FAQ
3+
description: Frequently asked questions about Mina Protocol.
4+
keywords:
5+
- mina faq
6+
- mina language
7+
- zkapp language
8+
- 22 KB
9+
- kimchi proof system
10+
- mina scalability
11+
- mina security audits
312
---
413

514
import Subhead from "@site/src/components/common/Subhead";
@@ -13,35 +22,35 @@ Frequently Asked Questions about Mina Protocol
1322

1423
### What language is Mina written in?
1524

16-
The Mina node is written in OCaml. But you don't need to know OCaml to write smart contracts for Mina.
25+
The Mina node is written in OCaml. You don't need to know OCaml to write smart contracts for Mina.
1726

1827
### What language are zkApp smart contracts written in?
1928

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

22-
Learn more about [how to write a zkApp](/zkapps/how-to-write-a-zkapp).
31+
See [How to write a zkApp](/zkapps/how-to-write-a-zkapp).
2332

2433
### How large is the Mina Blockchain?
2534

2635
22 KB
2736

2837
### Given Mina is only 22 KB, where are past transactions stored?
2938

30-
A Mina node can run with an optional flag to make it an archive node to store historic transactions. Archive nodes are useful for anyone running a service such as a block explorer. Still, this historical data is not required to verify the current consensus state of the protocol.
39+
A Mina node can run with an optional flag to make it an archive node to store historical transactions. Archive nodes are useful for anyone running a service, such as a block explorer. Still, this historical data is not required to verify the current consensus state of the protocol.
3140

32-
### What zk proof system does Mina use?
41+
### What zero knowledge (zk) proof system does Mina use?
3342

34-
Mina Protocol uses a custom proof system called Kimchi, which was developed by [O(1) Labs](https://o1labs.org/), and is the only blockchain offering infinite recursion.
43+
Mina Protocol uses a custom proof system called Kimchi, developed by [O(1) Labs](https://o1labs.org/). Mina is the only blockchain offering infinite recursion.
3544

3645
Check out the [Mina Book](https://o1-labs.github.io/proof-systems/plonk/overview.html) to learn more about Kimchi and the cryptography powering Mina Protocol.
3746

3847
### What can I do on the Mina network?
3948

40-
Any node can send and receive transactions on the Mina network. Any node can also choose to be a node operator. See [Node Operators](/node-operators).
49+
Any node can send and receive transactions on the Mina network. Any node can also be a [node operator](/node-operators).
4150

4251
### What consensus algorithm does Mina use?
4352

44-
Mina's consensus mechanism is an implementation of Ouroboros Proof-of-Stake. Due to Mina's unique compressed blockchain, certain aspects of the algorithm have diverged from the Ouroboros papers. The version Mina uses is called Ouroboros Samisika.
53+
Mina's consensus mechanism is an implementation of Ouroboros proof of stake. Due to Mina's unique compressed blockchain, certain aspects of the algorithm have diverged from the Ouroboros papers. The version Mina uses is called Ouroboros Samisika and achieves consensus without long-term history.
4554

4655
#### Is there a Mina block explorer?
4756

docs/about-mina/index.mdx

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,45 @@
11
---
2-
title: Overview
2+
title: Mina Overview
3+
description: Mina is an L1 blockchain based on zero-knowledge proofs (ZKP) with smart contracts written in TypeScript
4+
keywords:
5+
- mina blockchain
6+
- mina l1
7+
- 22 KB constant size blockchain
8+
- mina network
39
---
410

5-
# Overview
11+
# Mina Overview
612

7-
### What is Mina?
13+
## What is Mina?
814

9-
Mina is an L1 blockchain based on zero-knowledge proofs (ZKP) with smart contracts written in TypeScript. It is the first cryptocurrency protocol with a succinct blockchain (22KB).
15+
Mina is an L1 blockchain based on zero-knowledge proofs (ZKP) with smart contracts written in TypeScript. It is the first cryptocurrency protocol with a succinct blockchain (22KB).
1016

11-
### Why Mina?
17+
## Why Mina?
1218

13-
Mina Protocol uses zero-knowledge proofs to build a more ideal blockchain architecture.
19+
Mina Protocol uses zero knowledge proofs to build a more ideal blockchain architecture.
1420

15-
Early blockchains, like Bitcoin and Ethereum, accumulate data over time and are currently hundreds of gigabytes in size. As time goes on, their blockchains will continue to increase in size. The entire chain history is required in order to verify the current consensus state of these networks.
21+
Early blockchains, like Bitcoin and Ethereum, accumulate data over time and are currently hundreds of gigabytes in size. As time goes on, their blockchains will continue to increase in size. The entire chain history is required to verify the current consensus state of these networks.
1622

17-
With Mina, the blockchain always remains a constant sizeabout 22KB (the size of a few tweets). Its possible to verify the current consensus state of the protocol using this one recursive, 22KB zero-knowledge proof. This means participants can quickly sync and verify the current consensus state of the network.
23+
With Mina, the blockchain always remains a constant sizeabout 22KB (the size of a few tweets). It's possible to verify the current consensus state of the protocol using this one recursive, 22KB zero-knowledge proof. This means participants can quickly sync and verify the current consensus state of the network.
1824

19-
Learn more about [Minas unique protocol architecture](about-mina/protocol-architecture).
25+
Learn more about Mina's unique [protocol architecture](about-mina/protocol-architecture).
2026

21-
### What are zero-knowledge proofs?
27+
## What are zero-knowledge proofs?
2228

23-
Minas unique characteristics are made possible using zero-knowledge proofs.
29+
Mina's unique characteristics are made possible using zero-knowledge proofs.
2430

25-
Watch this [video to learn about zero-knowledge proofs](about-mina/what-are-zero-knowledge-proofs).
31+
Learn more in this video about [zero-knowledge proofs](about-mina/what-are-zero-knowledge-proofs).
2632

27-
### What are zkApps?
33+
## What are zkApps?
2834

2935
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.
3036

3137
See [zkApps Overview](/zkapps).
3238

33-
### How does consensus work on Mina?
39+
## How does consensus work on Mina?
3440

35-
The Mina network is secured by proof-of-stake (PoS) consensus called Ouroboros Samisika.
41+
The Mina network is secured by proof of stake (PoS) consensus called Ouroboros Samisika.
3642

37-
Based on Cardanos Ouroboros, Ouroboros Samisika is a PoS consensus mechanism that requires far less computing power than Bitcoins proof-of-work (PoW) protocol.
43+
Based on Cardano's Ouroboros, Ouroboros Samisika is a PoS consensus mechanism that requires far less computing power than Bitcoin's proof of work (PoW) protocol.
3844

39-
With this model of consensus, you don't need expensive and energy consuming mining equipment to participate in consensus. By simply holding MINA in our wallet, we can choose to either stake it ourselves if running a block producing node, or we can delegate it to another node.
40-
41-
Read more about [Mina’s consensus mechanism](./about-mina/consensus).
45+
With this model of Mina's [consensus mechanism](/about-mina/consensus), you don't need expensive and energy-consuming mining equipment to participate in consensus. By simply holding MINA in your wallet, you can choose to stake it yourself by running a [block producer](/node-operators/block-producers) node or delegate your MINA to another node.

docs/about-mina/protocol-architecture.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
2-
title: Protocol Architecture
2+
title: Mina Protocol Architecture
33
hide_title: true
4+
description: Short video explaining how the Mina protocol works.
5+
keywords:
6+
- how mina protocol works
47
---
58

69
import ResponsiveVideo from '@site/src/components/common/ResponsiveVideo';
@@ -11,11 +14,11 @@ A new version of Mina Docs is coming soon! This page will be rewritten.
1114

1215
:::
1316

14-
# Protocol Architecture
17+
# Mina Protocol Architecture
1518

1619
## How Does it Work?
1720

18-
Check out this short video explaining how the Mina protocol works in detail:
21+
Check out this short video explaining how the Mina protocol works:
1922

2023
<ResponsiveVideo src="https://www.youtube-nocookie.com/embed/eWVGATxEB6M?start=100&enablejsapi=1&rel=0" />
2124

docs/about-mina/smart-contracts.mdx

Lines changed: 0 additions & 42 deletions
This file was deleted.
Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
---
2-
title: What are Zero-Knowledge Proofs?
2+
title: What are Zero Knowledge Proofs?
3+
description: Short video explaining zero knowledge proofs.
4+
keywords:
5+
- zero knowledge proofs
36
---
47

58
import ResponsiveVideo from '@site/src/components/common/ResponsiveVideo';
69

7-
# What are Zero-Knowledge Proofs?
10+
# What are Zero Knowledge Proofs?
811

9-
Zero-knowledge proofs keep Mina's blockchain light and your personal data private.
12+
Zero knowledge proofs keep Mina's blockchain light and your personal data private.
1013

11-
In this video, Brandon from <a href="https://o1labs.org/">O(1) Labs</a> explains what zero-knowledge proofs are by comparing them to the game of "Where's Waldo?". By the end of this video, you know what zero-knowledge proofs are, how they work, and their importance to Mina and the greater crypto community.
14+
In this video, Brandon from <a href="https://o1labs.org/">O(1) Labs</a> explains what zero knowledge proofs are by comparing them to the game of "Where's Waldo?". Learn what zero knowledge proofs are, how they work, and their importance to Mina and the greater crypto community.
1215

1316
<ResponsiveVideo src="https://www.youtube.com/embed/GvwYJDzzI-g" />

0 commit comments

Comments
 (0)