subspace.go

package keeper

import (
	"fmt"
	"github.com/pokt-network/pocket-core/codec"
	"os"

	sdk "github.com/pokt-network/pocket-core/types"
	"github.com/pokt-network/pocket-core/x/gov/types"
)

const (
	FeatureUpgradeKey                    = "FEATURE"
	mAxValidatorsACLKey                  = "pos/MaxValidators"
	minSafeMaxValidatorParamChangeHeight = 40000
)

// Allocate subspace used for keepers
func (k Keeper) Subspace(s string) sdk.Subspace {
	_, ok := k.spaces[s]
	if ok {
		fmt.Println(fmt.Errorf("subspace %s already occupied", s))
		os.Exit(1)
	}
	if s == "" {
		fmt.Println(fmt.Errorf("cannot use empty stirng for subspace"))
		os.Exit(1)
	}
	space := sdk.NewSubspace(s)
	space.SetCodec(k.cdc)
	k.spaces[s] = space
	return space
}

func (k Keeper) AddSubspaces(subspaces ...sdk.Subspace) {
	for _, space := range subspaces {
		_, ok := k.spaces[space.Name()]
		if ok {
			fmt.Println(fmt.Errorf("subspace %s already occupied", space.Name()))
			os.Exit(1)
		}
		if space.Name() == "" {
			fmt.Println(fmt.Errorf("cannot use empty stirng for subspace"))
			os.Exit(1)
		}
		space.SetCodec(k.cdc)
		k.spaces[space.Name()] = space
	}
}

// Get existing substore from keeper
func (k Keeper) GetSubspace(s string) (sdk.Subspace, bool) {
	space, ok := k.spaces[s]
	if !ok {
		return sdk.Subspace{}, false
	}
	return space, ok
}

func (k Keeper) GetAllParamNames(ctx sdk.Ctx) (paramNames map[string]bool) {
	paramNames = make(map[string]bool)
	for _, space := range k.spaces {
		keys := space.GetAllParamKeys(ctx)
		for _, key := range keys {
			paramNames[space.Name()+"/"+key] = false // set to false for adjacency matrix
		}
	}
	return
}

func (k Keeper) GetAllParamNameValue(ctx sdk.Ctx) (paramNames map[string]string) {
	paramNames = make(map[string]string)
	for _, space := range k.spaces {
		keys := space.GetAllParamKeys(ctx)
		for _, key := range keys {
			paramNames[space.Name()+"/"+key] = string(space.GetIfExistsRaw(ctx, []byte(key)))
		}
	}
	return
}

func (k Keeper) HandleUpgrade(ctx sdk.Ctx, aclKey string, paramValue interface{}, owner sdk.Address) sdk.Result {
	if ctx.IsAfterUpgradeHeight() {
		return handleUpgradeAfterUpdate(ctx, aclKey, paramValue, owner, k)
	} else {
		if err := k.VerifyACL(ctx, aclKey, owner); err != nil {
			return err.Result()
		}
		subspaceName, paramKey := types.SplitACLKey(aclKey)
		space, ok := k.spaces[subspaceName]
		if !ok {
			k.Logger(ctx).Error(types.ErrSubspaceNotFound(types.ModuleName, subspaceName).Error())
			os.Exit(1)
		}
		space.Set(ctx, []byte(paramKey), paramValue)
		k.spaces[subspaceName] = space
		// create the event
		ctx.EventManager().EmitEvents(sdk.Events{
			sdk.NewEvent(
				types.EventParamChange,
				sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
				sdk.NewAttribute(sdk.AttributeKeyAction, fmt.Sprintf("modified: %s to: %v", aclKey, paramValue)),
				sdk.NewAttribute(sdk.AttributeKeySender, owner.String()),
			),
			sdk.NewEvent(
				sdk.EventTypeMessage,
				sdk.NewAttribute(sdk.AttributeKeyModule, types.AttributeValueCategory),
				sdk.NewAttribute(sdk.AttributeKeySender, owner.String()),
			),
		})
		// if upgrade, emit separate upgrade event
		if aclKey == types.NewACLKey(types.ModuleName, string(types.UpgradeKey)) {
			u, ok := paramValue.(types.Upgrade)
			if !ok {
				ctx.Logger().Error(fmt.Sprintf("unable to convert %v to upgrade, can't emit event about upgrade, at height: %d", paramValue, ctx.BlockHeight()))
				return sdk.Result{Events: ctx.EventManager().Events()}
			}
			codec.UpgradeHeight = u.Height
			ctx.EventManager().EmitEvent(sdk.NewEvent(
				types.EventUpgrade,
				sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
				sdk.NewAttribute(sdk.AttributeKeyAction, fmt.Sprintf("UPGRADE CONFIRMED: %s at height %v", u.UpgradeVersion(), u.UpgradeHeight())),
				sdk.NewAttribute(sdk.AttributeKeySender, owner.String()),
			))
		}
		return sdk.Result{Events: ctx.EventManager().Events()}
	}
}

func handleUpgradeAfterUpdate(ctx sdk.Ctx, aclKey string, paramValue interface{}, owner sdk.Address, k Keeper) sdk.Result {
	if err := k.VerifyACL(ctx, aclKey, owner); err != nil {
		return err.Result()
	}
	subspaceName, paramKey := types.SplitACLKey(aclKey)
	space, ok := k.spaces[subspaceName]
	if !ok {
		k.Logger(ctx).Error(types.ErrSubspaceNotFound(types.ModuleName, subspaceName).Error())
		os.Exit(1)
	}
	//retrieve old upgrade
	oldUpgrade := types.Upgrade{}
	space.Get(ctx, []byte(paramKey), &oldUpgrade)
	newUpgrade, ok := paramValue.(types.Upgrade)

	if newUpgrade.UpgradeHeight() != 1 && newUpgrade.UpgradeVersion() != FeatureUpgradeKey {
		newUpgrade.OldUpgradeHeight = oldUpgrade.GetHeight()
		if oldUpgrade.GetFeatures() == nil {
			oldUpgrade.Features = make([]string, 0)
		}
		featureSet := append(oldUpgrade.Features, newUpgrade.Features...)
		newUpgrade.Features = codec.CleanUpgradeFeatureSlice(featureSet)
	} else {
		//copy old one to new as we just want to update the features
		newUpgrade.OldUpgradeHeight = oldUpgrade.OldUpgradeHeight
		newUpgrade.Version = oldUpgrade.Version
		newUpgrade.Height = oldUpgrade.Height
		if oldUpgrade.GetFeatures() == nil {
			oldUpgrade.Features = make([]string, 0)
		}
		featureSet := append(oldUpgrade.Features, newUpgrade.Features...)
		newUpgrade.Features = codec.CleanUpgradeFeatureSlice(featureSet)
	}

	space.Set(ctx, []byte(paramKey), newUpgrade)
	k.spaces[subspaceName] = space
	// create the event
	ctx.EventManager().EmitEvents(sdk.Events{
		sdk.NewEvent(
			types.EventParamChange,
			sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
			sdk.NewAttribute(sdk.AttributeKeyAction, fmt.Sprintf("modified: %s to: %v", aclKey, paramValue)),
			sdk.NewAttribute(sdk.AttributeKeySender, owner.String()),
		),
		sdk.NewEvent(
			sdk.EventTypeMessage,
			sdk.NewAttribute(sdk.AttributeKeyModule, types.AttributeValueCategory),
			sdk.NewAttribute(sdk.AttributeKeySender, owner.String()),
		),
	})
	// if upgrade, emit separate upgrade event
	if aclKey == types.NewACLKey(types.ModuleName, string(types.UpgradeKey)) {
		if !ok {
			ctx.Logger().Error(fmt.Sprintf("unable to convert %v to upgrade, can't emit event about upgrade, at height: %d", paramValue, ctx.BlockHeight()))
			return sdk.Result{Events: ctx.EventManager().Events()}
		}
		codec.UpgradeHeight = newUpgrade.Height
		codec.OldUpgradeHeight = newUpgrade.OldUpgradeHeight
		codec.UpgradeFeatureMap = codec.SliceToExistingMap(newUpgrade.GetFeatures(), codec.UpgradeFeatureMap)
		ctx.EventManager().EmitEvent(sdk.NewEvent(
			types.EventUpgrade,
			sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
			sdk.NewAttribute(sdk.AttributeKeyAction, fmt.Sprintf("UPGRADE CONFIRMED: %s at height %v", newUpgrade.UpgradeVersion(), newUpgrade.UpgradeHeight())),
			sdk.NewAttribute(sdk.AttributeKeySender, owner.String()),
		))
	}
	return sdk.Result{Events: ctx.EventManager().Events()}
}

func (k Keeper) ModifyParam(ctx sdk.Ctx, aclKey string, paramValue []byte, owner sdk.Address) sdk.Result {
	if err := k.VerifyACL(ctx, aclKey, owner); err != nil {
		return err.Result()
	}

	if ctx.BlockHeight() >= minSafeMaxValidatorParamChangeHeight {
		if !k.cdc.IsAfterValidatorSplitUpgrade(ctx.BlockHeight()) && aclKey == mAxValidatorsACLKey {
			return types.ErrUnauthorizedHeightParamChange(types.ModuleName, codec.UpgradeHeight, aclKey).Result()
		}
	}

	subspaceName, paramKey := types.SplitACLKey(aclKey)
	space, ok := k.spaces[subspaceName]
	if !ok {
		k.Logger(ctx).Error(types.ErrSubspaceNotFound(types.ModuleName, subspaceName).Error())
		os.Exit(1)
	}
	_ = space.Update(ctx, []byte(paramKey), paramValue)
	k.spaces[subspaceName] = space
	// create the event
	ctx.EventManager().EmitEvents(sdk.Events{
		sdk.NewEvent(
			types.EventParamChange,
			sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
			sdk.NewAttribute(sdk.AttributeKeyAction, fmt.Sprintf("modified: %s to: %v", aclKey, paramValue)),
			sdk.NewAttribute(sdk.AttributeKeySender, owner.String()),
		),
		sdk.NewEvent(
			sdk.EventTypeMessage,
			sdk.NewAttribute(sdk.AttributeKeyModule, types.AttributeValueCategory),
			sdk.NewAttribute(sdk.AttributeKeySender, owner.String()),
		),
	})
	return sdk.Result{Events: ctx.EventManager().Events()}
}