From 136c8fab007d0259913b84ec0e43b6a434a4022a Mon Sep 17 00:00:00 2001 From: aljo242 Date: Fri, 10 Nov 2023 11:03:23 -0500 Subject: [PATCH 01/21] basic keeper funcs --- x/feemarket/keeper/keeper.go | 77 ++++++++++++++++++++++++++++++++++++ x/feemarket/types/keys.go | 11 +++++- 2 files changed, 86 insertions(+), 2 deletions(-) create mode 100644 x/feemarket/keeper/keeper.go diff --git a/x/feemarket/keeper/keeper.go b/x/feemarket/keeper/keeper.go new file mode 100644 index 0000000..e075ce5 --- /dev/null +++ b/x/feemarket/keeper/keeper.go @@ -0,0 +1,77 @@ +package keeper + +import ( + "fmt" + + "github.com/cometbft/cometbft/libs/log" + "github.com/cosmos/cosmos-sdk/codec" + storetypes "github.com/cosmos/cosmos-sdk/store/types" + sdk "github.com/cosmos/cosmos-sdk/types" + + "github.com/skip-mev/feemarket/x/feemarket/types" +) + +type Keeper struct { + cdc codec.BinaryCodec + storeKey storetypes.StoreKey + + // The address that is capable of executing a MsgParams message. + // Typically, this will be the governance module's address. + authority string +} + +// NewKeeper is a wrapper around NewKeeperWithRewardsAddressProvider for backwards compatibility. +func NewKeeper( + cdc codec.BinaryCodec, + storeKey storetypes.StoreKey, + authority string, +) Keeper { + return Keeper{ + cdc, + storeKey, + authority, + } +} + +// Logger returns a auction module-specific logger. +func (k Keeper) Logger(ctx sdk.Context) log.Logger { + return ctx.Logger().With("module", "x/"+types.ModuleName) +} + +// GetAuthority returns the address that is capable of executing a MsgUpdateParams message. +func (k Keeper) GetAuthority() string { + return k.authority +} + +// GetParams returns the feemarket module's parameters. +func (k Keeper) GetParams(ctx sdk.Context) (types.Params, error) { + store := ctx.KVStore(k.storeKey) + + key := types.KeyParams + bz := store.Get(key) + + if len(bz) == 0 { + return types.Params{}, fmt.Errorf("no params found for the feemarket module") + } + + params := types.Params{} + if err := params.Unmarshal(bz); err != nil { + return types.Params{}, err + } + + return params, nil +} + +// SetParams sets the feemarket module's parameters. +func (k Keeper) SetParams(ctx sdk.Context, params types.Params) error { + store := ctx.KVStore(k.storeKey) + + bz, err := params.Marshal() + if err != nil { + return err + } + + store.Set(types.KeyParams, bz) + + return nil +} diff --git a/x/feemarket/types/keys.go b/x/feemarket/types/keys.go index ead39b8..a2ca5b0 100644 --- a/x/feemarket/types/keys.go +++ b/x/feemarket/types/keys.go @@ -1,8 +1,15 @@ package types const ( - // ModuleName is the name of the module. + // ModuleName is the name of the feemarket module. ModuleName = "feemarket" - // StoreKey is the store key string for the sla module. + // StoreKey is the store key string for the feemarket module. StoreKey = ModuleName ) + +const ( + prefixParams = iota + 1 +) + +// KeyParams is the store key for the feemarket module's parameters. +var KeyParams = []byte{prefixParams} From 5ed1165d32b486632a7987a19c82bf5685fffadd Mon Sep 17 00:00:00 2001 From: aljo242 Date: Fri, 10 Nov 2023 11:07:53 -0500 Subject: [PATCH 02/21] test4 --- testutils/testutils.go | 198 ++++++++++++++++++++++++++++++ x/feemarket/keeper/keeper_test.go | 55 +++++++++ 2 files changed, 253 insertions(+) create mode 100644 testutils/testutils.go create mode 100644 x/feemarket/keeper/keeper_test.go diff --git a/testutils/testutils.go b/testutils/testutils.go new file mode 100644 index 0000000..abe9c33 --- /dev/null +++ b/testutils/testutils.go @@ -0,0 +1,198 @@ +package testutils + +import ( + "math/rand" + + "github.com/cosmos/cosmos-sdk/client" + "github.com/cosmos/cosmos-sdk/codec" + "github.com/cosmos/cosmos-sdk/codec/types" + cryptocodec "github.com/cosmos/cosmos-sdk/crypto/codec" + "github.com/cosmos/cosmos-sdk/crypto/keys/ed25519" + "github.com/cosmos/cosmos-sdk/crypto/keys/secp256k1" + cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types" + sdk "github.com/cosmos/cosmos-sdk/types" + "github.com/cosmos/cosmos-sdk/types/tx/signing" + authsigning "github.com/cosmos/cosmos-sdk/x/auth/signing" + "github.com/cosmos/cosmos-sdk/x/auth/tx" + banktypes "github.com/cosmos/cosmos-sdk/x/bank/types" + stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types" + + feemarkettypes "github.com/skip-mev/feemarket/x/feemarket/types" +) + +type EncodingConfig struct { + InterfaceRegistry types.InterfaceRegistry + Codec codec.Codec + TxConfig client.TxConfig + Amino *codec.LegacyAmino +} + +func CreateTestEncodingConfig() EncodingConfig { + cdc := codec.NewLegacyAmino() + interfaceRegistry := types.NewInterfaceRegistry() + + banktypes.RegisterInterfaces(interfaceRegistry) + cryptocodec.RegisterInterfaces(interfaceRegistry) + feemarkettypes.RegisterInterfaces(interfaceRegistry) + stakingtypes.RegisterInterfaces(interfaceRegistry) + + codec := codec.NewProtoCodec(interfaceRegistry) + + return EncodingConfig{ + InterfaceRegistry: interfaceRegistry, + Codec: codec, + TxConfig: tx.NewTxConfig(codec, tx.DefaultSignModes), + Amino: cdc, + } +} + +type Account struct { + PrivKey cryptotypes.PrivKey + PubKey cryptotypes.PubKey + Address sdk.AccAddress + ConsKey cryptotypes.PrivKey +} + +func (acc Account) Equals(acc2 Account) bool { + return acc.Address.Equals(acc2.Address) +} + +func RandomAccounts(r *rand.Rand, n int) []Account { + accs := make([]Account, n) + + for i := 0; i < n; i++ { + pkSeed := make([]byte, 15) + r.Read(pkSeed) + + accs[i].PrivKey = secp256k1.GenPrivKeyFromSecret(pkSeed) + accs[i].PubKey = accs[i].PrivKey.PubKey() + accs[i].Address = sdk.AccAddress(accs[i].PubKey.Address()) + + accs[i].ConsKey = ed25519.GenPrivKeyFromSecret(pkSeed) + } + + return accs +} + +func CreateTx(txCfg client.TxConfig, account Account, nonce, timeout uint64, msgs []sdk.Msg, fees ...sdk.Coin) (authsigning.Tx, error) { + txBuilder := txCfg.NewTxBuilder() + if err := txBuilder.SetMsgs(msgs...); err != nil { + return nil, err + } + + sigV2 := signing.SignatureV2{ + PubKey: account.PrivKey.PubKey(), + Data: &signing.SingleSignatureData{ + SignMode: signing.SignMode_SIGN_MODE_DIRECT, + Signature: nil, + }, + Sequence: nonce, + } + if err := txBuilder.SetSignatures(sigV2); err != nil { + return nil, err + } + + txBuilder.SetTimeoutHeight(timeout) + + txBuilder.SetFeeAmount(fees) + + return txBuilder.GetTx(), nil +} + +func CreateFreeTx(txCfg client.TxConfig, account Account, nonce, timeout uint64, validator string, amount sdk.Coin, fees ...sdk.Coin) (authsigning.Tx, error) { + msgs := []sdk.Msg{ + &stakingtypes.MsgDelegate{ + DelegatorAddress: account.Address.String(), + ValidatorAddress: validator, + Amount: amount, + }, + } + + return CreateTx(txCfg, account, nonce, timeout, msgs, fees...) +} + +func CreateRandomTx(txCfg client.TxConfig, account Account, nonce, numberMsgs, timeout uint64, gasLimit uint64, fees ...sdk.Coin) (authsigning.Tx, error) { + msgs := make([]sdk.Msg, numberMsgs) + for i := 0; i < int(numberMsgs); i++ { + msgs[i] = &banktypes.MsgSend{ + FromAddress: account.Address.String(), + ToAddress: account.Address.String(), + } + } + + txBuilder := txCfg.NewTxBuilder() + if err := txBuilder.SetMsgs(msgs...); err != nil { + return nil, err + } + + sigV2 := signing.SignatureV2{ + PubKey: account.PrivKey.PubKey(), + Data: &signing.SingleSignatureData{ + SignMode: signing.SignMode_SIGN_MODE_DIRECT, + Signature: nil, + }, + Sequence: nonce, + } + if err := txBuilder.SetSignatures(sigV2); err != nil { + return nil, err + } + + txBuilder.SetTimeoutHeight(timeout) + + txBuilder.SetFeeAmount(fees) + + txBuilder.SetGasLimit(gasLimit) + + return txBuilder.GetTx(), nil +} + +func CreateRandomTxBz(txCfg client.TxConfig, account Account, nonce, numberMsgs, timeout, gasLimit uint64) ([]byte, error) { + tx, err := CreateRandomTx(txCfg, account, nonce, numberMsgs, timeout, gasLimit) + if err != nil { + return nil, err + } + + return txCfg.TxEncoder()(tx) +} + +func CreateTxWithSigners(txCfg client.TxConfig, nonce, timeout uint64, signers []Account) (authsigning.Tx, error) { + msgs := []sdk.Msg{} + for _, signer := range signers { + msg := CreateRandomMsgs(signer.Address, 1) + msgs = append(msgs, msg...) + } + + txBuilder := txCfg.NewTxBuilder() + if err := txBuilder.SetMsgs(msgs...); err != nil { + return nil, err + } + + sigV2 := signing.SignatureV2{ + PubKey: signers[0].PrivKey.PubKey(), + Data: &signing.SingleSignatureData{ + SignMode: signing.SignMode_SIGN_MODE_DIRECT, + Signature: nil, + }, + Sequence: nonce, + } + + if err := txBuilder.SetSignatures(sigV2); err != nil { + return nil, err + } + + txBuilder.SetTimeoutHeight(timeout) + + return txBuilder.GetTx(), nil +} + +func CreateRandomMsgs(acc sdk.AccAddress, numberMsgs int) []sdk.Msg { + msgs := make([]sdk.Msg, numberMsgs) + for i := 0; i < numberMsgs; i++ { + msgs[i] = &banktypes.MsgSend{ + FromAddress: acc.String(), + ToAddress: acc.String(), + } + } + + return msgs +} diff --git a/x/feemarket/keeper/keeper_test.go b/x/feemarket/keeper/keeper_test.go new file mode 100644 index 0000000..8cdf021 --- /dev/null +++ b/x/feemarket/keeper/keeper_test.go @@ -0,0 +1,55 @@ +package keeper_test + +import ( + "github.com/skip-mev/feemarket/x/feemarket/keeper" + "testing" + + storetypes "github.com/cosmos/cosmos-sdk/store/types" + "github.com/cosmos/cosmos-sdk/testutil" + sdk "github.com/cosmos/cosmos-sdk/types" + + "github.com/stretchr/testify/suite" +) + +type KeeperTestSuite struct { + suite.Suite + + auctionkeeper keeper.Keeper + encCfg testutils.EncodingConfig + ctx sdk.Context + key *storetypes.KVStoreKey + authorityAccount sdk.AccAddress +} + +func TestKeeperTestSuite(t *testing.T) { + suite.Run(t, new(KeeperTestSuite)) +} + +func (s *KeeperTestSuite) SetupTest() { + s.encCfg = testutils.CreateTestEncodingConfig() + s.key = storetypes.NewKVStoreKey(types.StoreKey) + testCtx := testutil.DefaultContextWithDB(s.T(), s.key, storetypes.NewTransientStoreKey("transient_test")) + s.ctx = testCtx.Ctx + + s.accountKeeper = mocks.NewAccountKeeper(s.T()) + s.accountKeeper.On("GetModuleAddress", types.ModuleName).Return(sdk.AccAddress{}).Maybe() + + s.bankKeeper = mocks.NewBankKeeper(s.T()) + s.distrKeeper = mocks.NewDistributionKeeper(s.T()) + s.stakingKeeper = mocks.NewStakingKeeper(s.T()) + s.authorityAccount = sdk.AccAddress([]byte("authority")) + s.auctionkeeper = keeper.NewKeeper( + s.encCfg.Codec, + s.key, + s.accountKeeper, + s.bankKeeper, + s.distrKeeper, + s.stakingKeeper, + s.authorityAccount.String(), + ) + + err := s.auctionkeeper.SetParams(s.ctx, types.DefaultParams()) + s.Require().NoError(err) + + s.msgServer = keeper.NewMsgServerImpl(s.auctionkeeper) +} From 56afdb303298f617e52db48359a74724e8eec741 Mon Sep 17 00:00:00 2001 From: aljo242 Date: Fri, 10 Nov 2023 11:15:42 -0500 Subject: [PATCH 03/21] fix test --- x/feemarket/keeper/keeper_test.go | 25 ++++++++----------------- 1 file changed, 8 insertions(+), 17 deletions(-) diff --git a/x/feemarket/keeper/keeper_test.go b/x/feemarket/keeper/keeper_test.go index 8cdf021..f6c05b2 100644 --- a/x/feemarket/keeper/keeper_test.go +++ b/x/feemarket/keeper/keeper_test.go @@ -1,7 +1,6 @@ package keeper_test import ( - "github.com/skip-mev/feemarket/x/feemarket/keeper" "testing" storetypes "github.com/cosmos/cosmos-sdk/store/types" @@ -9,12 +8,16 @@ import ( sdk "github.com/cosmos/cosmos-sdk/types" "github.com/stretchr/testify/suite" + + "github.com/skip-mev/feemarket/testutils" + "github.com/skip-mev/feemarket/x/feemarket/keeper" + "github.com/skip-mev/feemarket/x/feemarket/types" ) type KeeperTestSuite struct { suite.Suite - auctionkeeper keeper.Keeper + feemarketKeeper keeper.Keeper encCfg testutils.EncodingConfig ctx sdk.Context key *storetypes.KVStoreKey @@ -31,25 +34,13 @@ func (s *KeeperTestSuite) SetupTest() { testCtx := testutil.DefaultContextWithDB(s.T(), s.key, storetypes.NewTransientStoreKey("transient_test")) s.ctx = testCtx.Ctx - s.accountKeeper = mocks.NewAccountKeeper(s.T()) - s.accountKeeper.On("GetModuleAddress", types.ModuleName).Return(sdk.AccAddress{}).Maybe() - - s.bankKeeper = mocks.NewBankKeeper(s.T()) - s.distrKeeper = mocks.NewDistributionKeeper(s.T()) - s.stakingKeeper = mocks.NewStakingKeeper(s.T()) - s.authorityAccount = sdk.AccAddress([]byte("authority")) - s.auctionkeeper = keeper.NewKeeper( + s.authorityAccount = []byte("authority") + s.feemarketKeeper = keeper.NewKeeper( s.encCfg.Codec, s.key, - s.accountKeeper, - s.bankKeeper, - s.distrKeeper, - s.stakingKeeper, s.authorityAccount.String(), ) - err := s.auctionkeeper.SetParams(s.ctx, types.DefaultParams()) + err := s.feemarketKeeper.SetParams(s.ctx, types.DefaultParams()) s.Require().NoError(err) - - s.msgServer = keeper.NewMsgServerImpl(s.auctionkeeper) } From e2c700817b342b6d709dd20a0bdf0c3b5a3c4a20 Mon Sep 17 00:00:00 2001 From: aljo242 Date: Fri, 10 Nov 2023 11:31:57 -0500 Subject: [PATCH 04/21] test --- x/feemarket/keeper/keeper.go | 44 ++++++++++++++++++++++++++----- x/feemarket/keeper/keeper_test.go | 24 ++++++++++++++++- x/feemarket/types/keys.go | 10 +++++-- 3 files changed, 69 insertions(+), 9 deletions(-) diff --git a/x/feemarket/keeper/keeper.go b/x/feemarket/keeper/keeper.go index e075ce5..00b7b20 100644 --- a/x/feemarket/keeper/keeper.go +++ b/x/feemarket/keeper/keeper.go @@ -3,6 +3,8 @@ package keeper import ( "fmt" + "github.com/skip-mev/feemarket/x/feemarket/interfaces" + "github.com/cometbft/cometbft/libs/log" "github.com/cosmos/cosmos-sdk/codec" storetypes "github.com/cosmos/cosmos-sdk/store/types" @@ -15,6 +17,9 @@ type Keeper struct { cdc codec.BinaryCodec storeKey storetypes.StoreKey + // plugin is the fee market implementation to be used. + plugin interfaces.FeeMarketImplementation + // The address that is capable of executing a MsgParams message. // Typically, this will be the governance module's address. authority string @@ -24,27 +29,54 @@ type Keeper struct { func NewKeeper( cdc codec.BinaryCodec, storeKey storetypes.StoreKey, + plugin interfaces.FeeMarketImplementation, authority string, -) Keeper { - return Keeper{ +) *Keeper { + return &Keeper{ cdc, storeKey, + plugin, authority, } } // Logger returns a auction module-specific logger. -func (k Keeper) Logger(ctx sdk.Context) log.Logger { +func (k *Keeper) Logger(ctx sdk.Context) log.Logger { return ctx.Logger().With("module", "x/"+types.ModuleName) } // GetAuthority returns the address that is capable of executing a MsgUpdateParams message. -func (k Keeper) GetAuthority() string { +func (k *Keeper) GetAuthority() string { return k.authority } +// Plugin returns the plugged fee market implementation of the keeper. +func (k *Keeper) Plugin() interfaces.FeeMarketImplementation { + return k.plugin +} + +// SetData sets arbitrary byte data in the keeper. +func (k *Keeper) SetData(ctx sdk.Context, data []byte) { + // TODO: limit max data size? + + store := ctx.KVStore(k.storeKey) + store.Set(types.KeyData, data) +} + +// GetData gets arbitrary byte data in the keeper. +func (k *Keeper) GetData(ctx sdk.Context) ([]byte, error) { + store := ctx.KVStore(k.storeKey) + bz := store.Get(types.KeyData) + + if len(bz) == 0 { + return nil, fmt.Errorf("no data set in the keeper") + } + + return bz, nil +} + // GetParams returns the feemarket module's parameters. -func (k Keeper) GetParams(ctx sdk.Context) (types.Params, error) { +func (k *Keeper) GetParams(ctx sdk.Context) (types.Params, error) { store := ctx.KVStore(k.storeKey) key := types.KeyParams @@ -63,7 +95,7 @@ func (k Keeper) GetParams(ctx sdk.Context) (types.Params, error) { } // SetParams sets the feemarket module's parameters. -func (k Keeper) SetParams(ctx sdk.Context, params types.Params) error { +func (k *Keeper) SetParams(ctx sdk.Context, params types.Params) error { store := ctx.KVStore(k.storeKey) bz, err := params.Marshal() diff --git a/x/feemarket/keeper/keeper_test.go b/x/feemarket/keeper/keeper_test.go index f6c05b2..c04a40e 100644 --- a/x/feemarket/keeper/keeper_test.go +++ b/x/feemarket/keeper/keeper_test.go @@ -3,6 +3,8 @@ package keeper_test import ( "testing" + "github.com/skip-mev/feemarket/x/feemarket/plugins/defaultmarket" + storetypes "github.com/cosmos/cosmos-sdk/store/types" "github.com/cosmos/cosmos-sdk/testutil" sdk "github.com/cosmos/cosmos-sdk/types" @@ -17,7 +19,7 @@ import ( type KeeperTestSuite struct { suite.Suite - feemarketKeeper keeper.Keeper + feemarketKeeper *keeper.Keeper encCfg testutils.EncodingConfig ctx sdk.Context key *storetypes.KVStoreKey @@ -34,13 +36,33 @@ func (s *KeeperTestSuite) SetupTest() { testCtx := testutil.DefaultContextWithDB(s.T(), s.key, storetypes.NewTransientStoreKey("transient_test")) s.ctx = testCtx.Ctx + plugin := defaultmarket.NewDefaultFeeMarket() + s.authorityAccount = []byte("authority") s.feemarketKeeper = keeper.NewKeeper( s.encCfg.Codec, s.key, + plugin, s.authorityAccount.String(), ) err := s.feemarketKeeper.SetParams(s.ctx, types.DefaultParams()) s.Require().NoError(err) } + +func (s *KeeperTestSuite) TestData() { + s.Run("get with no data returns error", func() { + _, err := s.feemarketKeeper.GetData(s.ctx) + s.Require().Error(err) + }) + + s.Run("set and get valid data", func() { + data := []byte("testdata") + + s.feemarketKeeper.SetData(s.ctx, data) + + gotData, err := s.feemarketKeeper.GetData(s.ctx) + s.Require().NoError(err) + s.Require().Equal(data, gotData) + }) +} diff --git a/x/feemarket/types/keys.go b/x/feemarket/types/keys.go index a2ca5b0..edfcb50 100644 --- a/x/feemarket/types/keys.go +++ b/x/feemarket/types/keys.go @@ -9,7 +9,13 @@ const ( const ( prefixParams = iota + 1 + prefixData ) -// KeyParams is the store key for the feemarket module's parameters. -var KeyParams = []byte{prefixParams} +var ( + // KeyParams is the store key for the feemarket module's parameters. + KeyParams = []byte{prefixParams} + + // KeyData is the store key for the feemarket module's data. + KeyData = []byte{prefixData} +) From cb57c3ae74e1f5484bbae2cff875c0e86bf78eba Mon Sep 17 00:00:00 2001 From: aljo242 Date: Fri, 10 Nov 2023 11:46:27 -0500 Subject: [PATCH 05/21] keeper --- x/feemarket/keeper/keeper.go | 33 +++++++++++++++++++++++++++---- x/feemarket/keeper/keeper_test.go | 13 ++++++------ 2 files changed, 35 insertions(+), 11 deletions(-) diff --git a/x/feemarket/keeper/keeper.go b/x/feemarket/keeper/keeper.go index 00b7b20..550c749 100644 --- a/x/feemarket/keeper/keeper.go +++ b/x/feemarket/keeper/keeper.go @@ -32,15 +32,17 @@ func NewKeeper( plugin interfaces.FeeMarketImplementation, authority string, ) *Keeper { - return &Keeper{ + k := &Keeper{ cdc, storeKey, plugin, authority, } + + return k } -// Logger returns a auction module-specific logger. +// Logger returns a feemarket module-specific logger. func (k *Keeper) Logger(ctx sdk.Context) log.Logger { return ctx.Logger().With("module", "x/"+types.ModuleName) } @@ -55,8 +57,31 @@ func (k *Keeper) Plugin() interfaces.FeeMarketImplementation { return k.plugin } +// SetFeeMarket sets the fee market implementation data in the keeper +func (k *Keeper) SetFeeMarket(ctx sdk.Context, fm interfaces.FeeMarketImplementation) error { + bz, err := fm.Marshal() + if err != nil { + return fmt.Errorf("unable to marshal fee market implemenation: %w", err) + } + + k.setData(ctx, bz) + + return nil +} + +// GetFeeMarket gets arbitrary byte data in the keeper. +func (k *Keeper) GetFeeMarket(ctx sdk.Context) (interfaces.FeeMarketImplementation, error) { + bz, err := k.getData(ctx) + if err != nil { + return nil, err + } + + err = k.plugin.Unmarshal(bz) + return k.plugin, err +} + // SetData sets arbitrary byte data in the keeper. -func (k *Keeper) SetData(ctx sdk.Context, data []byte) { +func (k *Keeper) setData(ctx sdk.Context, data []byte) { // TODO: limit max data size? store := ctx.KVStore(k.storeKey) @@ -64,7 +89,7 @@ func (k *Keeper) SetData(ctx sdk.Context, data []byte) { } // GetData gets arbitrary byte data in the keeper. -func (k *Keeper) GetData(ctx sdk.Context) ([]byte, error) { +func (k *Keeper) getData(ctx sdk.Context) ([]byte, error) { store := ctx.KVStore(k.storeKey) bz := store.Get(types.KeyData) diff --git a/x/feemarket/keeper/keeper_test.go b/x/feemarket/keeper/keeper_test.go index c04a40e..a4a1581 100644 --- a/x/feemarket/keeper/keeper_test.go +++ b/x/feemarket/keeper/keeper_test.go @@ -50,19 +50,18 @@ func (s *KeeperTestSuite) SetupTest() { s.Require().NoError(err) } -func (s *KeeperTestSuite) TestData() { +func (s *KeeperTestSuite) TestSetFeeMarket() { s.Run("get with no data returns error", func() { - _, err := s.feemarketKeeper.GetData(s.ctx) + _, err := s.feemarketKeeper.GetFeeMarket(s.ctx) s.Require().Error(err) }) s.Run("set and get valid data", func() { - data := []byte("testdata") + plugin := defaultmarket.NewDefaultFeeMarket() + s.feemarketKeeper.SetFeeMarket(s.ctx, plugin) - s.feemarketKeeper.SetData(s.ctx, data) - - gotData, err := s.feemarketKeeper.GetData(s.ctx) + gotPlugin, err := s.feemarketKeeper.GetFeeMarket(s.ctx) s.Require().NoError(err) - s.Require().Equal(data, gotData) + s.Require().Equal(plugin, gotPlugin) }) } From de5a79afce40b8af4f3c8b11d14dbd9101ae60f4 Mon Sep 17 00:00:00 2001 From: aljo242 Date: Fri, 10 Nov 2023 11:49:05 -0500 Subject: [PATCH 06/21] beautify --- x/feemarket/keeper/keeper.go | 3 +-- x/feemarket/keeper/keeper_test.go | 3 +-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/x/feemarket/keeper/keeper.go b/x/feemarket/keeper/keeper.go index 550c749..2bdd300 100644 --- a/x/feemarket/keeper/keeper.go +++ b/x/feemarket/keeper/keeper.go @@ -3,13 +3,12 @@ package keeper import ( "fmt" - "github.com/skip-mev/feemarket/x/feemarket/interfaces" - "github.com/cometbft/cometbft/libs/log" "github.com/cosmos/cosmos-sdk/codec" storetypes "github.com/cosmos/cosmos-sdk/store/types" sdk "github.com/cosmos/cosmos-sdk/types" + "github.com/skip-mev/feemarket/x/feemarket/interfaces" "github.com/skip-mev/feemarket/x/feemarket/types" ) diff --git a/x/feemarket/keeper/keeper_test.go b/x/feemarket/keeper/keeper_test.go index a4a1581..533ad5f 100644 --- a/x/feemarket/keeper/keeper_test.go +++ b/x/feemarket/keeper/keeper_test.go @@ -3,8 +3,6 @@ package keeper_test import ( "testing" - "github.com/skip-mev/feemarket/x/feemarket/plugins/defaultmarket" - storetypes "github.com/cosmos/cosmos-sdk/store/types" "github.com/cosmos/cosmos-sdk/testutil" sdk "github.com/cosmos/cosmos-sdk/types" @@ -13,6 +11,7 @@ import ( "github.com/skip-mev/feemarket/testutils" "github.com/skip-mev/feemarket/x/feemarket/keeper" + "github.com/skip-mev/feemarket/x/feemarket/plugins/defaultmarket" "github.com/skip-mev/feemarket/x/feemarket/types" ) From 8b9e117705db3b69bb5021522e25fd875804076b Mon Sep 17 00:00:00 2001 From: aljo242 Date: Fri, 10 Nov 2023 11:50:48 -0500 Subject: [PATCH 07/21] beautify --- x/feemarket/keeper/keeper.go | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/x/feemarket/keeper/keeper.go b/x/feemarket/keeper/keeper.go index 2bdd300..67f8848 100644 --- a/x/feemarket/keeper/keeper.go +++ b/x/feemarket/keeper/keeper.go @@ -56,7 +56,7 @@ func (k *Keeper) Plugin() interfaces.FeeMarketImplementation { return k.plugin } -// SetFeeMarket sets the fee market implementation data in the keeper +// SetFeeMarket sets the fee market implementation data in the keeper. func (k *Keeper) SetFeeMarket(ctx sdk.Context, fm interfaces.FeeMarketImplementation) error { bz, err := fm.Marshal() if err != nil { @@ -64,11 +64,12 @@ func (k *Keeper) SetFeeMarket(ctx sdk.Context, fm interfaces.FeeMarketImplementa } k.setData(ctx, bz) + k.plugin = fm return nil } -// GetFeeMarket gets arbitrary byte data in the keeper. +// GetFeeMarket gets the fee market implementation data in the keeper. Will func (k *Keeper) GetFeeMarket(ctx sdk.Context) (interfaces.FeeMarketImplementation, error) { bz, err := k.getData(ctx) if err != nil { @@ -79,7 +80,7 @@ func (k *Keeper) GetFeeMarket(ctx sdk.Context) (interfaces.FeeMarketImplementati return k.plugin, err } -// SetData sets arbitrary byte data in the keeper. +// setData sets arbitrary byte data in the keeper. func (k *Keeper) setData(ctx sdk.Context, data []byte) { // TODO: limit max data size? @@ -87,7 +88,7 @@ func (k *Keeper) setData(ctx sdk.Context, data []byte) { store.Set(types.KeyData, data) } -// GetData gets arbitrary byte data in the keeper. +// getData gets arbitrary byte data in the keeper. func (k *Keeper) getData(ctx sdk.Context) ([]byte, error) { store := ctx.KVStore(k.storeKey) bz := store.Get(types.KeyData) From 732bc58ae07590efb082376b476d2f648c499c80 Mon Sep 17 00:00:00 2001 From: aljo242 Date: Fri, 10 Nov 2023 12:18:02 -0500 Subject: [PATCH 08/21] add wrappers --- x/feemarket/keeper/feemarket.go | 40 +++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 x/feemarket/keeper/feemarket.go diff --git a/x/feemarket/keeper/feemarket.go b/x/feemarket/keeper/feemarket.go new file mode 100644 index 0000000..cb3a62a --- /dev/null +++ b/x/feemarket/keeper/feemarket.go @@ -0,0 +1,40 @@ +package keeper + +import ( + "encoding/json" + sdk "github.com/cosmos/cosmos-sdk/types" + "github.com/skip-mev/feemarket/x/feemarket/interfaces" +) + +// ------------------- Fee Market Parameters ------------------- // + +// Init which initializes the fee market (in InitGenesis) +func (k *Keeper) Init(ctx sdk.Context) error { + return k.plugin.Init(ctx) +} + +// Export which exports the fee market (in ExportGenesis) +func (k *Keeper) Export(ctx sdk.Context) (json.RawMessage, error) { + return k.plugin.Export(ctx) +} + +// BeginBlockUpdateHandler allows the fee market to be updated +// after every block. This will be added to the BeginBlock chain. +func (k *Keeper) BeginBlockUpdateHandler(ctx sdk.Context) interfaces.UpdateHandler { + return k.plugin.BeginBlockUpdateHandler(ctx) +} + +// EndBlockUpdateHandler allows the fee market to be updated +// after every block. This will be added to the EndBlock chain. +func (k *Keeper) EndBlockUpdateHandler(ctx sdk.Context) interfaces.UpdateHandler { + return k.plugin.EndBlockUpdateHandler(ctx) +} + +// ------------------- Fee Market Queries ------------------- // + +// GetFeeMarketInfo retrieves the fee market's information about +// how to pay for a transaction (min gas price, min tip, +// where the fees are being distributed, etc.). +func (k *Keeper) GetFeeMarketInfo(ctx sdk.Context) map[string]string { + return k.plugin.GetFeeMarketInfo(ctx) +} From 7238a2b05c30e4d261e1b572d51ba4928d0728dc Mon Sep 17 00:00:00 2001 From: aljo242 Date: Fri, 10 Nov 2023 12:18:40 -0500 Subject: [PATCH 09/21] wrap --- x/feemarket/keeper/feemarket.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/x/feemarket/keeper/feemarket.go b/x/feemarket/keeper/feemarket.go index cb3a62a..d4405f2 100644 --- a/x/feemarket/keeper/feemarket.go +++ b/x/feemarket/keeper/feemarket.go @@ -2,7 +2,9 @@ package keeper import ( "encoding/json" + sdk "github.com/cosmos/cosmos-sdk/types" + "github.com/skip-mev/feemarket/x/feemarket/interfaces" ) From 039dc35a807568313d319e6b5eb9dbfd4023c678 Mon Sep 17 00:00:00 2001 From: aljo242 Date: Fri, 10 Nov 2023 12:36:58 -0500 Subject: [PATCH 10/21] init --- x/feemarket/keeper/genesis.go | 35 ++++++++++++++++++++++++++++++ x/feemarket/keeper/genesis_test.go | 15 +++++++++++++ 2 files changed, 50 insertions(+) create mode 100644 x/feemarket/keeper/genesis.go create mode 100644 x/feemarket/keeper/genesis_test.go diff --git a/x/feemarket/keeper/genesis.go b/x/feemarket/keeper/genesis.go new file mode 100644 index 0000000..32a1b29 --- /dev/null +++ b/x/feemarket/keeper/genesis.go @@ -0,0 +1,35 @@ +package keeper + +import ( + sdk "github.com/cosmos/cosmos-sdk/types" + + "github.com/skip-mev/feemarket/x/feemarket/types" +) + +// InitGenesis initializes the feemarket module's state from a given genesis state. +func (k *Keeper) InitGenesis(ctx sdk.Context, gs types.GenesisState) { + // Set the feemarket module's parameters. + if err := k.SetParams(ctx, gs.Params); err != nil { + panic(err) + } + + // set the fee market implementation + if err := k.plugin.Unmarshal(gs.Plugin); err != nil { + panic(err) + } + + if err := k.Init(ctx); err != nil { + panic(err) + } +} + +// ExportGenesis returns a GenesisState for a given context. +func (k *Keeper) ExportGenesis(ctx sdk.Context) *types.GenesisState { + // Get the feemarket module's parameters. + params, err := k.GetParams(ctx) + if err != nil { + panic(err) + } + + return types.NewGenesisState(k.plugin, params) +} diff --git a/x/feemarket/keeper/genesis_test.go b/x/feemarket/keeper/genesis_test.go new file mode 100644 index 0000000..745bd9d --- /dev/null +++ b/x/feemarket/keeper/genesis_test.go @@ -0,0 +1,15 @@ +package keeper_test + +func (s *KeeperTestSuite) TestInitGenesis() { + s.Run("valid genesis should not panic", func() { + + }) + + s.Run("invalid params should panic", func() { + + }) + + s.Run("invalid plugin bytes should panic", func() { + + }) +} From 2a00da28f69553e849aa891f277b9c685ef2a4ee Mon Sep 17 00:00:00 2001 From: aljo242 Date: Fri, 10 Nov 2023 12:37:52 -0500 Subject: [PATCH 11/21] keystate --- x/feemarket/keeper/keeper.go | 4 ++-- x/feemarket/types/keys.go | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/x/feemarket/keeper/keeper.go b/x/feemarket/keeper/keeper.go index 67f8848..b16b4a3 100644 --- a/x/feemarket/keeper/keeper.go +++ b/x/feemarket/keeper/keeper.go @@ -85,13 +85,13 @@ func (k *Keeper) setData(ctx sdk.Context, data []byte) { // TODO: limit max data size? store := ctx.KVStore(k.storeKey) - store.Set(types.KeyData, data) + store.Set(types.KeyState, data) } // getData gets arbitrary byte data in the keeper. func (k *Keeper) getData(ctx sdk.Context) ([]byte, error) { store := ctx.KVStore(k.storeKey) - bz := store.Get(types.KeyData) + bz := store.Get(types.KeyState) if len(bz) == 0 { return nil, fmt.Errorf("no data set in the keeper") diff --git a/x/feemarket/types/keys.go b/x/feemarket/types/keys.go index edfcb50..a0cc483 100644 --- a/x/feemarket/types/keys.go +++ b/x/feemarket/types/keys.go @@ -9,13 +9,13 @@ const ( const ( prefixParams = iota + 1 - prefixData + prefixState ) var ( // KeyParams is the store key for the feemarket module's parameters. KeyParams = []byte{prefixParams} - // KeyData is the store key for the feemarket module's data. - KeyData = []byte{prefixData} + // KeyState is the store key for the feemarket module's data. + KeyState = []byte{prefixState} ) From 91d899af99116837949a5bf2783cef403c3c7bab Mon Sep 17 00:00:00 2001 From: aljo242 Date: Fri, 10 Nov 2023 12:40:24 -0500 Subject: [PATCH 12/21] simplify --- testutils/testutils.go | 67 ------------------------------------------ 1 file changed, 67 deletions(-) diff --git a/testutils/testutils.go b/testutils/testutils.go index abe9c33..5bc9d8c 100644 --- a/testutils/testutils.go +++ b/testutils/testutils.go @@ -74,43 +74,6 @@ func RandomAccounts(r *rand.Rand, n int) []Account { return accs } -func CreateTx(txCfg client.TxConfig, account Account, nonce, timeout uint64, msgs []sdk.Msg, fees ...sdk.Coin) (authsigning.Tx, error) { - txBuilder := txCfg.NewTxBuilder() - if err := txBuilder.SetMsgs(msgs...); err != nil { - return nil, err - } - - sigV2 := signing.SignatureV2{ - PubKey: account.PrivKey.PubKey(), - Data: &signing.SingleSignatureData{ - SignMode: signing.SignMode_SIGN_MODE_DIRECT, - Signature: nil, - }, - Sequence: nonce, - } - if err := txBuilder.SetSignatures(sigV2); err != nil { - return nil, err - } - - txBuilder.SetTimeoutHeight(timeout) - - txBuilder.SetFeeAmount(fees) - - return txBuilder.GetTx(), nil -} - -func CreateFreeTx(txCfg client.TxConfig, account Account, nonce, timeout uint64, validator string, amount sdk.Coin, fees ...sdk.Coin) (authsigning.Tx, error) { - msgs := []sdk.Msg{ - &stakingtypes.MsgDelegate{ - DelegatorAddress: account.Address.String(), - ValidatorAddress: validator, - Amount: amount, - }, - } - - return CreateTx(txCfg, account, nonce, timeout, msgs, fees...) -} - func CreateRandomTx(txCfg client.TxConfig, account Account, nonce, numberMsgs, timeout uint64, gasLimit uint64, fees ...sdk.Coin) (authsigning.Tx, error) { msgs := make([]sdk.Msg, numberMsgs) for i := 0; i < int(numberMsgs); i++ { @@ -155,36 +118,6 @@ func CreateRandomTxBz(txCfg client.TxConfig, account Account, nonce, numberMsgs, return txCfg.TxEncoder()(tx) } -func CreateTxWithSigners(txCfg client.TxConfig, nonce, timeout uint64, signers []Account) (authsigning.Tx, error) { - msgs := []sdk.Msg{} - for _, signer := range signers { - msg := CreateRandomMsgs(signer.Address, 1) - msgs = append(msgs, msg...) - } - - txBuilder := txCfg.NewTxBuilder() - if err := txBuilder.SetMsgs(msgs...); err != nil { - return nil, err - } - - sigV2 := signing.SignatureV2{ - PubKey: signers[0].PrivKey.PubKey(), - Data: &signing.SingleSignatureData{ - SignMode: signing.SignMode_SIGN_MODE_DIRECT, - Signature: nil, - }, - Sequence: nonce, - } - - if err := txBuilder.SetSignatures(sigV2); err != nil { - return nil, err - } - - txBuilder.SetTimeoutHeight(timeout) - - return txBuilder.GetTx(), nil -} - func CreateRandomMsgs(acc sdk.AccAddress, numberMsgs int) []sdk.Msg { msgs := make([]sdk.Msg, numberMsgs) for i := 0; i < numberMsgs; i++ { From ffa7fa61f0eadde7201782b4a88a7f56b14e8b97 Mon Sep 17 00:00:00 2001 From: aljo242 Date: Fri, 10 Nov 2023 12:41:27 -0500 Subject: [PATCH 13/21] docs --- x/feemarket/keeper/keeper.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/x/feemarket/keeper/keeper.go b/x/feemarket/keeper/keeper.go index b16b4a3..06de7ff 100644 --- a/x/feemarket/keeper/keeper.go +++ b/x/feemarket/keeper/keeper.go @@ -24,7 +24,7 @@ type Keeper struct { authority string } -// NewKeeper is a wrapper around NewKeeperWithRewardsAddressProvider for backwards compatibility. +// NewKeeper constructs a new feemarket keeper. func NewKeeper( cdc codec.BinaryCodec, storeKey storetypes.StoreKey, From 5f8ca42738ccaea39b9eac49ef063d7fe54820de Mon Sep 17 00:00:00 2001 From: Alex Johnson Date: Fri, 10 Nov 2023 12:53:32 -0500 Subject: [PATCH 14/21] Update x/feemarket/keeper/feemarket.go Co-authored-by: David Terpay <35130517+davidterpay@users.noreply.github.com> --- x/feemarket/keeper/feemarket.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/x/feemarket/keeper/feemarket.go b/x/feemarket/keeper/feemarket.go index d4405f2..a14e063 100644 --- a/x/feemarket/keeper/feemarket.go +++ b/x/feemarket/keeper/feemarket.go @@ -8,7 +8,7 @@ import ( "github.com/skip-mev/feemarket/x/feemarket/interfaces" ) -// ------------------- Fee Market Parameters ------------------- // +// ------------------- Fee Market Updates ------------------- // // Init which initializes the fee market (in InitGenesis) func (k *Keeper) Init(ctx sdk.Context) error { From 702a8dfd78a7beb5ffcf3c504ddc2351eec13265 Mon Sep 17 00:00:00 2001 From: aljo242 Date: Fri, 10 Nov 2023 14:05:44 -0500 Subject: [PATCH 15/21] mock panic --- proto/feemarket/feemarket/v1/panic.proto | 18 ++ x/feemarket/keeper/genesis.go | 8 + x/feemarket/keeper/genesis_test.go | 46 +++- x/feemarket/plugins/mocks/panic.pb.go | 327 +++++++++++++++++++++++ 4 files changed, 397 insertions(+), 2 deletions(-) create mode 100644 proto/feemarket/feemarket/v1/panic.proto create mode 100644 x/feemarket/plugins/mocks/panic.pb.go diff --git a/proto/feemarket/feemarket/v1/panic.proto b/proto/feemarket/feemarket/v1/panic.proto new file mode 100644 index 0000000..465eb78 --- /dev/null +++ b/proto/feemarket/feemarket/v1/panic.proto @@ -0,0 +1,18 @@ +syntax = "proto3"; +package feemarket.feemarket.v1; + +option go_package = "github.com/skip-mev/feemarket/x/feemarket/plugins/mocks"; + +import "cosmos_proto/cosmos.proto"; + +// PanicMarket is a message that contains the information about a panic +// fee market used ONLY for testing +// +// NOTE: Most operations of this fee market will panic for testing. +message PanicMarket { + option (cosmos_proto.implements_interface) = + "feemarket.feemarket.v1.FeeMarketImplementation"; + + // Data represents arbitrary data stored in the implementation. + bytes data = 1; +} diff --git a/x/feemarket/keeper/genesis.go b/x/feemarket/keeper/genesis.go index 32a1b29..a70e907 100644 --- a/x/feemarket/keeper/genesis.go +++ b/x/feemarket/keeper/genesis.go @@ -8,11 +8,19 @@ import ( // InitGenesis initializes the feemarket module's state from a given genesis state. func (k *Keeper) InitGenesis(ctx sdk.Context, gs types.GenesisState) { + if err := gs.Params.ValidateBasic(); err != nil { + panic(err) + } + // Set the feemarket module's parameters. if err := k.SetParams(ctx, gs.Params); err != nil { panic(err) } + if len(gs.Plugin) == 0 && gs.Params.Enabled { + panic("plugin must be set if feemarket is enabled") + } + // set the fee market implementation if err := k.plugin.Unmarshal(gs.Plugin); err != nil { panic(err) diff --git a/x/feemarket/keeper/genesis_test.go b/x/feemarket/keeper/genesis_test.go index 745bd9d..b11c6cb 100644 --- a/x/feemarket/keeper/genesis_test.go +++ b/x/feemarket/keeper/genesis_test.go @@ -1,15 +1,57 @@ package keeper_test +import ( + "github.com/skip-mev/feemarket/x/feemarket/plugins/defaultmarket" + "github.com/skip-mev/feemarket/x/feemarket/types" +) + func (s *KeeperTestSuite) TestInitGenesis() { + s.Run("default genesis should not panic", func() { + s.Require().NotPanics(func() { + s.feemarketKeeper.InitGenesis(s.ctx, *types.NewDefaultGenesisState()) + }) + }) + s.Run("valid genesis should not panic", func() { + bz, err := defaultmarket.NewDefaultFeeMarket().Marshal() + s.Require().NoError(err) + + gs := types.GenesisState{ + Plugin: bz, + Params: types.Params{}, + } + + s.Require().NotPanics(func() { + s.feemarketKeeper.InitGenesis(s.ctx, gs) + }) + }) + + s.Run("0 bytes plugin bytes should panic", func() { + gs := types.GenesisState{ + Plugin: make([]byte, 0), + Params: types.Params{ + Enabled: true, + }} + s.Require().Panics(func() { + s.feemarketKeeper.InitGenesis(s.ctx, gs) + }) }) - s.Run("invalid params should panic", func() { + s.Run("invalid plugin bytes should panic if module enabled", func() { + gs := types.GenesisState{ + Plugin: []byte("invalid"), + Params: types.Params{ + Enabled: true, + }, + } + s.Require().Panics(func() { + s.feemarketKeeper.InitGenesis(s.ctx, gs) + }) }) - s.Run("invalid plugin bytes should panic", func() { + s.Run("plugin init fail should panic", func() { }) } diff --git a/x/feemarket/plugins/mocks/panic.pb.go b/x/feemarket/plugins/mocks/panic.pb.go new file mode 100644 index 0000000..0a6f11c --- /dev/null +++ b/x/feemarket/plugins/mocks/panic.pb.go @@ -0,0 +1,327 @@ +// Code generated by protoc-gen-gogo. DO NOT EDIT. +// source: feemarket/feemarket/v1/panic.proto + +package mocks + +import ( + fmt "fmt" + _ "github.com/cosmos/cosmos-proto" + proto "github.com/cosmos/gogoproto/proto" + io "io" + math "math" + math_bits "math/bits" +) + +// Reference imports to suppress errors if they are not otherwise used. +var _ = proto.Marshal +var _ = fmt.Errorf +var _ = math.Inf + +// This is a compile-time assertion to ensure that this generated file +// is compatible with the proto package it is being compiled against. +// A compilation error at this line likely means your copy of the +// proto package needs to be updated. +const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package + +// PanicMarket is a message that contains the information about a panic +// fee market used ONLY for testing +// +// NOTE: Most operations of this fee market will panic for testing. +type PanicMarket struct { + // Data represents arbitrary data stored in the implementation. + Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"` +} + +func (m *PanicMarket) Reset() { *m = PanicMarket{} } +func (m *PanicMarket) String() string { return proto.CompactTextString(m) } +func (*PanicMarket) ProtoMessage() {} +func (*PanicMarket) Descriptor() ([]byte, []int) { + return fileDescriptor_497e7cde817162d1, []int{0} +} +func (m *PanicMarket) XXX_Unmarshal(b []byte) error { + return m.Unmarshal(b) +} +func (m *PanicMarket) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) { + if deterministic { + return xxx_messageInfo_PanicMarket.Marshal(b, m, deterministic) + } else { + b = b[:cap(b)] + n, err := m.MarshalToSizedBuffer(b) + if err != nil { + return nil, err + } + return b[:n], nil + } +} +func (m *PanicMarket) XXX_Merge(src proto.Message) { + xxx_messageInfo_PanicMarket.Merge(m, src) +} +func (m *PanicMarket) XXX_Size() int { + return m.Size() +} +func (m *PanicMarket) XXX_DiscardUnknown() { + xxx_messageInfo_PanicMarket.DiscardUnknown(m) +} + +var xxx_messageInfo_PanicMarket proto.InternalMessageInfo + +func (m *PanicMarket) GetData() []byte { + if m != nil { + return m.Data + } + return nil +} + +func init() { + proto.RegisterType((*PanicMarket)(nil), "feemarket.feemarket.v1.PanicMarket") +} + +func init() { + proto.RegisterFile("feemarket/feemarket/v1/panic.proto", fileDescriptor_497e7cde817162d1) +} + +var fileDescriptor_497e7cde817162d1 = []byte{ + // 204 bytes of a gzipped FileDescriptorProto + 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0xe2, 0x52, 0x4a, 0x4b, 0x4d, 0xcd, + 0x4d, 0x2c, 0xca, 0x4e, 0x2d, 0xd1, 0x47, 0xb0, 0xca, 0x0c, 0xf5, 0x0b, 0x12, 0xf3, 0x32, 0x93, + 0xf5, 0x0a, 0x8a, 0xf2, 0x4b, 0xf2, 0x85, 0xc4, 0xe0, 0x32, 0x7a, 0x08, 0x56, 0x99, 0xa1, 0x94, + 0x64, 0x72, 0x7e, 0x71, 0x6e, 0x7e, 0x71, 0x3c, 0x58, 0x95, 0x3e, 0x84, 0x03, 0xd1, 0xa2, 0x14, + 0xca, 0xc5, 0x1d, 0x00, 0x32, 0xc1, 0x17, 0xac, 0x58, 0x48, 0x88, 0x8b, 0x25, 0x25, 0xb1, 0x24, + 0x51, 0x82, 0x51, 0x81, 0x51, 0x83, 0x27, 0x08, 0xcc, 0xb6, 0x32, 0x3a, 0xb5, 0x45, 0x57, 0x0f, + 0xbb, 0xc9, 0x7a, 0x6e, 0xa9, 0xa9, 0x10, 0x9d, 0x9e, 0xb9, 0x05, 0x39, 0xa9, 0xb9, 0xa9, 0x79, + 0x25, 0x89, 0x25, 0x99, 0xf9, 0x79, 0x4e, 0x81, 0x27, 0x1e, 0xc9, 0x31, 0x5e, 0x78, 0x24, 0xc7, + 0xf8, 0xe0, 0x91, 0x1c, 0xe3, 0x84, 0xc7, 0x72, 0x0c, 0x17, 0x1e, 0xcb, 0x31, 0xdc, 0x78, 0x2c, + 0xc7, 0x10, 0x65, 0x9e, 0x9e, 0x59, 0x92, 0x51, 0x9a, 0xa4, 0x97, 0x9c, 0x9f, 0xab, 0x5f, 0x9c, + 0x9d, 0x59, 0xa0, 0x9b, 0x9b, 0x5a, 0x86, 0xe4, 0xa3, 0x0a, 0x24, 0x76, 0x41, 0x4e, 0x69, 0x7a, + 0x66, 0x5e, 0xb1, 0x7e, 0x6e, 0x7e, 0x72, 0x76, 0x71, 0x12, 0x1b, 0xd8, 0xc1, 0xc6, 0x80, 0x00, + 0x00, 0x00, 0xff, 0xff, 0xe7, 0x29, 0xf1, 0xd2, 0x09, 0x01, 0x00, 0x00, +} + +func (m *PanicMarket) Marshal() (dAtA []byte, err error) { + size := m.Size() + dAtA = make([]byte, size) + n, err := m.MarshalToSizedBuffer(dAtA[:size]) + if err != nil { + return nil, err + } + return dAtA[:n], nil +} + +func (m *PanicMarket) MarshalTo(dAtA []byte) (int, error) { + size := m.Size() + return m.MarshalToSizedBuffer(dAtA[:size]) +} + +func (m *PanicMarket) MarshalToSizedBuffer(dAtA []byte) (int, error) { + i := len(dAtA) + _ = i + var l int + _ = l + if len(m.Data) > 0 { + i -= len(m.Data) + copy(dAtA[i:], m.Data) + i = encodeVarintPanic(dAtA, i, uint64(len(m.Data))) + i-- + dAtA[i] = 0xa + } + return len(dAtA) - i, nil +} + +func encodeVarintPanic(dAtA []byte, offset int, v uint64) int { + offset -= sovPanic(v) + base := offset + for v >= 1<<7 { + dAtA[offset] = uint8(v&0x7f | 0x80) + v >>= 7 + offset++ + } + dAtA[offset] = uint8(v) + return base +} +func (m *PanicMarket) Size() (n int) { + if m == nil { + return 0 + } + var l int + _ = l + l = len(m.Data) + if l > 0 { + n += 1 + l + sovPanic(uint64(l)) + } + return n +} + +func sovPanic(x uint64) (n int) { + return (math_bits.Len64(x|1) + 6) / 7 +} +func sozPanic(x uint64) (n int) { + return sovPanic(uint64((x << 1) ^ uint64((int64(x) >> 63)))) +} +func (m *PanicMarket) Unmarshal(dAtA []byte) error { + l := len(dAtA) + iNdEx := 0 + for iNdEx < l { + preIndex := iNdEx + var wire uint64 + for shift := uint(0); ; shift += 7 { + if shift >= 64 { + return ErrIntOverflowPanic + } + if iNdEx >= l { + return io.ErrUnexpectedEOF + } + b := dAtA[iNdEx] + iNdEx++ + wire |= uint64(b&0x7F) << shift + if b < 0x80 { + break + } + } + fieldNum := int32(wire >> 3) + wireType := int(wire & 0x7) + if wireType == 4 { + return fmt.Errorf("proto: PanicMarket: wiretype end group for non-group") + } + if fieldNum <= 0 { + return fmt.Errorf("proto: PanicMarket: illegal tag %d (wire type %d)", fieldNum, wire) + } + switch fieldNum { + case 1: + if wireType != 2 { + return fmt.Errorf("proto: wrong wireType = %d for field Data", wireType) + } + var byteLen int + for shift := uint(0); ; shift += 7 { + if shift >= 64 { + return ErrIntOverflowPanic + } + if iNdEx >= l { + return io.ErrUnexpectedEOF + } + b := dAtA[iNdEx] + iNdEx++ + byteLen |= int(b&0x7F) << shift + if b < 0x80 { + break + } + } + if byteLen < 0 { + return ErrInvalidLengthPanic + } + postIndex := iNdEx + byteLen + if postIndex < 0 { + return ErrInvalidLengthPanic + } + if postIndex > l { + return io.ErrUnexpectedEOF + } + m.Data = append(m.Data[:0], dAtA[iNdEx:postIndex]...) + if m.Data == nil { + m.Data = []byte{} + } + iNdEx = postIndex + default: + iNdEx = preIndex + skippy, err := skipPanic(dAtA[iNdEx:]) + if err != nil { + return err + } + if (skippy < 0) || (iNdEx+skippy) < 0 { + return ErrInvalidLengthPanic + } + if (iNdEx + skippy) > l { + return io.ErrUnexpectedEOF + } + iNdEx += skippy + } + } + + if iNdEx > l { + return io.ErrUnexpectedEOF + } + return nil +} +func skipPanic(dAtA []byte) (n int, err error) { + l := len(dAtA) + iNdEx := 0 + depth := 0 + for iNdEx < l { + var wire uint64 + for shift := uint(0); ; shift += 7 { + if shift >= 64 { + return 0, ErrIntOverflowPanic + } + if iNdEx >= l { + return 0, io.ErrUnexpectedEOF + } + b := dAtA[iNdEx] + iNdEx++ + wire |= (uint64(b) & 0x7F) << shift + if b < 0x80 { + break + } + } + wireType := int(wire & 0x7) + switch wireType { + case 0: + for shift := uint(0); ; shift += 7 { + if shift >= 64 { + return 0, ErrIntOverflowPanic + } + if iNdEx >= l { + return 0, io.ErrUnexpectedEOF + } + iNdEx++ + if dAtA[iNdEx-1] < 0x80 { + break + } + } + case 1: + iNdEx += 8 + case 2: + var length int + for shift := uint(0); ; shift += 7 { + if shift >= 64 { + return 0, ErrIntOverflowPanic + } + if iNdEx >= l { + return 0, io.ErrUnexpectedEOF + } + b := dAtA[iNdEx] + iNdEx++ + length |= (int(b) & 0x7F) << shift + if b < 0x80 { + break + } + } + if length < 0 { + return 0, ErrInvalidLengthPanic + } + iNdEx += length + case 3: + depth++ + case 4: + if depth == 0 { + return 0, ErrUnexpectedEndOfGroupPanic + } + depth-- + case 5: + iNdEx += 4 + default: + return 0, fmt.Errorf("proto: illegal wireType %d", wireType) + } + if iNdEx < 0 { + return 0, ErrInvalidLengthPanic + } + if depth == 0 { + return iNdEx, nil + } + } + return 0, io.ErrUnexpectedEOF +} + +var ( + ErrInvalidLengthPanic = fmt.Errorf("proto: negative length found during unmarshaling") + ErrIntOverflowPanic = fmt.Errorf("proto: integer overflow") + ErrUnexpectedEndOfGroupPanic = fmt.Errorf("proto: unexpected end of group") +) From d689394d582b636e778bb5024211d7108ac76575 Mon Sep 17 00:00:00 2001 From: aljo242 Date: Fri, 10 Nov 2023 14:09:31 -0500 Subject: [PATCH 16/21] mock panic --- x/feemarket/plugins/mocks/panic.go | 104 +++++++++++++++++++++++++++++ 1 file changed, 104 insertions(+) create mode 100644 x/feemarket/plugins/mocks/panic.go diff --git a/x/feemarket/plugins/mocks/panic.go b/x/feemarket/plugins/mocks/panic.go new file mode 100644 index 0000000..dc28440 --- /dev/null +++ b/x/feemarket/plugins/mocks/panic.go @@ -0,0 +1,104 @@ +package mocks + +import ( + "encoding/json" + + sdk "github.com/cosmos/cosmos-sdk/types" + + "github.com/skip-mev/feemarket/x/feemarket/interfaces" +) + +var _ interfaces.FeeMarketImplementation = &PanicMarket{} + +// NewPanicMarket returns an instance of a new PanicMarket. +func NewPanicMarket() *PanicMarket { + return &PanicMarket{ + Data: []byte("panic"), + } +} + +// ValidateBasic is a no-op. +func (fm *PanicMarket) ValidateBasic() error { + panic("panic feemarket") + + return nil +} + +// Init which initializes the fee market (in InitGenesis). +func (fm *PanicMarket) Init(_ sdk.Context) error { + panic("panic feemarket") + + return nil +} + +// Export which exports the fee market (in ExportGenesis). +func (fm *PanicMarket) Export(_ sdk.Context) (json.RawMessage, error) { + panic("panic feemarket") + + return nil, nil +} + +// BeginBlockUpdateHandler allows the fee market to be updated +// after every block. This will be added to the BeginBlock chain. +func (fm *PanicMarket) BeginBlockUpdateHandler(_ sdk.Context) interfaces.UpdateHandler { + return func(ctx sdk.Context) error { + panic("panic feemarket") + + return nil + } +} + +// EndBlockUpdateHandler allows the fee market to be updated +// after every block. This will be added to the EndBlock chain. +func (fm *PanicMarket) EndBlockUpdateHandler(_ sdk.Context) interfaces.UpdateHandler { + return func(ctx sdk.Context) error { + panic("panic feemarket") + + return nil + } +} + +// GetFeeMarketInfo retrieves the fee market's information about +// how to pay for a transaction (min gas price, min tip, +// where the fees are being distributed, etc.). +func (fm *PanicMarket) GetFeeMarketInfo(_ sdk.Context) map[string]string { + panic("panic feemarket") + + return nil +} + +// GetID returns the identifier of the fee market. +func (fm *PanicMarket) GetID() string { + return "panic" +} + +// FeeAnteHandler will be called in the module AnteHandler. +// Performs no actions. +func (fm *PanicMarket) FeeAnteHandler( + _ sdk.Context, + _ sdk.Tx, + _ bool, + next sdk.AnteHandler, +) sdk.AnteHandler { + return func(ctx sdk.Context, tx sdk.Tx, simulate bool) (newCtx sdk.Context, err error) { + panic("panic feemarket") + + return next(ctx, tx, simulate) + } +} + +// FeePostHandler will be called in the module PostHandler +// if PostHandlers are implemented. Performs no actions. +func (fm *PanicMarket) FeePostHandler( + _ sdk.Context, + _ sdk.Tx, + _, + _ bool, + next sdk.PostHandler, +) sdk.PostHandler { + return func(ctx sdk.Context, tx sdk.Tx, simulate, success bool) (newCtx sdk.Context, err error) { + panic("panic feemarket") + + return next(ctx, tx, simulate, success) + } +} From c35b97c9f48e506063126ad260d26249b47aea11 Mon Sep 17 00:00:00 2001 From: aljo242 Date: Fri, 10 Nov 2023 14:19:11 -0500 Subject: [PATCH 17/21] add tests --- x/feemarket/keeper/genesis_test.go | 27 ++++++++++++++++++++++++++- x/feemarket/plugins/mocks/panic.go | 20 ++------------------ 2 files changed, 28 insertions(+), 19 deletions(-) diff --git a/x/feemarket/keeper/genesis_test.go b/x/feemarket/keeper/genesis_test.go index b11c6cb..23125dc 100644 --- a/x/feemarket/keeper/genesis_test.go +++ b/x/feemarket/keeper/genesis_test.go @@ -1,7 +1,12 @@ package keeper_test import ( + storetypes "github.com/cosmos/cosmos-sdk/store/types" + "github.com/cosmos/cosmos-sdk/testutil" + "github.com/skip-mev/feemarket/testutils" + "github.com/skip-mev/feemarket/x/feemarket/keeper" "github.com/skip-mev/feemarket/x/feemarket/plugins/defaultmarket" + "github.com/skip-mev/feemarket/x/feemarket/plugins/mocks" "github.com/skip-mev/feemarket/x/feemarket/types" ) @@ -31,7 +36,8 @@ func (s *KeeperTestSuite) TestInitGenesis() { Plugin: make([]byte, 0), Params: types.Params{ Enabled: true, - }} + }, + } s.Require().Panics(func() { s.feemarketKeeper.InitGenesis(s.ctx, gs) @@ -52,6 +58,25 @@ func (s *KeeperTestSuite) TestInitGenesis() { }) s.Run("plugin init fail should panic", func() { + encCfg := testutils.CreateTestEncodingConfig() + key := storetypes.NewKVStoreKey(types.StoreKey) + testCtx := testutil.DefaultContextWithDB(s.T(), key, storetypes.NewTransientStoreKey("new test")) + ctx := testCtx.Ctx + + plugin := mocks.NewPanicMarket() + k := keeper.NewKeeper(encCfg.Codec, key, plugin, s.authorityAccount.String()) + bz, err := plugin.Marshal() + s.Require().NoError(err) + gs := types.GenesisState{ + Plugin: bz, + Params: types.Params{ + Enabled: true, + }, + } + + s.Require().Panics(func() { + k.InitGenesis(ctx, gs) + }) }) } diff --git a/x/feemarket/plugins/mocks/panic.go b/x/feemarket/plugins/mocks/panic.go index dc28440..94ac25d 100644 --- a/x/feemarket/plugins/mocks/panic.go +++ b/x/feemarket/plugins/mocks/panic.go @@ -20,22 +20,16 @@ func NewPanicMarket() *PanicMarket { // ValidateBasic is a no-op. func (fm *PanicMarket) ValidateBasic() error { panic("panic feemarket") - - return nil } // Init which initializes the fee market (in InitGenesis). func (fm *PanicMarket) Init(_ sdk.Context) error { panic("panic feemarket") - - return nil } // Export which exports the fee market (in ExportGenesis). func (fm *PanicMarket) Export(_ sdk.Context) (json.RawMessage, error) { panic("panic feemarket") - - return nil, nil } // BeginBlockUpdateHandler allows the fee market to be updated @@ -43,8 +37,6 @@ func (fm *PanicMarket) Export(_ sdk.Context) (json.RawMessage, error) { func (fm *PanicMarket) BeginBlockUpdateHandler(_ sdk.Context) interfaces.UpdateHandler { return func(ctx sdk.Context) error { panic("panic feemarket") - - return nil } } @@ -53,8 +45,6 @@ func (fm *PanicMarket) BeginBlockUpdateHandler(_ sdk.Context) interfaces.UpdateH func (fm *PanicMarket) EndBlockUpdateHandler(_ sdk.Context) interfaces.UpdateHandler { return func(ctx sdk.Context) error { panic("panic feemarket") - - return nil } } @@ -63,8 +53,6 @@ func (fm *PanicMarket) EndBlockUpdateHandler(_ sdk.Context) interfaces.UpdateHan // where the fees are being distributed, etc.). func (fm *PanicMarket) GetFeeMarketInfo(_ sdk.Context) map[string]string { panic("panic feemarket") - - return nil } // GetID returns the identifier of the fee market. @@ -78,12 +66,10 @@ func (fm *PanicMarket) FeeAnteHandler( _ sdk.Context, _ sdk.Tx, _ bool, - next sdk.AnteHandler, + _ sdk.AnteHandler, ) sdk.AnteHandler { return func(ctx sdk.Context, tx sdk.Tx, simulate bool) (newCtx sdk.Context, err error) { panic("panic feemarket") - - return next(ctx, tx, simulate) } } @@ -94,11 +80,9 @@ func (fm *PanicMarket) FeePostHandler( _ sdk.Tx, _, _ bool, - next sdk.PostHandler, + _ sdk.PostHandler, ) sdk.PostHandler { return func(ctx sdk.Context, tx sdk.Tx, simulate, success bool) (newCtx sdk.Context, err error) { panic("panic feemarket") - - return next(ctx, tx, simulate, success) } } From b6a3ced3924a83f41eda5737a4b3832af45e01ff Mon Sep 17 00:00:00 2001 From: Alex Johnson Date: Fri, 10 Nov 2023 17:57:54 -0500 Subject: [PATCH 18/21] Update x/feemarket/keeper/genesis.go Co-authored-by: David Terpay <35130517+davidterpay@users.noreply.github.com> --- x/feemarket/keeper/genesis.go | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/x/feemarket/keeper/genesis.go b/x/feemarket/keeper/genesis.go index a70e907..66a655a 100644 --- a/x/feemarket/keeper/genesis.go +++ b/x/feemarket/keeper/genesis.go @@ -25,7 +25,9 @@ func (k *Keeper) InitGenesis(ctx sdk.Context, gs types.GenesisState) { if err := k.plugin.Unmarshal(gs.Plugin); err != nil { panic(err) } - +if err := k.plugin.ValidateBasic(); err != nil { + panic(err) +} if err := k.Init(ctx); err != nil { panic(err) } From c02a7428ccc1f28a3df2c6346398a783143c0abc Mon Sep 17 00:00:00 2001 From: aljo242 Date: Fri, 10 Nov 2023 17:59:32 -0500 Subject: [PATCH 19/21] format --- x/feemarket/keeper/genesis.go | 6 +++--- x/feemarket/keeper/genesis_test.go | 1 + x/feemarket/plugins/eip1559/types/params_test.go | 3 ++- x/feemarket/plugins/eip1559/types/state_test.go | 3 ++- 4 files changed, 8 insertions(+), 5 deletions(-) diff --git a/x/feemarket/keeper/genesis.go b/x/feemarket/keeper/genesis.go index 66a655a..19204b1 100644 --- a/x/feemarket/keeper/genesis.go +++ b/x/feemarket/keeper/genesis.go @@ -25,9 +25,9 @@ func (k *Keeper) InitGenesis(ctx sdk.Context, gs types.GenesisState) { if err := k.plugin.Unmarshal(gs.Plugin); err != nil { panic(err) } -if err := k.plugin.ValidateBasic(); err != nil { - panic(err) -} + if err := k.plugin.ValidateBasic(); err != nil { + panic(err) + } if err := k.Init(ctx); err != nil { panic(err) } diff --git a/x/feemarket/keeper/genesis_test.go b/x/feemarket/keeper/genesis_test.go index 23125dc..87a54a0 100644 --- a/x/feemarket/keeper/genesis_test.go +++ b/x/feemarket/keeper/genesis_test.go @@ -3,6 +3,7 @@ package keeper_test import ( storetypes "github.com/cosmos/cosmos-sdk/store/types" "github.com/cosmos/cosmos-sdk/testutil" + "github.com/skip-mev/feemarket/testutils" "github.com/skip-mev/feemarket/x/feemarket/keeper" "github.com/skip-mev/feemarket/x/feemarket/plugins/defaultmarket" diff --git a/x/feemarket/plugins/eip1559/types/params_test.go b/x/feemarket/plugins/eip1559/types/params_test.go index 302d602..3f2498c 100644 --- a/x/feemarket/plugins/eip1559/types/params_test.go +++ b/x/feemarket/plugins/eip1559/types/params_test.go @@ -4,8 +4,9 @@ import ( "testing" "cosmossdk.io/math" - "github.com/skip-mev/feemarket/x/feemarket/plugins/eip1559/types" "github.com/stretchr/testify/require" + + "github.com/skip-mev/feemarket/x/feemarket/plugins/eip1559/types" ) func TestParams(t *testing.T) { diff --git a/x/feemarket/plugins/eip1559/types/state_test.go b/x/feemarket/plugins/eip1559/types/state_test.go index 2b43081..6c3be2c 100644 --- a/x/feemarket/plugins/eip1559/types/state_test.go +++ b/x/feemarket/plugins/eip1559/types/state_test.go @@ -4,8 +4,9 @@ import ( "testing" "cosmossdk.io/math" - "github.com/skip-mev/feemarket/x/feemarket/plugins/eip1559/types" "github.com/stretchr/testify/require" + + "github.com/skip-mev/feemarket/x/feemarket/plugins/eip1559/types" ) func TestState(t *testing.T) { From 41f14be2efcccdef6cc63389d7d17fe67cc8583e Mon Sep 17 00:00:00 2001 From: aljo242 Date: Fri, 10 Nov 2023 18:01:13 -0500 Subject: [PATCH 20/21] remove --- x/feemarket/keeper/genesis.go | 4 ---- 1 file changed, 4 deletions(-) diff --git a/x/feemarket/keeper/genesis.go b/x/feemarket/keeper/genesis.go index 19204b1..34da53c 100644 --- a/x/feemarket/keeper/genesis.go +++ b/x/feemarket/keeper/genesis.go @@ -17,10 +17,6 @@ func (k *Keeper) InitGenesis(ctx sdk.Context, gs types.GenesisState) { panic(err) } - if len(gs.Plugin) == 0 && gs.Params.Enabled { - panic("plugin must be set if feemarket is enabled") - } - // set the fee market implementation if err := k.plugin.Unmarshal(gs.Plugin); err != nil { panic(err) From b210932c3830c652f46a8f6dac22fee438425857 Mon Sep 17 00:00:00 2001 From: aljo242 Date: Fri, 10 Nov 2023 18:01:38 -0500 Subject: [PATCH 21/21] remove --- x/feemarket/keeper/genesis_test.go | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/x/feemarket/keeper/genesis_test.go b/x/feemarket/keeper/genesis_test.go index 87a54a0..678b9e0 100644 --- a/x/feemarket/keeper/genesis_test.go +++ b/x/feemarket/keeper/genesis_test.go @@ -32,19 +32,6 @@ func (s *KeeperTestSuite) TestInitGenesis() { }) }) - s.Run("0 bytes plugin bytes should panic", func() { - gs := types.GenesisState{ - Plugin: make([]byte, 0), - Params: types.Params{ - Enabled: true, - }, - } - - s.Require().Panics(func() { - s.feemarketKeeper.InitGenesis(s.ctx, gs) - }) - }) - s.Run("invalid plugin bytes should panic if module enabled", func() { gs := types.GenesisState{ Plugin: []byte("invalid"),