vald

Documentation

Index

• Constants
• func GetHealthCheckCommand() *cobra.Command
• func GetValdCommand() *cobra.Command
• type RWFile
  • func NewRWFile(path string) RWFile
  • func (f RWFile) ReadAll() ([]byte, error)
  • func (f RWFile) WriteAll(bz []byte) error
• type ReadWriter
• type StateStore
  • func NewStateStore(rw ReadWriter) StateStore
  • func (s StateStore) GetState() (completed int64, err error)
  • func (s StateStore) SetState(completed int64) error

Constants

const RW = 0600

RW grants -rw------- file permissions

const RWX = 0700

RWX grants -rwx------ file permissions

Functions

func GetHealthCheckCommand

func GetHealthCheckCommand() *cobra.Command

GetHealthCheckCommand returns the command to execute a node health check

func GetValdCommand

func GetValdCommand() *cobra.Command

GetValdCommand returns the command to start vald

Types

type RWFile

type RWFile struct {
	// contains filtered or unexported fields
}

RWFile implements the ReadWriter interface for an underlying file

func NewRWFile

func NewRWFile(path string) RWFile

NewRWFile returns a new RWFile instance for the given file path

func (RWFile) ReadAll

func (f RWFile) ReadAll() ([]byte, error)

ReadAll returns the full content of the file

func (RWFile) WriteAll

func (f RWFile) WriteAll(bz []byte) error

WriteAll writes the given bytes to a file. Creates a new fille if it does not exist, overwrites the previous content otherwise.

type ReadWriter

type ReadWriter interface {
	WriteAll([]byte) error
	ReadAll() ([]byte, error)
}

ReadWriter represents a data source/sink

type StateStore

type StateStore struct {
	// contains filtered or unexported fields
}

StateStore manages event state persistence

func NewStateStore

func NewStateStore(rw ReadWriter) StateStore

NewStateStore returns a new StateStore instance

func (StateStore) GetState

func (s StateStore) GetState() (completed int64, err error)

GetState returns the stored block height for which all events have been published

func (StateStore) SetState

func (s StateStore) SetState(completed int64) error

SetState persists the block height for which all events have been published