keeper

package
v2.4.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 9, 2025 License: Apache-2.0 Imports: 30 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ErrConsensusQueueNotImplemented   = whoops.Errorf("consensus queue not implemented for queueTypeName %s")
	ErrUnableToFindPubKeyForValidator = whoops.Errorf("unable to find public key for validator: %s")
	ErrSignatureVerificationFailed    = whoops.Errorf("signature verification failed (msgId: %d, valAddr: %s, pubKey: %s)")
	ErrInvalidLimitValue              = whoops.Errorf("invalid N value: %d")
)

Variables

This section is empty.

Functions

func NewMsgServerImpl 

func NewMsgServerImpl(keeper Keeper) types.MsgServer

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

func NewRegistry 

func NewRegistry() *registry

Types

type FeeProvider 

type FeeProvider interface {
	GetCombinedFeesForRelay(ctx context.Context, valAddress sdk.ValAddress, chainReferenceID string) (*types.MessageFeeSettings, error)
}

type Keeper 

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

func NewKeeper 

func NewKeeper(
	cdc codec.Codec,
	storeKey store.KVStoreService,
	ps paramtypes.Subspace,
	valsetKeeper types.ValsetKeeper,
	reg *registry,
	fp FeeProvider,
) *Keeper

func (*Keeper) AddMessageConsensusAttestedListener 

func (k *Keeper) AddMessageConsensusAttestedListener(l metrixtypes.OnConsensusMessageAttestedListener)

func (Keeper) AddMessageEvidence 

func (k Keeper) AddMessageEvidence(
	ctx context.Context,
	valAddr sdk.ValAddress,
	msg *types.MsgAddEvidence,
) error

func (Keeper) AddMessageGasEstimates 

func (k Keeper) AddMessageGasEstimates(
	ctx context.Context,
	valAddr sdk.ValAddress,
	msgs []*types.MsgAddMessageGasEstimates_GasEstimate,
) error

func (Keeper) AddMessageSignature 

func (k Keeper) AddMessageSignature(
	ctx context.Context,
	valAddr sdk.ValAddress,
	msgs []*types.ConsensusMessageSignature,
) error

AddMessageSignature adds signatures to the messages.

func (Keeper) CheckAndProcessAttestedMessages 

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

CheckAndProcessAttestedMessages is supposed to be used within the EndBlocker. It will get messages for the attestators that have reached a consensus and process them.

func (Keeper) CheckAndProcessEstimatedMessages 

func (k Keeper) CheckAndProcessEstimatedMessages(ctx context.Context) (err error)

CheckAndProcessEstimatedMessages is supposed to be used within the EndBlocker. It will get messages which have received gas estimates and try to process them.

func (Keeper) DeleteJob 

func (k Keeper) DeleteJob(ctx context.Context, queueTypeName string, id uint64) (err error)

func (Keeper) GetAllQueueNames 

func (k Keeper) GetAllQueueNames(goCtx context.Context, req *types.QueryGetAllQueueNamesRequest) (*types.QueryGetAllQueueNamesResponse, error)

func (Keeper) GetMessagesForAttesting 

func (k Keeper) GetMessagesForAttesting(ctx context.Context, queueTypeName string, valAddress sdk.ValAddress) (msgs []types.QueuedSignedMessageI, err error)

GetMessagesForAttesting returns messages for a single validator to attest.

func (Keeper) GetMessagesForGasEstimation 

func (k Keeper) GetMessagesForGasEstimation(ctx context.Context, queueTypeName string, valAddress sdk.ValAddress) (msgs []types.QueuedSignedMessageI, err error)

func (Keeper) GetMessagesForRelaying 

func (k Keeper) GetMessagesForRelaying(ctx context.Context, queueTypeName string, valAddress sdk.ValAddress) (msgs []types.QueuedSignedMessageI, err error)

GetMessagesForRelaying returns messages for a single validator to relay.

func (Keeper) GetMessagesForSigning 

func (k Keeper) GetMessagesForSigning(ctx context.Context, queueTypeName string, valAddress sdk.ValAddress) (msgs []types.QueuedSignedMessageI, err error)

GetMessagesForSigning returns messages for a single validator that needs to be signed.

func (Keeper) GetMessagesFromQueue 

func (k Keeper) GetMessagesFromQueue(ctx context.Context, queueTypeName string, n int) (msgs []types.QueuedSignedMessageI, err error)

GetMessagesFromQueue gets N messages from the queue.

func (Keeper) GetMessagesThatHaveReachedConsensus 

func (k Keeper) GetMessagesThatHaveReachedConsensus(ctx context.Context, queueTypeName string) ([]types.QueuedSignedMessageI, error)

GetMessagesThatHaveReachedConsensus returns messages from a given queueTypeName that have reached consensus based on the latest snapshot available. TODO: This is never used?

func (Keeper) GetParams 

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

GetParams get all parameters as types.Params

func (Keeper) GetPendingValsetUpdates 

func (k Keeper) GetPendingValsetUpdates(ctx context.Context, queueTypeName string) ([]types.QueuedSignedMessageI, error)

TODO: The infusion of EVM types into the consensus module is a bit of a code smell. We should consider moving the entire logic of message assignment and retrieval to the EVM module to keep the consensus module content-agnostic.

func (*Keeper) LateInject 

func (k *Keeper) LateInject(evm types.EvmKeeper)

func (Keeper) Logger 

func (k Keeper) Logger(ctx context.Context) log.Logger

func (Keeper) MessageByID 

func (k Keeper) MessageByID(goCtx context.Context, req *types.QueryMessageByIDRequest) (*types.MessageQueryResult, error)

func (Keeper) MessagesInQueue 

func (k Keeper) MessagesInQueue(goCtx context.Context, req *types.QueryMessagesInQueueRequest) (*types.QueryMessagesInQueueResponse, error)

func (Keeper) ModuleName 

func (k Keeper) ModuleName() string

func (Keeper) Params 

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

func (Keeper) PruneJob 

func (k Keeper) PruneJob(sdkCtx sdk.Context, queueTypeName string, id uint64) error

PruneJob should only be called during the EndBlocker, it will automatically jail any validators who failed to supply evidence for this message. Any message that actually reached consensus will be removed from the queue during attestation, other messages like superfluous valset updates will get removed in their respective logic flows, but none of them should be using this function.

func (Keeper) PruneOldMessages 

func (k Keeper) PruneOldMessages(ctx sdk.Context, blocksAgo int64) error

func (Keeper) PutMessageInQueue 

func (k Keeper) PutMessageInQueue(ctx context.Context, queueTypeName string, msg consensus.ConsensusMsg, opts *consensus.PutOptions) (uint64, error)

func (Keeper) QueuedMessagesForAttesting 

func (k Keeper) QueuedMessagesForAttesting(goCtx context.Context, req *types.QueryQueuedMessagesForAttestingRequest) (*types.QueryQueuedMessagesForAttestingResponse, error)

func (Keeper) QueuedMessagesForGasEstimation 

func (k Keeper) QueuedMessagesForGasEstimation(goCtx context.Context, req *types.QueryQueuedMessagesForGasEstimationRequest) (*types.QueryQueuedMessagesForGasEstimationResponse, error)

func (Keeper) QueuedMessagesForRelaying 

func (k Keeper) QueuedMessagesForRelaying(goCtx context.Context, req *types.QueryQueuedMessagesForRelayingRequest) (*types.QueryQueuedMessagesForRelayingResponse, error)

func (Keeper) QueuedMessagesForSigning 

func (k Keeper) QueuedMessagesForSigning(goCtx context.Context, req *types.QueryQueuedMessagesForSigningRequest) (*types.QueryQueuedMessagesForSigningResponse, error)

func (Keeper) ReassignOrphanedMessages 

func (k Keeper) ReassignOrphanedMessages(ctx sdk.Context, blockAge int64) (err error)

func (Keeper) RemoveConsensusQueue 

func (k Keeper) RemoveConsensusQueue(ctx context.Context, queueTypeName string) error

func (Keeper) SetMessageErrorData 

func (k Keeper) SetMessageErrorData(
	ctx context.Context,
	valAddr sdk.ValAddress,
	msg *types.MsgSetErrorData,
) error

func (Keeper) SetMessagePublicAccessData 

func (k Keeper) SetMessagePublicAccessData(
	ctx context.Context,
	valAddr sdk.ValAddress,
	msg *types.MsgSetPublicAccessData,
) error

func (Keeper) SetParams 

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

SetParams set the params

func (Keeper) Store 

func (k Keeper) Store(ctx context.Context) storetypes.KVStore

Source Files

View all Source files

Directories

Path Synopsis
mocks

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.