x/auth: update NewAccountKeeper docs #9020
Conversation
robert-zaremba
requested review from
aaronc,
alessio and
alexanderbez
as code owners
| // `maccPerms` is a map of module account to list of permissisons. It's used to construct | ||
| // types.PermissionsForAddress and used in keeper.ValidatePermissions. Permissions is a string, | ||
| // without any specific structure. It's not use internally by this module (x/auth) but may | ||
| // be used by other modules using auth.Keeper to check against configured permissions. | ||
| func NewAccountKeeper( | ||
| cdc codec.BinaryMarshaler, key sdk.StoreKey, paramstore paramtypes.Subspace, proto func() types.AccountI, | ||
| maccPerms map[string][]string, |
There was a problem hiding this comment.
I was thinking to change the maccPerms type to map[string]types.PermissionsForAddress, but that would add redundancy when creating the parameters: PermissionsForAddress repeats the module name (the map key) in it's attributes.
|
Benchmark finished. See the result: https://github.orijtech.com/benchmark/result?id=2736655a38c040539241d6b7d6da2b68 |
|
Benchmark beginning. Status page: https://github.orijtech.com/benchmark/status?commit=49a760d940f59d015530ac02f4bea12ed2f770f1 |
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
|
Benchmark finished. See the result: https://github.orijtech.com/benchmark/result?id=e09a93f9b45f4e499075c63622359d46 |
|
Benchmark beginning. Status page: https://github.orijtech.com/benchmark/status?commit=78ba066e375a63b962be235fd9747ccf5f42a452 |
robert-zaremba
added
the
A:automerge
Co-authored-by: Alessio Treglia <alessio@tendermint.com>
robert-zaremba
removed
the
A:automerge
Co-authored-by: Alessio Treglia <alessio@tendermint.com>
|
@barriebyron , @alessio - thanks for suggestions. |
robert-zaremba
added
the
A:automerge
Description
Updates documentation about
maccPermsparameter forNewAccountKeeperBefore we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/) or specification (x/<module>/spec/)godoccomments.Unreleasedsection inCHANGELOG.mdFiles changedin the Github PR explorerCodecov Reportin the comment section below once CI passes