Merge pull request #4 from allinbits/atomone_gov_compat

feat: add atomone compat gov

Author: n2p5

app/provider/app.go

@@ -112,6 +112,7 @@ import (
 	ibcproviderclient "github.com/cosmos/interchain-security/v5/x/ccv/provider/client"
 	ibcproviderkeeper "github.com/cosmos/interchain-security/v5/x/ccv/provider/keeper"
 	providertypes "github.com/cosmos/interchain-security/v5/x/ccv/provider/types"
+	ccvtypes "github.com/cosmos/interchain-security/v5/x/ccv/types"
 
 	"github.com/cosmos/cosmos-sdk/testutil/testdata/testpb"
 	sigtypes "github.com/cosmos/cosmos-sdk/types/tx/signing"
@@ -125,6 +126,61 @@ const (
 
 // this line is used by starport scaffolding # stargate/wasm/app/enabledProposals
 
+// AtomOneGovKeeper wraps the standard SDK gov keeper to behave like AtomOne's gov keeper
+// This implements the ccv.GovKeeper interface
+type AtomOneGovKeeper struct {
+	keeper *govkeeper.Keeper
+}
+
+// GetProposal implements the AtomOne-style GetProposal method
+func (a *AtomOneGovKeeper) GetProposal(ctx sdk.Context, proposalID uint64) (ccvtypes.Proposal, bool) {
+	prop, err := a.keeper.Proposals.Get(ctx, proposalID)
+	if err != nil {
+		return ccvtypes.Proposal{}, false
+	}
+	// Convert SDK proposal to ICS minimal proposal type
+	return ccvtypes.Proposal{
+		Messages: prop.Messages,
+	}, true
+}
+
+// AtomOneGovHooksWrapper wraps ICS provider hooks to work with standard SDK gov module
+// This bridges between AtomOne-style hooks (no errors) and SDK hooks (with errors)
+type AtomOneGovHooksWrapper struct {
+	hooks ibcproviderkeeper.Hooks
+}
+
+// Implement standard SDK GovHooks interface by wrapping AtomOne-style hooks
+func (w AtomOneGovHooksWrapper) AfterProposalSubmission(ctx context.Context, proposalID uint64) error {
+	sdkCtx := sdk.UnwrapSDKContext(ctx)
+	w.hooks.AfterProposalSubmission(sdkCtx, proposalID)
+	return nil
+}
+
+func (w AtomOneGovHooksWrapper) AfterProposalVotingPeriodEnded(ctx context.Context, proposalID uint64) error {
+	sdkCtx := sdk.UnwrapSDKContext(ctx)
+	w.hooks.AfterProposalVotingPeriodEnded(sdkCtx, proposalID)
+	return nil
+}
+
+func (w AtomOneGovHooksWrapper) AfterProposalDeposit(ctx context.Context, proposalID uint64, depositorAddr sdk.AccAddress) error {
+	sdkCtx := sdk.UnwrapSDKContext(ctx)
+	w.hooks.AfterProposalDeposit(sdkCtx, proposalID, depositorAddr)
+	return nil
+}
+
+func (w AtomOneGovHooksWrapper) AfterProposalVote(ctx context.Context, proposalID uint64, voterAddr sdk.AccAddress) error {
+	sdkCtx := sdk.UnwrapSDKContext(ctx)
+	w.hooks.AfterProposalVote(sdkCtx, proposalID, voterAddr)
+	return nil
+}
+
+func (w AtomOneGovHooksWrapper) AfterProposalFailedMinDeposit(ctx context.Context, proposalID uint64) error {
+	sdkCtx := sdk.UnwrapSDKContext(ctx)
+	w.hooks.AfterProposalFailedMinDeposit(sdkCtx, proposalID)
+	return nil
+}
+
 var (
 	// DefaultNodeHome default home directories for the application daemon
 	DefaultNodeHome string
@@ -460,6 +516,9 @@ func New(
 		authtypes.NewModuleAddress(govtypes.ModuleName).String(),
 	)
 
+	// Create AtomOne-style gov keeper wrapper
+	atomOneGovKeeper := &AtomOneGovKeeper{keeper: app.GovKeeper}
+
 	// IBC v10: scopedKeeper and portKeeper removed from provider keeper initialization
 	app.ProviderKeeper = ibcproviderkeeper.NewKeeper(
 		appCodec,
@@ -473,7 +532,7 @@ func New(
 		app.AccountKeeper,
 		app.DistrKeeper,
 		app.BankKeeper,
-		*app.GovKeeper,
+		atomOneGovKeeper,
 		authtypes.NewModuleAddress(govtypes.ModuleName).String(),
 		authcodec.NewBech32Codec(sdk.GetConfig().GetBech32ValidatorAddrPrefix()),
 		authcodec.NewBech32Codec(sdk.GetConfig().GetBech32ConsensusAddrPrefix()),
@@ -490,8 +549,9 @@ func New(
 	// Set legacy router for backwards compatibility with gov v1beta1
 	app.GovKeeper.SetLegacyRouter(govRouter)
 
+	// Use the AtomOne hooks wrapper to bridge between the two interfaces
 	app.GovKeeper = app.GovKeeper.SetHooks(
-		govtypes.NewMultiGovHooks(app.ProviderKeeper.Hooks()),
+		govtypes.NewMultiGovHooks(AtomOneGovHooksWrapper{hooks: app.ProviderKeeper.Hooks()}),
 	)
 
 	providerModule := ibcprovider.NewAppModule(&app.ProviderKeeper, app.GetSubspace(providertypes.ModuleName))

testutil/keeper/unit_test_helpers.go

@@ -29,7 +29,6 @@ import (
 	abci "github.com/cometbft/cometbft/abci/types"
 	tmproto "github.com/cometbft/cometbft/proto/tendermint/types"
 
-	govkeeper "github.com/cosmos/cosmos-sdk/x/gov/keeper"
 	consumerkeeper "github.com/cosmos/interchain-security/v5/x/ccv/consumer/keeper"
 	consumertypes "github.com/cosmos/interchain-security/v5/x/ccv/consumer/types"
 	providerkeeper "github.com/cosmos/interchain-security/v5/x/ccv/provider/keeper"
@@ -80,6 +79,14 @@ func NewInMemKeeperParams(tb testing.TB) InMemKeeperParams {
 	}
 }
 
+// TestGovKeeper is a mock implementation of GovKeeper for testing
+type TestGovKeeper struct{}
+
+// GetProposal returns an empty proposal - tests don't use actual proposals
+func (k TestGovKeeper) GetProposal(ctx sdk.Context, proposalID uint64) (types.Proposal, bool) {
+	return types.Proposal{}, false
+}
+
 // A struct holding pointers to any mocked external keeper needed for provider/consumer keeper setup.
 type MockedKeepers struct {
 	*MockScopedKeeper
@@ -130,8 +137,7 @@ func NewInMemProviderKeeper(params InMemKeeperParams, mocks MockedKeepers) provi
 		mocks.MockAccountKeeper,
 		mocks.MockDistributionKeeper,
 		mocks.MockBankKeeper,
-		// mocks.MockGovKeeper,
-		govkeeper.Keeper{}, // HACK: to make parts of the test work
+		TestGovKeeper{}, // Test implementation of GovKeeper
 		authtypes.NewModuleAddress(govtypes.ModuleName).String(),
 		address.NewBech32Codec("cosmosvaloper"),
 		address.NewBech32Codec("cosmosvalcons"),

x/ccv/provider/keeper/hooks.go

@@ -6,8 +6,7 @@ import (
 
 	"cosmossdk.io/math"
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	sdkgov "github.com/cosmos/cosmos-sdk/x/gov/types"
-	v1 "github.com/cosmos/cosmos-sdk/x/gov/types/v1"
+	govv1 "github.com/cosmos/cosmos-sdk/x/gov/types/v1"
 	stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
 
 	"github.com/cosmos/interchain-security/v5/x/ccv/provider/types"
@@ -22,7 +21,7 @@ type Hooks struct {
 
 var (
 	_ stakingtypes.StakingHooks = Hooks{}
-	_ sdkgov.GovHooks           = Hooks{}
+	// AtomOne GovHooks interface compatibility is ensured by method signatures
 )
 
 // Returns new provider hooks
@@ -209,38 +208,29 @@ func (h Hooks) BeforeTokenizeShareRecordRemoved(_ context.Context, _ uint64) err
 // AfterProposalSubmission - call hook if registered
 // After a consumerAddition proposal submission, a record is created
 // that maps the proposal ID to the consumer chain ID.
-func (h Hooks) AfterProposalSubmission(goCtx context.Context, proposalID uint64) error {
-	ctx := sdk.UnwrapSDKContext(goCtx)
-
+func (h Hooks) AfterProposalSubmission(ctx sdk.Context, proposalID uint64) {
 	if p, ok := h.GetConsumerAdditionLegacyPropFromProp(ctx, proposalID); ok {
 		h.k.SetProposedConsumerChain(ctx, p.ChainId, proposalID)
 	}
-	return nil
 }
 
 // AfterProposalVotingPeriodEnded - call hook if registered
 // After proposal voting ends, the consumer chainID in store is deleted.
 // When a consumerAddition proposal passes, the consumer chainID is available in providerKeeper.GetAllPendingConsumerAdditionProps
 // or providerKeeper.GetAllConsumerChains(ctx).
-func (h Hooks) AfterProposalVotingPeriodEnded(goCtx context.Context, proposalID uint64) error {
-	ctx := sdk.UnwrapSDKContext(goCtx)
-
+func (h Hooks) AfterProposalVotingPeriodEnded(ctx sdk.Context, proposalID uint64) {
 	if _, ok := h.GetConsumerAdditionLegacyPropFromProp(ctx, proposalID); ok {
 		h.k.DeleteProposedConsumerChainInStore(ctx, proposalID)
 	}
-	return nil
 }
 
-func (h Hooks) AfterProposalDeposit(ctx context.Context, proposalID uint64, depositorAddr sdk.AccAddress) error {
-	return nil
+func (h Hooks) AfterProposalDeposit(ctx sdk.Context, proposalID uint64, depositorAddr sdk.AccAddress) {
 }
 
-func (h Hooks) AfterProposalVote(ctx context.Context, proposalID uint64, voterAddr sdk.AccAddress) error {
-	return nil
+func (h Hooks) AfterProposalVote(ctx sdk.Context, proposalID uint64, voterAddr sdk.AccAddress) {
 }
 
-func (h Hooks) AfterProposalFailedMinDeposit(ctx context.Context, proposalID uint64) error {
-	return nil
+func (h Hooks) AfterProposalFailedMinDeposit(ctx sdk.Context, proposalID uint64) {
 }
 
 // GetConsumerAdditionLegacyPropFromProp extracts a consumer addition legacy proposal from
@@ -249,20 +239,20 @@ func (h Hooks) GetConsumerAdditionLegacyPropFromProp(
 	ctx sdk.Context,
 	proposalID uint64,
 ) (providertypes.ConsumerAdditionProposal, bool) {
-	p, err := h.k.govKeeper.Proposals.Get(ctx, proposalID)
-	if err != nil {
+	p, found := h.k.govKeeper.GetProposal(ctx, proposalID)
+	if !found {
 		return providertypes.ConsumerAdditionProposal{}, false
 	}
 
 	// Iterate over the messages in the proposal
 	// Note that it's assumed that at most ONE message can contain a consumer addition proposal
 	for _, msg := range p.GetMessages() {
-		sdkMsg, isLegacyProposal := msg.GetCachedValue().(*v1.MsgExecLegacyContent)
+		sdkMsg, isLegacyProposal := msg.GetCachedValue().(*govv1.MsgExecLegacyContent)
 		if !isLegacyProposal {
 			continue
 		}
 
-		content, err := v1.LegacyContentFromMessage(sdkMsg)
+		content, err := govv1.LegacyContentFromMessage(sdkMsg)
 		if err != nil {
 			panic(fmt.Errorf("failed to get legacy proposal %d from prop message", proposalID))
 		}

x/ccv/provider/keeper/keeper.go

@@ -23,7 +23,6 @@ import (
 	paramtypes "github.com/cosmos/cosmos-sdk/x/params/types"
 
 	"cosmossdk.io/log"
-	govkeeper "github.com/cosmos/cosmos-sdk/x/gov/keeper"
 
 	consumertypes "github.com/cosmos/interchain-security/v5/x/ccv/consumer/types"
 	"github.com/cosmos/interchain-security/v5/x/ccv/provider/types"
@@ -48,7 +47,7 @@ type Keeper struct {
 	slashingKeeper     ccv.SlashingKeeper
 	distributionKeeper ccv.DistributionKeeper
 	bankKeeper         ccv.BankKeeper
-	govKeeper          govkeeper.Keeper
+	govKeeper          ccv.GovKeeper
 	feeCollectorName   string
 
 	validatorAddressCodec addresscodec.Codec
@@ -64,7 +63,7 @@ func NewKeeper(
 	stakingKeeper ccv.StakingKeeper, slashingKeeper ccv.SlashingKeeper,
 	accountKeeper ccv.AccountKeeper,
 	distributionKeeper ccv.DistributionKeeper, bankKeeper ccv.BankKeeper,
-	govKeeper govkeeper.Keeper,
+	govKeeper ccv.GovKeeper,
 	authority string,
 	validatorAddressCodec, consensusAddressCodec addresscodec.Codec,
 	feeCollectorName string,

x/ccv/types/expected_keepers.go

@@ -12,6 +12,7 @@ import (
 
 	"cosmossdk.io/math"
 	storetypes "cosmossdk.io/store/types"
+	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	slashingtypes "github.com/cosmos/cosmos-sdk/x/slashing/types"
 	stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
@@ -118,6 +119,23 @@ type ConsumerHooks interface {
 	AfterValidatorBonded(ctx context.Context, consAddr sdk.ConsAddress, valAddresses sdk.ValAddress) error
 }
 
+// Proposal defines the minimal proposal type needed by ICS
+// This is a simplified version that only contains the fields ICS actually uses
+type Proposal struct {
+	Messages []*codectypes.Any
+}
+
+// GetMessages returns the proposal messages
+func (p Proposal) GetMessages() []*codectypes.Any {
+	return p.Messages
+}
+
+// GovKeeper defines the expected interface for the governance keeper
+// Compatible with AtomOne's custom governance implementation
+type GovKeeper interface {
+	GetProposal(ctx sdk.Context, proposalID uint64) (Proposal, bool)
+}
+
 // BankKeeper defines the expected interface needed to retrieve account balances.
 type BankKeeper interface {
 	GetBalance(ctx context.Context, addr sdk.AccAddress, denom string) sdk.Coin