From 72e255c63253615c7a49c5dee69e51ef915685f3 Mon Sep 17 00:00:00 2001 From: Nitanshu Lokhande <56120084+nlok5923@users.noreply.github.com> Date: Thu, 21 Dec 2023 05:48:18 +0530 Subject: [PATCH] chore: doc improvements (#371) fix notes broken link --- docs/src/architecture/accounts.md | 2 +- docs/src/architecture/notes.md | 2 +- docs/src/architecture/state.md | 4 ++-- docs/src/architecture/transactions.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/src/architecture/accounts.md b/docs/src/architecture/accounts.md index 6ca32d8a8..8883d9a95 100644 --- a/docs/src/architecture/accounts.md +++ b/docs/src/architecture/accounts.md @@ -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. diff --git a/docs/src/architecture/notes.md b/docs/src/architecture/notes.md index 8141a7b87..1f4f3aabb 100644 --- a/docs/src/architecture/notes.md +++ b/docs/src/architecture/notes.md @@ -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. diff --git a/docs/src/architecture/state.md b/docs/src/architecture/state.md index 10c1fe29b..f7eb008e3 100644 --- a/docs/src/architecture/state.md +++ b/docs/src/architecture/state.md @@ -29,7 +29,7 @@ The latest account states - and data for onchain accounts - are recorded in a [s

-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. @@ -47,7 +47,7 @@ Notes are recorded in an append-only accumulator, a [Merkle Mountain Range](http

-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. diff --git a/docs/src/architecture/transactions.md b/docs/src/architecture/transactions.md index 99bf88642..f0e1ebdbc 100644 --- a/docs/src/architecture/transactions.md +++ b/docs/src/architecture/transactions.md @@ -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.