keeper

Documentation

Index

• Constants
• func GetNumBlocksUndelegationRetention(sharedParams *sharedtypes.Params) int64
• func NewMsgServerImpl(keeper Keeper) types.MsgServer
• type Keeper
  • func NewKeeper(cdc codec.BinaryCodec, storeService store.KVStoreService, logger log.Logger, ...) Keeper
  • func (k Keeper) AllApplications(ctx context.Context, req *types.QueryAllApplicationsRequest) (*types.QueryAllApplicationsResponse, error)
  • func (k Keeper) Application(ctx context.Context, req *types.QueryGetApplicationRequest) (*types.QueryGetApplicationResponse, error)
  • func (k Keeper) CleanupOrphanedUndelegationIndexes(ctx context.Context) (int, error)
  • func (k Keeper) EndBlockerAutoUndelegateFromUnbondingGateways(ctx cosmostypes.Context) error
  • func (k Keeper) EndBlockerPruneAppToGatewayPendingUndelegation(ctx sdk.Context) error
  • func (k Keeper) EndBlockerTransferApplication(ctx context.Context) error
  • func (k Keeper) EndBlockerUnbondApplications(ctx context.Context) error
  • func (k Keeper) GetAllApplications(ctx context.Context) (apps []types.Application)
  • func (k Keeper) GetAllApplicationsIterator(ctx context.Context) sharedtypes.RecordIterator[types.Application]
  • func (k Keeper) GetAllTransferringApplicationsIterator(ctx context.Context) sharedtypes.RecordIterator[types.Application]
  • func (k Keeper) GetAllUnstakingApplicationsIterator(ctx context.Context) sharedtypes.RecordIterator[types.Application]
  • func (k Keeper) GetApplication(ctx context.Context, appAddr string) (app types.Application, found bool)
  • func (k Keeper) GetAuthority() string
  • func (k Keeper) GetDelegationsIterator(ctx context.Context, gatewayAddress string) sharedtypes.RecordIterator[types.Application]
  • func (k Keeper) GetNumBlocksUndelegationRetention(ctx context.Context) int64
  • func (k Keeper) GetParams(ctx context.Context) (params types.Params)
  • func (k Keeper) GetUndelegationsIterator(ctx context.Context, applicationAddress string) sharedtypes.RecordIterator[types.PendingUndelegation]
  • func (k Keeper) Logger() log.Logger
  • func (k Keeper) Params(ctx context.Context, req *types.QueryParamsRequest) (*types.QueryParamsResponse, error)
  • func (k Keeper) RemoveApplication(ctx context.Context, application types.Application)
  • func (k Keeper) SetApplication(ctx context.Context, application types.Application)
  • func (k Keeper) SetParams(ctx context.Context, params types.Params) error
  • func (k Keeper) StakeApplication(ctx context.Context, logger cosmoslog.Logger, msg *types.MsgStakeApplication) (_ *types.Application, err error)
  • func (k Keeper) UnbondApplication(ctx context.Context, app *apptypes.Application) error

Constants

const ALL_UNDELEGATIONS = ""

const NumSessionsAppToGatewayUndelegationRetention = 2

NumSessionsAppToGatewayUndelegationRetention is the number of sessions for which undelegation from applications to gateways are delayed before being pruned. TODO_DOCUMENT(@red-0ne): Need to document the flow from this comment so its clear to everyone why this is necessary; https://github.com/pokt-network/poktroll/issues/476#issuecomment-2052639906. TODO_MAINNET(#516): Should this be configurable? Note that it should likely be a function of SubmitProofCloseWindowNumBlocks once implemented.

Functions

func GetNumBlocksUndelegationRetention

func GetNumBlocksUndelegationRetention(sharedParams *sharedtypes.Params) int64

GetNumBlocksUndelegationRetention returns the number of blocks for which undelegations should be kept before being pruned, given the passed shared module parameters.

func NewMsgServerImpl

func NewMsgServerImpl(keeper Keeper) types.MsgServer

NewMsgServerImpl returns an implementation of the MsgServer interface for the provided Keeper.

Types

type Keeper

type Keeper struct {
	// contains filtered or unexported fields
}

func NewKeeper

func NewKeeper(
	cdc codec.BinaryCodec,
	storeService store.KVStoreService,
	logger log.Logger,
	authority string,

	bankKeeper types.BankKeeper,
	accountKeeper types.AccountKeeper,
	gatewayKeeper types.GatewayKeeper,
	sharedKeeper types.SharedKeeper,
) Keeper

func (Keeper) AllApplications

func (k Keeper) AllApplications(ctx context.Context, req *types.QueryAllApplicationsRequest) (*types.QueryAllApplicationsResponse, error)

func (Keeper) Application

func (k Keeper) Application(ctx context.Context, req *types.QueryGetApplicationRequest) (*types.QueryGetApplicationResponse, error)

func (Keeper) CleanupOrphanedUndelegationIndexes

func (k Keeper) CleanupOrphanedUndelegationIndexes(ctx context.Context) (int, error)

CleanupOrphanedUndelegationIndexes removes orphaned undelegation index entries that reference applications which no longer exist in the store.

This can occur when an application with pending undelegations is removed (unstaked or transferred) but the undelegation index entries are not properly cleaned up due to a bug in removeApplicationUndelegationIndex that was deleting from the delegation store instead of the undelegation store.

Returns the count of orphaned entries removed and any error.

func (Keeper) EndBlockerAutoUndelegateFromUnbondingGateways

func (k Keeper) EndBlockerAutoUndelegateFromUnbondingGateways(ctx cosmostypes.Context) error

EndBlockerAutoUndelegateFromUnbondingGateways is called every block and handles Application auto-undelegating from unbonding gateways that are no longer active.

func (Keeper) EndBlockerPruneAppToGatewayPendingUndelegation

func (k Keeper) EndBlockerPruneAppToGatewayPendingUndelegation(ctx sdk.Context) error

EndBlockerPruneAppToGatewayPendingUndelegation runs at the end of each block and prunes app to gateway undelegations that have exceeded the retention delay.

func (Keeper) EndBlockerTransferApplication

func (k Keeper) EndBlockerTransferApplication(ctx context.Context) error

EndBlockerTransferApplication completes pending application transfers. This always happens on the last block of a session during which the transfer started. It is accomplished by:

1. Copying the current state of the source app onto a new destination app
2. Unstaking (removing) the source app
3. Staking (storing) the destination app

func (Keeper) EndBlockerUnbondApplications

func (k Keeper) EndBlockerUnbondApplications(ctx context.Context) error

EndBlockerUnbondApplications unbonds applications whose unbonding period has elapsed.

func (Keeper) GetAllApplications

func (k Keeper) GetAllApplications(ctx context.Context) (apps []types.Application)

GetAllApplications returns all applications in the store. - Ensures PendingUndelegations is always initialized

func (Keeper) GetAllApplicationsIterator

func (k Keeper) GetAllApplicationsIterator(ctx context.Context) sharedtypes.RecordIterator[types.Application]

GetAllApplicationsIterator returns a RecordIterator over all Application records. - Uses the main application store and unmarshals each record - Initializes nil fields in each application object

func (Keeper) GetAllTransferringApplicationsIterator

func (k Keeper) GetAllTransferringApplicationsIterator(
	ctx context.Context,
) sharedtypes.RecordIterator[types.Application]

GetAllTransferringApplicationsIterator returns an iterator over all transferring applications. - Uses transferring applications store as the source of truth - Accesses full application objects via primary key accessor

func (Keeper) GetAllUnstakingApplicationsIterator

func (k Keeper) GetAllUnstakingApplicationsIterator(
	ctx context.Context,
) sharedtypes.RecordIterator[types.Application]

GetAllUnstakingApplicationsIterator returns an iterator over all unstaking applications. - Uses unstaking applications store as the source of truth - Accesses full application objects via primary key accessor

func (Keeper) GetApplication

func (k Keeper) GetApplication(
	ctx context.Context,
	appAddr string,
) (app types.Application, found bool)

GetApplication retrieves an application by address. - Returns false if not found - Initializes PendingUndelegations as an empty map if nil - Initializes DelegateeGatewayAddresses as an empty slice if nil

func (Keeper) GetAuthority

func (k Keeper) GetAuthority() string

GetAuthority returns the module's authority.

func (Keeper) GetDelegationsIterator

func (k Keeper) GetDelegationsIterator(
	ctx context.Context,
	gatewayAddress string,
) sharedtypes.RecordIterator[types.Application]

GetDelegationsIterator returns an iterator for applications delegated to a specific gateway. - Filters delegations by gateway address prefix - Returns only delegations related to the given gateway

func (Keeper) GetNumBlocksUndelegationRetention

func (k Keeper) GetNumBlocksUndelegationRetention(ctx context.Context) int64

GetNumBlocksUndelegationRetention returns the number of blocks for which undelegations should be kept before being pruned, given the current onchain shared module parameters.

func (Keeper) GetParams

func (k Keeper) GetParams(ctx context.Context) (params types.Params)

GetParams get all parameters as types.Params

func (Keeper) GetUndelegationsIterator

func (k Keeper) GetUndelegationsIterator(
	ctx context.Context,
	applicationAddress string,
) sharedtypes.RecordIterator[types.PendingUndelegation]

GetUndelegationsIterator returns an iterator for applications with pending undelegations. - If ALL_UNDELEGATIONS is passed, returns all pending undelegations - Otherwise, filters by application address prefix

func (Keeper) Logger

func (k Keeper) Logger() log.Logger

Logger returns a module-specific logger.

func (Keeper) Params

func (k Keeper) Params(ctx context.Context, req *types.QueryParamsRequest) (*types.QueryParamsResponse, error)

func (Keeper) RemoveApplication

func (k Keeper) RemoveApplication(ctx context.Context, application types.Application)

RemoveApplication deletes an application from the store and all related indexes. - Removes from unstaking, transfer, undelegation, and delegation indexes - Deletes from the main application store

func (Keeper) SetApplication

func (k Keeper) SetApplication(ctx context.Context, application types.Application)

SetApplication sets an application in the store and updates all related indexes. - Indexes the application in all relevant indexes - Stores the application in the main application store

func (Keeper) SetParams

func (k Keeper) SetParams(ctx context.Context, params types.Params) error

SetParams set the params

func (Keeper) StakeApplication

func (k Keeper) StakeApplication(
	ctx context.Context,
	logger cosmoslog.Logger,
	msg *types.MsgStakeApplication,
) (_ *types.Application, err error)

StakeApplication stakes (or updates) the application according to the given msg by applying the following logic:

• the msg is validated
• if the application is not found, it is created (in memory) according to the valid msg
• if the application is found and is not unbonding, it is updated (in memory) according to the msg
• if the application is found and is unbonding, it is updated (in memory; and no longer unbonding)
• additional stake validation (e.g. min stake, etc.)
• the positive difference between the msg stake and any current stake is transferred from the staking application's account, to the application module's accounts.
• the (new or updated) application is persisted.
• an EventApplicationUnbondingCanceled event is emitted if the application was unbonding.
• an EventApplicationStaked event is emitted.

func (Keeper) UnbondApplication

func (k Keeper) UnbondApplication(ctx context.Context, app *apptypes.Application) error

UnbondApplication transfers the application stake to the bank module balance for the corresponding account and removes the application from the application module state.