bitboxbasestatus

Documentation

Index

• type Event
• type Status

Types

type Event

type Event string

Event represents state change events

const (
	// EventStatusChange should be emitted to the frontend if the status transitions from one to another of
	// above defined status strings.
	EventStatusChange Event = "statusChanged"

	// EventChannelHashChange should be emitted whenever the noise channel hash changes.
	EventChannelHashChange Event = "channelHashChanged"

	// EventSampleInfoChange should be emitted whenever the rpcclient gets a new SampleInfo notification
	EventSampleInfoChange Event = "sampleInfoChanged"

	// EventVerificationProgressChange should be emitted whenever the rpcclient gets a new VerificationProgress notification
	EventVerificationProgressChange Event = "verificationProgressChanged"

	// EventServiceInfoChanged should be emitted whenever the rpcClient receives a 'service info changed' notification
	EventServiceInfoChanged Event = "serviceInfoChanged"
)

type Status

type Status string

Status represents the BitBox Base status.

const (
	// StatusConnected ist the first status, right after the bitboxbase is connected. We automatically
	// move to StatusUnpaired
	StatusConnected Status = "connected"

	// StatusUnpaired means the pairing has not been confirmed yet. After the pairing screen has
	// been confirmed, we move to StatusBitcoinPre.
	StatusUnpaired Status = "unpaired"

	// StatusPairingFailed is when the pairing code was rejected on the app or on the BitBox Base.
	StatusPairingFailed Status = "pairingFailed"

	// StatusPasswordNotSet is after status unpaired, if the Base has not been initialized before.
	StatusPasswordNotSet Status = "passwordNotSet"

	// StatusBitcoinPre is after status unpaired, if the Base has not been initialized before.
	StatusBitcoinPre Status = "bitcoinPre"

	// StatusLocked is before status initialized and after unpairs, passwordNotSet or bitcoinPre
	StatusLocked Status = "locked"

	// StatusInitialized means the BitBox Base has verfied the pairing
	StatusInitialized Status = "initialized"
)