devnet

package

Go to main page

Versions in this module

v0

v0.8.0

Dec 2, 2025

v0.7.2

Dec 2, 2025

Changes in this version

type ClientSpec

+ RouteLivenessDebug bool

+ RouteLivenessEnableActive bool

+ RouteLivenessEnablePassive bool

+ RouteLivenessPeerMetrics bool

v0.6.3

Sep 8, 2025

v0.6.2

Sep 2, 2025

v0.6.1

Sep 2, 2025

v0.6.0

Aug 28, 2025

v0.5.3

Aug 19, 2025

Changes in this version

type ControllerSpec

+ NoEnableInterfacesAndPeers bool

type DeviceSpec

+ AdditionalNetworks []string

+ Interfaces map[string]string

+ LoopbackInterfaces map[string]string

type Devnet

+ func (d *Devnet) CreateDeviceLoopbackInterface(ctx context.Context, deviceCode string, interfaceName string, ...) error

+ func (d *Devnet) DeleteDeviceLoopbackInterface(ctx context.Context, deviceCode string, interfaceName string) error

type DevnetSpec

+ DeviceTunnelNet string

type FunderSpec

+ ExtraRecipients map[string]string

+ type MiscNetwork struct

+ Name string

+ func NewMiscNetwork(dn *Devnet, log *slog.Logger, suffix string) *MiscNetwork

+ func (n *MiscNetwork) Create(ctx context.Context) error

+ func (n *MiscNetwork) CreateIfNotExists(ctx context.Context) (bool, error)

+ func (n *MiscNetwork) Exists(ctx context.Context) (bool, error)

v0.4.0

Aug 4, 2025

Changes in this version

+ const LabelsFilterTypeDevnet

+ const LabelsKeyDeployID

+ const LabelsKeyDomain

+ const LabelsKeyType

+ const LabelsKeyTypeValueDevnet

+ var ErrDeviceNotFoundOnchain = errors.New("device not found onchain")

+ var ErrDevicePubkeyNotFoundOnchain = errors.New("device pubkey not found onchain")

+ func BuildContainerImages(ctx context.Context, log *slog.Logger, workspaceDir string, verbose bool) error

+ func DeviceExecAristaCliJSON[T any](ctx context.Context, device *Device, command string) (T, error)

+ func LoadContainerImagesEnvFile(log *slog.Logger, workspaceDir string) error

+ func WorkspaceDir() (string, error)

+ type Activator struct

+ ContainerID string

+ func (a *Activator) Exists(ctx context.Context) (bool, error)

+ func (a *Activator) Start(ctx context.Context) error

+ func (a *Activator) StartIfNotRunning(ctx context.Context) (bool, error)

+ type ActivatorSpec struct

+ ContainerImage string

+ func (s *ActivatorSpec) Validate() error

+ type BuildConfig struct

+ Verbose bool

+ type CYOANetwork struct

+ Name string

+ SubnetCIDR string

+ func (n *CYOANetwork) Create(ctx context.Context) error

+ func (n *CYOANetwork) CreateIfNotExists(ctx context.Context) (bool, error)

+ func (n *CYOANetwork) Exists(ctx context.Context) (bool, error)

+ type CYOANetworkSpec struct

+ CIDRPrefix int

+ func (s *CYOANetworkSpec) Validate() error

+ type Client struct

+ CYOANetworkIP string

+ ContainerID string

+ Pubkey string

+ Spec *ClientSpec

+ func (c *Client) Exec(ctx context.Context, command []string, options ...docker.ExecOption) ([]byte, error)

+ func (c *Client) ExecReturnJSONList(ctx context.Context, command []string, options ...docker.ExecOption) ([]map[string]any, error)

+ func (c *Client) Exists(ctx context.Context) (bool, error)

+ func (c *Client) GetTunnelStatus(ctx context.Context) ([]ClientStatusResponse, error)

+ func (c *Client) Start(ctx context.Context) error

+ func (c *Client) StartIfNotRunning(ctx context.Context) (bool, error)

+ func (c *Client) WaitForLatencyResults(ctx context.Context, wantDevicePK string, timeout time.Duration) error

+ func (c *Client) WaitForTunnelDisconnected(ctx context.Context, timeout time.Duration) error

+ func (c *Client) WaitForTunnelStatus(ctx context.Context, wantStatus ClientSessionStatus, timeout time.Duration) error

+ func (c *Client) WaitForTunnelUp(ctx context.Context, timeout time.Duration) error

+ type ClientSession struct

+ LastSessionUpdate int64

+ SessionStatus ClientSessionStatus

+ type ClientSessionStatus string

+ const ClientSessionStatusDisconnected

+ const ClientSessionStatusDown

+ const ClientSessionStatusUp

+ type ClientSpec struct

+ CYOANetworkIPHostID uint32

+ ContainerImage string

+ KeypairPath string

+ func (s *ClientSpec) Validate(cyoaNetworkSpec CYOANetworkSpec) error

+ type ClientStatusResponse struct

+ DoubleZeroIP net.IP

+ DoubleZeroStatus ClientSession

+ TunnelDst net.IP

+ TunnelName string

+ TunnelSrc net.IP

+ UserType ClientUserType

+ type ClientUserType string

+ type Controller struct

+ ContainerID string

+ DefaultNetworkIP string

+ ExternalPort int

+ func (c *Controller) Exists(ctx context.Context) (bool, error)

+ func (c *Controller) GetAgentConfig(ctx context.Context, deviceAgentPubkey string) (*pb.ConfigResponse, error)

+ func (c *Controller) Start(ctx context.Context) error

+ func (c *Controller) StartIfNotRunning(ctx context.Context) (bool, error)

+ type ControllerSpec struct

+ ContainerImage string

+ func (s *ControllerSpec) Validate(cyoaNetworkSpec CYOANetworkSpec) error

+ type DefaultNetwork struct

+ Name string

+ SubnetCIDR string

+ func (n *DefaultNetwork) Create(ctx context.Context) error

+ func (n *DefaultNetwork) CreateIfNotExists(ctx context.Context) (bool, error)

+ func (n *DefaultNetwork) Exists(ctx context.Context) (bool, error)

+ type Device struct

+ CYOANetworkIP string

+ ContainerID string

+ ExternalEAPIHTTPPort int

+ ExternalTelemetryMetricsPort int

+ ID string

+ Spec *DeviceSpec

+ func (d *Device) Exec(ctx context.Context, command []string) ([]byte, error)

+ func (d *Device) Exists(ctx context.Context) (bool, error)

+ func (d *Device) GetEAPIHTTPClient() (*goeapi.Node, error)

+ func (d *Device) GetTelemetryMetricsClient() *prometheus.MetricsClient

+ func (d *Device) InternalTelemetryMetricsPort() (int, error)

+ func (d *Device) Start(ctx context.Context) error

+ func (d *Device) StartIfNotRunning(ctx context.Context) (bool, error)

+ type DeviceSpec struct

+ CYOANetworkAllocatablePrefix uint32

+ CYOANetworkIPHostID uint32

+ Code string

+ ContainerImage string

+ Exchange string

+ Location string

+ MetricsPublisherPK string

+ Telemetry DeviceTelemetrySpec

+ func (s *DeviceSpec) Validate(cyoaNetworkSpec CYOANetworkSpec) error

+ type DeviceTelemetrySpec struct

+ Enabled bool

+ KeypairPath string

+ ManagementNS string

+ MetricsAddr string

+ MetricsEnable bool

+ PeersRefreshInterval time.Duration

+ ProbeInterval time.Duration

+ SubmissionInterval time.Duration

+ TWAMPListenPort uint16

+ Verbose bool

+ func (s *DeviceTelemetrySpec) Validate() error

+ type Devnet struct

+ Activator *Activator

+ CYOANetwork *CYOANetwork

+ Clients map[string]*Client

+ Controller *Controller

+ DefaultNetwork *DefaultNetwork

+ Devices map[string]*Device

+ ExternalHost string

+ Funder *Funder

+ Ledger *Ledger

+ Manager *Manager

+ Spec DevnetSpec

+ func New(spec DevnetSpec, log *slog.Logger, dockerClient *client.Client, ...) (*Devnet, error)

+ func (d *Devnet) AddClient(ctx context.Context, spec ClientSpec) (*Client, error)

+ func (d *Devnet) AddDevice(ctx context.Context, spec DeviceSpec) (*Device, error)

+ func (d *Devnet) Close()

+ func (d *Devnet) CreateDeviceOnchain(ctx context.Context, deviceCode string, location string, exchange string, ...) error

+ func (d *Devnet) Destroy(ctx context.Context, all bool) error

+ func (d *Devnet) GetDevicePubkeyOnchain(ctx context.Context, deviceCode string) (string, error)

+ func (d *Devnet) GetOrCreateDeviceOnchain(ctx context.Context, deviceCode string, location string, exchange string, ...) (string, error)

+ func (d *Devnet) Start(ctx context.Context, buildConfig *BuildConfig) error

+ func (d *Devnet) Stop(ctx context.Context) error

+ func (dn *Devnet) DeployServiceabilityProgram(ctx context.Context) error

+ func (dn *Devnet) DeployServiceabilityProgramIfNotDeployed(ctx context.Context) (bool, error)

+ func (dn *Devnet) DeployTelemetryProgram(ctx context.Context) error

+ func (dn *Devnet) DeployTelemetryProgramIfNotDeployed(ctx context.Context) (bool, error)

+ func (dn *Devnet) InitSmartContract(ctx context.Context) error

+ func (dn *Devnet) InitSmartContractIfNotInitialized(ctx context.Context) (bool, error)

+ func (dn *Devnet) IsServiceabilityProgramDeployed(ctx context.Context) (bool, error)

+ func (dn *Devnet) IsSmartContractInitialized(ctx context.Context) (bool, error)

+ func (dn *Devnet) IsTelemetryProgramDeployed(ctx context.Context) (bool, error)

+ type DevnetSpec struct

+ Activator ActivatorSpec

+ CYOANetwork CYOANetworkSpec

+ Clients map[string]ClientSpec

+ Controller ControllerSpec

+ DeployDir string

+ DeployID string

+ Devices map[string]DeviceSpec

+ ExtraLabels map[string]string

+ Funder FunderSpec

+ Ledger LedgerSpec

+ Manager ManagerSpec

+ func (s *DevnetSpec) Validate() error

+ type Funder struct

+ ContainerID string

+ ExternalMetricsPort int

+ func (c *Funder) Exists(ctx context.Context) (bool, error)

+ func (c *Funder) GetMetricsClient() *prometheus.MetricsClient

+ func (c *Funder) PrivateKey() (solana.PrivateKey, error)

+ func (c *Funder) Start(ctx context.Context) error

+ func (c *Funder) StartIfNotRunning(ctx context.Context) (bool, error)

+ type FunderSpec struct

+ ContainerImage string

+ Interval time.Duration

+ KeypairPath string

+ MinBalanceSOL float64

+ TopUpSOL float64

+ Verbose bool

+ func (s *FunderSpec) Validate() error

+ type Ledger struct

+ ContainerID string

+ ExternalRPCPort int

+ InternalIPRPCURL string

+ InternalRPCURL string

+ InternalRPCWSURL string

+ func (l *Ledger) Exists(ctx context.Context) (bool, error)

+ func (l *Ledger) GetRPCClient() *rpc.Client

+ func (l *Ledger) GetServiceabilityClient() (*serviceability.Client, error)

+ func (l *Ledger) GetTelemetryClient(signer *solana.PrivateKey) (*telemetry.Client, error)

+ func (l *Ledger) Start(ctx context.Context) error

+ func (l *Ledger) StartIfNotRunning(ctx context.Context) (bool, error)

+ type LedgerSpec struct

+ ContainerImage string

+ func (s *LedgerSpec) Validate() error

+ type Manager struct

+ ContainerID string

+ Pubkey string

+ ServiceabilityProgramID string

+ TelemetryProgramID string

+ func (m *Manager) Exec(ctx context.Context, command []string, opts ...docker.ExecOption) ([]byte, error)

+ func (m *Manager) Exists(ctx context.Context) (bool, error)

+ func (m *Manager) Start(ctx context.Context) error

+ func (m *Manager) StartIfNotRunning(ctx context.Context) (bool, error)

+ type ManagerSpec struct

+ ContainerImage string

+ ManagerKeypairPath string

+ ServiceabilityProgramKeypairPath string

+ TelemetryProgramKeypairPath string

+ func (s *ManagerSpec) Validate() error

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