0.19.2

Caution

This release includes a database migration for the mint. Ensure you back up your database before upgrading your Nutshell instance to avoid data loss.

What's Changed

• feat(core+cli): add NUT-18 Payment Request support by @a1denvalu3 in #891
• fix: no witness if no spending condition by @callebtc in #894
• fix: tests by @callebtc in #895
• bump to 0.19.2 by @callebtc in #896

Full Changelog: 0.19.0...0.19.2

0.19.0

Wallet

• Lightning address support via npubx.cash

Mint

• Background sync for unpaid invoices
• Tor service

NUTs

• new P2PK spending rules (#842)
• keyset metadata in keysets response (#868)

What's Changed

• Fix a typo in an error message by @jooray in #836
• Wallet: remove nostr by @callebtc in #833
• docs: update poetry activation instructions by @b-l-u-e in #840
• p2pk both spend paths possible after timelock by @callebtc in #842
• fix mint migration 027 for old sqlite compat by @callebtc in #820
• fix(Makefile): fixes docker-build command by @TheRealCheebs in #849
• docs: Fix Docker Compose setup and improve documentation by @b-l-u-e in #845
• NUT-errors: New pending error codes by @callebtc in #852
• ws: serialize melt/mint quote notifications consistently by @a1denvalu3 in #788
• refactor: move to coincurve by @a1denvalu3 in #843
• refactor: move to coincurve by @aidenvalue in #861
• fix: correct inverted expiry check in mint quote validation by @zk-bits in #858
• This is a rebased version of "simplify amount_split by iterating over amount bits" by @TheRealCheebs in #851
• feat: include keyset metadata in keys response by @callebtc in #868
• chore: upgrade pydantic by @a1denvalu3 in #866
• fix: create melt quote on condition by @a1denvalu3 in #859
• Tor service by @gandlafbtc in #853
• Mint should check pending proofs and expired quotes regularly by @KvngMikey in #839
• fix: add --version flag support to mint CLI by @hsdredgun in #837
• fix: redis startup connection check by @a1denvalu3 in #876
• fix: mint quote paid timestamps by @a1denvalu3 in #877
• Remove Wallet V0 Support by @KvngMikey in #814
• feat(wallet): add NPC LNURL support by @a1denvalu3 in #888
• bump to 0.19.0 by @callebtc in #889

New Contributors

• @jooray made their first contribution in #836
• @b-l-u-e made their first contribution in #840
• @TheRealCheebs made their first contribution in #849
• @aidenvalue made their first contribution in #861
• @zk-bits made their first contribution in #858
• @gandlafbtc made their first contribution in #853
• @KvngMikey made their first contribution in #839
• @hsdredgun made their first contribution in #837

Full Changelog: 0.18.2...0.19.0

0.18.2

This release introduces updated default mint fees and several bug fixes across both the mint and wallet.

Default Fees

New mints now use a default fee of 100 ppk. This value can be changed via the .env parameter:

MINT_INPUT_FEE_PPK=100

Recap: How Cashu fees work

Fees in Cashu are based on the number of inputs in a transaction (see NUT-02). Each proof counted as an input contributes linearly to total fees. A fee of 100 ppk means 100 parts per thousand inputs, rounded up. In other words, roughly 0.1 base units per input, rounded up to the nearest integer.

Example:

• For a sat keyset, 5 inputs incur 0.5 sat fee, rounded up to 1 sat.
• Any transaction with up to 10 inputs costs 1 sat, 11 to 20 inputs cost 2 sats, and so on.
• For usd keysets, this corresponds to 1 cent per 10 inputs.

Fees are designed to stay low to maintain a smooth user experience while still discouraging abuse. All mints are encouraged to enable fees for protection.

Fixes

• Mint now returns a clean error for pending blinded outputs (code 10002). A dedicated error code for pending outputs will be introduced soon to distinguish this case from already-signed outputs.
• Strike backend now applies USDT fees correctly.
• Wallet updates keyset fee settings when they change.
• Mint now tracks fees accurately across multiple keysets.

What's Changed

• Fix blind message already signed error by @callebtc in #828
• Mint: StrikeBackend handle USDT fees by @callebtc in #829
• gRPC interface: description of settings by @callebtc in #823
• Wallet fix: update keyset fees on load_mint() by @callebtc in #830
• Mint: turn on fees by default by @callebtc in #831
• fix: increment fees for correct keysets by @lollerfirst in #825
• bump to 0.18.2 by @callebtc in #832
• bump to 0.18.2 again by @callebtc in #834
• revert error message change from #828 by @callebtc in #835

Full Changelog: 0.18.1...0.18.2

0.18.1

Caution

This release includes a database migration for the mint. Ensure you back up your database before upgrading your Nutshell instance to avoid data loss.

Fixes

• Clean up large witnesses that might contaminate the database due to the lack of a size check on the HTLC preimage size.
• Remove timeout for Lightning backend HTTP connections.

What's Changed

• Mint: migration to clean up overly large witnesses by @callebtc in #817
• fix: remove 5 seconds timeout by @lollerfirst in #819

Full Changelog: 0.18.0...0.18.1

0.18.0

Caution

This release includes a database migration for the mint. Ensure you back up your database before upgrading your Nutshell instance to avoid data loss.

New Features

Mint management via gRPC

Mint management gRPC server for integration with management UI Orchard and a CLI tool that can send commands to the Mint while it's running.

Additional Protocol Updates

• NUT-04: Create invoices with a description.

Fixes and Improvements

• SIG_ALL signature flag
• USD support for Strike backend
• Improve invoice stream to Lightning backend
• Prevent duplicate blank outputs while melting
• Fix double-execution of melt quotes for the same invoice
• Several other bug fixes

What's Changed

• Mint: adjust mint melt settings by @callebtc in #764
• Add verbose request logging feature to wallet by @olindost in #758
• Mint Management gRPC Server by @lollerfirst in #723
• [BUGFIX] SIG_ALL check returns true for other sigflags by @lollerfirst in #767
• management RPC follow up by @lollerfirst in #770
• fix "Expected currency USD, got USDT" when generating mint quote by @gudnuf in #772
• Adjust mint melt settings 2 by @callebtc in #777
• feat: implement exponential backoff for paid_invoices_stream by @lollerfirst in #778
• fix: subscription re-init bug by @lollerfirst in #781
• add description to NUT-04 method options by @callebtc in #783
• update .env.example by @asmogo in #794
• Fix duplicate blank outputs during melt by @callebtc in #795
• check for existing b by @callebtc in #802
• refactor: HTLC spending conditions by @lollerfirst in #803
• fix: unique ('PENDING', checking_ID) for melt quotes by @lollerfirst in #800
• bump to 0.18.0 by @callebtc in #812

New Contributors

• @olindost made their first contribution in #758
• @asmogo made their first contribution in #794

Full Changelog: 0.17.1...0.18.0

0.17.1

This release includes a hotfix for the updated LNbits v1 backend API.

What's Changed

• Add NUT-23 setting constant by @callebtc in #763
• Another changes for LNbits API by @iWarpBTC in #739

Full Changelog: 0.17.0...0.17.1

0.17.0

Caution

This release includes a database migration for the mint. Ensure you back up your database before upgrading your Nutshell instance to avoid data loss.

New Features

Blind Authentication

• Limit mint access using Clear and Blind Authentication. Nutshell now supports NUT-21 and NUT-22, enabling the use of OAuth 2.0 identity providers like Keycloak (or any compatible provider). This allows you to create closed systems where only registered users of a service can access the mint.
• NUT-22 introduces Blind Authentication, which enhances user privacy by anonymizing authentication within the set of registered users.

Improved Multi-Nut Payments

• Multi-nut payments via LND are now more reliable. Nutshell queries multiple routes before failing, significantly improving payment success rates.

Removed Features

The wallet REST API has been removed from the project due to a low utility to maintenance cost ratio.

Additional Protocol Updates

• SIG_ALL Multisig Flag: Users can now lock ecash to specific destinations (outputs). PR #735
• Mint and Melt Quote Enhancements: The update to NUT-04/05 introduces new fields (amount, unit, request) to mint and melt quotes. PR #719
• ToS URL: Mints now have the option to enter a Terms of Service (ToS) URL in the mint info settings.

Fixes and Improvements

• Wallet Un-reservation: Nutshell wallet now un-reserves ecash after a failed Lightning payment more reliably.
• Improved Keyset Rotation: Enhanced keyset rotation process for mints.
• Pending Melt Quotes: Mints now check pending melt quotes in the background every hour, ensuring more reliable processing of pending ecash.
• Balance Tracking for Keysets: Mints can now track balances for each keyset separately, offering better observability and reporting.
• Strike backend: now supports msat keysets

What's Changed

• Blind authentication by @callebtc in #675
• Update Error Codes by @lollerfirst in #702
• Set correct blink min fee by @callebtc in #701
• Balance Views Grouped By Keyset by @lollerfirst in #652
• Add CLI Decode Command by @lollerfirst in #709
• Update README.md - Add Redis info? by @findingsov in #714
• Update README.md-install nutshell into nutshell dir by @findingsov in #713
• [FIX] NUT-15 mpp amount in millisats by @lollerfirst in #703
• Add LightningPaymentFailedError exception by @callebtc in #706
• [NUT-15] LND: Try Multiple Routes by @lollerfirst in #692
• Wallet: determine valid amounts from mint's keys response by @NonsoAmadi10 in #684
• Upgrade coincurve to version 21.0.0 by @ofek in #721
• NUT-04/05: add amount, unit, request to melt and mint quote responses by @callebtc in #719
• Fix mint migrations: Fill in missing keyset IDs in proofs and promises by @callebtc in #729
• Add terms of service URL to MintInformation class by @callebtc in #715
• Cjbeery24/mint copy: Invoice checker background tasks by @callebtc in #722
• Fix getting the invoice from LNbits API by @iWarpBTC in #732
• SIG_ALL signature flag for P2PK by @callebtc in #735
• Mint Keyset Rotation by @lollerfirst in #734
• Wallet: add Wallet.get_melt_proof(), recover reserved state in failed Wallet.melt() by @callebtc in #730
• Chore: reorganize docker compose files for redis and keycloak by @callebtc in #736
• Wallet: Fix cli mpp off by @callebtc in #741
• Mint: add new init test to mint by @callebtc in #743
• .env.example update for mint TOS by @callebtc in #746
• Testing: check if pipeline gets stuck because of startup task by @callebtc in #745
• Bump version to 0.16.6 by @callebtc in #747
• [PATCH] LND use_mission_control + exclude failing channels by @lollerfirst in #738
• Tests: split wallet test from mint test pipeline by @callebtc in #748
• Mint: watchdog balance log and killswitch by @callebtc in #705
• Wallet: fix db migration 13 duplicate by @callebtc in #750
• Mint: add msat support for Strike backend by @callebtc in #755

New Contributors

• @NonsoAmadi10 made their first contribution in #684
• @ofek made their first contribution in #721
• @iWarpBTC made their first contribution in #732

Full Changelog: 0.16.5...0.16.6-rc1

0.17.0-rc1

Important

This release candidate is not meant to be used in production.

Caution

This release includes a database migration for the mint. Ensure you back up your database before upgrading your Nutshell instance to avoid data loss.

New Features

Blind Authentication

• Limit mint access using Clear and Blind Authentication. Nutshell now supports NUT-21 and NUT-22, enabling the use of OAuth 2.0 identity providers like Keycloak (or any compatible provider). This allows you to create closed systems where only registered users of a service can access the mint.
• NUT-22 introduces Blind Authentication, which enhances user privacy by anonymizing authentication within the set of registered users.

Improved Multi-Nut Payments

• Multi-nut payments via LND are now more reliable. Nutshell queries multiple routes before failing, significantly improving payment success rates.

Removed Features

The wallet REST API has been removed from the project due to a low utility to maintenance cost ratio.

Additional Protocol Updates

• SIG_ALL Multisig Flag: Users can now lock ecash to specific destinations (outputs). PR #735
• Mint and Melt Quote Enhancements: The update to NUT-04/05 introduces new fields (amount, unit, request) to mint and melt quotes. PR #719
• ToS URL: Mints now have the option to enter a Terms of Service (ToS) URL in the mint info settings.

Fixes and Improvements

• Wallet Un-reservation: Nutshell wallet now un-reserves ecash after a failed Lightning payment more reliably.
• Improved Keyset Rotation: Enhanced keyset rotation process for mints.
• Pending Melt Quotes: Mints now check pending melt quotes in the background every hour, ensuring more reliable processing of pending ecash.
• Balance Tracking for Keysets: Mints can now track balances for each keyset separately, offering better tracking and reporting.
• Strike backend: now supports msat keysets

What's Changed

• Blind authentication by @callebtc in #675
• Update Error Codes by @lollerfirst in #702
• Set correct blink min fee by @callebtc in #701
• Balance Views Grouped By Keyset by @lollerfirst in #652
• Add CLI Decode Command by @lollerfirst in #709
• Update README.md - Add Redis info? by @findingsov in #714
• Update README.md-install nutshell into nutshell dir by @findingsov in #713
• [FIX] NUT-15 mpp amount in millisats by @lollerfirst in #703
• Add LightningPaymentFailedError exception by @callebtc in #706
• [NUT-15] LND: Try Multiple Routes by @lollerfirst in #692
• Wallet: determine valid amounts from mint's keys response by @NonsoAmadi10 in #684
• Upgrade coincurve to version 21.0.0 by @ofek in #721
• NUT-04/05: add amount, unit, request to melt and mint quote responses by @callebtc in #719
• Fix mint migrations: Fill in missing keyset IDs in proofs and promises by @callebtc in #729
• Add terms of service URL to MintInformation class by @callebtc in #715
• Cjbeery24/mint copy: Invoice checker background tasks by @callebtc in #722
• Fix getting the invoice from LNbits API by @iWarpBTC in #732
• SIG_ALL signature flag for P2PK by @callebtc in #735
• Mint Keyset Rotation by @lollerfirst in #734
• Wallet: add Wallet.get_melt_proof(), recover reserved state in failed Wallet.melt() by @callebtc in #730
• Chore: reorganize docker compose files for redis and keycloak by @callebtc in #736
• Wallet: Fix cli mpp off by @callebtc in #741
• Mint: add new init test to mint by @callebtc in #743
• .env.example update for mint TOS by @callebtc in #746
• Testing: check if pipeline gets stuck because of startup task by @callebtc in #745
• Bump version to 0.16.6 by @callebtc in #747
• [PATCH] LND use_mission_control + exclude failing channels by @lollerfirst in #738
• Tests: split wallet test from mint test pipeline by @callebtc in #748
• Mint: watchdog balance log and killswitch by @callebtc in #705
• Wallet: fix db migration 13 duplicate by @callebtc in #750

New Contributors

• @NonsoAmadi10 made their first contribution in #684
• @ofek made their first contribution in #721
• @iWarpBTC made their first contribution in #732

Full Changelog: 0.16.5...0.16.6-rc1

0.16.5

This maintenance release contains various bug fixes for the mint and the wallet. Most notably, overpaid Lightning fees are now issued to the user at the next restart of the mint in cases where the mint has crashed or turned off while an outgoing Lightning payment was still pending.

What's Changed

• Add restart policy for Redis Docker container by @callebtc in #687
• update asyncpg 0.29.0 -> 0.30.0 to make Python 3.13 happy by @prusnak in #690
• chore: use poetry the latest 1.8.x poetry consistently by @prusnak in #691
• config cleanup regarding MPP by @prusnak in #689
• Issue NUT-08 overpaid Lightning fees for melt quote checks on startup by @callebtc in #688
• Fix Redis teardown logic based on usage by @callebtc in #696
• [FIX] Specs conformant error codes by @lollerfirst in #693
• wallet fix: load proofs before receiving by @callebtc in #698
• [FIX] Reject Internal MPP Melt Quote Requests by @lollerfirst in #697
• bump to 0.16.5 by @callebtc in #699

Full Changelog: 0.16.4...0.16.5

0.16.4

This release brings two new protocol spec updates to nutshell, NUT-19 and NUT-20 (thank you @lollerfirst). It also includes a new HTTP compression middleware (thank you @ok300) and several bug fixes.

Note

Don't forget to run poetry install if you update nutshell from the GitHub repository.

NUT-19: Cached Response

The nutshell mint now supports NUT-19 cached responses using Redis. The mint will replay successful mint, melt, and swap responses from its caching middleware. Enable these settings in your .env to cache responses in Redis:

MINT_REDIS_CACHE_ENABLED=TRUE
MINT_REDIS_CACHE_URL="redis://localhost:6379"

A new file in /docker/docker-compose.yml can be used to start a redis server using docker compose up.

NUT-20: Signature on Mint Quote

NUT-20 allows users to create mint quotes that can only be minted if a valid signature is provided by the creator of the mint quote.

What's Changed

• Add MPP methods key to info endpoint by @callebtc in #672
• parse env example by @callebtc in #677
• recommend openssl for key generation by @callebtc in #678
• Mint: Catch websocket disconnect errors by @callebtc in #674
• fix: NUT-15 setting remove mpp boolean by @callebtc in #673
• Add HTTP compression middleware by @ok300 in #676
• NUT-19: Cached Requests and Responses by @lollerfirst in #624
• NUT-20 (signatures on quotes) for mint and wallet side by @lollerfirst in #670
• Add period at the end of the phrase by @whileunless in #681
• Bump version to 0.16.4 by @callebtc in #685
• Add NUT-19 example for caching responses by @callebtc in #686

New Contributors

• @ok300 made their first contribution in #676
• @whileunless made their first contribution in #681

Full Changelog: 0.16.3...0.16.4