Docs editorial, three more docs #554
Conversation
kmurphypolygon
commented
Mar 28, 2024
kmurphypolygon
commented
- Assets
- Execution
- State
docs/architecture/assets.md
Outdated
|
|
||
| All native assets in Miden are stored directly in accounts, like Ether in Ethereum. Miden does not track ownership of assets using global hashmaps, e.g., ERC20 contracts. Storage of assets locally in accounts provides privacy and the ability for client-side proofs. That is because ownership changes always involve only one account and not the change of a global hashmap. Thus, they can happen in parallel. Additionally, asset exchange is censorship resistant at this level because there is no global contract the transfer must pass through. Finally, users can pay fees in any asset. | ||
| All native assets in Miden are stored directly in accounts, like Ether in Ethereum. Miden does not track asset ownership using global hashmaps, e.g., ERC20 contracts. Local asset storage in accounts provides privacy and the ability for client-side proofs. That is because ownership changes are reflected only on an account and not on a global hashmap. Thus, these changes can happen in parallel. Additionally, asset exchange is censorship resistant at this level because there is no global contract the transfer must pass through. Finally, users can pay fees in any asset. |
There was a problem hiding this comment.
I think this difference is important:
That is because ownership changes are reflected only on an account and not on a global hashmap.
We should emphasize that the ownership change in Miden is reflected only in the owning account and not an ERC20 account (which is a global hashmap).
docs/architecture/assets.md
Outdated
|
|
||
| ### Storage | ||
| [Accounts](https://0xpolygonmiden.github.io/miden-base/architecture/accounts.html) and [notes](https://0xpolygonmiden.github.io/miden-base/architecture/notes.html) contain asset vaults that are used to store assets. Accounts can keep unlimited assets in a Sparse Merkle Tree called `account vault`. Notes can only store up to `255` distinct assets. | ||
|
|
||
| [Accounts](accounts.md) and [notes](notes.md) contain asset vaults that are used to store assets. Accounts can keep unlimited assets in a Sparse Merkle Tree called `account vault`. Notes can store up to `255` distinct assets. |
There was a problem hiding this comment.
Nit: can you change Sparse Merkle Tree to sparse Merkle tree?
docs/architecture/state.md
Outdated
| * Parallel transactions executed concurrently by distinct actors. | ||
| * Concurrent state model that allows block production without knowing the full state. | ||
|
|
||
| Privacy is enforced by a UTXO-like state model consisting of notes and nullifiers combined with off-chain execution using zero-knowledge proofs. State bloat describes the ever growing state stored in blockchain nodes. Polygon Miden addresses this challenge via its state model that enables concurrent off-chain execution and off-chain storage. Simply put, users can store their own data locally which reduces the burden on the network while integrity is ensured using zero-knowledge. |
There was a problem hiding this comment.
Can you make two paragraphs for this? The paragraph should explain (in short) how we achieve the goals above. Privacy and parallelism by UTXO-like state and zkProofs. State bloat minimization by our new state model.
docs/architecture/state.md
Outdated
|
|
||
| ### Account database | ||
| The latest account states - and data for onchain accounts - are recorded in a Sparse Merkle Tree which maps account IDs to account hashes and account data if needed. | ||
|
|
||
| The latest account states - and data for onchain accounts - are recorded in a Sparse Merkle Tree which maps account IDs to account hashes, and account data if needed. |
There was a problem hiding this comment.
Nit: can you again write sparse Merkle tree instead of Sparse Merkle Tree?
docs/architecture/state.md
Outdated
|
|
||
| ### Nullifier database | ||
| Nullifiers are stored in a Sparse Merkle Tree, which maps [Note Nullifiers](https://0xpolygonmiden.github.io/miden-base/architecture/notes.html#note-nullifier) to block numbers at which the nullifiers were inserted into the chain (or to $0$ for nullifiers which haven't been recorded yet). Nullifiers provide information on whether a specific note has been consumed. The database allows proving that a given nullifier is not in the database. | ||
|
|
||
| Nullifiers are stored in a Sparse Merkle Tree, which maps [note nullifiers](notes.md#note-nullifier-to-ensure-private-consumption) to block numbers at which the nullifiers are inserted into the chain (or to $0$ for nullifiers which haven't been recorded yet). Nullifiers provide information on whether a specific note has been consumed. The database allows proving that a given nullifier is not in the database. |
There was a problem hiding this comment.
Nit: can you change Sparse Merkle Tree to sparse Merkle tree
There was a problem hiding this comment.
and also here, should we change the number format to 0 instead of
There was a problem hiding this comment.
it's coming up as
docs/architecture/state.md
Outdated
| @@ -18,70 +25,75 @@ The Miden Node(s) maintain three databases to describe the state: | |||
| { width="80%" } | |||
| </center> | |||
|
|
|||
| These databases are represented by authenticated data structures; for easily proving that items were added to or removed from a database, and so that a commitment to the database is very small. | |||
There was a problem hiding this comment.
I stumbled upon this sentence, can you maybe rephrase to
These databases are represented by authenticated data structures, enabling easy proof of items being added to or removed from a database and ensuring that the commitment to the database remains very small.
docs/architecture/state.md
Outdated
| @@ -18,70 +25,75 @@ The Miden Node(s) maintain three databases to describe the state: | |||
| { width="80%" } | |||
| </center> | |||
|
|
|||
| These databases are represented by authenticated data structures; for easily proving that items were added to or removed from a database, and so that a commitment to the database is very small. | |||
There was a problem hiding this comment.
| These databases are represented by authenticated data structures; for easily proving that items were added to or removed from a database, and so that a commitment to the database is very small. | |
| These databases are represented by authenticated data structures; for easily proving that items were added to or removed from a database, and so that a commitment to the database is very small. |
There was a problem hiding this comment.
I stumbled upon this sentence, can you maybe rephrase it?
There was a problem hiding this comment.
Reads more simpler for me, in this way:
These databases are represented by authenticated data structures that enable easy proof of items added to or removed from a database. This ensures that the commitment to the database remains very small.
