store

package

v1.1.3 Latest Latest Go to latest Published: Mar 27, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/icon-project/centralized-relay

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func GetKey(keys []string) []byte
type BlockStore
- func NewBlockStore(db Store, prefix string) *BlockStore
type FinalityStore
- func NewFinalityStore(db Store, prefix string) *FinalityStore
type KeyValueReader
type KeyValueWriter
type MessageStore
- func NewMessageStore(db Store, prefix string) *MessageStore
type Pagination
- func NewPagination() *Pagination
type Store

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrNotFound = errors.New("key not found")
)

Functions ¶

func GetKey ¶

func GetKey(keys []string) []byte

Types ¶

type BlockStore ¶

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

func NewBlockStore ¶

func NewBlockStore(db Store, prefix string) *BlockStore

func (*BlockStore) Decode ¶

func (ms *BlockStore) Decode(data []byte, output interface{}) error

func (*BlockStore) Encode ¶

func (ms *BlockStore) Encode(d interface{}) ([]byte, error)

func (*BlockStore) GetKey ¶

func (bs *BlockStore) GetKey(nId string) []byte

func (*BlockStore) GetLastStoredBlock ¶

func (bs *BlockStore) GetLastStoredBlock(nId string) (uint64, error)

GetLastStoredBlock queries the blockstore and returns latest known block

func (*BlockStore) StoreBlock ¶

func (bs *BlockStore) StoreBlock(height uint64, nId string) error

StoreBlock stores block number per domainID into blockstore

type FinalityStore ¶

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

func NewFinalityStore ¶

func NewFinalityStore(db Store, prefix string) *FinalityStore

func (*FinalityStore) Decode ¶

func (ms *FinalityStore) Decode(data []byte, output interface{}) error

func (*FinalityStore) DeleteTxObject ¶

func (ms *FinalityStore) DeleteTxObject(messageKey *types.MessageKey) error

func (*FinalityStore) Encode ¶

func (ms *FinalityStore) Encode(d interface{}) ([]byte, error)

func (*FinalityStore) GetTxObject ¶

func (ms *FinalityStore) GetTxObject(messageKey *types.MessageKey) (*types.TransactionObject, error)

func (*FinalityStore) GetTxObjects ¶

func (ms *FinalityStore) GetTxObjects(nId string, p *Pagination) ([]*types.TransactionObject, error)

func (*FinalityStore) StoreTxObject ¶

func (ms *FinalityStore) StoreTxObject(message *types.TransactionObject) error

message will be stored based on destination nId

func (*FinalityStore) TotalCount ¶

func (ms *FinalityStore) TotalCount() (uint64, error)

func (*FinalityStore) TotalCountByChain ¶

func (ms *FinalityStore) TotalCountByChain(nId string) (uint64, error)

type KeyValueReader ¶

type KeyValueReader interface {
	GetByKey(key []byte) ([]byte, error)
}

type KeyValueWriter ¶

type KeyValueWriter interface {
	SetByKey(key []byte, value []byte) error
}

type MessageStore ¶

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

func NewMessageStore ¶

func NewMessageStore(db Store, prefix string) *MessageStore

func (*MessageStore) Decode ¶

func (ms *MessageStore) Decode(data []byte, output interface{}) error

func (*MessageStore) DeleteMessage ¶

func (ms *MessageStore) DeleteMessage(messageKey *types.MessageKey) error

func (*MessageStore) Encode ¶

func (ms *MessageStore) Encode(d interface{}) ([]byte, error)

func (*MessageStore) GetMessage ¶

func (ms *MessageStore) GetMessage(messageKey *types.MessageKey) (*types.RouteMessage, error)

func (*MessageStore) GetMessages ¶

func (ms *MessageStore) GetMessages(nId string, p *Pagination) ([]*types.RouteMessage, error)

func (*MessageStore) StoreMessage ¶

func (ms *MessageStore) StoreMessage(message *types.RouteMessage) error

func (*MessageStore) TotalCount ¶

func (ms *MessageStore) TotalCount() (uint, error)

func (*MessageStore) TotalCountByChain ¶

func (ms *MessageStore) TotalCountByChain(nId string) (uint, error)

type Pagination struct {
	Limit  uint
	Offset uint
	All    bool
}

func NewPagination ¶

func NewPagination() *Pagination

func (p *Pagination) CalculateOffset(page uint) uint

CalculateOffset calculates the offset based on the page and limit

func (p *Pagination) CalculateTotalPages(total int) uint

CalculateTotalPages calculates the total pages based on the limit and total count

func (p *Pagination) GetAll() *Pagination

func (p *Pagination) WithLimit(l uint) *Pagination

func (p *Pagination) WithOffset(o uint) *Pagination

func (p *Pagination) WithPage(page, limit uint) *Pagination

WithPage sets the page and calculates the offset

type Store ¶

type Store interface {
	KeyValueReader
	KeyValueWriter
	NewIterator(prefix []byte) iterator.Iterator
	ClearStore() error
	DeleteByKey(key []byte) error
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL