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

docs(x/auth): vesting (backport #21715) #21716

Merged
merged 1 commit into from
Sep 13, 2024
Merged

docs(x/auth): vesting (backport #21715) #21716

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions UPGRADING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,11 @@ Most of Cosmos SDK modules have migrated to [collections](https://docs.cosmos.ne
Many functions have been removed due to this changes as the API can be smaller thanks to collections.
For modules that have migrated, verify you are checking against `collections.ErrNotFound` when applicable.

#### `x/auth`

Vesting accounts messages (and CLIs) have been removed. Existing vesting accounts will keep working but no new vesting accounts can be created.
Use `x/accounts` lockup accounts or implement an `x/accounts` vesting account instead.

#### `x/accounts`

Accounts's AccountNumber will be used as a global account number tracking replacing Auth legacy AccountNumber. Must set accounts's AccountNumber with auth's AccountNumber value in upgrade handler. This is done through auth keeper MigrateAccountNumber function.
Expand Down
2 changes: 1 addition & 1 deletion x/auth/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ Ref: https://keepachangelog.com/en/1.0.0/

* [#18641](https://github.com/cosmos/cosmos-sdk/pull/18641) Support the ability to broadcast unordered transactions per ADR-070. See UPGRADING.md for more details on integration.
* [#18281](https://github.com/cosmos/cosmos-sdk/pull/18281) Support broadcasting multiple transactions.
* (vesting) [#17810](https://github.com/cosmos/cosmos-sdk/pull/17810) Add the ability to specify a start time for continuous vesting accounts.

### Improvements

Expand Down Expand Up @@ -60,6 +59,7 @@ Ref: https://keepachangelog.com/en/1.0.0/

* [#18817](https://github.com/cosmos/cosmos-sdk/pull/18817) SigVerification, GasConsumption, IncreaseSequence ante decorators have all been joined into one SigVerification decorator. Gas consumption during TX validation flow has reduced.
* [#19093](https://github.com/cosmos/cosmos-sdk/pull/19093) SetPubKeyDecorator was merged into SigVerification, gas consumption is almost halved for a simple tx.
* [#19535](https://github.com/cosmos/cosmos-sdk/pull/19535) Remove vesting account creation when the chain is running. The accounts module is required for creating [#vesting accounts](../accounts/defaults/lockup/README.md) on a running chain.

### Bug Fixes

Expand Down
6 changes: 6 additions & 0 deletions x/auth/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,12 @@ message BaseAccount {

### Vesting Account

:::warning
Vesting accounts are deprecated in favor of `x/accounts`.
The creation of vesting account, using `x/auth/vesting`, is not possible since v0.52.
For existing chains, importing the `x/auth/vesting module` is still required for backward compatibility purposes.
:::

See [Vesting](https://docs.cosmos.network/main/modules/auth/vesting/).

## AnteHandlers
Expand Down
6 changes: 3 additions & 3 deletions x/auth/vesting/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ sidebar_position: 1
# `x/auth/vesting`

:::warning
This module is deprecated in favor of x/accounts.
The creation of vesting account, using x/auth/vesting, is not possible since v0.51.
For existing chains, importing the x/auth/vesting module is still required for backward compatibility purposes.
Vesting accounts are deprecated in favor of `x/accounts`.
The creation of vesting account, using `x/auth/vesting`, is not possible since v0.52.
For existing chains, importing the `x/auth/vesting module` is still required for backward compatibility purposes.
:::

* [Intro and Requirements](#intro-and-requirements)
Expand Down
Loading