chains

Documentation

Index

• Variables
• type ChainOpts
• type ChainsKV
  • func NewChainsKV[T types.ChainService](cs map[string]T) *ChainsKV[T]
  • func (c *ChainsKV[T]) Get(id string) (T, error)
  • func (c *ChainsKV[T]) Len() int
  • func (c *ChainsKV[T]) List(ids ...string) ([]T, error)
  • func (c *ChainsKV[T]) Slice() []T
• type ID
• type Node

Variables

var (
	// ErrChainIDEmpty is returned when chain is required but was empty.
	ErrChainIDEmpty = errors.New("chain id empty")
	ErrNotFound     = errors.New("not found")
)

var (
	ErrLOOPPUnsupported = errors.New("LOOPP not yet supported")
	ErrChainDisabled    = errors.New("chain is disabled")
)

var ErrNoSuchChainID = errors.New("chain id does not exist")

Types

type ChainOpts

type ChainOpts interface {
	Validate() error
}

ChainOpts holds options for configuring a Chain

type ChainsKV

type ChainsKV[T types.ChainService] struct {
	// contains filtered or unexported fields
}

func NewChainsKV

func NewChainsKV[T types.ChainService](cs map[string]T) *ChainsKV[T]

func (*ChainsKV[T]) Get

func (c *ChainsKV[T]) Get(id string) (T, error)

Get return ErrNoSuchChainID if [id] is not found

func (*ChainsKV[T]) Len

func (c *ChainsKV[T]) Len() int

func (*ChainsKV[T]) List

func (c *ChainsKV[T]) List(ids ...string) ([]T, error)

func (*ChainsKV[T]) Slice

func (c *ChainsKV[T]) Slice() []T

type ID

type ID any

ID types represent unique identifiers within a particular chain type. Using string is recommended.

type Node

type Node any

Node types should be a struct including these default fields:

ID        int32
Name      string