common

Documentation

Index

• Constants
• func DefaultAccessNodeIDS(snapshot protocol.Snapshot) ([]flow.Identifier, error)
• func FlowClient(conf *FlowClientConfig) (*client.Client, error)
• func FlowIDFromHexString(accessNodeIDS ...string) ([]flow.Identifier, error)
• func GetNodeInfoForProposedNodesScript(network string) ([]byte, 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)
• func ValidateAccessNodeIDSFlag(accessNodeIDS []string, chainID flow.ChainID, snapshot protocol.Snapshot) ([]flow.Identifier, error)
• type FlowClientConfig
  • func FlowClientConfigs(accessNodeIDS []flow.Identifier, insecureAccessAPI bool, ...) ([]*FlowClientConfig, error)
  • func NewFlowClientConfig(accessAddress, accessApiNodePubKey string, accessNodeID flow.Identifier, ...) (*FlowClientConfig, error)
  • func (f *FlowClientConfig) String() string

Constants

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

const (
	DefaultAccessNodeIDSMinimumMainnet = 2
	DefaultAccessNodeIDSMinimum        = 1
)

Functions

func DefaultAccessNodeIDS

func DefaultAccessNodeIDS(snapshot protocol.Snapshot) ([]flow.Identifier, error)

DefaultAccessNodeIDS will return all the access node IDS in the protocol state for staked access nodes

func FlowClient

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

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

func FlowIDFromHexString

func FlowIDFromHexString(accessNodeIDS ...string) ([]flow.Identifier, error)

FlowIDFromHexString convert flow node id(s) from hex string(s) to flow identifier(s)

func GetNodeInfoForProposedNodesScript

func GetNodeInfoForProposedNodesScript(network string) ([]byte, error)

GetNodeInfoForProposedNodesScript returns a script that will return an array of FlowIDTableStaking.NodeInfo for each node in the proposed table.

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

func ValidateAccessNodeIDSFlag

func ValidateAccessNodeIDSFlag(accessNodeIDS []string, chainID flow.ChainID, snapshot protocol.Snapshot) ([]flow.Identifier, error)

ValidateAccessNodeIDSFlag validates flag --access-node-ids and converts all ids to flow.Identifier

Types

type FlowClientConfig

type FlowClientConfig struct {
	AccessAddress    string
	AccessNodePubKey string
	AccessNodeID     flow.Identifier
	Insecure         bool
}

func FlowClientConfigs

func FlowClientConfigs(accessNodeIDS []flow.Identifier, 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, accessNodeID flow.Identifier, insecure bool) (*FlowClientConfig, error)

NewFlowClientConfig returns *FlowClientConfig

func (*FlowClientConfig) String

func (f *FlowClientConfig) String() string