keeper

Documentation

Index

• Constants
• func EmitEvent(k HasModuleName, ctx sdk.Context, name string, attrs ...sdk.Attribute)
• func IterAll[T codec.ProtoMarshaler](store sdk.KVStore, pu ProtoUnmarshaler) ([][]byte, []T, error)
• func IterAllFnc[T codec.ProtoMarshaler](store sdk.KVStore, pu ProtoUnmarshaler, fnc func([]byte, T) bool) error
• func IterAllRaw(store sdk.KVStore, pu ProtoUnmarshaler) (keys [][]byte, values [][]byte, _err error)
• func Load[T codec.ProtoMarshaler](store sdk.KVStore, pu ProtoUnmarshaler, key []byte) (T, error)
• func Save(store sdk.KVStore, pm ProtoMarshaler, key []byte, val codec.ProtoMarshaler) error
• func Uint64ToByte(n uint64) []byte
• 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 sdk.Context, name string) uint64
  • func (i IDGenerator) IncrementNextID(ctx sdk.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]) Set(ctx types.Context, key Byter, value T) error
• type KeeperUtil
  • func (ku KeeperUtil[T]) Load(store sdk.KVStore, pu ProtoUnmarshaler, key []byte) (T, error)
  • func (ku KeeperUtil[T]) Save(store sdk.KVStore, pm ProtoMarshaler, key []byte, val codec.ProtoMarshaler) error
• type KeeperUtilI
• type ProtoMarshaler
• type ProtoSerializer
• type ProtoUnmarshaler
• type StoreGetter
  • func SimpleStoreGetter(s sdk.KVStore) StoreGetter
• type StoreGetterFn
  • func (s StoreGetterFn) Store(ctx sdk.Context) sdk.KVStore

Constants

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

Functions

func EmitEvent

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

func IterAll

func IterAll[T codec.ProtoMarshaler](store sdk.KVStore, pu ProtoUnmarshaler) ([][]byte, []T, error)

func IterAllFnc

func IterAllFnc[T codec.ProtoMarshaler](store sdk.KVStore, pu ProtoUnmarshaler, fnc func([]byte, T) bool) error

func IterAllRaw

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

func Load

func Load[T codec.ProtoMarshaler](store sdk.KVStore, pu ProtoUnmarshaler, key []byte) (T, error)

func Save

func Save(store sdk.KVStore, pm ProtoMarshaler, key []byte, val codec.ProtoMarshaler) error

func Uint64ToByte

func Uint64ToByte(n uint64) []byte

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 sdk.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 sdk.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]) 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 sdk.KVStore, pu ProtoUnmarshaler, key []byte) (T, error)

func (KeeperUtil[T]) Save

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

type KeeperUtilI

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

type ProtoMarshaler

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

type ProtoSerializer

type ProtoSerializer interface {
	ProtoMarshaler
	ProtoUnmarshaler
}

type ProtoUnmarshaler

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

type StoreGetter

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

func SimpleStoreGetter

func SimpleStoreGetter(s sdk.KVStore) StoreGetter

type StoreGetterFn

type StoreGetterFn func(ctx sdk.Context) sdk.KVStore

func (StoreGetterFn) Store

func (s StoreGetterFn) Store(ctx sdk.Context) sdk.KVStore