add liquidstake module

Author: puneet2019

x/liquidstake/abci.go

@@ -0,0 +1,26 @@
+package liquidstake
+
+import (
+	"context"
+	"time"
+
+	"github.com/cosmos/cosmos-sdk/telemetry"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	"github.com/persistenceOne/persistenceCore/v16/x/liquidstake/keeper"
+	"github.com/persistenceOne/persistenceCore/v16/x/liquidstake/types"
+)
+
+func BeginBlock(ctx context.Context, k keeper.Keeper) error {
+	defer telemetry.ModuleMeasureSince(types.ModuleName, time.Now(), telemetry.MetricKeyBeginBlocker)
+	sdkCtx := sdk.UnwrapSDKContext(ctx)
+	params, err := k.GetParams(sdkCtx)
+	if err != nil {
+		return err
+	}
+	if !params.ModulePaused {
+		// return value of UpdateLiquidValidatorSet is useful only in testing
+		_ = k.UpdateLiquidValidatorSet(sdkCtx, false)
+	}
+	return nil
+}

x/liquidstake/abci_test.go

@@ -0,0 +1,56 @@
+package liquidstake_test
+
+import (
+	"testing"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/persistenceOne/persistenceCore/v16/app"
+	"github.com/persistenceOne/persistenceCore/v16/app/constants"
+	"github.com/stretchr/testify/suite"
+
+	"github.com/persistenceOne/persistenceCore/v16/x/liquidstake"
+	"github.com/persistenceOne/persistenceCore/v16/x/liquidstake/keeper"
+)
+
+type ABCITestSuite struct {
+	suite.Suite
+
+	app    *app.Application
+	ctx    sdk.Context
+	keeper keeper.Keeper
+}
+
+func TestABCITestSuite(t *testing.T) {
+	suite.Run(t, new(ABCITestSuite))
+}
+
+func (s *ABCITestSuite) SetupTest() {
+	constants.SetUnsealedConfig()
+	s.app = app.Setup(s.T())
+	s.ctx = s.app.BaseApp.NewContext(false)
+
+	s.keeper = *s.app.LiquidStakeKeeper
+	blocktime, err := sdk.ParseTime("2022-03-01T00:00:00.000000000")
+	s.Require().NoError(err)
+	s.ctx = s.ctx.WithBlockHeight(100).WithBlockTime(blocktime)
+}
+
+func (s *ABCITestSuite) TestBeginBlock() {
+	// Test when module is not paused
+	params, err := s.keeper.GetParams(s.ctx)
+	s.Require().NoError(err)
+	params.ModulePaused = false
+	s.Require().NoError(s.keeper.SetParams(s.ctx, params))
+
+	// Call BeginBlock
+	err = liquidstake.BeginBlock(s.ctx, s.keeper)
+	s.Require().NoError(err)
+
+	// Test when module is paused
+	params.ModulePaused = true
+	s.Require().NoError(s.keeper.SetParams(s.ctx, params))
+
+	// Call BeginBlock
+	err = liquidstake.BeginBlock(s.ctx, s.keeper)
+	s.Require().NoError(err)
+}

x/liquidstake/autocli.go

@@ -0,0 +1,82 @@
+package liquidstake
+
+import (
+	autocliv1 "cosmossdk.io/api/cosmos/autocli/v1"
+
+	liquidstakev1beta1 "github.com/persistenceOne/persistenceCore/v16/x/liquidstake/types"
+)
+
+// AutoCLIOptions returns the AutoCLI configuration for the liquidstake module.
+// This enables `pstaked` to auto-generate CLI commands for this module based
+// on the Msg and Query protobuf service definitions.
+func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions {
+	return &autocliv1.ModuleOptions{
+		Query: &autocliv1.ServiceCommandDescriptor{
+			Service: liquidstakev1beta1.Query_serviceDesc.ServiceName,
+			RpcCommandOptions: []*autocliv1.RpcCommandOptions{
+				{
+					RpcMethod: "Params",
+					Use:       "params",
+					Short:     "Query the liquidstake module parameters",
+				},
+				{
+					RpcMethod: "LiquidValidators",
+					Use:       "liquid-validators",
+					Short:     "Query all liquid validators",
+				},
+				{
+					RpcMethod: "States",
+					Use:       "states",
+					Short:     "Query liquidstake module states (net amount, mint rate)",
+				},
+			},
+		},
+		Tx: &autocliv1.ServiceCommandDescriptor{
+			Service: liquidstakev1beta1.Msg_serviceDesc.ServiceName,
+			RpcCommandOptions: []*autocliv1.RpcCommandOptions{
+				{
+					RpcMethod: "LiquidStake",
+					Use:       "liquid-stake [amount]",
+					Short:     "Liquid-stake XPRT",
+					PositionalArgs: []*autocliv1.PositionalArgDescriptor{
+						{ProtoField: "amount"},
+					},
+				},
+				{
+					RpcMethod: "StakeToLP",
+					Use:       "stake-to-lp [validator-addr] [staked_amount] [liquid_amount]",
+					Short:     "Convert delegation into stkXPRT and lock into LP",
+					PositionalArgs: []*autocliv1.PositionalArgDescriptor{
+						{ProtoField: "validator_address"},
+						{ProtoField: "staked_amount"},
+						{ProtoField: "liquid_amount", Optional: true},
+					},
+				},
+				{
+					RpcMethod: "LiquidUnstake",
+					Use:       "liquid-unstake [amount]",
+					Short:     "Liquid-unstake stkXPRT",
+					PositionalArgs: []*autocliv1.PositionalArgDescriptor{
+						{ProtoField: "amount"},
+					},
+				},
+				// Authority gated admin txs are kept but discoverable via autocli; typically used with --from authority
+				{
+					RpcMethod: "UpdateParams",
+					Use:       "update-params",
+					Short:     "Update liquidstake module params (authority only)",
+				},
+				{
+					RpcMethod: "UpdateWhitelistedValidators",
+					Use:       "update-whitelisted-validators",
+					Short:     "Update whitelisted validators (authority only)",
+				},
+				{
+					RpcMethod: "SetModulePaused",
+					Use:       "set-module-paused",
+					Short:     "Set module paused flag (authority only)",
+				},
+			},
+		},
+	}
+}