bitboxbase

type BitBoxBase struct {
	observable.Implementation
	// contains filtered or unexported fields
}

type Interface interface {

	// Identifier returns the bitboxBaseID.
	Identifier() string

	// GetRPCClient returns the rpcClient so we can listen to its events.
	RPCClient() *rpcclient.RPCClient

	// Close tells the bitboxbase to close all connections.
	Close()

	// GetRegisterTime implements a getter for the timestamp of when the bitboxBase was registered
	GetRegisterTime() time.Time

	// MiddlewareInfo returns some blockchain information.
	MiddlewareInfo() (rpcmessages.SampleInfoResponse, error)

	// VerificationProgress returns the bitcoind verification progress.
	VerificationProgress() (rpcmessages.VerificationProgressResponse, error)

	// ConnectElectrum connects to the electrs server on the base and configures the backend accordingly
	ConnectElectrum() error

	// Ping sends a get requset to the bitbox base middleware root handler and returns true if successful
	Ping() (bool, error)

	// Self returns an instance of the base
	Self() *BitBoxBase

	// Status returns the current status of the base
	Status() bitboxbasestatus.Status

	// ChannelHash returns the hash of the noise channel
	ChannelHash() (string, bool)

	// Deregister calls the backend's BitBoxBase Deregister callback and sends a notification to the frontend, if bitboxbase is active.
	// If bitboxbase is not active, an error is returned.
	Deregister() error

	// ReindexBitcoin starts a bitcoin reindex on the base.
	ReindexBitcoin() error

	// ResyncBitcoin starts a bitcoin resync on the base.
	ResyncBitcoin() error

	// SetHostname sets the hostname of the BitBox Base
	SetHostname(string) error

	// UserChangePassword sets a new password for a given user
	UserChangePassword(string, string, string) error

	// UserAuthenticate returns is the authentication with a username and password was successful
	UserAuthenticate(string, string) error

	// BackupSysconfig backs up the system config to the flashdrive
	BackupSysconfig() error

	// BackupHSMSecret backs up the lightning hsm_secret
	BackupHSMSecret() error

	// RestoreSysconfig restores the system config from the flashdrive
	RestoreSysconfig() error

	// RestoreHSMSecret restores the lightning hsm_secret
	RestoreHSMSecret() error

	// EnableTor enables/disables Tor
	EnableTor(rpcmessages.ToggleSettingArgs) error

	// EnableTorMiddleware enables/disables Tor for the middleware
	EnableTorMiddleware(rpcmessages.ToggleSettingArgs) error

	// EnableTorElectrs enables/disables Tor for electrs
	EnableTorElectrs(rpcmessages.ToggleSettingArgs) error

	// EnableTorSSH enables/disables Tor for SSH
	EnableTorSSH(rpcmessages.ToggleSettingArgs) error

	// EnableClearnetIBD configures bitcoind to run over clearnet while in IBD
	EnableClearnetIBD(rpcmessages.ToggleSettingArgs) error

	// EnableRootLogin enables/disables login via the root user/password
	EnableRootLogin(rpcmessages.ToggleSettingArgs) error

	// SetRootPassword sets the systems root password
	SetRootPassword(string) error

	// ShutdownBase initiates a `shutdown now` call via the bbb-cmd.sh script
	ShutdownBase() error

	// RebootBase initiates a `reboot` call via the bbb-cmd.sh script
	RebootBase() error

	// BaseInfo returns information about the Base
	BaseInfo() (rpcmessages.GetBaseInfoResponse, error)

	// ServiceInfo returns information about the services running on the Base
	// As for example the bitcoind, electrs and ligthningd block height
	ServiceInfo() (rpcmessages.GetServiceInfoResponse, error)
}

type SyncOption string