feat: add oracle upgrade endblocker

app/app.go

@@ -10,6 +10,7 @@ import (
 
 	"github.com/cosmos/cosmos-sdk/x/authz"
 	"github.com/medibloc/panacea-core/v2/x/oracle"
+	oracleclient "github.com/medibloc/panacea-core/v2/x/oracle/client"
 	oraclekeeper "github.com/medibloc/panacea-core/v2/x/oracle/keeper"
 	oracletypes "github.com/medibloc/panacea-core/v2/x/oracle/types"
 
@@ -162,6 +163,7 @@ func getGovProposalHandlers() []govclient.ProposalHandler {
 		upgradeclient.ProposalHandler,
 		upgradeclient.CancelProposalHandler,
 		// this line is used by starport scaffolding # stargate/app/govProposalHandler
+		oracleclient.ProposalHandler,
 	)
 	govProposalHandlers = append(govProposalHandlers, wasmclient.ProposalHandlers...)
 
@@ -440,6 +442,7 @@ func New(
 		keys[oracletypes.MemStoreKey],
 		app.GetSubspace(oracletypes.ModuleName),
 	)
+	govRouter.AddRoute(oracletypes.RouterKey, oracle.NewOracleProposalHandler(app.oracleKeeper))
 
 	app.datadealKeeper = *datadealkeeper.NewKeeper(
 		appCodec,

proto/panacea/oracle/v2/oracle.proto

@@ -40,3 +40,12 @@ message OracleRegistration {
   string oracle_commission_max_change_rate = 10 [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", (gogoproto.nullable) = false];
   bytes encrypted_oracle_priv_key = 11;
 }
+
+// OracleUpgradeInfo defines the info of oracle upgrade, which includes the target height of upgrade and unique ID of the new version of oracle
+message OracleUpgradeInfo {
+  option (gogoproto.equal) = true;
+
+  string unique_id = 1;
+
+  int64 height = 2;
+}

proto/panacea/oracle/v2/proposal.proto

@@ -0,0 +1,25 @@
+syntax = "proto3";
+package panacea.oracle.v2;
+
+option go_package = "github.com/medibloc/panacea-core/x/oracle/types";
+option (gogoproto.goproto_getters_all) = false;
+
+import "gogoproto/gogo.proto";
+
+// Plan defines upgrade plan information.
+message Plan {
+  option (gogoproto.equal) = true;
+
+  string unique_id = 1;
+
+  int64 height = 2;
+}
+
+// OracleUpgradeProposal defines the information required for a proposal.
+message OracleUpgradeProposal {
+  option (gogoproto.equal) = true;
+
+  string title       = 1;
+  string description = 2;
+  Plan   plan        = 3 [(gogoproto.nullable) = false];
+}

proto/panacea/oracle/v2/query.proto

@@ -32,6 +32,11 @@ service Query {
     option (google.api.http).get = "/panacea/oracle/v2/oracle-registrations/{unique_id}/{oracle_address}";
   }
 
+  // OracleUpgradeInfo returns OracleUpgradeInfo of oracle module.
+  rpc OracleUpgradeInfo(QueryOracleUpgradeInfoRequest) returns (QueryOracleUpgradeInfoResponse) {
+    option (google.api.http).get = "/panacea/oracle/v2alpha2/oracle-upgrade-info";
+  }
+
   // Params returns params of oracle module.
   rpc Params(QueryOracleParamsRequest) returns (QueryParamsResponse) {
     option (google.api.http).get = "/panacea/oracle/v2/params";
@@ -82,6 +87,14 @@ message QueryOracleRegistrationResponse {
   OracleRegistration oracle_registration = 1;
 }
 
+// QueryOracleUpgradeInfoRequest is the request type for the Query/OracleUpgradeInfo RPC method.
+message QueryOracleUpgradeInfoRequest {}
+
+// QueryOracleUpgradeInfoRequest is the response type for the Query/OracleUpgradeInfo RPC method.
+message QueryOracleUpgradeInfoResponse {
+  OracleUpgradeInfo oracle_upgrade_info = 1;
+}
+
 // QueryOracleParamsRequest is the request type for the Query/OracleParams RPC method.
 message QueryOracleParamsRequest {}
 

x/oracle/abci.go

@@ -0,0 +1,31 @@
+package oracle
+
+import (
+	"errors"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/medibloc/panacea-core/v2/x/oracle/keeper"
+	"github.com/medibloc/panacea-core/v2/x/oracle/types"
+)
+
+func EndBlocker(ctx sdk.Context, keeper keeper.Keeper) {
+	handlerOracleUpgrade(ctx, keeper)
+}
+
+func handlerOracleUpgrade(ctx sdk.Context, keeper keeper.Keeper) {
+	upgradeInfo, err := keeper.GetOracleUpgradeInfo(ctx)
+	if err != nil {
+		if errors.Is(err, types.ErrOracleUpgradeInfoNotFound) {
+			return
+		} else {
+			panic(err)
+		}
+	}
+
+	if upgradeInfo.ShouldExecute(ctx) {
+		if err := keeper.ApplyUpgrade(ctx, upgradeInfo); err != nil {
+			panic(err)
+		}
+		keeper.RemoveOracleUpgradeInfo(ctx)
+	}
+}

x/oracle/abci_test.go

@@ -0,0 +1,83 @@
+package oracle_test
+
+import (
+	"encoding/base64"
+	"testing"
+
+	"github.com/btcsuite/btcd/btcec"
+	"github.com/medibloc/panacea-core/v2/types/testsuite"
+	"github.com/medibloc/panacea-core/v2/x/oracle"
+	"github.com/medibloc/panacea-core/v2/x/oracle/types"
+	"github.com/stretchr/testify/suite"
+)
+
+type abciTestSuite struct {
+	testsuite.TestSuite
+
+	uniqueID string
+}
+
+func TestAbciTestSuite(t *testing.T) {
+	suite.Run(t, new(abciTestSuite))
+}
+
+func (suite *abciTestSuite) BeforeTest(_, _ string) {
+	ctx := suite.Ctx
+	suite.uniqueID = "uniqueID"
+
+	oraclePrivKey, err := btcec.NewPrivateKey(btcec.S256())
+	suite.Require().NoError(err)
+
+	suite.OracleKeeper.SetParams(ctx, types.Params{
+		OraclePublicKey:          base64.StdEncoding.EncodeToString(oraclePrivKey.PubKey().SerializeCompressed()),
+		OraclePubKeyRemoteReport: base64.StdEncoding.EncodeToString([]byte("oraclePubKeyRemoteReport")),
+		UniqueId:                 suite.uniqueID,
+	})
+}
+
+func (suite *abciTestSuite) TestOracleUpgradeSuccess() {
+	ctx := suite.Ctx
+	ctx = ctx.WithBlockHeight(1)
+
+	suite.Require().Equal(suite.uniqueID, suite.OracleKeeper.GetParams(ctx).UniqueId)
+
+	upgradeUniqueID := "upgradeUniqueID"
+
+	upgradeInfo := &types.OracleUpgradeInfo{
+		UniqueId: upgradeUniqueID,
+		Height:   10,
+	}
+
+	suite.Require().NoError(suite.OracleKeeper.SetOracleUpgradeInfo(ctx, upgradeInfo))
+
+	ctx = ctx.WithBlockHeight(10)
+
+	oracle.EndBlocker(ctx, suite.OracleKeeper)
+
+	suite.Require().Equal(upgradeUniqueID, suite.OracleKeeper.GetParams(ctx).UniqueId)
+
+	_, err := suite.OracleKeeper.GetOracleUpgradeInfo(ctx)
+	suite.Require().Error(err, types.ErrOracleUpgradeInfoNotFound)
+}
+
+func (suite *abciTestSuite) TestOracleUpgradeFailedBeforeReachUpgradeHeight() {
+	ctx := suite.Ctx
+	ctx = ctx.WithBlockHeight(1)
+
+	suite.Require().Equal(suite.uniqueID, suite.OracleKeeper.GetParams(ctx).UniqueId)
+
+	upgradeUniqueID := "upgradeUniqueID"
+
+	upgradeInfo := &types.OracleUpgradeInfo{
+		UniqueId: upgradeUniqueID,
+		Height:   10,
+	}
+
+	suite.Require().NoError(suite.OracleKeeper.SetOracleUpgradeInfo(ctx, upgradeInfo))
+
+	ctx = ctx.WithBlockHeight(9)
+
+	oracle.EndBlocker(ctx, suite.OracleKeeper)
+
+	suite.Require().Equal(suite.uniqueID, suite.OracleKeeper.GetParams(ctx).UniqueId)
+}

x/oracle/client/cli/query.go

@@ -23,6 +23,7 @@ func GetQueryCmd(queryRoute string) *cobra.Command {
 	cmd.AddCommand(CmdGetOracle())
 	cmd.AddCommand(CmdGetOracleRegistrations())
 	cmd.AddCommand(CmdGetOracleRegistration())
+	cmd.AddCommand(CmdGetOracleUpgradeInfo())
 	cmd.AddCommand(CmdGetParams())
 
 	return cmd

x/oracle/client/cli/queryOracleUpgradeInfo.go

@@ -0,0 +1,35 @@
+package cli
+
+import (
+	"github.com/cosmos/cosmos-sdk/client"
+	"github.com/cosmos/cosmos-sdk/client/flags"
+	"github.com/medibloc/panacea-core/v2/x/oracle/types"
+	"github.com/spf13/cobra"
+)
+
+func CmdGetOracleUpgradeInfo() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "oracle-upgrade-info",
+		Short: "Query an oracle upgrade information",
+		Args:  cobra.ExactArgs(0),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			clientCtx, err := client.GetClientQueryContext(cmd)
+			if err != nil {
+				return err
+			}
+
+			queryClient := types.NewQueryClient(clientCtx)
+
+			res, err := queryClient.OracleUpgradeInfo(cmd.Context(), &types.QueryOracleUpgradeInfoRequest{})
+			if err != nil {
+				return err
+			}
+
+			return clientCtx.PrintProto(res)
+		},
+	}
+
+	flags.AddQueryFlagsToCmd(cmd)
+
+	return cmd
+}

x/oracle/client/cli/txUpgradeOracleProposal.go

@@ -0,0 +1,100 @@
+package cli
+
+import (
+	"github.com/cosmos/cosmos-sdk/client"
+	"github.com/cosmos/cosmos-sdk/client/tx"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	govcli "github.com/cosmos/cosmos-sdk/x/gov/client/cli"
+	govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
+	"github.com/medibloc/panacea-core/v2/x/oracle/types"
+	"github.com/spf13/cobra"
+)
+
+const (
+	FlagUpgradeUniqueID = "upgrade-unique-id"
+	FlagUpgradeHeight   = "upgrade-height"
+)
+
+func CmdUpgradeOracleProposal() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "oracle-upgrade (--upgrade-unique-id [uniqueID]) (--upgrade-height [height]) [flags]",
+		Args:  cobra.ExactArgs(0),
+		Short: "Submit an oracle upgrade proposal",
+		Long: "Submit an oracle upgrade proposal along with an initial deposit.\n + " +
+			"You must enter the uniqueID of a new version of oracle and target block height for upgrade.",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			clientCtx, err := client.GetClientTxContext(cmd)
+			if err != nil {
+				return err
+			}
+			from := clientCtx.GetFromAddress()
+
+			depositStr, err := cmd.Flags().GetString(govcli.FlagDeposit)
+			if err != nil {
+				return err
+			}
+
+			deposit, err := sdk.ParseCoinsNormalized(depositStr)
+			if err != nil {
+				return err
+			}
+
+			content, err := makeProposalContent(cmd)
+			if err != nil {
+				return err
+			}
+
+			msg, err := govtypes.NewMsgSubmitProposal(content, deposit, from)
+			if err != nil {
+				return err
+			}
+			if err := msg.ValidateBasic(); err != nil {
+				return err
+			}
+
+			return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msg)
+		},
+	}
+	cmd.Flags().String(govcli.FlagTitle, "", "title of proposal")
+	cmd.Flags().String(govcli.FlagDescription, "", "description of proposal")
+	cmd.Flags().String(govcli.FlagDeposit, "", "deposit of proposal")
+	cmd.Flags().Int64(FlagUpgradeHeight, 0, "The height at which the upgrade must happen")
+	cmd.Flags().String(FlagUpgradeUniqueID, "", "Oracle's uniqueID to be upgraded")
+
+	if err := cmd.MarkFlagRequired(FlagUpgradeHeight); err != nil {
+		panic(err)
+	}
+	if err := cmd.MarkFlagRequired(FlagUpgradeUniqueID); err != nil {
+		panic(err)
+	}
+	return cmd
+}
+
+func makeProposalContent(cmd *cobra.Command) (govtypes.Content, error) {
+	title, err := cmd.Flags().GetString(govcli.FlagTitle)
+	if err != nil {
+		return nil, err
+	}
+
+	description, err := cmd.Flags().GetString(govcli.FlagDescription)
+	if err != nil {
+		return nil, err
+	}
+
+	height, err := cmd.Flags().GetInt64(FlagUpgradeHeight)
+	if err != nil {
+		return nil, err
+	}
+
+	uniqueID, err := cmd.Flags().GetString(FlagUpgradeUniqueID)
+	if err != nil {
+		return nil, err
+	}
+
+	plan := types.Plan{UniqueId: uniqueID, Height: height}
+	if err := plan.ValidateBasic(); err != nil {
+		return nil, err
+	}
+	content := types.NewOracleUpgradeProposal(title, description, plan)
+	return content, nil
+}

x/oracle/client/proposal_handler.go

@@ -0,0 +1,10 @@
+package client
+
+import (
+	govclient "github.com/cosmos/cosmos-sdk/x/gov/client"
+	"github.com/medibloc/panacea-core/v2/x/oracle/client/rest"
+
+	"github.com/medibloc/panacea-core/v2/x/oracle/client/cli"
+)
+
+var ProposalHandler = govclient.NewProposalHandler(cli.CmdUpgradeOracleProposal, rest.ProposalRESTHandler)