feat: add endblocker with valsetupdate type #15829

tac0turtle · 2023-04-13T10:07:50Z

Description

This pr adds valset updating to the module manager in the shape of a endblocker interface

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...

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 ! 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)

runtime/app.go

x/staking/keeper/abci.go

x/staking/module.go

@@ -191,13 +189,15 @@
 // BeginBlock returns the begin blocker for the staking module.
 func (am AppModule) BeginBlock(ctx context.Context) error {
 	c := sdk.UnwrapSDKContext(ctx)
-	BeginBlocker(c, am.keeper)
+
+	am.keeper.BeginBlocker(c)


x/staking/keeper/abci.go

github-actions · 2023-04-13T11:55:15Z

baseapp/abci.go

 		}
 	}

+	// set the validator set for the next block
+	res.ValidatorUpdates = app.updatedValidators
+
 	return res


Change potentially affects state.

Call sequence:

(*github.com/cosmos/cosmos-sdk/baseapp.BaseApp).EndBlock (baseapp/abci.go:229)

x/staking/keeper/abci.go

x/staking/module.go

aaronc · 2023-04-13T13:16:24Z

runtime/app.go

@@ -52,6 +51,8 @@ type App struct {
 	// initChainer is the init chainer function defined by the app config.
 	// this is only required if the chain wants to add special InitChainer logic.
 	initChainer sdk.InitChainer
+
+	ValSetUpdate []abci.ValidatorUpdate


why is this needed?

aaronc · 2023-04-13T13:17:48Z

baseapp/abci.go

@@ -252,6 +252,9 @@ func (app *BaseApp) EndBlock(req abci.RequestEndBlock) (res abci.ResponseEndBloc
 		}
 	}

+	// set the validator set for the next block
+	res.ValidatorUpdates = app.updatedValidators


The challenge is that this overwrites updates in the case where the app is not using the update service. So we need to have some bool flag on the update service to indicate that updates have been set I think

alexanderbez

This level of abstraction doesn't make sense to me personally.

alexanderbez · 2023-04-13T13:17:17Z

baseapp/abci.go

@@ -252,6 +252,9 @@ func (app *BaseApp) EndBlock(req abci.RequestEndBlock) (res abci.ResponseEndBloc
 		}
 	}

+	// set the validator set for the next block


Nice!

QQ: When is res, err = app.endBlocker(app.deliverState.ctx, req) going to become err = app.endBlocker(app.deliverState.ctx, req)? i.e. when are we removing the ResponseEndBlock types from core's EndBlock API?

alexanderbez · 2023-04-13T13:18:55Z

baseapp/valset_update.go

+	abci "github.com/cometbft/cometbft/abci/types"
+)
+
+// ValidatorUpdateService is the service that runtime will provide to the module that sets validator updates.


I thought BaseApp would just have a reference to the service, which is defined in runtime? Why is this being defined in BaseApp?

x/staking/testutil/helpers.go

 	return sh.Ctx
 }

 // TurnBlockTimeDiff calls EndBlocker and updates the block time by adding the
 // duration to the current block time
 func (sh *Helper) TurnBlockTimeDiff(diff time.Duration) sdk.Context {
 	sh.Ctx = sh.Ctx.WithBlockTime(sh.Ctx.BlockHeader().Time.Add(diff))
-	staking.EndBlocker(sh.Ctx, sh.k)
+	sh.k.EndBlocker(sh.Ctx)


x/staking/testutil/helpers.go

@@ -127,15 +126,15 @@
 // TurnBlock calls EndBlocker and updates the block time
 func (sh *Helper) TurnBlock(newTime time.Time) sdk.Context {
 	sh.Ctx = sh.Ctx.WithBlockTime(newTime)
-	staking.EndBlocker(sh.Ctx, sh.k)
+	sh.k.EndBlocker(sh.Ctx)


tac0turtle · 2023-04-13T15:16:48Z

proto/cosmos/base/abci/v1beta1/abci.proto

+message ValidatorUpdate {
+  option (gogoproto.stringer) = true;
+
+  tendermint.crypto.PublicKey pub_key = 1 [(gogoproto.nullable) = false];
+  int64                       power   = 2;
+}


we only need this type to make it work, should we just depend on comet for it? @aaronc @alexanderbez

The pubkey? I think that's fine

The validator update type

If we're defining parts of ABCI ourselves, I would say let's define the entire type, no?

since this endblock is tied to comet i may leave it for now.

x/staking/keeper/abci.go

 	defer telemetry.ModuleMeasureSince(types.ModuleName, time.Now(), telemetry.MetricKeyEndBlocker)

-	return k.BlockValidatorUpdates(ctx)
+	return k.BlockValidatorUpdates(sdk.UnwrapSDKContext(ctx)), nil


x/staking/module.go

-func (am AppModule) EndBlock(ctx sdk.Context, _ abci.RequestEndBlock) []abci.ValidatorUpdate {
-	return EndBlocker(ctx, am.keeper)
+func (am AppModule) EndBlock(ctx context.Context) ([]sdk.ValidatorUpdate, error) {
+	return am.keeper.EndBlocker(ctx)


types/module/module.go

@@ -695,6 +701,22 @@
 			if err != nil {
 				return abci.ResponseEndBlock{}, err
 			}
+		} else if module, ok := m.Modules[moduleName].(HasABCIEndblock); ok {
+			moduleValUpdates, err := module.EndBlock(ctx)


alexanderbez · 2023-04-13T16:09:05Z

proto/cosmos/base/abci/v1beta1/abci.proto

+message ValidatorUpdate {
+  option (gogoproto.stringer) = true;
+
+  tendermint.crypto.PublicKey pub_key = 1 [(gogoproto.nullable) = false];
+  int64                       power   = 2;
+}


The pubkey? I think that's fine

julienrbrt · 2023-04-14T09:49:26Z

types/module/module.go

@@ -212,6 +213,11 @@ type EndBlockAppModule interface {
 	EndBlock(sdk.Context, abci.RequestEndBlock) []abci.ValidatorUpdate
 }

+type HasABCIEndblock interface {


Do we have somewhere something that explains the difference between:

HasABCIEndblock, EndBlockAppModule and HasEndBlocker?

Those 3 extension interfaces doing seemingly the same thing (I know they don't but still) could get confusing.

Small nit on that new extension interface, I think it should have had a capital B for block for consistency with the other 2.

the one above gets removed in another pr. Left a todo for when we do docs on core api

add setvalidator set update in staking

7e297f4

github-actions bot added C:x/feegrant C:x/staking labels Apr 13, 2023

github-advanced-security bot found potential problems Apr 13, 2023

View reviewed changes

different approach

2adba9d

github-actions bot reviewed Apr 13, 2023

View reviewed changes

tac0turtle added 2 commits April 13, 2023 13:55

cleanup

7afe9b9

Merge branch 'main' into marko/valsetupdate

8d970e7

tac0turtle marked this pull request as ready for review April 13, 2023 11:56

tac0turtle requested a review from a team as a code owner April 13, 2023 11:56

tac0turtle assigned aaronc and alexanderbez Apr 13, 2023

This comment has been minimized.

Sign in to view

github-advanced-security bot found potential problems Apr 13, 2023

View reviewed changes

x/staking/keeper/abci.go Fixed Show fixed Hide fixed

x/staking/module.go Fixed Show fixed Hide fixed

aaronc reviewed Apr 13, 2023

View reviewed changes

alexanderbez reviewed Apr 13, 2023

View reviewed changes

tac0turtle added 2 commits April 13, 2023 16:56

cleanup

b2e6188

cleanup

ccfe454

github-advanced-security bot found potential problems Apr 13, 2023

View reviewed changes

define type

475a4c2

tac0turtle commented Apr 13, 2023

View reviewed changes

tac0turtle changed the title ~~feat: add validatorset update in runtime~~ feat: add endblocker with valsetupdate type Apr 13, 2023

github-advanced-security bot found potential problems Apr 13, 2023

View reviewed changes

alexanderbez approved these changes Apr 13, 2023

View reviewed changes

fix a few things

c4d0e22

github-actions bot added C:x/auth C:x/gov C:x/slashing labels Apr 14, 2023

tac0turtle added 2 commits April 14, 2023 11:11

changelog and todo

74ecd2a

Merge branch 'main' into marko/valsetupdate

68bf01a

tac0turtle enabled auto-merge (squash) April 14, 2023 09:20

tac0turtle merged commit 8d6c23f into main Apr 14, 2023

tac0turtle deleted the marko/valsetupdate branch April 14, 2023 09:41

julienrbrt reviewed Apr 14, 2023

View reviewed changes

cool-develope pushed a commit that referenced this pull request Apr 26, 2023

feat: add endblocker with valsetupdate type (#15829)

15271ad

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add endblocker with valsetupdate type #15829

feat: add endblocker with valsetupdate type #15829

tac0turtle commented Apr 13, 2023 •

edited

Loading

github-actions bot Apr 13, 2023

This comment has been minimized.

aaronc Apr 13, 2023

aaronc Apr 13, 2023

alexanderbez left a comment

alexanderbez Apr 13, 2023

alexanderbez Apr 13, 2023

tac0turtle Apr 13, 2023

alexanderbez Apr 13, 2023

tac0turtle Apr 13, 2023 •

edited

Loading

alexanderbez Apr 13, 2023

tac0turtle Apr 14, 2023

alexanderbez Apr 13, 2023

julienrbrt Apr 14, 2023 •

edited

Loading

tac0turtle Apr 14, 2023

feat: add endblocker with valsetupdate type #15829

feat: add endblocker with valsetupdate type #15829

Conversation

tac0turtle commented Apr 13, 2023 • edited Loading

Description

Author Checklist

Reviewers Checklist

github-actions bot Apr 13, 2023

Choose a reason for hiding this comment

This comment has been minimized.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexanderbez left a 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

tac0turtle Apr 13, 2023 • edited Loading

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

julienrbrt Apr 14, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tac0turtle commented Apr 13, 2023 •

edited

Loading

tac0turtle Apr 13, 2023 •

edited

Loading

julienrbrt Apr 14, 2023 •

edited

Loading