framework

package

Go to main page

Versions in this module

v1

v1.2.8

Aug 11, 2023

v1.2.7

Aug 10, 2023

v1.2.6

Aug 9, 2023

v1.2.5

Aug 4, 2023

v1.2.4

Feb 14, 2023

v1.2.3

Feb 13, 2023

v1.2.2

Jan 9, 2023

Changes in this version

+ const GenesisAddressHex

+ const GenesisAddressPublicKeyHex

+ const RestAPIPort

+ type AutopeeringConfig struct

+ BindAddr string

+ EntryNodes []string

+ InboundPeers int

+ OutboundPeers int

+ RunAsEntryNode bool

+ SaltLifetime time.Duration

+ func DefaultAutopeeringConfig() AutopeeringConfig

+ func (autoConfig *AutopeeringConfig) CLIFlags() []string

type CoordinatorConfig

+ IssuanceInterval time.Duration

+ PrivateKeys []string

+ type DebugNodeAPIClient struct

+ func NewDebugNodeAPIClient(baseURL string, opts ...iotago.NodeHTTPAPIClientOption) *DebugNodeAPIClient

+ func (api *DebugNodeAPIClient) BaseURL() string

type DockerContainer

+ func (d *DockerContainer) CreateWhiteFlagMockContainer(cfg *WhiteFlagMockServerConfig) error

+ type IntegrationNetworkConfig struct

+ SpawnWhiteFlagMockServer bool

+ WhiteFlagMockServerConfig *WhiteFlagMockServerConfig

+ type MigratorConfig struct

+ Bootstrap bool

+ MaxEntries int

+ StartIndex int

+ StateFilePath string

+ func DefaultMigratorConfig() MigratorConfig

+ func (migConfig *MigratorConfig) CLIFlags() []string

type Network

+ WhiteFlagMockServer *DockerContainer

+ func (n *Network) CreateWhiteFlagMockServer(cfg *WhiteFlagMockServerConfig) error

type NetworkConfig

+ BindMultiAddresses []string

+ ConnMngHighWatermark int

+ ConnMngLowWatermark int

+ DatabasePath string

+ GossipUnknownPeersLimit int

+ IdentityPrivKey string

+ PeerAliases []string

+ Peers []string

+ ReconnectInterval time.Duration

type Node

+ DebugNodeAPIClient *DebugNodeAPIClient

+ ID peer.ID

+ func (p *Node) SetPeers(peers []*iotago.PeerResponse)

+ func (p *Node) TotalPeers() int

type NodeConfig

+ Autopeering AutopeeringConfig

+ Migrator MigratorConfig

+ Protocol ProtocolConfig

+ Receipts ReceiptsConfig

+ RestAPI RestAPIConfig

+ func (cfg *NodeConfig) WithMigration()

+ type ProtocolConfig struct

+ MinPoWScore float64

+ NetworkIDName string

+ PublicKeyRanges []coopkg.PublicKeyRange

+ func DefaultProtocolConfig() ProtocolConfig

+ func (protoConfig *ProtocolConfig) CLIFlags() []string

+ type ReceiptsConfig struct

+ APIAddress string

+ APITimeout time.Duration

+ BackupEnabled bool

+ BackupFolder string

+ CoordinatorAddress string

+ CoordinatorMerkleTreeDepth int

+ IgnoreSoftErrors bool

+ Validate bool

+ func DefaultReceiptValidatorConfig() ReceiptsConfig

+ func (receiptsConfig *ReceiptsConfig) CLIFlags() []string

+ type RestAPIConfig struct

+ BindAddress string

+ PoWEnabled bool

+ ProtectedRoutes []string

+ PublicRoutes []string

+ func DefaultRestAPIConfig() RestAPIConfig

+ func (restAPIConfig *RestAPIConfig) CLIFlags() []string

type SnapshotConfig

+ DeltaSnapshotFilePath string

+ FullSnapshotFilePath string

+ type WhiteFlagMockServerConfig struct

+ Binds []string

+ Envs []string

+ Name string

+ func DefaultWhiteFlagMockServerConfig(configFileName string) *WhiteFlagMockServerConfig

v0

v0.5.10

Aug 9, 2023

v0.5.9

Aug 4, 2023

Changes in this version

+ const GenesisAddress

+ const GenesisSeed

+ const WebAPIPort

+ var ErrBadRequest = errors.New("bad request")

+ var ErrInternalServerError = errors.New("internal server error")

+ var ErrLayoutEmpty = errors.New("layout must not be empty")

+ var ErrNoStaticPeers = errors.New("nodes must have static nodes")

+ var ErrNodeMissingInLayout = errors.New("node is missing in layout")

+ var ErrNodesDidNotPeerInTime = errors.New("nodes did not peer in time")

+ var ErrNodesDidNotSyncInTime = errors.New("nodes did not sync in time")

+ var ErrNodesNotOnlineInTime = errors.New("nodes did not become online in time")

+ var ErrNotFound = errors.New("not found")

+ var ErrNotImplemented = errors.New("operation not implemented/supported/available")

+ var ErrSelfPeering = errors.New("a node can not peer to itself")

+ var ErrUnauthorized = errors.New("unauthorized")

+ var ErrUnknownError = errors.New("unknown error")

+ func ShutdownNetwork(t *testing.T, n Shutdowner)

+ type AutopeeredNetwork struct

+ func (n *AutopeeredNetwork) AwaitPeering(minimumNeighbors int) error

+ func (n *AutopeeredNetwork) CreatePeer(cfg *NodeConfig) (*Node, error)

+ func (n *AutopeeredNetwork) DeletePartitions() error

+ func (n *AutopeeredNetwork) Partitions() []*Partition

+ func (n *AutopeeredNetwork) Shutdown() error

+ func (n *AutopeeredNetwork) Split(partitions ...[]*Node) error

+ type CfgOverrideFunc func(index int, cfg *NodeConfig)

+ type CoordinatorConfig struct

+ Address string

+ Bootstrap bool

+ IssuanceIntervalSeconds int

+ MWM int

+ MerkleTreeDepth int

+ MerkleTreeFilePath string

+ RunAsCoo bool

+ SecurityLevel int

+ Seed string

+ func DefaultCoordinatorConfig() CoordinatorConfig

+ func (cooConfig *CoordinatorConfig) CLIFlags() []string

+ type DashboardConfig struct

+ BindAddress string

+ func DefaultDashboardConfig() DashboardConfig

+ func (dashboardConfig *DashboardConfig) CLIFlags() []string

+ type DockerContainer struct

+ func NewDockerContainer(c *client.Client) *DockerContainer

+ func NewDockerContainerFromExisting(c *client.Client, name string) (*DockerContainer, error)

+ func (d *DockerContainer) ConnectToNetwork(networkID string) error

+ func (d *DockerContainer) CreateContainer(name string, containerConfig *container.Config, ...) error

+ func (d *DockerContainer) CreateNodeContainer(cfg *NodeConfig) error

+ func (d *DockerContainer) CreatePumbaContainer(name string, containerName string, targetIPs []string) error

+ func (d *DockerContainer) DisconnectFromNetwork(networkID string) error

+ func (d *DockerContainer) ExitStatus() (int, error)

+ func (d *DockerContainer) IP(network string) (string, error)

+ func (d *DockerContainer) Logs() (io.ReadCloser, error)

+ func (d *DockerContainer) Remove() error

+ func (d *DockerContainer) Start() error

+ func (d *DockerContainer) Stop(optionalTimeout ...time.Duration) error

+ type Framework struct

+ func Instance() (f *Framework, err error)

+ func (f *Framework) CreateAutopeeredNetwork(name string, peerCount int, minimumNeighbors int, ...) (*AutopeeredNetwork, error)

+ func (f *Framework) CreateNetworkWithPartitions(name string, peerCount, partitions, minimumNeighbors int, ...) (*AutopeeredNetwork, error)

+ func (f *Framework) CreateStaticNetwork(name string, layout StaticPeeringLayout, cfgOverrideF ...CfgOverrideFunc) (*StaticNetwork, error)

+ type Network struct

+ ID string

+ Name string

+ NetworkType NetworkType

+ Nodes []*Node

+ func (n *Network) AwaitAllSync(ctx context.Context) error

+ func (n *Network) AwaitOnline(ctx context.Context) error

+ func (n *Network) Coordinator() *Node

+ func (n *Network) CreateNode(cfg *NodeConfig) (*Node, error)

+ func (n *Network) PrefixName(suffix string) string

+ func (n *Network) RandomNode() *Node

+ func (n *Network) Shutdown() error

+ func (n *Network) SpamZeroVal(dur time.Duration, parallelism int, batchSize ...int) error

+ func (n *Network) TakeCPUProfiles(dur time.Duration) error

+ func (n *Network) TakeHeapSnapshots() error

+ type NetworkConfig struct

+ AcceptAnyConnection bool

+ AutopeeringSeed string

+ EntryNodes []string

+ MaxPeers int

+ RunAsEntryNode bool

+ StaticPeers []string

+ func DefaultNetworkConfig() NetworkConfig

+ func (netConfig *NetworkConfig) CLIFlags() []string

+ type NetworkType byte

+ const NetworkTypeAutopeered

+ const NetworkTypeStatic

+ type Node struct

+ Config *NodeConfig

+ DebugWebAPI *WebAPI

+ IP string

+ Name string

+ WebAPI *api.API

+ func (p *Node) APIURI() string

+ func (p *Node) SetNeighbors(peers []*peer.Info)

+ func (p *Node) Spam(dur time.Duration, depth int, parallelism int, batchSize ...int) (int32, error)

+ func (p *Node) String() string

+ func (p *Node) TotalNeighbors() int

+ type NodeConfig struct

+ Binds []string

+ Coordinator CoordinatorConfig

+ Dashboard DashboardConfig

+ Envs []string

+ ExposedPorts nat.PortSet

+ Name string

+ Network NetworkConfig

+ Plugins PluginConfig

+ Profiling ProfilingConfig

+ Snapshot SnapshotConfig

+ WebAPI WebAPIConfig

+ func DefaultConfig() *NodeConfig

+ func (cfg *NodeConfig) AsCoo()

+ func (cfg *NodeConfig) CLIFlags() []string

+ type Partition struct

+ func (p *Partition) Peers() []*Node

+ func (p *Partition) PeersMap() map[string]*Node

+ func (p *Partition) String() string

+ type PluginConfig struct

+ Disabled []string

+ Enabled []string

+ func DefaultPluginConfig() PluginConfig

+ func (pluginConfig *PluginConfig) CLIFlags() []string

+ type Profiler struct

+ func (n *Profiler) GraphMetrics(dur time.Duration) error

+ func (n *Profiler) TakeCPUProfile(dur time.Duration) error

+ func (n *Profiler) TakeHeapSnapshot() error

+ type ProfilingConfig struct

+ BindAddress string

+ func DefaultProfilingConfig() ProfilingConfig

+ func (profilingConfig *ProfilingConfig) CLIFlags() []string

+ type Shutdowner interface

+ Shutdown func() error

+ type SnapshotConfig struct

+ EpochSpentAddressesFilePath []string

+ GlobalSnapshotFilePath string

+ GlobalSnapshotIndex int

+ LoadType string

+ LocalSnapshotFilePath string

+ func DefaultSnapshotConfig() SnapshotConfig

+ func (snapshotConfig *SnapshotConfig) CLIFlags() []string

+ type StaticNetwork struct

+ func (n *StaticNetwork) AwaitPeering(ctx context.Context) error

+ func (n *StaticNetwork) ConnectNodes() error

+ type StaticPeeringLayout map[int]map[int]connected

+ var DefaultStaticPeeringLayout StaticPeeringLayout = map[int]map[int]connected{ ... }

+ func (spl StaticPeeringLayout) Validate() error

+ type WebAPI struct

+ func NewWebAPI(baseURL string, httpClient ...http.Client) *WebAPI

+ func (api *WebAPI) BaseURL() string

+ func (api *WebAPI) Info() (*webapi.GetNodeInfoResponse, error)

+ func (api *WebAPI) Neighbors() ([]*peer.Info, error)

+ type WebAPIConfig struct

+ BindAddress string

+ PermittedAPICalls []string

+ func DefaultWebAPIConfig() WebAPIConfig

+ func (webAPIConfig *WebAPIConfig) CLIFlags() []string

Other modules containing this package

github.com/iotaledger/hornet/v2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL