feat(accounts): use account number as state prefix for account state

[testinginprod]

Description

Before this PR account state was stored as:

• account_module_store_key + account_address + state

After this PR account state is stored as:

• account_module_store_key + account_number + state.

This gives some nice properties:

• smaller state keys for accounts
• constant size prefixes

---

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 in the PR title
• confirmed ! in the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• updated the relevant documentation or specification, including comments for documenting Go code
• 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 in the PR title
• confirmed all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• New Features

  • Introduced account number field to enhance account identification and management.

• Bug Fixes

  • Adjusted account-related functions to correctly handle the new account number field.

• Documentation

  • Updated message definitions to reflect the addition of the account number field.

• Refactor

  • Improved account context creation with additional account number parameter.
  • Enhanced account state storage with composite keys for better data organization.

• Style

  • Standardized message interface naming for consistency across the codebase.

[coderabbitai]

Walkthrough

Walkthrough

The overall change involves the introduction of an AccountNumber field to the GenesisAccount structure and its handling across various functions and methods. This includes updates to the Go source code and protobuf definitions, reflecting a shift towards using a numerical identifier for accounts. The changes affect how accounts are stored, accessed, and managed within the codebase, with updates to function signatures, method calls, and data structures to accommodate the new account number field.

Changes

File(s)	Summary
api/cosmos/accounts/v1/genesis.pulsar.go x/accounts/genesis.go x/accounts/internal/implementation/context.go x/accounts/internal/implementation/context_test.go x/accounts/keeper.go	Introduced AccountNumber field to GenesisAccount and updated associated methods, function signatures, and data structures to handle the new field.
proto/cosmos/accounts/v1/genesis.proto	Modified GenesisAccount message to include account_number field and updated field numbering.
store/root/store_test.go	Added import for "cosmossdk.io/store/v2/pruning" and adjusted import order.

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• If you reply to a review comment from CodeRabbit, the bot will automatically respond.
• To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
• Note: Review comments are made on code diffs or files, not on the PR overview.
• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

[github-actions]

@testinginprod your pull request is missing a changelog!

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 8fb6205 and 2468521.

Files ignored due to filter (1)

• x/accounts/v1/genesis.pb.go

Files selected for processing (7)

• api/cosmos/accounts/v1/genesis.pulsar.go (14 hunks)
• proto/cosmos/accounts/v1/genesis.proto (1 hunks)
• store/root/store_test.go (1 hunks)
• x/accounts/genesis.go (3 hunks)
• x/accounts/internal/implementation/context.go (3 hunks)
• x/accounts/internal/implementation/context_test.go (5 hunks)
• x/accounts/keeper.go (8 hunks)

Files skipped from review due to trivial changes (1)

• store/root/store_test.go

Additional comments: 19

api/cosmos/accounts/v1/genesis.pulsar.go (5)

• 557-622: The summary mentions renaming of _GenesisAccount_3_list to _GenesisAccount_4_list, but the provided code does not show any such renaming. It only shows the final state of the code with _GenesisAccount_4_list.

• 702-707: The addition of the AccountNumber field to the GenesisAccount struct aligns with the PR objectives and the summary provided.

• 1908-1911: The summary does not mention any changes to the KVPair struct, but the provided code includes this struct.

• 699-712: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [624-1011]

The summary does not mention the fastReflection_GenesisAccount type, but the provided code includes this type and related methods.

• 1912-1925: The summary does not mention the fastReflection_KVPair type, but the provided code includes this type and related methods.

proto/cosmos/accounts/v1/genesis.proto (1)

• 18-24: The changes to the GenesisAccount message are consistent with the PR objectives and the provided summary. The addition of the account_number field and the update to the state field's number from 3 to 4 are correctly implemented.

x/accounts/genesis.go (3)

• 20-30: The addition of AccountNumber to genState and its usage in the exportAccount method call is consistent with the PR's objective to use account numbers as prefixes for state keys.

• 41-58: The changes to the exportAccount method, including the addition of AccountNumber to the GenesisAccount struct and the use of a prefixed pair range for the AccountsState.Walk method, align with the PR's objective to use account numbers as prefixes.

• 89-100: The updates to the importAccount method, including setting the account number and using it in the AccountsState.Set method call, are consistent with the PR's objective to use account numbers as prefixes for state keys.

x/accounts/internal/implementation/context.go (1)

• 66-66: Verify the length of AccountStatePrefix is intended to be 255 and that it aligns with the system's requirements for prefix lengths.

---

The new context from the shell commands shows that AccountStatePrefix is used in multiple places within the codebase:

• It is used to initialize AccountsState in keeper.go.
• It is used in a Get method call in context_test.go.
• It is declared as a new prefix with a length of 255 in context.go.
• It is used in the prefixstore.New call in context.go.

Given this usage, it seems that the length of 255 is intentional and consistently used across the system for the account state prefix. There is no indication that this length is incorrect or inconsistent with the system's requirements for prefix lengths.

Final review comment:

The length of `AccountStatePrefix` is confirmed to be intentionally set to 255 and is consistently used across the system. The changes align with the PR objectives and are correctly implemented.

x/accounts/internal/implementation/context_test.go (5)

• 5-5: The addition of the encoding/binary package is appropriate for handling binary encoding operations as per the PR's objective to change the storage method.

• 21-21: The update to the MakeAccountContext function call to use an integer for the account number is consistent with the PR's objective to use account numbers as prefixes.

• 42-44: The test correctly verifies that the account state is stored with the new prefix format, which includes the account number in big-endian format.

• 59-61: The update to the MakeAccountContext function call and the test for the module execution response are consistent with the PR's changes.

• 70-72: The update to the MakeAccountContext function call and the test for the query module response are consistent with the PR's changes.

x/accounts/keeper.go (4)

• 86-90: The AccountsState data structure has been updated to use composite keys of type collections.Pair[uint64, []byte] instead of simple []byte keys, aligning with the PR objective to use account numbers as prefixes. This change will affect how account state values are stored and accessed, ensuring a constant size for the prefixes and potentially improving the efficiency of state key storage.

• 125-130: The comment above AccountsState explains its usage for genesis import and export, providing a mapping between account numbers and account state keys to their values. This is a helpful comment for maintainability, as it clarifies the purpose of the data structure within the system.

• 158-158: The makeAccountContext function signature has been correctly updated to include the accountNumber uint64 parameter, which is used to create a context for an account. This change is consistent with the PR's objective to use account numbers in account state management.

• 365-365: The variable msgInterfaceName has been renamed from "cosmos.accounts.Msg.v1" to "cosmos.accounts.v1.MsgInterface". This change reflects a modification in the naming convention or structure of message interfaces and should be verified across the codebase to ensure consistency.

---

The variable msgInterfaceName has been successfully renamed to "cosmos.accounts.v1.MsgInterface" and is consistent within the codebase.

[alexanderbez]

LGTM

[alexanderbez]

Suggested change

// get account number

[likhita-809]

lgtm

[likhita-809]

It'd be good to add a godoc or inline comment mentioning the keys and value

[testinginprod]

this good: https://github.com/cosmos/cosmos-sdk/pull/18664/files#diff-c86def99d2ff8d9493d9ce55f86fbdba6b07ece4d3569b33d4911db0104d6274R130 ?

I can add more docs in case it's not good, lmk