feat(sequencer): set/update reward addr

go.mod

@@ -302,3 +302,5 @@ replace (
 	github.com/syndtr/goleveldb => github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7
 	github.com/tendermint/tendermint => github.com/cometbft/cometbft v0.34.28
 )
+
+replace github.com/osmosis-labs/osmosis/v15 => github.com/dymensionxyz/osmosis/v15 v15.2.0-dymension-v1.1.2

proto/sequencers/genesis.proto

@@ -4,15 +4,10 @@ package rollapp.sequencers.types;
 import "gogoproto/gogo.proto";
 import "sequencers/params.proto";
 
-// this line is used by starport scaffolding # genesis/proto/import
-
 option go_package = "github.com/dymensionxyz/dymension-rdk/x/sequencers/types";
 
-// GenesisState defines the test module's genesis state.
+// GenesisState defines the module's genesis state.
 message GenesisState {
   Params params = 1 [ (gogoproto.nullable) = false ];
-
-  // genesis_operator_address defines the genesis operator address of the
-  // sequencer.
-  string genesis_operator_address = 2;
+  reserved 2;
 }

proto/sequencers/query.proto

@@ -8,7 +8,6 @@ import "google/api/annotations.proto";
 import "cosmos/base/query/v1beta1/pagination.proto";
 import "sequencers/params.proto";
 
-// this line is used by starport scaffolding # 1
 
 option go_package = "github.com/dymensionxyz/dymension-rdk/x/sequencers/types";
 
@@ -93,4 +92,3 @@ message QueryParamsResponse {
   Params params = 1 [ (gogoproto.nullable) = false ];
 }
 
-// this line is used by starport scaffolding # 3

proto/sequencers/tx.proto

@@ -0,0 +1,73 @@
+syntax = "proto3";
+package rollapp.sequencers.types;
+
+import "gogoproto/gogo.proto";
+import "cosmos/staking/v1beta1/staking.proto";
+//import "types/tendermint/crypto/keys.proto";
+import "cosmos/msg/v1/msg.proto";
+import "google/protobuf/any.proto";
+
+// TODO: use sequencer object?
+// Sequencer - only the
+// cosmos.staking.v1beta1.Validator sequencer = 1
+// [ (gogoproto.nullable) = false ];
+
+option go_package = "github.com/dymensionxyz/dymension-rdk/x/sequencers/types";
+
+// Msg defines the Msg service.
+service Msg {
+    rpc CreateSequencer(MsgCreateSequencer) returns (MsgCreateSequencerResponse);
+    rpc UpdateSequencer(MsgUpdateSequencer) returns (MsgUpdateSequencerResponse);
+}
+
+// PayloadToSign is marshalled and signed
+message PayloadToSign {
+    // PayloadApp is application specific signed data
+    bytes payload_app = 1;
+    // ChainId will be verified against processing chain
+    string chain_id = 2;
+    // AccountNumber is the auth account keeper account number, it is verified against the message creator
+    uint64 account_number = 3;
+}
+
+message KeyAndSig {
+    google.protobuf.Any pub_key = 1;
+//    tendermint.crypto.PublicKey pub_key = 1 [(gogoproto.nullable) = false];
+    bytes signature = 2; // signature for some <payload, chain id, account number, account addr, sequence num> // TODO: not seq num
+}
+
+message CreateSequencerPayload {
+    string operator_addr = 1; // TODO: document
+}
+
+message MsgCreateSequencer {
+    option (cosmos.msg.v1.signer) = "creator";
+    // Creator is the bech32-encoded address of the actor sending the update
+    string creator = 1;
+    // KeyAndSig has the cons key of the sequencer, as well as a sig over the payload and some replay protection metadata
+    KeyAndSig key_and_sig = 2;
+    // Payload - signature is in key and sig
+    CreateSequencerPayload payload = 3;
+}
+
+message MsgCreateSequencerResponse {
+
+}
+
+message UpdateSequencerPayload {
+    string reward_addr = 1;
+}
+
+message MsgUpdateSequencer {
+    option (cosmos.msg.v1.signer) = "creator";
+    // Creator is the bech32-encoded address of the actor sending the update
+    string creator = 1;
+    // KeyAndSig has the cons key of the sequencer, as well as a sig over the payload and some replay protection metadata
+    KeyAndSig key_and_sig = 2;
+    // Payload - signature is in key and sig
+    UpdateSequencerPayload payload = 3;
+}
+
+message MsgUpdateSequencerResponse {
+
+}

testutil/app/app.go

@@ -746,7 +746,7 @@ func (app *App) InitChainer(ctx sdk.Context, req abci.RequestInitChain) abci.Res
 	}
 
 	// Passing the dymint sequencers to the sequencer module from RequestInitChain
-	app.SequencersKeeper.SetDymintSequencers(ctx, req.Validators)
+	app.SequencersKeeper.SetDymintValidatorUpdates(ctx, req.Validators)
 
 	app.UpgradeKeeper.SetModuleVersionMap(ctx, app.mm.GetVersionMap())
 	res := app.mm.InitGenesis(ctx, app.appCodec, genesisState)

x/dist/keeper/allocation.go

@@ -29,27 +29,27 @@ func (k Keeper) AllocateTokens(ctx sdk.Context, blockProposer sdk.ConsAddress) {
 
 	/* ---------------------------- Pay the proposer ---------------------------- */
 	// calculate and pay proposer reward
-	proposer, found := k.seqKeeper.GetSequencerByConsAddr(ctx, blockProposer)
+	addr, found := k.seqKeeper.GetRewardAddrByConsAddr(ctx, blockProposer)
 	if !found {
-		logger.Error("failed to find the validator for this block. reward not allocated")
+		logger.Error("Finding the validator for this block. Reward not allocated.")
 	} else {
 		proposerReward := feesCollected.MulDecTruncate(k.GetBaseProposerReward(ctx))
 		proposerCoins, proposerRemainder := proposerReward.TruncateDecimal()
-
-		err := k.AllocateTokensToSequencer(ctx, proposer, proposerCoins)
-		if err != nil {
-			logger.Error("failed to reward proposer", "error", err, "proposer", proposer.GetOperator())
-		} else {
-			remainingFees = feesCollected.Sub(proposerReward).Add(proposerRemainder...)
-
-			// update outstanding rewards
-			ctx.EventManager().EmitEvent(
-				sdk.NewEvent(
-					disttypes.EventTypeDistSequencerRewards,
-					sdk.NewAttribute(sdk.AttributeKeyAmount, proposerCoins.String()),
-					sdk.NewAttribute(disttypes.AttributeKeySequencer, proposer.GetOperator().String()),
-				),
-			)
+		if !proposerCoins.IsZero() {
+			err := k.bankKeeper.SendCoinsFromModuleToAccount(ctx, types.ModuleName, addr, proposerCoins)
+			if err != nil {
+				logger.Error("Send rewards to proposer.", "err", err, "proposer reward addr", addr)
+			} else {
+				remainingFees = feesCollected.Sub(proposerReward).Add(proposerRemainder...)
+				// update outstanding rewards
+				ctx.EventManager().EmitEvent(
+					sdk.NewEvent(
+						disttypes.EventTypeDistSequencerRewards,
+						sdk.NewAttribute(sdk.AttributeKeyAmount, proposerCoins.String()),
+						sdk.NewAttribute(disttypes.AttributeKeyRewardee, addr.String()),
+					),
+				)
+			}
 		}
 	}
 
@@ -75,11 +75,3 @@ func (k Keeper) AllocateTokens(ctx sdk.Context, blockProposer sdk.ConsAddress) {
 	feePool.CommunityPool = feePool.CommunityPool.Add(remainingFees...)
 	k.SetFeePool(ctx, feePool)
 }
-
-func (k Keeper) AllocateTokensToSequencer(ctx sdk.Context, val stakingtypes.ValidatorI, tokens sdk.Coins) error {
-	if tokens.IsZero() {
-		return nil
-	}
-	accAddr := sdk.AccAddress(val.GetOperator())
-	return k.bankKeeper.SendCoinsFromModuleToAccount(ctx, types.ModuleName, accAddr, tokens)
-}

x/dist/module.go

@@ -22,7 +22,7 @@ var (
 	_ module.AppModuleSimulation = AppModule{}
 )
 
-// AppModule embeds the Cosmos SDK's x/distribution AppModuleBasic.
+// AppModuleBasic embeds the Cosmos SDK's x/distribution AppModuleBasic.
 type AppModuleBasic struct {
 	distribution.AppModuleBasic
 }
@@ -71,7 +71,7 @@ func (am AppModule) BeginBlock(ctx sdk.Context, req abci.RequestBeginBlock) {
 func (am AppModuleBasic) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage {
 	defGenesis := types.DefaultGenesisState()
 
-	// by default, all rewards goes to the governers
+	// by default, all rewards goes to the governors
 	defGenesis.Params.CommunityTax = sdk.ZeroDec()
 	defGenesis.Params.BaseProposerReward = sdk.ZeroDec()
 	defGenesis.Params.BonusProposerReward = sdk.ZeroDec()

x/dist/types/events.go

@@ -3,5 +3,5 @@ package types
 // Minting module event types.
 const (
 	EventTypeDistSequencerRewards = "sequencer_rewards"
-	AttributeKeySequencer         = "sequencer"
+	AttributeKeyRewardee          = "rewardee"
 )

x/dist/types/expected_keepers.go

@@ -9,17 +9,17 @@ import (
 
 // SequencerKeeper expected sequencer keeper (noalias)
 type SequencerKeeper interface {
-	GetSequencerByConsAddr(ctx sdk.Context, consAddr sdk.ConsAddress) (stakingtypes.Validator, bool)
+	GetRewardAddrByConsAddr(ctx sdk.Context, consAddr sdk.ConsAddress) (sdk.AccAddress, bool)
 }
 
 // StakingKeeper expected staking keeper (noalias)
 type StakingKeeper interface {
 	GetLastTotalPower(ctx sdk.Context) math.Int
 
-	// iterate through validators by operator address, execute func for each validator
+	// IterateValidators iterate through validators by operator address, execute func for each validator
 	IterateValidators(sdk.Context,
 		func(index int64, validator stakingtypes.ValidatorI) (stop bool))
-	// iterate through bonded validators by operator address, execute func for each validator
+	// IterateBondedValidatorsByPower iterate through bonded validators by operator address, execute func for each validator
 	IterateBondedValidatorsByPower(sdk.Context,
 		func(index int64, validator stakingtypes.ValidatorI) (stop bool))
 

x/sequencers/client/cli/query.go

@@ -7,7 +7,7 @@
 	"fmt"
 
 	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/dymensionxyz/dymension-rdk/x/sequencers/types"
 	"github.com/spf13/cobra"
 )
 
@@ -25,11 +25,8 @@
 	cmd.AddCommand(CmdQuerySequencers())
 	cmd.AddCommand(CmdQuerySequencer())
 
-	// TODO:
-	// cmd.AddCommand(CmdQueryHistoricalInfo())
-	// Add queries for specific sequencer (num of blocks, rewards, etc..)
-
-	// this line is used by starport scaffolding # 1
+	// TODO: historical info
+	// TODO: Add queries for specific sequencer (num of blocks, rewards, etc..)
 
 	return cmd
 }

x/sequencers/handler.go

@@ -0,0 +1,28 @@
+package sequencers
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+	"github.com/dymensionxyz/dymension-rdk/x/sequencers/keeper"
+	"github.com/dymensionxyz/dymension-rdk/x/sequencers/types"
+)
+
+// NewHandler returns a new msg handler.
+func NewHandler(k keeper.Keeper) sdk.Handler {
+	msgServer := keeper.NewMsgServerImpl(k)
+
+	return func(ctx sdk.Context, msg sdk.Msg) (*sdk.Result, error) {
+		ctx = ctx.WithEventManager(sdk.NewEventManager())
+
+		switch msg := msg.(type) {
+		case *types.MsgCreateSequencer:
+			res, err := msgServer.CreateSequencer(sdk.WrapSDKContext(ctx), msg)
+			return sdk.WrapServiceResult(ctx, res, err)
+		case *types.MsgUpdateSequencer:
+			res, err := msgServer.UpdateSequencer(sdk.WrapSDKContext(ctx), msg)
+			return sdk.WrapServiceResult(ctx, res, err)
+		default:
+			return nil, sdkerrors.Wrapf(sdkerrors.ErrUnknownRequest, "unrecognized %s message type: %T", types.ModuleName, msg)
+		}
+	}
+}

x/sequencers/keeper/dymint.go

@@ -1,54 +1,21 @@
 package keeper
 
 import (
+	errorsmod "cosmossdk.io/errors"
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/dymensionxyz/gerr-cosmos/gerrc"
 	abci "github.com/tendermint/tendermint/abci/types"
 
 	"github.com/dymensionxyz/dymension-rdk/x/sequencers/types"
-
-	cryptocodec "github.com/cosmos/cosmos-sdk/crypto/codec"
-	tmcrypto "github.com/tendermint/tendermint/crypto/encoding"
 )
 
-// SetDymintSequencers sets the sequencers set by dymint on InitChain.
-// As currently we're using the abci InitChain, there are 2 obstacles we need to face, unlike when creating a validator:
-// 1. InitChain expected the validatorUpdate it gets in return to be the same as it sends
-// 2. We need someway to set the operator address, which is the address that will be used for rewards for the sequencer.
-// To overcome those obstacles, we do the following:
-//  1. Upon InitChain, call SetDymintSequencers and create a dummy sequencer object with the consensus pubkey and power we get from the validatorUpdate.
-//  2. Afterwards, upon initGenesis, we build a validator-like object where the operator address is the one we set in the genesis file and the
-//     consensus pubkey and power are the ones we set in the dummy sequencer object.
-//
-// At the end we delete the dummy sequencer object.
-func (k Keeper) SetDymintSequencers(ctx sdk.Context, sequencers []abci.ValidatorUpdate) {
-	if len := len(sequencers); len != 1 {
-		switch len {
-		case 0:
-			panic(types.ErrNoSequencerOnInitChain)
-		default:
-			panic(types.ErrMultipleDymintSequencers)
-		}
-	}
-	seq := sequencers[0]
-
-	tmkey, err := tmcrypto.PubKeyFromProto(seq.PubKey)
-	if err != nil {
-		panic(err)
-	}
-	pubKey, err := cryptocodec.FromTmPubKeyInterface(tmkey)
-	if err != nil {
-		panic(err)
-	}
-
-	// On InitChain we only have the consesnsus pubkey, so we set the operator address to a dummy value
-	sequencer, err := types.NewSequencer(sdk.ValAddress(types.InitChainStubAddr), pubKey, seq.Power)
-	if err != nil {
-		panic(err)
-	}
-
-	k.SetSequencer(ctx, sequencer)
-	err = k.SetSequencerByConsAddr(ctx, sequencer)
-	if err != nil {
-		panic(err)
+// SetDymintValidatorUpdates  - ABCI expects the result of init genesis to return the same value as passed in InitChainer,
+// so we save it to return later.
+func (k Keeper) SetDymintValidatorUpdates(ctx sdk.Context, updates []abci.ValidatorUpdate) {
+	if len(updates) != 1 {
+		panic(errorsmod.Wrapf(gerrc.ErrOutOfRange, "expect 1 abci validator update: got: %d", len(updates)))
 	}
+	u := updates[0]
+	k.cdc.MustMarshal(&u)
+	ctx.KVStore(k.storeKey).Set(types.ValidatorUpdateKey, k.cdc.MustMarshal(&u))
 }