fix doc for AuthenticationKey #5415
Merged
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
alinush
reviewed
Nov 2, 2022
| @@ -354,7 +354,7 @@ impl AccountAuthenticator { | |||
| } | |||
| } | |||
|
|
|||
| /// A struct that represents an account authentication key. An account's address is the last 16 | |||
| /// A struct that represents an account authentication key. An account's address is the last `AccountAddress::LENGTH` | |||
There was a problem hiding this comment.
@davidiw, an account's address is set to be the authentication key used to create it, right? Because right now we assume |auth_key| == |addr|.
There was a problem hiding this comment.
sorry I got distracted...
- There's no derived address -- it is just the same as the authentication key
- There's no prefix -- it is always []
We should clean up the documentation and the code. The AuthenticationKey is now just a way to derive an account address from a source of authentication (or something). I'd rather do a proper clean up rather than a single nit.
davidiw
previously approved these changes
Nov 2, 2022
davidiw
reviewed
Dec 3, 2022
davidiw
approved these changes
Dec 3, 2022
Closed
areshand
pushed a commit
to areshand/aptos-core-1
that referenced
this pull request
Dec 18, 2022
* fix doc for AuthenticationKey * Update types/src/transaction/authenticator.rs Co-authored-by: David Wolinsky <isaac.wolinsky@gmail.com>
Closed
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.
This change is