cosmos-sdk/collections/lookup_map.go
Likhita Polavarapu 639735d41a
feat(collections): Implement LookupMap (#18933)
Co-authored-by: cool-developer <51834436+cool-develope@users.noreply.github.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2024-01-30 08:21:28 +00:00

105 lines
2.8 KiB
Go

package collections
import (
"context"
"fmt"
"cosmossdk.io/collections/codec"
)
// LookupMap represents a map that is not iterable.
type LookupMap[K, V any] Map[K, V]
// NewLookupMap creates a new LookupMap.
func NewLookupMap[K, V any](
schemaBuilder *SchemaBuilder,
prefix Prefix,
name string,
keyCodec codec.KeyCodec[K],
valueCodec codec.ValueCodec[V],
) LookupMap[K, V] {
m := LookupMap[K, V](NewMap[K, V](schemaBuilder, prefix, name, keyCodec, valueCodec))
return m
}
// GetName returns the name of the collection.
func (m LookupMap[K, V]) GetName() string {
return m.name
}
// GetPrefix returns the prefix of the collection.
func (m LookupMap[K, V]) GetPrefix() []byte {
return m.prefix
}
// Set maps the provided value to the provided key in the store.
// Errors with ErrEncoding if key or value encoding fails.
func (m LookupMap[K, V]) Set(ctx context.Context, key K, value V) error {
bytesKey, err := EncodeKeyWithPrefix(m.prefix, m.kc, key)
if err != nil {
return err
}
valueBytes, err := m.vc.Encode(value)
if err != nil {
return fmt.Errorf("%w: value encode: %w", ErrEncoding, err)
}
kvStore := m.sa(ctx)
return kvStore.Set(bytesKey, valueBytes)
}
// Get returns the value associated with the provided key,
// errors with ErrNotFound if the key does not exist, or
// with ErrEncoding if the key or value decoding fails.
func (m LookupMap[K, V]) Get(ctx context.Context, key K) (v V, err error) {
bytesKey, err := EncodeKeyWithPrefix(m.prefix, m.kc, key)
if err != nil {
return v, err
}
kvStore := m.sa(ctx)
valueBytes, err := kvStore.Get(bytesKey)
if err != nil {
return v, err
}
if valueBytes == nil {
return v, fmt.Errorf("%w: key '%s' of type %s", ErrNotFound, m.kc.Stringify(key), m.vc.ValueType())
}
v, err = m.vc.Decode(valueBytes)
if err != nil {
return v, fmt.Errorf("%w: value decode: %w", ErrEncoding, err)
}
return v, nil
}
// Has reports whether the key is present in storage or not.
// Errors with ErrEncoding if key encoding fails.
func (m LookupMap[K, V]) Has(ctx context.Context, key K) (bool, error) {
bytesKey, err := EncodeKeyWithPrefix(m.prefix, m.kc, key)
if err != nil {
return false, err
}
kvStore := m.sa(ctx)
return kvStore.Has(bytesKey)
}
// Remove removes the key from the storage.
// Errors with ErrEncoding if key encoding fails.
// If the key does not exist then this is a no-op.
func (m LookupMap[K, V]) Remove(ctx context.Context, key K) error {
bytesKey, err := EncodeKeyWithPrefix(m.prefix, m.kc, key)
if err != nil {
return err
}
kvStore := m.sa(ctx)
return kvStore.Delete(bytesKey)
}
// KeyCodec returns the Map's KeyCodec.
func (m LookupMap[K, V]) KeyCodec() codec.KeyCodec[K] { return m.kc }
// ValueCodec returns the Map's ValueCodec.
func (m LookupMap[K, V]) ValueCodec() codec.ValueCodec[V] { return m.vc }