Skip to content

Commit

Permalink
chore: doc improvements (#371)
Browse files Browse the repository at this point in the history
fix notes broken link
  • Loading branch information
nlok5923 authored Dec 21, 2023
1 parent 95daadb commit 72e255c
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/src/architecture/accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ There are four types of accounts in Miden:
| **Code updatability** | yes | no | no | no |
| **Most significant bits** | `00` | `01` | `10` | `11` |

## Account storage mode
## Account storage modes
Account data - stored by the Miden Node - can be public, private, or encrypted. The third and fourth most significant bits of the account ID specifies whether the account data is public `00`, encrypted `01`, or private `11`.

* Accounts with **public state**, where the actual state is stored onchain. These would be similar to how accounts work in public blockchains. Smart contracts that depend on public shared state should be stored public on Miden, e.g., DEX contract.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/architecture/notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The diagram below illustrates the contents of a note:

As shown in the above picture:
* **Vault →** serves as [asset](assets.md) container for a note. It can contain up to `255` assets stored in an array which can be reduced to a single hash.
* **Script →** will be executed in a [transaction](https://0xpolygonmiden.github.io/miden-base/architecture/transactions.html) aginst a single account, see next chapter.
* **Script →** will be executed in a [transaction](https://0xpolygonmiden.github.io/miden-base/architecture/transactions.html) against a single account, see next chapter.
* **Inputs →** are placed onto the stack as parameters before a note's script is executed.
* **Serial number →** a note's unique identifier to break linkability between [note hash](https://0xpolygonmiden.github.io/miden-base/architecture/notes.html#note-hash) and [nullifier](https://0xpolygonmiden.github.io/miden-base/architecture/notes.html#note-nullifier). Should be a random `Word` chosen by the user - if revealed, the nullifier might be computed easily.

Expand Down
4 changes: 2 additions & 2 deletions docs/src/architecture/state.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The latest account states - and data for onchain accounts - are recorded in a [s
<img src="../diagrams/architecture/state/Account_DB.png" width="80%">
</p>

As described in [Accounts](http://localhost:3000/architecture/accounts.html#account-storage-modes), there are two types of accounts:
As described in [Accounts](https://0xpolygonmiden.github.io/miden-base/architecture/accounts.html#account-storage-modes), there are two types of accounts:

* **Public accounts** where all account data is stored onchain.
* **Private accounts** where only the hashes of accounts are stored onchain.
Expand All @@ -47,7 +47,7 @@ Notes are recorded in an append-only accumulator, a [Merkle Mountain Range](http
<img src="../diagrams/architecture/state/Note_DB.png" width="80%">
</p>

As described in [Notes](http://localhost:3000/architecture/notes.html#note-storage-modes), there are two types of [notes](https://0xpolygonmiden.github.io/miden-base/architecture/notes.html):
As described in [Notes](https://0xpolygonmiden.github.io/miden-base/architecture/notes.html#note-storage-modes), there are two types of [notes](https://0xpolygonmiden.github.io/miden-base/architecture/notes.html):

* **Public notes** where the entire note content is recorded in the state.
* **Private notes** where only a note's hash is recorded in the state.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/architecture/transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ As inputs, a transaction requires
### Transaction program
In addition to specifying inputs and outputs, a transaction must be represented by an executable program. The transaction program has a well-defined structure which must do the following:

1. **Prologue**: during this step we build a single unified vault all all transaction inputs (account + notes).
1. **Prologue**: during this step we build a single unified vault all transaction inputs (account + notes).
2. **Execution**: during this step we first execute scripts of all input notes (one after another), and then execute an optional user-defined script (called tx script).
3. **Epilogue**: during this step we build a single unified vault of all transaction outputs (account + notes), and make sure it contains the same assets as the input vault.

Expand Down

0 comments on commit 72e255c

Please sign in to comment.