keeper

Documentation

Index

• Constants
• Variables
• func EmitEvent(k HasModuleName, ctx context.Context, name string, attrs ...sdk.Attribute)
• func IterAll[T proto.Message](store storetypes.KVStore, pu ProtoUnmarshaler) ([][]byte, []T, error)
• func IterAllFnc[T proto.Message](store storetypes.KVStore, pu ProtoUnmarshaler, fnc func([]byte, T) bool) error
• func IterAllRaw(store storetypes.KVStore, pu ProtoUnmarshaler) (keys [][]byte, values [][]byte, _err error)
• func Load[T proto.Message](store storetypes.KVStore, pu ProtoUnmarshaler, key []byte) (T, error)
• func Save(store storetypes.KVStore, pm ProtoMarshaler, key []byte, val proto.Message) error
• func Uint64ToByte(n uint64) []byte
• func ValAddressFromBech32(addressCodec address.Codec, valAddr string) ([]byte, error)
• type Byter
• type EventAttribute
  • func (e EventAttribute) With(value string) sdk.Attribute
• type HasModuleName
  • func ModuleNameFunc(moduleName string) HasModuleName
• type IDGenerator
  • func NewIDGenerator(sg StoreGetter, idkey []byte) IDGenerator
  • func (i IDGenerator) GetLastID(ctx context.Context, name string) uint64
  • func (i IDGenerator) IncrementNextID(ctx context.Context, name string) uint64
  • func (i IDGenerator) Zero() bool
• type KVStoreWrapper
  • func NewKvStoreWrapper[T codec.ProtoMarshaler](s StoreGetterFn, ps ProtoSerializer) *KVStoreWrapper[T]
  • func (v *KVStoreWrapper[T]) Get(ctx types.Context, key Byter) (T, error)
  • func (v *KVStoreWrapper[T]) Iterate(ctx types.Context, fn func([]byte, T) bool) error
  • func (v *KVStoreWrapper[T]) Set(ctx types.Context, key Byter, value T) error
• type KeeperUtil
  • func (ku KeeperUtil[T]) Load(store storetypes.KVStore, pu ProtoUnmarshaler, key []byte) (T, error)
  • func (ku KeeperUtil[T]) Save(store storetypes.KVStore, pm ProtoMarshaler, key []byte, ...) error
• type KeeperUtilI
• type ProtoMarshaler
• type ProtoSerializer
• type ProtoUnmarshaler
• type StoreGetter
  • func SimpleStoreGetter(s storetypes.KVStore) StoreGetter
• type StoreGetterFn
  • func (s StoreGetterFn) Store(ctx context.Context) storetypes.KVStore

Constants

const ErrFailedToParseValAddress = liberr.Error("failed to parse validator address from bech32: %s")

const (
	ErrNotFound = whoops.Errorf("item (%T) not found in store: %s")
)

Variables

var ErrUnknownPanic = errors.New("unknown panic")

Functions

func EmitEvent

func EmitEvent(k HasModuleName, ctx context.Context, name string, attrs ...sdk.Attribute)

func IterAll

func IterAll[T proto.Message](store storetypes.KVStore, pu ProtoUnmarshaler) ([][]byte, []T, error)

func IterAllFnc

func IterAllFnc[T proto.Message](store storetypes.KVStore, pu ProtoUnmarshaler, fnc func([]byte, T) bool) error

func IterAllRaw

func IterAllRaw(store storetypes.KVStore, pu ProtoUnmarshaler) (keys [][]byte, values [][]byte, _err error)

func Load

func Load[T proto.Message](store storetypes.KVStore, pu ProtoUnmarshaler, key []byte) (T, error)

func Save

func Save(store storetypes.KVStore, pm ProtoMarshaler, key []byte, val proto.Message) error

func Uint64ToByte

func Uint64ToByte(n uint64) []byte

func ValAddressFromBech32

func ValAddressFromBech32(addressCodec address.Codec, valAddr string) ([]byte, error)

Types

type Byter

type Byter interface {
	Bytes() []byte
}

type EventAttribute

type EventAttribute string

func (EventAttribute) With

func (e EventAttribute) With(value string) sdk.Attribute

type HasModuleName

type HasModuleName interface {
	ModuleName() string
}

func ModuleNameFunc

func ModuleNameFunc(moduleName string) HasModuleName

type IDGenerator

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

func NewIDGenerator

func NewIDGenerator(sg StoreGetter, idkey []byte) IDGenerator

NewIDGenerator creates a new ID generator. IT uses idKey as a main

func (IDGenerator) GetLastID

func (i IDGenerator) GetLastID(ctx context.Context, name string) uint64

getLastID returns the last id that was inserted for the given name. If one does not exist, then it returns 0,

func (IDGenerator) IncrementNextID

func (i IDGenerator) IncrementNextID(ctx context.Context, name string) uint64

incrementNextID returns new ID which can now be used for referencing data and increments the counter internally. It returns the newly inserted ID.

func (IDGenerator) Zero

func (i IDGenerator) Zero() bool

type KVStoreWrapper

type KVStoreWrapper[T codec.ProtoMarshaler] struct {
	// contains filtered or unexported fields
}

func NewKvStoreWrapper

func NewKvStoreWrapper[T codec.ProtoMarshaler](s StoreGetterFn, ps ProtoSerializer) *KVStoreWrapper[T]

func (*KVStoreWrapper[T]) Get

func (v *KVStoreWrapper[T]) Get(ctx types.Context, key Byter) (T, error)

func (*KVStoreWrapper[T]) Iterate

func (v *KVStoreWrapper[T]) Iterate(ctx types.Context, fn func([]byte, T) bool) error

func (*KVStoreWrapper[T]) Set

func (v *KVStoreWrapper[T]) Set(ctx types.Context, key Byter, value T) error

type KeeperUtil

type KeeperUtil[T codec.ProtoMarshaler] struct {
	Val T
}

func (KeeperUtil[T]) Load

func (ku KeeperUtil[T]) Load(store storetypes.KVStore, pu ProtoUnmarshaler, key []byte) (T, error)

func (KeeperUtil[T]) Save

func (ku KeeperUtil[T]) Save(store storetypes.KVStore, pm ProtoMarshaler, key []byte, val codec.ProtoMarshaler) error

type KeeperUtilI

type KeeperUtilI[T codec.ProtoMarshaler] interface {
	Save(store storetypes.KVStore, pm ProtoMarshaler, key []byte, val codec.ProtoMarshaler) error
	Load(store storetypes.KVStore, pu ProtoUnmarshaler, key []byte) (T, error)
}

type ProtoMarshaler

type ProtoMarshaler interface {
	Marshal(ptr proto.Message) ([]byte, error)
}

type ProtoSerializer

type ProtoSerializer interface {
	ProtoMarshaler
	ProtoUnmarshaler
}

type ProtoUnmarshaler

type ProtoUnmarshaler interface {
	Unmarshal(bz []byte, ptr proto.Message) error
}

type StoreGetter

type StoreGetter interface {
	Store(ctx context.Context) storetypes.KVStore
}

func SimpleStoreGetter

func SimpleStoreGetter(s storetypes.KVStore) StoreGetter

type StoreGetterFn

type StoreGetterFn func(ctx context.Context) storetypes.KVStore

func (StoreGetterFn) Store

func (s StoreGetterFn) Store(ctx context.Context) storetypes.KVStore