types

Documentation

Index

• Constants
• Variables
• func AssertSanitizedIndex(safeIndex string, prefix string)
• func DecodeBlockAndKey(encodedKey []byte) (uint64, []byte)
• func DecodeKey(encodedKey []byte) uint64
• func DesanitizeIndex(safeIndex string) string
• func EncodeBlockAndKey(block uint64, key []byte) []byte
• func EncodeKey(key uint64) []byte
• func FindMax[T constraints.Ordered](s []T) T
• func FindMin[T constraints.Ordered](s []T) T
• func Intersection[T comparable](arrays ...[]T) []T
• func IsEntryIndexLive(value []byte) bool
• func KeyPrefix(p string) []byte
• func ReadYaml(filePath string, primaryKey string, content interface{}) error
• func SanitizeIndex(index string) (string, error)
• func ValidateString(s string, restrictType charRestrictionEnum, disallowedChars []rune) bool
• type Entry
  • func (*Entry) Descriptor() ([]byte, []int)
  • func (m *Entry) GetBlock() uint64
  • func (m *Entry) GetData() []byte
  • func (m *Entry) GetDeleteAt() uint64
  • func (m *Entry) GetIndex() string
  • func (m *Entry) GetRefcount() uint64
  • func (m *Entry) GetStaleAt() uint64
  • func (entry Entry) HasDeleteAt() bool
  • func (entry Entry) IsDeleted(ctx sdk.Context) bool
  • func (entry Entry) IsDeletedBy(block uint64) bool
  • func (entry Entry) IsStaleBy(block uint64) bool
  • func (m *Entry) Marshal() (dAtA []byte, err error)
  • func (m *Entry) MarshalTo(dAtA []byte) (int, error)
  • func (m *Entry) MarshalToSizedBuffer(dAtA []byte) (int, error)
  • func (*Entry) ProtoMessage()
  • func (m *Entry) Reset()
  • func (m *Entry) Size() (n int)
  • func (m *Entry) String() string
  • func (m *Entry) Unmarshal(dAtA []byte) error
  • func (m *Entry) XXX_DiscardUnknown()
  • func (m *Entry) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *Entry) XXX_Merge(src proto.Message)
  • func (m *Entry) XXX_Size() int
  • func (m *Entry) XXX_Unmarshal(b []byte) error
• type TimerType

Constants

const (
	ASCII_MIN = 32  // min visible ascii
	ASCII_MAX = 126 // max visible ascii
	ASCII_DEL = 127 // ascii for DEL
)

const (
	STALE_ENTRY_TIME int64  = 1440 // 1440 blocks (equivalent to 24 hours when block_time = 1min)
	MODULE_NAME      string = "common"
)

const (
	FixationVersionKey = "Entry_Version"
	EntryIndexPrefix   = "Entry_Index_"
	EntryPrefix        = "Entry_Value_"
)

const (
	TimerVersionKey = "Entry_Version"
	NextTimerPrefix = "Timer_Next_"
	TimerPrefix     = "Timer_Value_"
)

const (
	NAME_RESTRICTIONS charRestrictionEnum = "name"
)

Variables

var (
	ErrInvalidLengthFixationEntry        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowFixationEntry          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupFixationEntry = fmt.Errorf("proto: unexpected end of group")
)

var (
	// use single byte to save storage.
	// (value cannot be part of a valid index)
	EntryIndexLive = []byte{1}
	EntryIndexDead = []byte{2}
)

var (
	ErrInvalidIndex = sdkerrors.Register(MODULE_NAME, 1, "entry index is invalid")
)

x/pairing module sentinel errors

var NextTimerKey = []string{
	"NextBlock",
	"NextDate",
}

var TimerTypePrefix = []string{
	"Block_",
	"Time_",
}

Functions

func AssertSanitizedIndex

func AssertSanitizedIndex(safeIndex string, prefix string)

func DecodeBlockAndKey

func DecodeBlockAndKey(encodedKey []byte) (uint64, []byte)

func DecodeKey

func DecodeKey(encodedKey []byte) uint64

func DesanitizeIndex

func DesanitizeIndex(safeIndex string) string

desantizeIndex reverts the effect of sanitizeIndex - removes the trailing (ascii) DEL terminator.

func EncodeBlockAndKey

func EncodeBlockAndKey(block uint64, key []byte) []byte

func EncodeKey

func EncodeKey(key uint64) []byte

func FindMax

func FindMax[T constraints.Ordered](s []T) T

func FindMin

func FindMin[T constraints.Ordered](s []T) T

func Intersection

func Intersection[T comparable](arrays ...[]T) []T

func IsEntryIndexLive

func IsEntryIndexLive(value []byte) bool

IsEntryIndexLive tests whether an entry-index is live

func KeyPrefix

func KeyPrefix(p string) []byte

func ReadYaml

func ReadYaml(filePath string, primaryKey string, content interface{}) error

func SanitizeIndex

func SanitizeIndex(index string) (string, error)

sanitizeIdnex checks that a string contains only visible ascii characters (i.e. Ascii 32-126), and appends a (ascii) DEL to the index; this ensures that an index can never be a prefix of another index.

func ValidateString

func ValidateString(s string, restrictType charRestrictionEnum, disallowedChars []rune) bool

Validates name strings. Current policy:

name: lowercase ascii letters and digits only and the characters {' ', '_'}. can't be empty.

Types

type Entry

type Entry struct {
	Index    string `protobuf:"bytes,1,opt,name=index,proto3" json:"index,omitempty"`
	Block    uint64 `protobuf:"varint,2,opt,name=block,proto3" json:"block,omitempty"`
	StaleAt  uint64 `protobuf:"varint,3,opt,name=stale_at,json=staleAt,proto3" json:"stale_at,omitempty"`
	Refcount uint64 `protobuf:"varint,4,opt,name=refcount,proto3" json:"refcount,omitempty"`
	Data     []byte `protobuf:"bytes,5,opt,name=data,proto3" json:"data,omitempty"`
	DeleteAt uint64 `protobuf:"varint,6,opt,name=delete_at,json=deleteAt,proto3" json:"delete_at,omitempty"`
}

func (*Entry) Descriptor

func (*Entry) Descriptor() ([]byte, []int)

func (*Entry) GetBlock

func (m *Entry) GetBlock() uint64

func (*Entry) GetData

func (m *Entry) GetData() []byte

func (*Entry) GetDeleteAt

func (m *Entry) GetDeleteAt() uint64

func (*Entry) GetIndex

func (m *Entry) GetIndex() string

func (*Entry) GetRefcount

func (m *Entry) GetRefcount() uint64

func (*Entry) GetStaleAt

func (m *Entry) GetStaleAt() uint64

func (Entry) HasDeleteAt

func (entry Entry) HasDeleteAt() bool

IsMarkedDeleted tests whether an entry is marked for deletion, i.e. has entry.Deleted != math.MaxUint64.

func (Entry) IsDeleted

func (entry Entry) IsDeleted(ctx sdk.Context) bool

IsDeleted tests whether an entry is currently deleted, i.e. has its entry.DeleteAt below the current ctx block height.

func (Entry) IsDeletedBy

func (entry Entry) IsDeletedBy(block uint64) bool

IsDeletedBy tests whether an entry is deleted, with respect to a given block, i.e. has entry.DeletAt smaller or equal to that that block.

func (Entry) IsStaleBy

func (entry Entry) IsStaleBy(block uint64) bool

IsStale tests whether an entry is stale, i.e. has refcount zero _and_ has passed its stale_at time (more than STALE_ENTRY_TIME since deletion).

func (*Entry) Marshal

func (m *Entry) Marshal() (dAtA []byte, err error)

func (*Entry) MarshalTo

func (m *Entry) MarshalTo(dAtA []byte) (int, error)

func (*Entry) MarshalToSizedBuffer

func (m *Entry) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Entry) ProtoMessage

func (*Entry) ProtoMessage()

func (*Entry) Reset

func (m *Entry) Reset()

func (*Entry) Size

func (m *Entry) Size() (n int)

func (*Entry) String

func (m *Entry) String() string

func (*Entry) Unmarshal

func (m *Entry) Unmarshal(dAtA []byte) error

func (*Entry) XXX_DiscardUnknown

func (m *Entry) XXX_DiscardUnknown()

func (*Entry) XXX_Marshal

func (m *Entry) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Entry) XXX_Merge

func (m *Entry) XXX_Merge(src proto.Message)

func (*Entry) XXX_Size

func (m *Entry) XXX_Size() int

func (*Entry) XXX_Unmarshal

func (m *Entry) XXX_Unmarshal(b []byte) error

type TimerType

type TimerType int

const (
	BlockHeight TimerType = iota
	BlockTime
)