Docs for currency #2042
Merged
Docs for currency #2042
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
grumbach
force-pushed
the
currency_docs
branch
from
70e6a84 to
86941c7
Compare
maqi
reviewed
Aug 21, 2024
|
|
||
| Without the `DerivationIndex`, there is no way to link a `MainPubkey` to a `UniquePubkey`. Since `UniquePubkey`s are spendable only once, this means every transaction involves new and unique keys which are all unrelated and unlinkable to their original owner's `MainPubkey`. | ||
|
|
||
| Under the hood, those types are simply: |
maqi
requested changes
Aug 27, 2024
maqi
reviewed
Aug 27, 2024
| pub struct Spend { | ||
| pub unique_pubkey: UniquePubkey, | ||
| pub ancestors: BTreeSet<UniquePubkey>, | ||
| pub descendants: BTreeMap<UniquePubkey, NanoTokens>, |
There was a problem hiding this comment.
still need to keep the royalties member field
also, shall the doc cover the reason member field as well?
if this doc is just about currency & spend DAG, which these two fields (especially the reason field) are not that related,
at least put a ... below the line of descendants, to avoid give a mis-impression to the readers that Spend struct only has that three member fields ?
There was a problem hiding this comment.
Yes I didn't document that as those fields are more likely to evolve thus the ...
There was a problem hiding this comment.
We could add those once stabilized?
grumbach
force-pushed
the
currency_docs
branch
from
86941c7 to
aaaff31
Compare
maqi
approved these changes
Aug 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docs for the currency