package
4.46.3+incompatible
Repository: https://github.com/bitboxswiss/bitbox-wallet-app.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author

# Functions

BundledFirmware returns the binary of the bundled firmware.
BundledFirmwareVersion returns the version of the bundled firmware.
IsErrorSDCard returns whether the SD card was not inserted during an operation that requires it.
NewCommunication creates a new Communication instance.
NewDevice creates a new instance of Device.
NewError creates a error with the given message and code.
NewPasswordPolicy creates a new password policy with a regular expression pattern, which is used to match the password.

# Constants

ErrInitializing is returned when the device is still booting up.
ErrIONoPassword is returned when no password has been configured.
ErrSDCard is returned when the SD card is needed, but not inserted.
ErrSDNoMatch is returned when the backup check fails.
ErrTouchAbort is returned when the user short-touches the button.
ErrTouchTimeout is returned when the user does not confirm or abort for 30s.
EventBootloaderStatusChanged is fired when the bootloader status changes.
EventPairingAborted is fired when the pairing aborted.
EventPairingError is fired when an error happened during the pairing.
EventPullFailed is fired when a message cannot be pulled through the pairing relay server.
EventPairingScanningFailed is fired when the mobile does not respond with success after scanning the pairing code.
EventPairingStarted is fired when the pairing started.
EventPairingSuccess is fired when the pairing successfully finished.
EventPairingTimedout is fired when the pairing timed out.
EventSignProgress is fired when starting to sign a new batch of hashes.
EventStatusChanged is fired when the status changes.
ProductName is the name of the bitbox.
StatusBootloader means that the device is in bootloader mode, and the bootloader API can be used.
StatusInitialized means the password was set and the device was seeded.
StatusLoggedIn means device authentication was successful, but the device is not yet seeded.
StatusRequireAppUpgrade means that the an app upgrade is required (firmware version too new).
StatusRequireFirmwareUpgrade means that the a firmware upgrade is required before being able to proceed to StatusLoggedIn or StatusSeeded (firmware version too old).
StatusSeeded means we are authenticated, and the device is seeded.
StatusUninitialized is the uninitialized device, i.e.

# Variables

ErrMustBeLoggedIn is returned by API calls when a login is required, but the device has not beed unlocked.

# Structs

BootloaderStatus has all the info to handle the bootloader mode.
Communication implements CommunicationInterface.
Device provides the API to communicate with the digital bitbox.
DeviceInfo is the data returned from the device info api call.
Error wraps an error by the bitbox.
FeatureSet are the device features one can modify with FeatureSet().
PasswordPolicy represents the password policy.
SignatureWithRecID also contains the recoverable ID, with which one can more efficiently recover the public key.

# Interfaces

CommunicationInterface contains functions needed to communicate with the device.

# Type aliases

PasswordValidationError indicates an error when the given password does not comply with the policy.
Status represents the device status.