feat: implement fswap module's genesis and params

CHANGELOG.md

@@ -41,6 +41,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 ### Features
 * (consensus) [\#1178](https://github.com/Finschia/finschia-sdk/pull/1178) change the consensus from Ostracon to Tendermint v0.34.24
 * (x/fswap) [\#1336](https://github.com/Finschia/finschia-sdk/pull/1336) Initialize fswap module 
+* (x/fswap) [\#1339](https://github.com/Finschia/finschia-sdk/pull/1339) Implement fswap module's genesis
 
 ### Improvements
 * (docs) [\#1120](https://github.com/Finschia/finschia-sdk/pull/1120) Update links in x/foundation README.md

Makefile

@@ -144,6 +144,7 @@ mocks: $(MOCKS_DIR)
 	mockgen -package mocks -destination tests/mocks/grpc_server.go github.com/gogo/protobuf/grpc Server
 	mockgen -package mocks -destination tests/mocks/tendermint_tendermint_libs_log_DB.go github.com/tendermint/tendermint/libs/log Logger
 	mockgen -source=x/stakingplus/expected_keepers.go -package testutil -destination x/stakingplus/testutil/expected_keepers_mocks.go
+	mockgen -source=x/fswap/types/expected_keepers.go -package testutil -destination x/fswap/testutil/expected_keepers_mocks.go
 .PHONY: mocks
 
 $(MOCKS_DIR):

docs/core/proto-docs.md

@@ -12791,7 +12791,7 @@ Params defines the parameters for the module.
 
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
-| `new_coin_denom` | [string](#string) |  | new denomination for new coin after swap |
+| `swappable_new_coin_amount` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) |  |  |
 
 
 

proto/lbm/fswap/v1/fswap.proto

@@ -6,7 +6,7 @@ option go_package = "github.com/Finschia/finschia-sdk/x/fswap/types";
 import "gogoproto/gogo.proto";
 import "cosmos/base/v1beta1/coin.proto";
 
-message Swapped{
+message Swapped {
   cosmos.base.v1beta1.Coin old_coin_amount = 1
       [(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/Finschia/finschia-sdk/types.Coin"];
   cosmos.base.v1beta1.Coin new_coin_amount = 2

proto/lbm/fswap/v1/genesis.proto

@@ -4,11 +4,11 @@ package lbm.fswap.v1;
 option go_package = "github.com/Finschia/finschia-sdk/x/fswap/types";
 
 import "gogoproto/gogo.proto";
-import "lbm/fswap/v1/params.proto";
 import "lbm/fswap/v1/fswap.proto";
+import "lbm/fswap/v1/params.proto";
 
 // GenesisState defines the fswap module's genesis state.
 message GenesisState {
-  Params params = 1 [(gogoproto.nullable) = false];
-  Swapped swapped =2 [(gogoproto.nullable) = false];
+  Params  params  = 1 [(gogoproto.nullable) = false];
+  Swapped swapped = 2 [(gogoproto.nullable) = false];
 }

proto/lbm/fswap/v1/params.proto

@@ -4,10 +4,11 @@ package lbm.fswap.v1;
 option go_package = "github.com/Finschia/finschia-sdk/x/fswap/types";
 
 import "gogoproto/gogo.proto";
+import "cosmos/base/v1beta1/coin.proto";
 
 // Params defines the parameters for the module.
 message Params {
   option (gogoproto.goproto_stringer) = false;
-  // new denomination for new coin after swap
-  string new_coin_denom = 1;
-}
+  cosmos.base.v1beta1.Coin swappable_new_coin_amount = 1
+      [(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/Finschia/finschia-sdk/types.Coin"];
+}

simapp/app.go

@@ -72,6 +72,9 @@ import (
 	foundationclient "github.com/Finschia/finschia-sdk/x/foundation/client"
 	foundationkeeper "github.com/Finschia/finschia-sdk/x/foundation/keeper"
 	foundationmodule "github.com/Finschia/finschia-sdk/x/foundation/module"
+	"github.com/Finschia/finschia-sdk/x/fswap"
+	fswapkeeper "github.com/Finschia/finschia-sdk/x/fswap/keeper"
+	fswaptypes "github.com/Finschia/finschia-sdk/x/fswap/types"
 	"github.com/Finschia/finschia-sdk/x/genutil"
 	genutiltypes "github.com/Finschia/finschia-sdk/x/genutil/types"
 	"github.com/Finschia/finschia-sdk/x/gov"
@@ -138,6 +141,7 @@ var (
 		vesting.AppModuleBasic{},
 		tokenmodule.AppModuleBasic{},
 		collectionmodule.AppModuleBasic{},
+		fswap.AppModuleBasic{},
 	)
 
 	// module account permissions
@@ -197,6 +201,7 @@ type SimApp struct {
 	ClassKeeper      classkeeper.Keeper
 	TokenKeeper      tokenkeeper.Keeper
 	CollectionKeeper collectionkeeper.Keeper
+	FswapKeeper      fswapkeeper.Keeper
 
 	// the module manager
 	mm *module.Manager
@@ -250,6 +255,7 @@ func NewSimApp(
 		token.StoreKey,
 		collection.StoreKey,
 		authzkeeper.StoreKey,
+		fswaptypes.StoreKey,
 	)
 	tkeys := sdk.NewTransientStoreKeys(paramstypes.TStoreKey)
 	// NOTE: The testingkey is just mounted for testing purposes. Actual applications should
@@ -352,6 +358,10 @@ func NewSimApp(
 	// If evidence needs to be handled for the app, set routes in router here and seal
 	app.EvidenceKeeper = *evidenceKeeper
 
+	/****  Phase 1 ****/
+	fswapConfig := fswaptypes.DefaultConfig()
+	app.FswapKeeper = fswapkeeper.NewKeeper(appCodec, keys[fswaptypes.StoreKey], app.AccountKeeper, app.BankKeeper, fswapConfig)
+
 	/****  Module Options ****/
 
 	// NOTE: we may consider parsing `appOpts` inside module constructors. For the moment
@@ -383,6 +393,7 @@ func NewSimApp(
 		tokenmodule.NewAppModule(appCodec, app.TokenKeeper),
 		collectionmodule.NewAppModule(appCodec, app.CollectionKeeper),
 		authzmodule.NewAppModule(appCodec, app.AuthzKeeper, app.AccountKeeper, app.BankKeeper, app.interfaceRegistry),
+		fswap.NewAppModule(appCodec, app.FswapKeeper, app.AccountKeeper, app.BankKeeper),
 	)
 
 	// During begin block slashing happens after distr.BeginBlocker so that
@@ -410,6 +421,7 @@ func NewSimApp(
 		vestingtypes.ModuleName,
 		token.ModuleName,
 		collection.ModuleName,
+		fswaptypes.ModuleName,
 	)
 	app.mm.SetOrderEndBlockers(
 		crisistypes.ModuleName,
@@ -431,6 +443,7 @@ func NewSimApp(
 		foundation.ModuleName,
 		token.ModuleName,
 		collection.ModuleName,
+		fswaptypes.ModuleName,
 	)
 
 	// NOTE: The genutils module must occur after staking so that pools are
@@ -458,6 +471,7 @@ func NewSimApp(
 		vestingtypes.ModuleName,
 		token.ModuleName,
 		collection.ModuleName,
+		fswaptypes.ModuleName,
 	)
 
 	// Uncomment if you want to set a custom migration order here.

x/ERRORS.md

@@ -177,7 +177,9 @@
 
 |Error Name|Codespace|Code|Description|
 |:-|:-|:-|:-|
-|ErrSample|fswap|1100|sample error|
+|ErrParamsNotFound|fswap|1100|params does not exist|
+|ErrSwappedNotFound|fswap|1101|swapped does not exist|
+|ErrTotalSupplyNotFound|fswap|1102|swappable new coin amount does not exist|
 
 >You can also find detailed information in the following Errors.go files:
   * [fswap/types/errors.go](fswap/types/errors.go)

x/fswap/keeper/fswap.go

@@ -0,0 +1,51 @@
+package keeper
+
+import (
+	sdk "github.com/Finschia/finschia-sdk/types"
+	"github.com/Finschia/finschia-sdk/x/fswap/types"
+)
+
+// GetSwapped get all parameters as types.Swapped
+func (k Keeper) GetSwapped(ctx sdk.Context) types.Swapped {
+	store := ctx.KVStore(k.storeKey)
+	bz := store.Get([]byte{types.SwappedKey})
+	var swapped types.Swapped
+
+	if bz == nil {
+		panic(types.ErrSwappedNotFound)
+	}
+	k.cdc.MustUnmarshal(bz, &swapped)
+	return swapped
+}
+
+// SetSwapped set the types.Swapped
+func (k Keeper) SetSwapped(ctx sdk.Context, swapped types.Swapped) error {
+	store := ctx.KVStore(k.storeKey)
+	bz, err := k.cdc.Marshal(&swapped)
+	if err != nil {
+		return err
+	}
+	store.Set([]byte{types.SwappedKey}, bz)
+	return nil
+}
+
+func (k Keeper) GetTotalSupply(ctx sdk.Context) sdk.Coin {
+	store := ctx.KVStore(k.storeKey)
+	bz := store.Get([]byte{types.SwappableNewCoinAmountKey})
+	var totalSupply sdk.Coin
+	if bz == nil {
+		panic(types.ErrTotalSupplyNotFound)
+	}
+	k.cdc.MustUnmarshal(bz, &totalSupply)
+	return totalSupply
+}
+
+func (k Keeper) SetTotalSupply(ctx sdk.Context, totalSupply sdk.Coin) error {
+	store := ctx.KVStore(k.storeKey)
+	bz, err := k.cdc.Marshal(&totalSupply)
+	if err != nil {
+		return err
+	}
+	store.Set([]byte{types.SwappableNewCoinAmountKey}, bz)
+	return nil
+}

x/fswap/keeper/genesis.go

@@ -0,0 +1,25 @@
+package keeper
+
+import (
+	sdk "github.com/Finschia/finschia-sdk/types"
+	"github.com/Finschia/finschia-sdk/x/fswap/types"
+)
+
+// InitGenesis initializes the module's state from a provided genesis
+// state.
+func (k Keeper) InitGenesis(ctx sdk.Context, genState types.GenesisState) {
+	if err := k.SetParams(ctx, genState.Params); err != nil {
+		panic(err)
+	}
+	if err := k.SetSwapped(ctx, genState.Swapped); err != nil {
+		panic(err)
+	}
+}
+
+// ExportGenesis returns the capability module's exported genesis.
+func (k Keeper) ExportGenesis(ctx sdk.Context) *types.GenesisState {
+	return &types.GenesisState{
+		Params:  k.GetParams(ctx),
+		Swapped: k.GetSwapped(ctx),
+	}
+}

x/fswap/keeper/genesis_test.go

@@ -0,0 +1,13 @@
+package keeper_test
+
+import (
+	"github.com/Finschia/finschia-sdk/x/fswap/types"
+)
+
+func (s *KeeperTestSuite) TestInitAndExportGenesis() {
+	s.keeper.InitGenesis(s.sdkCtx, *types.DefaultGenesis())
+	got := s.keeper.ExportGenesis(s.sdkCtx)
+	s.Require().NotNil(got)
+	s.Require().Equal(types.DefaultParams(), got.Params)
+	s.Require().Equal(types.DefaultSwapped(), got.Swapped)
+}

x/fswap/keeper/keeper.go

@@ -14,23 +14,26 @@ import (
 type (
 	Keeper struct {
 		cdc           codec.BinaryCodec
+		storeKey      storetypes.StoreKey
 		accountKeeper types.AccountKeeper
 		bankKeeper    types.BankKeeper
-		storeKey      storetypes.StoreKey
+		config        types.Config
 	}
 )
 
 func NewKeeper(
 	cdc codec.BinaryCodec,
+	storeKey storetypes.StoreKey,
 	ak types.AccountKeeper,
 	bk types.BankKeeper,
-	storeKey storetypes.StoreKey,
+	config types.Config,
 ) Keeper {
 	return Keeper{
 		cdc:           cdc,
+		storeKey:      storeKey,
 		accountKeeper: ak,
 		bankKeeper:    bk,
-		storeKey:      storeKey,
+		config:        config,
 	}
 }
 

x/fswap/keeper/keeper_test.go

@@ -0,0 +1,43 @@
+package keeper_test
+
+import (
+	"context"
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/stretchr/testify/suite"
+	tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
+
+	"github.com/Finschia/finschia-sdk/simapp"
+	sdk "github.com/Finschia/finschia-sdk/types"
+	"github.com/Finschia/finschia-sdk/x/fswap/keeper"
+	"github.com/Finschia/finschia-sdk/x/fswap/testutil"
+	"github.com/Finschia/finschia-sdk/x/fswap/types"
+)
+
+type KeeperTestSuite struct {
+	suite.Suite
+	sdkCtx     sdk.Context
+	goCtx      context.Context
+	keeper     keeper.Keeper
+	bankKeeper types.BankKeeper
+
+	msgServer types.MsgServer
+}
+
+func TestKeeperTestSuite(t *testing.T) {
+	suite.Run(t, new(KeeperTestSuite))
+}
+
+func (s *KeeperTestSuite) SetupTest() {
+	ctrl := gomock.NewController(s.T())
+	bankKeeper := testutil.NewMockBankKeeper(ctrl)
+	s.bankKeeper = bankKeeper
+	checkTx := false
+	app := simapp.Setup(checkTx)
+	s.sdkCtx = app.BaseApp.NewContext(checkTx, tmproto.Header{})
+	s.goCtx = sdk.WrapSDKContext(s.sdkCtx)
+	s.keeper = app.FswapKeeper
+
+	s.msgServer = keeper.NewMsgServerImpl(s.keeper)
+}

x/fswap/keeper/params.go

@@ -7,10 +7,28 @@
 
 // GetParams get all parameters as types.Params
 func (k Keeper) GetParams(ctx sdk.Context) types.Params {
-	return types.NewParams()
+	store := ctx.KVStore(k.storeKey)
+	bz := store.Get([]byte{types.ParamsKey})
+	var params types.Params
+	if bz == nil {
+		panic(types.ErrParamsNotFound)
+	}
+	k.cdc.MustUnmarshal(bz, &params)
+	return params
 }
 
 // SetParams set the params
-func (k Keeper) SetParams(ctx sdk.Context, params types.Params) {
-	// k.paramstore.SetParamSet(ctx, &params)
+func (k Keeper) SetParams(ctx sdk.Context, params types.Params) error {
+	store := ctx.KVStore(k.storeKey)
+	bz, err := k.cdc.Marshal(&params)
+	if err != nil {
+		return err
+	}
+	store.Set([]byte{types.ParamsKey}, bz)
+	return nil
+}
+
+func (k Keeper) SwappableNewCoinAmount(ctx sdk.Context) sdk.Coin {
+	params := k.GetParams(ctx)
+	return params.SwappableNewCoinAmount
 }