collcompat

Documentation

Index

• Variables
• func LengthPrefixedAddressKey[T addressUnion](keyCodec collcodec.KeyCodec[T]) collcodec.KeyCodec[T]
• func NewKVStoreService(storeKey storetypes.StoreKey) store.KVStoreService
• func ProtoValue[T any, PT protoMessage[T]](cdc codec.BinaryCodec) collcodec.ValueCodec[T]

Variables

var (
	// AccAddressKey follows the same semantics of collections.BytesKey.
	// It just uses humanized format for the String() and EncodeJSON().
	AccAddressKey collcodec.KeyCodec[sdk.AccAddress] = genericAddressKey[sdk.AccAddress]{
					// contains filtered or unexported fields
	}

	// ValAddressKey follows the same semantics as AccAddressKey.
	ValAddressKey collcodec.KeyCodec[sdk.ValAddress] = genericAddressKey[sdk.ValAddress]{
					// contains filtered or unexported fields
	}

	// ConsAddressKey follows the same semantics as ConsAddressKey.
	ConsAddressKey collcodec.KeyCodec[sdk.ConsAddress] = genericAddressKey[sdk.ConsAddress]{
					// contains filtered or unexported fields
	}

	// IntValue represents a collections.ValueCodec to work with Int.
	IntValue collcodec.ValueCodec[math.Int] = intValueCodec{}

	// TimeKey represents a collections.KeyCodec to work with time.Time
	// Deprecated: exists only for state compatibility reasons, should not
	// be used for new storage keys using time. Please use the time KeyCodec
	// provided in the collections package.
	TimeKey collcodec.KeyCodec[time.Time] = timeKeyCodec{}
)

Functions

func LengthPrefixedAddressKey

func LengthPrefixedAddressKey[T addressUnion](keyCodec collcodec.KeyCodec[T]) collcodec.KeyCodec[T]

Deprecated: LengthPrefixedAddressKey implements an SDK backwards compatible indexing key encoder for addresses. The status quo in the SDK is that address keys are length prefixed even when they're the last part of a composite key. This should never be used unless to retain state compatibility. For example, a composite key composed of `[string, address]` in theory would need you only to define a way to understand when the string part finishes, we usually do this by appending a null byte to the string, then when you know when the string part finishes, it's logical that the part which remains is the address key. In the SDK instead we prepend to the address key its length too.

func NewKVStoreService

func NewKVStoreService(storeKey storetypes.StoreKey) store.KVStoreService

func ProtoValue

func ProtoValue[T any, PT protoMessage[T]](cdc codec.BinaryCodec) collcodec.ValueCodec[T]

ProtoValue inits a collections.ValueCodec for a generic gogo protobuf message.