db

Documentation

Overview

Package db contains the database implementation for the relayer

Index

• type CCTPRelayerDB
• type CCTPRelayerDBReader
• type CCTPRelayerDBWriter

Types

type CCTPRelayerDB

type CCTPRelayerDB interface {
	CCTPRelayerDBReader
	CCTPRelayerDBWriter
	SubmitterDB() submitterDB.Service
}

CCTPRelayerDB is the interface for the database service.

type CCTPRelayerDBReader

type CCTPRelayerDBReader interface {
	// GetLastBlockNumber gets the last block number that had a message for the respective origin chain in the database.
	GetLastBlockNumber(ctx context.Context, chainID uint32) (uint64, error)
	// GetMessagesByState gets all messages with the given state.
	GetMessagesByState(ctx context.Context, states ...types.MessageState) ([]types.Message, error)
	// GetMessageByOriginHash gets a message by its origin hash.
	GetMessageByOriginHash(ctx context.Context, originHash common.Hash) (*types.Message, error)
	// GetMessageByRequestID gets a message by its request id.
	GetMessageByRequestID(ctx context.Context, requestID string) (*types.Message, error)
}

CCTPRelayerDBReader is the interface for reading from the database.

type CCTPRelayerDBWriter

type CCTPRelayerDBWriter interface {
	// StoreMessage stores a message in the database.
	StoreMessage(ctx context.Context, message types.Message) error
}

CCTPRelayerDBWriter is the interface for writing to the database.