orchestration

type BeeClientOption func(*bee.ClientOptions) error

type Cluster interface {
	Accounting(ctx context.Context) (accounting ClusterAccounting, err error)
	AddNodeGroup(name string, o NodeGroupOptions)
	Addresses(ctx context.Context) (addrs map[string]NodeGroupAddresses, err error)
	Balances(ctx context.Context) (balances ClusterBalances, err error)
	FlattenAccounting(ctx context.Context) (accounting NodeGroupAccounting, err error)
	FlattenBalances(ctx context.Context) (balances NodeGroupBalances, err error)
	FlattenOverlays(ctx context.Context, exclude ...string) (map[string]swarm.Address, error)
	FlattenSettlements(ctx context.Context) (settlements NodeGroupSettlements, err error)
	FlattenTopologies(ctx context.Context) (topologies map[string]bee.Topology, err error)
	FullNodeNames() (names []string)
	GlobalReplicationFactor(ctx context.Context, a swarm.Address) (grf int, err error)
	LightNodeNames() (names []string)
	Name() string
	NodeGroup(name string) (ng NodeGroup, err error)
	NodeGroups() (l map[string]NodeGroup)
	NodeGroupsSorted() (l []string)
	NodeNames() (names []string)
	Nodes() map[string]Node
	NodesClients(ctx context.Context) (map[string]*bee.Client, error)
	NodesClientsAll(ctx context.Context) (map[string]*bee.Client, error)
	Overlays(ctx context.Context, exclude ...string) (overlays ClusterOverlays, err error)
	Peers(ctx context.Context, exclude ...string) (peers ClusterPeers, err error)
	RandomNode(ctx context.Context, r *rand.Rand) (node Node, err error)
	Settlements(ctx context.Context) (settlements ClusterSettlements, err error)
	Size() (size int)
	Topologies(ctx context.Context) (topologies ClusterTopologies, err error)
}

type ClusterAccounting map[string]NodeGroupAccounting

type ClusterAddresses map[string]NodeGroupAddresses

type ClusterBalances map[string]NodeGroupBalances

type ClusterOptions struct {
	Annotations         map[string]string
	APIDomain           string
	APIInsecureTLS      bool
	APIScheme           string
	DebugAPIDomain      string
	DebugAPIInsecureTLS bool
	DebugAPIScheme      string
	K8SClient           *k8s.Client
	SwapClient          swap.Client
	Labels              map[string]string
	Namespace           string
	DisableNamespace    bool
	AdminPassword       string
}

type ClusterOverlays map[string]NodeGroupOverlays

type ClusterPeers map[string]NodeGroupPeers

type ClusterSettlements map[string]NodeGroupSettlements

type ClusterTopologies map[string]NodeGroupTopologies

type Config struct {
	AllowPrivateCIDRs         bool          // allow to advertise private CIDRs to the public network
	APIAddr                   string        // HTTP API listen address
	BlockTime                 uint64        // chain block time
	Bootnodes                 string        // initial nodes to connect to
	BootnodeMode              bool          // cause the node to always accept incoming connections
	CacheCapacity             uint64        // cache capacity in chunks, multiply by 4096 (MaxChunkSize) to get approximate capacity in bytes
	ClefSignerEnable          bool          // enable clef signer
	ClefSignerEndpoint        string        // clef signer endpoint
	CORSAllowedOrigins        string        // origins with CORS headers enabled
	DataDir                   string        // data directory
	DbOpenFilesLimit          int           // number of open files allowed by database
	DbBlockCacheCapacity      int           // size of block cache of the database in bytes
	DbWriteBufferSize         int           // size of the database write buffer in bytes
	DbDisableSeeksCompaction  bool          // disables DB compactions triggered by seeks
	DebugAPIAddr              string        // debug HTTP API listen address
	DebugAPIEnable            bool          // enable debug HTTP API
	FullNode                  bool          // cause the node to start in full mode
	Mainnet                   bool          // enable mainnet
	NATAddr                   string        // NAT exposed address
	NetworkID                 uint64        // ID of the Swarm network
	P2PAddr                   string        // P2P listen address
	P2PWSEnable               bool          // enable P2P WebSocket transport
	Password                  string        // password for decrypting keys
	PaymentEarly              uint64        // amount in BZZ below the peers payment threshold when we initiate settlement
	PaymentThreshold          uint64        // threshold in BZZ where you expect to get paid from your peers
	PaymentTolerance          uint64        // excess debt above payment threshold in BZZ where you disconnect from your peer
	PostageStampAddress       string        // postage stamp address
	PostageContractStartBlock uint64        // postage stamp address
	PriceOracleAddress        string        // price Oracle address
	ResolverOptions           string        // ENS compatible API endpoint for a TLD and with contract address, can be repeated, format [tld:][contract-addr@]url
	Restricted                bool          // start node in restricted mode
	TokenEncryptionKey        string        // username for API authentication
	AdminPassword             string        // password hash for API authentication
	ChequebookEnable          bool          // enable chequebook
	SwapEnable                bool          // enable swap
	SwapEndpoint              string        // swap ethereum blockchain endpoint
	SwapDeploymentGasPrice    string        // gas price in wei to use for deployment and funding
	SwapFactoryAddress        string        // swap factory address
	RedistributionAddress     string        // redistribution address
	StakingAddress            string        // staking address
	StorageIncentivesEnable   string        // storage incentives enable flag
	SwapInitialDeposit        uint64        // initial deposit if deploying a new chequebook
	TracingEnabled            bool          // enable tracing
	TracingEndpoint           string        // endpoint to send tracing data
	TracingServiceName        string        // service name identifier for tracing
	Verbosity                 uint64        // log verbosity level 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=trace
	WelcomeMessage            string        // send a welcome message string during handshakes
	WarmupTime                time.Duration // warmup time pull/pushsync protocols
	WithdrawAddress           string        // allowed addresses for wallet withdrawal
}

type CreateOptions struct {
	// Bee configuration
	Config Config
	// Kubernetes configuration
	Name                      string
	Namespace                 string
	Annotations               map[string]string
	ClefImage                 string
	ClefImagePullPolicy       string
	ClefKey                   string
	ClefPassword              string
	Labels                    map[string]string
	Image                     string
	ImagePullPolicy           string
	ImagePullSecrets          []string
	IngressAnnotations        map[string]string
	IngressClass              string
	IngressHost               string
	IngressDebugAnnotations   map[string]string
	IngressDebugClass         string
	IngressDebugHost          string
	LibP2PKey                 string
	NodeSelector              map[string]string
	PersistenceEnabled        bool
	PersistenceStorageClass   string
	PersistenceStorageRequest string
	PodManagementPolicy       string
	RestartPolicy             string
	ResourcesLimitCPU         string
	ResourcesLimitMemory      string
	ResourcesRequestCPU       string
	ResourcesRequestMemory    string
	Selector                  map[string]string
	SwarmKey                  string
	UpdateStrategy            string
}

type EncryptedKey string

type EncryptedKeyJson struct {
	Address string `json:"address"`
}

type FundingOptions struct {
	Eth  float64
	Bzz  float64
	GBzz float64
}

type Node interface {
	ClefKey() string
	ClefPassword() string
	Client() *bee.Client
	Config() *Config
	LibP2PKey() string
	Name() string
	SetClefKey(key string) Node
	SetClefPassword(key string) Node
	SetSwarmKey(key string) Node
	SwarmKey() string
	Create(ctx context.Context, o CreateOptions) (err error)
	Delete(ctx context.Context, namespace string) (err error)
	Ready(ctx context.Context, namespace string) (ready bool, err error)
	Start(ctx context.Context, namespace string) (err error)
	Stop(ctx context.Context, namespace string) (err error)
}

type NodeGroup interface {
	Accounting(ctx context.Context) (infos NodeGroupAccounting, err error)
	AddNode(ctx context.Context, name string, o NodeOptions, opts ...BeeClientOption) (err error)
	Addresses(ctx context.Context) (addrs NodeGroupAddresses, err error)
	Balances(ctx context.Context) (balances NodeGroupBalances, err error)
	CreateNode(ctx context.Context, name string) (err error)
	DeleteNode(ctx context.Context, name string) (err error)
	GetEthAddress(ctx context.Context, name string, o NodeOptions) (ethAddress string, err error)
	GroupReplicationFactor(ctx context.Context, a swarm.Address) (grf int, err error)
	Name() string
	Node(name string) (Node, error)
	NodeClient(name string) (*bee.Client, error)
	NodeReady(ctx context.Context, name string) (ok bool, err error)
	Nodes() map[string]Node
	NodesClients(ctx context.Context) (map[string]*bee.Client, error)
	NodesClientsAll(ctx context.Context) map[string]*bee.Client
	NodesSorted() (l []string)
	Overlays(ctx context.Context) (overlays NodeGroupOverlays, err error)
	Peers(ctx context.Context) (peers NodeGroupPeers, err error)
	RunningNodes(ctx context.Context) (running []string, err error)
	Settlements(ctx context.Context) (settlements NodeGroupSettlements, err error)
	SetupNode(ctx context.Context, name string, o NodeOptions) (ethAddress string, err error)
	Size() int
	StartNode(ctx context.Context, name string) (err error)
	StopNode(ctx context.Context, name string) (err error)
	StoppedNodes(ctx context.Context) (stopped []string, err error)
	Topologies(ctx context.Context) (topologies NodeGroupTopologies, err error)
}

type NodeGroupAccounting map[string]map[string]bee.Account

type NodeGroupAddresses map[string]bee.Addresses

type NodeGroupBalances map[string]map[string]int64

type NodeGroupOptions struct {
	Annotations               map[string]string
	ClefImage                 string
	ClefImagePullPolicy       string
	BeeConfig                 *Config
	Image                     string
	ImagePullPolicy           string
	ImagePullSecrets          []string
	IngressAnnotations        map[string]string
	IngressClass              string
	IngressDebugAnnotations   map[string]string
	IngressDebugClass         string
	Labels                    map[string]string
	NodeSelector              map[string]string
	PersistenceEnabled        bool
	PersistenceStorageClass   string
	PersistenceStorageRequest string
	PodManagementPolicy       string
	RestartPolicy             string
	ResourcesLimitCPU         string
	ResourcesLimitMemory      string
	ResourcesRequestCPU       string
	ResourcesRequestMemory    string
	UpdateStrategy            string
}

type NodeGroupOverlays map[string]swarm.Address

type NodeGroupPeers map[string][]swarm.Address

type NodeGroupSettlements map[string]map[string]SentReceived

type NodeGroupTopologies map[string]bee.Topology

type NodeOptions struct {
	ClefKey      string
	ClefPassword string
	Client       *bee.Client
	Config       *Config
	LibP2PKey    string
	SwarmKey     EncryptedKey
}

type NodeOrchestrator interface {
	Create(ctx context.Context, o CreateOptions) (err error)
	Delete(ctx context.Context, name string, namespace string) (err error)
	Ready(ctx context.Context, name string, namespace string) (ready bool, err error)
	Start(ctx context.Context, name string, namespace string) (err error)
	Stop(ctx context.Context, name string, namespace string) (err error)
	RunningNodes(ctx context.Context, namespace string) (running []string, err error)
	StoppedNodes(ctx context.Context, namespace string) (stopped []string, err error)
}

type SentReceived struct {
	Received int64
	Sent     int64
}