handlers

Documentation

Index

• type BitBox02
• type Handlers
  • func NewHandlers(handleFunc func(string, func(*http.Request) (interface{}, error)) *mux.Route, ...) *Handlers
  • func (handlers *Handlers) Init(device BitBox02)
  • func (handlers *Handlers) Uninit()

Types

type BitBox02

type BitBox02 interface {
	Version() *semver.SemVer
	Status() bitbox02.Status
	Random() ([]byte, error)
	ChannelHash() (string, bool)
	ChannelHashVerify(ok bool)
	DeviceInfo() (*bitbox02.DeviceInfo, error)
	SetDeviceName(deviceName string) error
	SetPassword() error
	CreateBackup() error
	ListBackups() ([]*bitbox02.Backup, error)
	CheckBackup(bool) (string, error)
	RestoreBackup(string) error
	CheckSDCard() (bool, error)
	InsertRemoveSDCard(messages.InsertRemoveSDCardRequest_SDCardAction) error
	SetMnemonicPassphraseEnabled(bool) error
	UpgradeFirmware() error
	Attestation() bool
	Reset() error
	ShowMnemonic() error
	RestoreFromMnemonic() error
	Edition() bitbox02common.Edition
}

BitBox02 models the API of the bitbox02 package.

type Handlers

type Handlers struct {
	// contains filtered or unexported fields
}

Handlers provides a web API to the Bitbox.

func NewHandlers

func NewHandlers(
	handleFunc func(string, func(*http.Request) (interface{}, error)) *mux.Route,
	log *logrus.Entry,
) *Handlers

NewHandlers creates a new Handlers instance.

func (*Handlers) Init

func (handlers *Handlers) Init(device BitBox02)

Init installs a bitbox02 as a base for the web api. This needs to be called before any requests are made.

func (*Handlers) Uninit

func (handlers *Handlers) Uninit()

Uninit removes the bitbox. After this, not requests should be made.