common

Documentation

Index

• Constants
• func FlowClient(opt *FlowClientConfig) (*client.Client, error)
• func InitProtocolState(db *badger.DB, storages *storage.All) (protocol.State, error)
• func InitStorage(datadir string) *badger.DB
• func InitStorageWithTruncate(datadir string, truncate bool) *badger.DB
• func InitStorages(db *badger.DB) *storage.All
• func PrettyPrint(entity interface{})
• func PrettyPrintEntity(entity flow.Entity)
• type FlowClientConfig
  • func FlowClientConfigs(accessNodeIDS []string, insecureAccessAPI bool, snapshot protocol.Snapshot) ([]*FlowClientConfig, error)
  • func NewFlowClientConfig(accessAddress, accessApiNodePubKey string, insecure bool) (*FlowClientConfig, error)
  • func (f *FlowClientConfig) String() string

Constants

const (
	DefaultAccessNodeIDSMinimum = 2
	DefaultAccessAPIPort        = "9000"
	DefaultAccessAPISecurePort  = "9001"
)

Functions

func FlowClient

func FlowClient(opt *FlowClientConfig) (*client.Client, error)

FlowClient will return a secure or insecure flow client depending on *FlowClientConfig.Insecure

func InitProtocolState

func InitProtocolState(db *badger.DB, storages *storage.All) (protocol.State, error)

func InitStorage

func InitStorage(datadir string) *badger.DB

func InitStorageWithTruncate

func InitStorageWithTruncate(datadir string, truncate bool) *badger.DB

func InitStorages

func InitStorages(db *badger.DB) *storage.All

func PrettyPrint

func PrettyPrint(entity interface{})

PrettyPrint an interface

func PrettyPrintEntity

func PrettyPrintEntity(entity flow.Entity)

PrettyPrintEntity pretty print a flow entity

Types

type FlowClientConfig

type FlowClientConfig struct {
	AccessAddress    string
	AccessNodePubKey string
	Insecure         bool
}

func FlowClientConfigs

func FlowClientConfigs(accessNodeIDS []string, insecureAccessAPI bool, snapshot protocol.Snapshot) ([]*FlowClientConfig, error)

FlowClientConfigs will assemble connection options for the flow client for each access node id

func NewFlowClientConfig

func NewFlowClientConfig(accessAddress, accessApiNodePubKey string, insecure bool) (*FlowClientConfig, error)

NewFlowClientConfig returns *FlowClientConfig

func (*FlowClientConfig) String

func (f *FlowClientConfig) String() string