EPIC: Remove bech32 globals #9690
Comments
|
We just had a WG meeting discussing this, meeting notes are here: #7091. The idea is to move the the bech32 prefix string as a x/auth keeper field. See the 1st post for a proposal broken up into small steps. |
|
This would mean any and all utilities that need to bech32 encode or decode an address would need access to the x/auth keeper? |
|
All other keepers would. But we would need to figure out a client solution - maybe with client.Context or AccountRetriever. |
19 tasks
mergify bot
pushed a commit
that referenced
this issue
Aug 25, 2021
<!-- The default pull request template is for types feat, fix, or refactor. For other templates, add one of the following parameters to the url: - template=docs.md - template=other.md --> ## Description Closes **Step1** from #9690 <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> - Add auth keeper methods and gRPC queries: - the `NewAccountKeeper` should take a `string bech32Prefix` argument - ` auth AccountKeeper` implements `Codec` interface that contains 2 methods: `ConvertAddressStringToBytes` and `ConvertAddressBytesToString` - Add the 3 following gRPC queries: - Get bech32 prefix - `AddressStringToBytes` (converts `AccountAddr` string to `AccountAddr` bytes) - `AddressBytesToString` ( converts `AccountAddr` bytes to `AccountAddr` str) - Add the corresponding keeper methods - Add tests --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [x] added a changelog entry to `CHANGELOG.md` - [x] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
|
I think |
This was referenced Sep 28, 2021
Closed
|
closing in favour of #13140 |
19 tasks
19 tasks
19 tasks
larry0x
pushed a commit
to larry0x/cosmos-sdk
that referenced
this issue
May 22, 2023
<!-- The default pull request template is for types feat, fix, or refactor. For other templates, add one of the following parameters to the url: - template=docs.md - template=other.md --> ## Description Closes **Step1** from cosmos#9690 <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> - Add auth keeper methods and gRPC queries: - the `NewAccountKeeper` should take a `string bech32Prefix` argument - ` auth AccountKeeper` implements `Codec` interface that contains 2 methods: `ConvertAddressStringToBytes` and `ConvertAddressBytesToString` - Add the 3 following gRPC queries: - Get bech32 prefix - `AddressStringToBytes` (converts `AccountAddr` string to `AccountAddr` bytes) - `AddressBytesToString` ( converts `AccountAddr` bytes to `AccountAddr` str) - Add the corresponding keeper methods - Add tests --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [x] added a changelog entry to `CHANGELOG.md` - [x] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
20 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Summary
Remove bech32 globals, move the bech32 prefix as a x/auth keeper field.
Problem Definition
See #7448 for context.
Proposal
The idea is to remove the bech32 global defined in
types/address.go, and put it as a parameter into the auth keeper (like we do for codecs).@cyberbono3 Step 1 (updated). Add auth keeper methods and gRPC queries:
string bech32Prefixonauth AccountKeeperstructauth AccountKeeperimplementsAddressCdcinterface that contains 2 methods:AddressStringToBytesandAddressBytesToStringAccountAddrstring toAccountAddrbytes)AccountAddrbytes toAccountAddrstr)Step 2. Go through all modules, and for each module perform the following checklist. We can create 1 PR for maybe 2-3 modules.
sdk.*bech32*functions in modules (e.g.sdk.Bech32ifyAddressBytes,sdk.AccAddressFromBech32), and replace them with a call to x/auth keeper method.Step 3. Cleanup.
sdk.*bech32*from non-module code.types/address.go.Some other TODOs:
Remove address verifier from global config, put it as argument to NewAccountKeeper
Support cosmos.msg.v1.signer as alternative to Msg.GetSigners #11275
For Admin Use
The text was updated successfully, but these errors were encountered: