Describe note discovery note tags #713
Conversation
Dominik1999
force-pushed
the
dominik_describe_note_discovery_note_tags
branch
from
198479e to
f077324
Compare
docs/architecture/notes.md
Outdated
| | `0b10` | Local | Any | NoteType::Public | | ||
| | `0b11` | Local | Any | Any | | ||
|
|
||
| - Execution hint: Set to `Network` for network transactions. These notes will be validated and, if possible, consumed in a network transaction. |
There was a problem hiding this comment.
| - Execution hint: Set to `Network` for network transactions. These notes will be validated and, if possible, consumed in a network transaction. | |
| - Execution hint: Set to `Network` for network transactions. These notes are validated and, if possible, consumed in a network transaction. |
docs/architecture/notes.md
Outdated
| @@ -196,10 +195,32 @@ hash(hash(hash(hash(serial_num, [0; 4]), script_hash), input_hash), vault_hash) | |||
| !!! info | |||
| To compute a note's hash, we do not need to know the note's `serial_num`. Knowing the hash of the `serial_num` (as well as `script_hash`, `input_hash` and `note_vault`) is also sufficient. We compute the hash of `serial_num` as `hash(serial_num, [0; 4])` to simplify processing within the VM._ | |||
|
|
|||
| ## Note discovery | |||
| ## Note discovery (note tags) | |||
There was a problem hiding this comment.
I think one thing missing from this section is a concrete example of how note tag can be used by one user to make a note discoverable by another user. I think after reading this, people may still not fully understand how tags can be used and an example could drive it home. We could use a P2ID note tag scheme to explain this.
In general, I think we can make this section much more detailed (the content here could be easily 3x - 4x of what is here now) and it could maybe even be its own separate sub-section. But maybe that's for another PR.
There was a problem hiding this comment.
Jup, I also have the feeling that the entire note chapter is too long already. I will add the example for now and we should do a bigger refactor for the chapter and add several sub-sections.
There was a problem hiding this comment.
In general, I think, what is missing to make those really great docs:
- the ppl who write / design the code should also write the section (they know exactly why a certain design was chosen)
- Miden cannot be used at the moment, but the docs should describe how to use Miden. It will get better, once there is the compiler. Then we can describe how to use a note tag using a specific example.
Dominik1999
force-pushed
the
dominik_describe_note_discovery_note_tags
branch
2 times, most recently
from
c91cd8d to
547bb0d
Compare
Dominik1999
force-pushed
the
dominik_describe_note_discovery_note_tags
branch
from
547bb0d to
1654062
Compare
* docs: adding note tags to note discovery * changing it slightly * after review * after another review * adding a P2ID example * adding a P2ID example
Closes #440
I describe how Note Tags are used to discover relevant notes.