-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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.
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
feat(auth): allow BaseAccounts to be migrated to x/accounts #21820
Open
testinginprod
wants to merge
8
commits into
main
Choose a base branch
from
tip/auth/migrate_to_accounts
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+2,209
−136
Open
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
047ef79
checkpoint
testinginprod 45c2546
finalize testing et all
testinginprod 5cac757
lints <3
testinginprod edcf798
add upgrade notes
testinginprod 4dcc4d5
better docs
testinginprod 5b02e74
CHANGELOG.md
testinginprod 9523268
Merge branch 'main' into tip/auth/migrate_to_accounts
testinginprod fbec402
merge main
testinginprod File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -936,6 +936,55 @@ To find out more please read the [signer field](https://github.com/cosmos/cosmos | |||||
|
||||||
For ante handler construction via `ante.NewAnteHandler`, the field `ante.HandlerOptions.SignModeHandler` has been updated to `x/tx/signing/HandlerMap` from `x/auth/signing/SignModeHandler`. Callers typically fetch this value from `client.TxConfig.SignModeHandler()` (which is also changed) so this change should be transparent to most users. | ||||||
|
||||||
#### Account Migration Guide: x/auth to x/accounts | ||||||
|
||||||
Users can now migrate accounts from `x/auth` to `x/accounts` using the `auth.MsgMigrateAccount` message. Currently, this migration is only supported for `BaseAccount` due to security considerations. | ||||||
|
||||||
##### Migration Process | ||||||
|
||||||
The migration process allows an auth BaseAccount to migrate to any kind of x/accounts supported acocunt type, here we will show how to migrate from a legacy x/auth `BaseAccount` to a `x/accounts` `BaseAccount` | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
###### Migrating to x/accounts/defaults/base | ||||||
|
||||||
To migrate to the `BaseAccount` in `x/accounts`, follow these steps: | ||||||
|
||||||
1. Send a `basev1.MsgInit` message. | ||||||
2. This process allows you to: | ||||||
- Switch to a new public key | ||||||
- Reset your sequence number | ||||||
|
||||||
> **Important**: If you intend to keep the same public key, ensure you use your current sequence number. | ||||||
|
||||||
##### Example: x/auth.MsgMigrateAccount | ||||||
|
||||||
Here's an example of the `x/auth.MsgMigrateAccount` message structure: | ||||||
|
||||||
```json | ||||||
{ | ||||||
"signer": "cosmos1w43tr39v3lzvxz969e4ty9a74rq9nw7563tqvy", | ||||||
"account_type": "base", | ||||||
"account_init_msg": { | ||||||
"@type": "/cosmos.accounts.defaults.base.v1.MsgInit", | ||||||
"pub_key": { | ||||||
"@type": "/cosmos.crypto.secp256k1.PubKey", | ||||||
"key": "AkeoE1z32tlQyE7xpx3v+JE9XJL0trVQBFoDCn0pGl3w" | ||||||
}, | ||||||
"init_sequence": "100" | ||||||
} | ||||||
} | ||||||
``` | ||||||
|
||||||
###### Field Descriptions | ||||||
|
||||||
- `signer`: The address of the account you want to migrate from. | ||||||
- `account_type`: The new account type you want to migrate to (depends on what's installed on the chain). | ||||||
- `account_init_msg`: The custom initialization message for the new account. | ||||||
- `@type`: Specifies the type of account (in this case, x/accounts base account). | ||||||
- `pub_key`: The public key for the account. You can migrate to a different public key if desired. | ||||||
- `init_sequence`: The new sequence number for the account. | ||||||
|
||||||
> **Warning**: If you're keeping the same public key, make sure to use your current sequence number to prevent potential replay attacks. | ||||||
|
||||||
#### `x/capability` | ||||||
|
||||||
Capability has been moved to [IBC Go](https://github.com/cosmos/ibc-go). IBC v8 will contain the necessary changes to incorporate the new module location. | ||||||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wrong indentation, we need to add a
#
everywhere