[Docs]: Update Accounts section
#1012
Conversation
phklive
added
the
no changelog
There was a problem hiding this comment.
Looks good. To me its clearer now.
I think, we can get rid of even more details:
- the bits of an account ID. We can simply say, type and storage mode are encoded in the ID
- that the Account Vault is represented as sparse Merkle tree
I left comments for those.
We can think about having deep dives for those implementation details in a different section.
docs/architecture/accounts.md
Outdated
|
|
||
| # increments the nonce (anyone should be able to call that function) | ||
| push.1 exec.account::incr_nonce | ||
| Assets are stored in a sparse Merkle tree, allowing for efficient, cryptographically secure proofs of ownership and state: |
There was a problem hiding this comment.
Do we need to explain that they are stored in a sparse Merkle tree?
I know I also had it in my version, but maybe its better to stick to the protocol and not the implementation.
So we could say how big the vault is and that it can hold fungible and non-fungible assets.
There was a problem hiding this comment.
Changed it to something shorter and less implementation focused.
docs/architecture/accounts.md
Outdated
|
|
||
| ## Account design | ||
| In Miden, an `Account` represents an entity capable of holding assets, storing data, and executing custom code. Each `Account` is essentially a specialized smart contract providing a programmable interface for interacting with its state and managed assets. |
There was a problem hiding this comment.
Can you add here the "Why" as well?
In Miden, we have accounts as entities because we want expressive smart contracts.
For payments only we could do the UTXO model alone.
There was a problem hiding this comment.
I feel like the documentation should explain what and not really why. I don't think that it's relevant for the user / builder to understand our choice. It's more something that we would put in a blog post imo.
There was a problem hiding this comment.
Yes, I can see that argument. For me, at the beginning of the chapter, especially in a design / yellow paper section, we can have one paragraph of the why.
In this PR I propose to update the
Accountssection of the Miden documentation: