All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Add support for esp32s3 DIY devices TTGO TWatchS3 and M5Stack CoreS3
- Support building pypi project wheel and readthedocs.io documentation
- Use PIN-entry style screen for entering bip85 index and bip44 account number
- On larger displays show address strings in groups of 4 characters
- Update ESP-IDF base firmware to v5.3.1, and update dependencies
- Update libwally to 1.3.1
- Fixed issue with QR xpub export for testnet wallets
- Improve fw upgrade and psbt signing using connected usb-storage (eg. sd card reader) for esp32s3 devices
- Fix memory exhaustion issues on DIY devices without PSRAM
- Fix display issues with DIY esp32 wrover
- Identify and automatically validate change outputs when signing Green 'Multisig Shield' PSBT
- Show message to highlight if displayed tx output is verified as being sent back to the spending wallet (eg. re-org/consolidation)
- Show message when presented PSBT/tx that does not appear to contain any inputs that require a signature from the Jade signer
- Allow abandoning PIN entry by going 'back' from first digit
- Enable BLE bonds to be cleared when BLE not running
- Allow flipping screen orientation (ie. 180-degree rotation) in diy hardware
- Add cli tool for simple command-line interaction and testing
- Add support for M5StickCPlus2 device
- Experimental support for esp32s3 devices ttgo-tdisplayS3 and ttgo-tdisplay-S3procamera
- Newly designed Home and Camera/QRScan screens
- Lock device only when in-use serial or BLE connection lost (ie. not when just [un-]plugging for charging purposes)
- Always reset to 'no bip39 passphrase' when new wallet initially created/restored
- Stop BLE listener/handler tasks if doing serial-OTA or once user authenticated over USB/serial or QR
- Optimise cbor message parsing from bytes received
- Update ESP-IDF base firmware to v5.2.2, and update dependencies
- Change UI graphics library to esp_lcd
- Update libwally to 1.3.0
- Improve UI on larger diy displays
- Fix bug identifying change outputs when signer placeholder reused in registered descriptor policy
- Correct display of confidential liquid taproot address when signing to include blinding
- Protect against stack-overflow crash if presented elements/liquid PSET (in place of PSBT)
- Added 'get_registered_descriptors' and 'get_registered_descriptor' api calls
- Added menu option to set network selection (mainnet/testnet) for stateless QR code users
- Add to all generic keyboard screens
- Update ESP-IDF base firmware to v5.1.3
- NOTE: THIS WILL INVALIDATE ALL CURRENTLY SAVED BLUETOOTH BONDS - DEVICES WILL NEED TO BE RE-PAIRED
- Corrected/updated documentation
- Fixed display of error messages if OTA (delta) fails
- Fix bug when signer placeholder reused in registered descriptor policy
- Fixed handling of Specter 'sign_message' QR when bip32 path missing
- Fix regression when requesting liquid master blinding key
- Feature to change PIN on next login/unlock
- Option to change PIN of currently unlocked Jade using QR codes
- More thorough new wallet phrase words confirmation (every word displayed, 1 in 3 verified)
- Changed pinserver oracle protocol to only require a single roundtrip, exchanging a single base64-encoded string
- UI code changes to improve spacing/centering of text labels in general
- Tweaks to fetching the liquid master blinding key so the caller can predict whether Jade will block while awaiting user approval
- Update libwally to 1.2.0
- Miscellaneous internal changes/improvements, mostly in UI code
- Better checking of base58 xpub strings when importing multisig details, with clearer error messages
- Better error handling if passed empty bytestring in api cbor message
- Add a warning when fee amount greater than spend amount
- Add 'get_registered_multisig' api call to export multisig registration by name
- Changed screen shown for liquid OP_RETURN outputs to highlight asset burn
- Update ESP-IDF base firmware to v5.1.2
- Update libwally to 1.0.0
- Miscellaneous internal changes/improvements
- Fix bug registering multisig when identical record already exists
- Fix incorrect state returned when 'get-version-info' called while unit booting
- Fix dev dockerfile, some code comments and README docs
- Revert unwanted changes included in 1.0.25
- Minor internal improvements
- Support BLE comms with Android 14 (limit payload to 512 bytes)
- Add support for registered descriptor wallets
- Added setting account and change flag when when verifying scanned address
- Allow user to specifiy account for xpub export qr
- Added support for diy hw with camera
- Added web interaction/display to the jade qemu emulator
- Update ESP-IDF base firmware to v5.1.1
- Update button-lib dependency to espressif/button 3.0.1
- Correct camera image transformation to display picture
- Improve fw update script for early firmwares with less version-info
- Correct multisig validation when different signers share the same fingerprint
- Add option to export registered multisig data in the import file format by QR
- Export BIP85 entropy AES encrypted with key derived from ecdh shared secret by QR
- Support QR export of legacy address scripts/xpubs using BIP44 paths
- Accept optional 'sorted' boolean in the multisig import file
- Add support for explicit proofs when signing liquid transactions
- Update libwally to 0.9.1
- Ensure to set build config flag APP_REPRODUCIBLE_BUILD to true in all configs
- UI improvement when viewing registered multisigs showing all multisig data
- Insist custom pinserver urls are prefixed 'http://' or 'https://'
- Correct BIP85 24-word generation
- Display issues when confirming long BIP39 passphrase and BIP85 mnemonic
- Initialising wallet on diy device without camera or Bluetooth
- Correct sending error reply when user opts not to retry after network error
- Correct error handling in update_jade_fw.py when no suitable fw to download
- Python api fixes - logger hierarchy, deprecated functions, qemu emulator connection, and update cbor dependency
- Generic QR scan handles scanning a seed/wallet QR and switching wallets
- Ability to change UI color scheme / highlight color
- New 'ping' message which will always return immediately, even if main handler thread is busy
- Jade UI screens - larger font, clearer highlighting, consistent look-and-feel, more 'help' links
- Update ESP-IDF base firmware to v5.0.2
- Support for LiquiDEX 2-step swap protocol, including signing partial transactions (ie. swap maker)
- Add screen brightness setting to 'Power-Off Timeout' screen, and rename 'Power Settings'
- Add 'OFF' option to idle-timeout, so unit never reboots, powers-off, or locks the wallet due to inactivity
- Allow the screen to dim (but the wallet remain loaded and Jade powered on) when the only activity is via messaging (ie. no physical button/wheel activity occuring)
- Add option to 'get_blinding_factor' API to be able to fetch both abf and vbf for a tx output in a single call
- M5StickC-Plus Support and DIY documentation
- Add support for camera GC0308
- Update libwally to 0.8.9
- Change idle-timeout so as not to power-off completely when connected via USB, but instead reboot with the screen dimmed
- Increase the default idle-timeout from 5mins to 10mins
- Reduce contrast of displayed QR codes to assist scanning
- Reword warning message shown when receive address being verified is a valid internal/change address
- Fix 'stuck button' when BLE enabled on M5Stack devices
- Re-enable M5Stack-Fire diy config option
- Change sign_psbt api call to take 'network', consistent with other signing calls
- Corrected the config flag which controls persisting BLE pairings in NVS
- Allow the hash of the final firmware image to displayed and verified during OTA
- Allow the signing of non-trivial PSBTs passed over the CBOR messaging interface by splitting the reply over multiple messages
- Performance improvements, notably around scanning a Recovery Phrase and unlocking Jade with a PIN
- Change the way the hash hex is displayed during OTA
- Rename 'Passphrase Settings' button and screen to 'BIP39 Passphrase'
- Make final commitments optional in sign_liquid_tx message, if they are already present in the txn data
- Extend existing change validation to be able to run on any wallet output
- Update ESP-IDF base firmware to v5.0.1
- Update libwally to a master commit which supports using mbedtls for sha calculations
- Changes to remove some dependencies to reduce fw binary size
- Update jade_ota.py in line with update_jade_fw.py
- Addressed out-of-memory issue when scanning large PSBTs consisting of many QR frames
- Improved internal type consistency strictness
- Added option to unlock Jade with PIN using only QR codes (ie. airgapped)
- Added BIP85 creation of BIP39 mnemonic phrase
- Reworked initial screens and settings/options menus
- Handle truncating long multisig wallet names when scanning QR multisig setup
- Added more visible warning when offering BIP39 passphrase use
- Update libwally to 0.8.8
- Fixed text widths in update_jade_fw.py script when loading alpha or beta fw
- Removed unused camera support from build configs
- Facilitate BIP39 passphrases made up only of wordlist words
- Add option to calculate the final BIP39 mnemonic word
- Support sign-message via QR (eg. Specter)
- Add wallet 'logout' option to lock hw unit
- Improved display of BTC output to avoid scrolling address string
- Update Liquid asset registry info
- Update ESP-IDF base firmware to v4.4.4
- Update esp32-camera library to v2.0.3
- Apply a minimum 'idle-off time' when scanning or displaying qr codes
- Fix pressing 'Scan' on a 'diy' esp32 device without a camera
- Fix display of multisig bech32 addresses in 'verify address' screen
- Support QR import of multisig wallet via common format
- Support scanning and verifying registered multisig receive address QR
- Support change output detection and verification for registered multisig wallets
- Support scanning pinserver setup details via QR
- Support scanning current epoch time QR (for TOTP)
- Support scanning OTP setup QR directly from main 'Scan' page
- Show signer/wallet fingerprint on main 'Ready' screen
- Update Liquid asset registry info
- Update libwally to 0.8.7, and to candidate 0.8.8 master commit
- Update ESP-IDF base firmware to v4.4.2
- qemu emulator port number changed from 2222 to 30121
- Update python tools to default to first detected unit, rather than ttyUSB0
- Show timeout value on button label in Settings->Device menu
- Respect any 'Use Passphrase' setting when using 'Recovery Phrase Login'
- Corrected path and script type in singlesig xpub export QR
- Support scanning and signing txns using PSBTs and QR codes (ur:crypto-psbt)
- Support scanning and verifying a singlesig receive address QR
- Export a BIP44-like xpub using QR codes (ur:crypto-account)
- Support importing mnemonic in ur:crypto-bip39 format (vi QR)
- Update Liquid asset registry info
- Update 'Settings' menus
- Update libwally to 0.8.6
- Show BLE config of firmware during OTA
- Update Liquid asset registry info
- Improved menu navigation 'back' button behaviour
- Fix internal error when connecting using 'Recovery Phrase Login'
- Support scan and import/recovery of SeedSigner 'CompactSeedQR' codes
- Added screens to facilitate export (ie manual copy) of CompactSeedQR code
- Use camera when booting to feed image entropy into RNG
- Update Liquid asset registry info
- Updated some UI strings
- Reduced some log levels in jadepy api
- Fix jadepy api issue where connection to qemu simulator did not respect passed timeout
- Internal code-quality improvements
- Added 'Settings' menu for uninitialised Jade units
- Update Liquid asset registry info
- Renamed 'Emergency Restore' to 'Recovery Phrase Login'
- Updated some UI strings and menu options
- Fix issue viewing multisig records introduced in v0.1.35
- Internal code-quality improvements
- Update Liquid asset registry info
- Display new mnemonic words in a column rather than a grid
- Updated some UI strings
- Fixed issue when entering OTP URI via the on-screen keyboard
- Fixed issue when OTA-delta fails patching
- Add 'wallet-erase' duress pin
- Add support for HOTP and TOTP code generation, including passing current UTC time to Jade
- Support scan and import/recovery of SeedSigner 'SeedQR' codes
- Added message fields to be able to pass asset registry data when signing a Liquid transaction
- Update Liquid asset registry info
- Update ESP-IDF base firmware to v4.4.2
- Changed how to specify when to enter a BIP39 passphrase
- Updated QR scanning - much faster and no need to press front button to scan
- Settings menu items rearranged, and added pre-PIN Settings menu
- Fixed issue when scanning QR of mnemonic that contains valid words which are prefixes of other valid words
- Reduce memory usage in UI screens
- Fixed incorrect error code/id returned if firmware update fails
- Internal code improvements
- Add support for generic multisig on liquid and remove requirement on deterministic blinders and commitments hmac
- Show battery icon in orange/red when charge level low/very-low
- Update Liquid asset registry info
- Update ESP-IDF base firmware to v4.4.1
- Increase max supported BIP39 passphrase length to 100 characters
- QR mnemonic scan accepts unambiguous word prefixes
- Refactor OTA and OTA-delta to use a common submodule to wrap the fw decompress
- Fixed occasional ephemeral 'low battery' icon when battery charged/charging
- Fixed rare/intermittent failure to start camera
- Always send rejection message when receive buffers stale or overflowed
- Reduce memory usage and memory fragmentation
- Internal code-consistency improvements
- Support for OTA by delta, rather than uploading entire firmware image
- Add RPC/CBOR message documentation, and add docstrings to jadepy client
- Add support for SSH and GPG keys and signing, for curve nist256p1/secp256r1
- Add testnet-liquid assets
- Display of OP_RETURN outputs
- Generate non-confidential liquid addresess, and support signing non-confidential inputs
- Display warning if multisig path suffixes differ
- Add info screen showing storage usage
- Update Liquid asset registry info
- Update ESP-IDF base firmware to v4.4.0
- Increase allowed multisig configurations to include from 1of1 to nof15
- Increase number of allowed multisig registrations from 8 to 16
- Improve 'out of storage space' reply and on-screen message when saving multisig record
- Make Python API BLE dependencies an optional/extra in setup.py
- Change wallet initialisation to store entropy rather than wallet master key
- Fix progress-bar screen flicker
- Reliability improvements reading input messages, esp. over serial
- Do not error on number of persisted multisig records when updating an existing record
- Update Liquid asset registry info
- Fix crash reported after entering passphrase with v0.1.31
- Show current running firmware version on initial connection screens
- Add support for BIP67 sorted-multisig
- Add compressed file hash when uploading firmware in OTA process - currently optional but will be made mandatory in a future release
- Add battery status in version-info data, so companion apps can display Jade's approximate charge level
- Ensure Bech32m/P2TR transaction output addresses are displayed properly when signing
- Add flag to 'get_shared_nonce' call to also return the public blinding key, to avoid needing to make a second roundtrip
- Add flashing support for alternative hardware serial/USB chip CH9102
- Update Liquid asset registry info
- Refactor internal tasks and GUI updating and event handling
- Update ESP-IDF base firmware to v4.3.1
- Update Libwally to 0.8.4 and use 'minimal build' flag to reduce size of binary and static memory footprint
- Fix issues with Bluetooth bonding to support multiple Jade devices
- NOTE: THIS WILL INVALIDATE ALL CURRENTLY SAVED BLUETOOTH BONDS - DEVICES WILL NEED TO BE RE-PAIRED
- Fix Python API compatability issues with python version 3.10
- Fix font issues with some punctuation characters when displaying BIP39 passphrase
- Reset network restrictions when using temporary/emergency wallet
- Support for generic multisig, following registration/approval of the multisig descriptor
- Support for BIP39 passphrase, if selected during wallet initialisation/setup
- On-screen warnings for unexpected BIP32 paths when generating addresses and when validating change addresses
- Update Liquid asset registry info
- Make 'requests' module an optional dependency for the python api
- Remove returning a root certificate for the default pinserver
- Update policy asset and address prefixes for testnet-liquid network
- Remove 'regtest' as a network synonym for 'localtest' in Jade API
- Update qemu version, including adding support for spiram emulation
- Fix issue where Jade v1.1 jog-wheel appears to be stuck down in certain conditions when connected via Bluetooth
- Error earlier when insufficient/incorrect commitments passed to sign-liquid-tx
- Improve reliability of OTA, especially when running over BLE
- Fix path in script executing qemu in docker image
- Enable creation of new 12-word recovery phrase
- Method to export liquid master blinding key, after user confirmation
- Add support for testnet-liquid network
- Update Liquid asset registry info
- Update libwally to 0.8.3
- Update esp-idf base firmware to v4.2.2
- Improve performance and reliability when receiving large messages (eg. sign-liquid-tx) over Bluetooth
- Potential issue where derived key may not be zero'd in memory after failure
- Fixed corner-case issue reading long strings from cbor messages
- Derive liquid blinding factors consistently with Ledger
- Reduced memory usage for no-PSRAM hardware
- Enable repeating next/prev events when jog-wheel (btn on M5Stack) held down
- Support firmware download for new Jade hardware in 'jade_ota.py' script
- Added '(Temporary Wallet)' to 'Ready!' screen, if using temporary restore wallet
- Added screens to show legal certification text and icons as required
- Update Liquid asset registry info
- Setup screens to use 'recovery phrase' wording rather than 'mnemonic'
- At boot, delay powering screen backlight until splash screen image ready
- Corrected detecting USB connected on new Jade hardware
- Fixed assert when trying to display large amount strings when signing
- Do not allow wiping Bluetooth bonding data when Bluetooth disabled
- Fixed detecting when Jade disconncted from companion app when entering PIN or signing tx etc.
- New Emergency Restore / Temporary Wallet - can be used without persistence or pinserver interaction
- New 'offline' setup of Jade wallet/mnemonic, tweaks to setup screens
- Add support for user-set bespoke pinserver
- Add support for new Jade hardware
- Add support for running under QEMU emulator
- Add configs for M5stack basic/core, and TTGO-TDisplay boards
- Update Liquid asset registry info
- Update default pinserver certificate
- Prefer 'Bluetooth' to 'BLE' in button labels, and use official bluetooth icon
- Use larger font when entering PIN
- 'Sign message' screen to prefer showing the message text, rather than the hash
- Tests running on no-PSRAM devices
- Do not try to access camera on hw boards which do not have one
- Add locked-state and network-restriction to 'get_version_info' reply data
- Have 'auth_user()' call return immediately if passed inappropriate network
- Add support for 'Anti-Exfil' signatures in Jade
- Enable wallet recovery using 12-word mnemonic
- Support for single-sig transaction signing and address generation
- Update Liquid asset registry info
- Update libwally to 0.8.2 and include libsecp's S2C module
- When several screens to scroll through, set the 'Next' button as default
- Separate jadepy communications backends into modules
- Use larger font when displaying new mnemonic words
- Add dependencies missing from
setup.py - When signing always require prevout script to be passed explicitly
- Do not show backspace '<' when entering first digit of pin
- Fix CMakeLists.txt for autogen-lang files.
- Extend 'jade_ota.py' script to be able to download and flash current beta fw version
- Added board-type to 'get_version_info' reply data
- Only accept requests over the connection which authenticated the user/verified the PIN
- Lock Jade when serial or BLE is connected or disconnected (ie. so user must re-enter PIN)
- Update Liquid asset registry info
- If enter incorrect pin, 'auth_user()' call returns false rather than string
- Minor improvements to mnemonic entry screen
- Move pinserver out to its own repo
- Update libwally to 0.8.1
- Fixed issue sending to a legacy (1xxxx) address
- Show 'No Address' when confirming outputs with no scriptpubkey
- Return 'BAD_PARAMS' error when tx data missing from 'sign-msg' request
- Return 'BAD_PARAMS' error when tx input amounts insufficient to cover outputs
- Fixed GPIO conflict on M5Stack devices that caused issue with Button-A
- Fixed memory leak when using camera to scan qr codes
- Fixed skipping words if scroll backwards when confirming mnemonic word
- Initial release of Blockstream Jade firmware
- Support for Green multisig wallet
- Supports btc and liquid