Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: update documentation for functions #8353

Merged
merged 4 commits into from
Jun 12, 2024
Merged

chore: update documentation for functions #8353

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
821d732
chore: update documentation for functions
PaddyMc Jun 5, 2024
0939b50
chore: update comment to make more sense
PaddyMc Jun 11, 2024
60dd767
chore: update comment again
PaddyMc Jun 11, 2024
e359aef
chore: fix spelling
PaddyMc Jun 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion x/smart-account/authenticator/signature_authenticator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@ func (sva SignatureVerification) ConfirmExecution(ctx sdk.Context, request Authe

func (sva SignatureVerification) OnAuthenticatorAdded(ctx sdk.Context, account sdk.AccAddress, config []byte, authenticatorId string) error {
// We allow users to pass no data or a valid public key for signature verification.
// Users can pass no data if the public key is already contained in the auth store.
if len(config) != secp256k1.PubKeySize {
return fmt.Errorf("invalid secp256k1 public key size, expected %d, got %d", secp256k1.PubKeySize, len(config))
}
Expand Down
2 changes: 1 addition & 1 deletion x/smart-account/keeper/keeper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ func (k Keeper) GetSelectedAuthenticatorData(
}

// GetInitializedAuthenticatorForAccount returns a single authenticator for the account
// this function relies in GetAuthenticatorDataForAccount, this function calls
// this function relies in GetSelectedAuthenticatorData, this function calls
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still typo, "this function relies in X," doesn't make sense. I'm also not sure if the top line is supposed to continue on to the second line or if its a new sentence.

Copy link
Contributor Author

@PaddyMc PaddyMc Jun 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review:

Updated to be:

// GetInitializedAuthenticatorForAccount returns a single initialized authenticator for the account.
// It fetches the authenticator data from the store, gets the authenticator struct from the manager, then calls initialize on the authenticator data

// Initialize on the specific authenticator
func (k Keeper) GetInitializedAuthenticatorForAccount(
ctx sdk.Context,
Expand Down