refactor(x/auth): Decouple store from auth module #21405

sontrinh16 · 2024-08-26T13:36:17Z

Description

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, you can find examples of the prefixes below:
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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

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

coderabbitai · 2024-08-26T13:36:24Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions · 2024-08-28T08:41:47Z

types/context.go

 	return c
 }

+// WithNewGasMeter returns a Context with a newly created transaction GasMeter.
+func (c Context) WithNewGasMeter(gaslimit storetypes.Gas) Context {
+	c.gasMeter = storetypes.NewGasMeter(gaslimit)
+	return c


Change potentially affects state.

Call sequence:

(github.com/cosmos/cosmos-sdk/types.Context).WithBlockGasMeter (types/context.go:224) (*github.com/cosmos/cosmos-sdk/baseapp.BaseApp).PrepareProposal (types/context.go:393)

tac0turtle · 2024-08-28T09:44:10Z

core/gas/service.go

@@ -38,6 +38,7 @@ type Meter interface {
 	Consume(amount Gas, descriptor string) error
 	Refund(amount Gas, descriptor string) error
 	Remaining() Gas
+	Consumed() Gas


should avoid adding this

i thinks return remaining in consumed is not corect since remaining implied limit - consumed but we need to get the consumed amount only

#21440 & #21440 (comment) :D

It's in stf implementation too

cosmos-sdk/server/v2/stf/gas/meter.go

Line 24 in 355f4d7

func (m *Meter) Consumed() gas.Gas {

, so i'd say it is great to add indeed and fix the issue of the Remaining usage as well.

yeah i was plugging SDKGasMeter in the test and got weird output

sontrinh16 · 2024-08-28T10:07:52Z

runtime/gas.go

+		gm: gm,
+	}
+}
+
 func (gm SDKGasMeter) GasConsumed() storetypes.Gas {


@tac0turtle this is where i think we need a consumed API

julienrbrt · 2024-08-28T12:35:14Z

core/store/snapshot.go

Let's not move this to core, auth could have its own expected interface that store/(v2) implements

julienrbrt · 2024-08-28T12:35:35Z

types/context.go

@@ -220,6 +220,18 @@ func (c Context) WithGasMeter(meter storetypes.GasMeter) Context {
 	return c
 }

+// WithNewGasMeter returns a Context with a newly created transaction GasMeter.


imho we shouldn't add anything to sdk.Context. We want to move away from it.

julienrbrt · 2024-08-28T12:36:17Z

runtime/store.go

@@ -16,6 +16,14 @@ func NewKVStoreService(storeKey *storetypes.KVStoreKey) store.KVStoreService {
 	return &kvStoreService{key: storeKey}
 }

+func NewKVStoreKey(name string) *storetypes.KVStoreKey {


Why do we need this? Shouldn't we use the mock kvstore service from core/testing in tests? Plus that removes no dependencies, it just makes it indirect.

yeah i can move some of the core test stuff from Marko PR in to remove the use of storekey

julienrbrt · 2024-08-28T12:37:34Z

types/gas.go

+)
+
+// Wrapper errors for store/v1 ErrorOutOfGas, ErrorNegativeGasConsumed and ErrorGasOverflow so that
+// modules don't have to import storev1 directly.


I'd rather have module import store tan the SDK tbh (my t.wo cents)
Can we avoid adding stuff in the SDK?

hmmmm if we use stf gas implementation then we can avoid import storetypes ErrorOutOfGas all together (so i dont have to wrapped it here). But then we need to add a wrapper for the legacy sdkCtx gas meter, the problem is that the wrapper is in runtime

sontrinh16 added 5 commits August 26, 2024 17:07

remove store/v1 import

060a014

merge main

fadb7a9

fix tests

77e255b

minor

fcf9e67

minor

1eac6e9

github-actions bot added C:x/auth C:core/testing labels Aug 26, 2024

add ctx new gas meter

839870c

github-actions bot reviewed Aug 28, 2024

View reviewed changes

sontrinh16 added 2 commits August 28, 2024 15:45

minor

2aded01

minor

4ec51db

tac0turtle reviewed Aug 28, 2024

View reviewed changes

sontrinh16 commented Aug 28, 2024

View reviewed changes

sontrinh16 added 3 commits August 28, 2024 17:40

wrapper error

9b6e081

go mod tidy

9e79102

more tidy

a080b27

julienrbrt reviewed Aug 28, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(x/auth): Decouple store from auth module #21405

refactor(x/auth): Decouple store from auth module #21405

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

Documentation and Community

refactor(x/auth): Decouple store from auth module #21405

Are you sure you want to change the base?

refactor(x/auth): Decouple store from auth module #21405

Conversation

Description

Author Checklist

Reviewers Checklist

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

Documentation and Community

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment