Skip to content

Releases: cashubtc/nutshell

0.16.3

14 Nov 14:41
@callebtc callebtc
0.16.3
6a4f1bd
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
0.16.3 Latest
Latest

This is service update fixing a number of bugs and other minor issues.

Mint

  • bolt11 invoices with different units on the same mint now settle externally via the Lightning network
  • Turn on multipath payments (MPP) by default for LND and CLN
  • NUT-06: Signal alternative URLs to reach the mint from using .env var MINT_INFO_URLS
  • Fix: Signal NUT-14 support (HTLCs) in info endpoint
  • Fix: Return LN preimage in lookup of successful melt quote

Wallet

  • Store Lightning invoices in new melt and mint quote tables
  • Sort outputs by amount to mitigate transaction amount privacy leaks
  • Minor bug fixes to support older mints

What's Changed

New Contributors

Full Changelog: 0.16.1...0.16.3

Contributors

prusnak, davidcaseria, and 4 other contributors
Assets 2
Loading

0.16.2

04 Nov 08:07
@callebtc callebtc
0.16.2
f4c2185
Compare
Choose a tag to compare
0.16.2

0.16.2

This hot fix disables a feature introduced in 0.16.1 that prevented proofs from getting stuck in case where the Lightning backend is detected to be malfunctioning. In that case, the mint would lock all Lightning payments and return the error "Melt is disabled. Please contact the operator.".

Tests have shown that this feature triggers in too many unrelated cases which is why it is disabled by default now. To manually turn on this feature, set the .env variable MINT_DISABLE_MELT_ON_ERROR=True.

Changes since 0.16.1: 0.16.1-branch...0.16.2-branch

0.16.1

This update brings several bug fixes and stability improvements to nutshell. It also adds support for LND via gRPC.

Mint

  • Support for LND via gRPC for LndRPCWallet
  • NUT-15 Multinut payments for CLNRestWallet
  • Stability improvements

Wallet

  • Several minor bug fixes

Protocol

  • NUT-06: Announce local time
  • NUT-06: Announce icon URL with the .env flag MINT_INFO_ICON
  • NUT-04: Mint invoices with a description
  • Fix: HTLC signature model

Updating

Notice: This release bumps the minimal Python version to 3.10. If you were using an older version, upgrade your Python version first before you upgrade nutshell.

Dn't forget to run poetry install if you update from the git repository.

What's Changed

New Contributors

Full Changelog: 0.16.0...0.16.1

Contributors

prusnak, lollerfirst, and 2 other contributors
Assets 2
Loading

0.16.1

30 Oct 14:48
@callebtc callebtc
0.16.1
48b0368
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
0.16.1

This update brings several bug fixes and stability improvements to nutshell. It also adds support for LND via gRPC.

Mint

  • Support for LND via gRPC for LndRPCWallet
  • NUT-15 Multinut payments for CLNRestWallet
  • Stability improvements

Wallet

  • Several minor bug fixes

Protocol

  • NUT-06: Announce local time
  • NUT-06: Announce icon URL with the .env flag MINT_INFO_ICON
  • NUT-04: Mint invoices with a description
  • Fix: HTLC signature model

Updating

Notice: This release bumps the minimal Python version to 3.10. If you were using an older version, upgrade your Python version first before you upgrade nutshell.

Dn't forget to run poetry install if you update from the git repository.

What's Changed

New Contributors

Full Changelog: 0.16.0...0.16.1

Contributors

prusnak, lollerfirst, and 2 other contributors
Assets 2
Loading

0.16.0

25 Jul 10:06
@callebtc callebtc
0.16.0
125ce9e
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
0.16.0

This is major release comes with a ton of new features, bug fixes, performance improvements, and protocol updates. We have a new binary token format that is smaller, the wallet got a lot smarter with coin selection, the nutshell mint and wallet now support ecash fees, WebSocket updates, Multinut payments, and much more.

This release includes a database migration for the mint. Make sure to back up your mint database before upgrading.

New features

New binary token format

The Cashu protocol introduced a new binary Cashu TokenV4 format (with prefix cashuB) that saves around 40% space compared to the previous token format (with prefix cashuA). The Nutshell wallet will produce TokenV4 tokens by default now. To produce tokens with the old format, you can use the command cashu send --legacy <amount> (or -l for short). If you created a new token already but you'd like to see the legacy version of it, enter cashu pending -l.

Offline wallet and improved coin selection

The Nutshell wallet is now equipped with a vastly improved coin selection algorithm that allows the user to make as many transactions offline as possible while also saving on future fees by avoiding swaps with the mint as much as possible. This improves the utility, speed, and privacy of the Nutshell wallet, as it requires less communication with the mint.

Ecash fees

Nutshell now supports fees for Ecash transactions according to changes in NUT-02. Fees are determined by the number of Ecash inputs to a transaction. Fees are given in parts per thousand (ppk). As an example, if the fee is set to 250 ppk (in Satoshis), a transaction spending 4 inputs will require 1 sat in fees. Mints can enable fees by setting MINT_INPUT_FEE_PPK to an integer value in parts per thousand. Fees will only affect newly generated keysets, not old ones.

Warning: Wallet support for fees is still in active development. Enabling fees will break compatibility with most wallets in their current state. Mint operators should enable fees later in the future when there is widespread support for fees.

WebSocket subscriptions

The Cashu protocol recently introduced WebSocket subscriptions in NUT-17 which allows wallets to get notifications for state changes of mint quotes, melt quotes, and ecash spent states and the witness used for unlocking a locked token. The Nutshell mint can now receive subscription requests and send out updates to its clients. For the Nutshell wallet, this improves the responsiveness when minting new tokens as it does not require constant polling anymore. This feature will also improve the execution of smart contracts that require a timely retrieval of the witness used to unlock a token (for example when making atomic swaps against Lightning payments).

Multinut payments

The Nutshell mint now supports Multinut payments with the LND backend (see NUT-15). This feature is still experimental. To enable it, set the env variable MINT_LND_ENABLE_MPP=TRUE. To initiate a partial payment with the Nutshell wallet, use cashu pay <invoice> <amount> where <amount> is the partial amount you want the mint to send. You can initiate partial payments from different mints by repeating this command with different mints that support this feature.

Getting ready for the cloud

A lot of work has been made to extract all state of the mint from the system's memory into the database. These are preparations for making Nutshell ready for parallel deployments in a Kubernetes cluster so that multiple instances of the mint can run on top of the same database. This will allow scaling Nutshell to process many more transactions than what was previously possible.

Support for EUR

We added initial support for Euro Ecash using the StrikeWallet backend for Strike users who have access to Euro balances. FakeWallet now also supports the Euro.

Support for CLN Rest

A new CLNRestWallet backend was added that now supports CLN through the clnrest.py plugin. Previously, CLN was only supported through the c-lightning-rest third party interface for which we will phase out support through the CoreLightningRestWallet.

Protocol updates

NUT-04 and NUT-5 state fields

Mint and melt quotes now have a new state enum field that represents the state of the quote (PR) to reflect changes in the corresponding NUT-04 and NUT-05 specifications.

What's Changed

New Contributors

Full Changelog: 0.15.3...0.16.0

Contributors

lollerfirst, elnosh, and 2 other contributors
Assets 2
Loading

0.16.0-rc3

24 Jul 05:19
@callebtc callebtc
0.16.0-rc3
125ce9e
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
0.16.0-rc3 Pre-release
Pre-release

This is a huge major release with tons of new features, bug fixes, performance improvements, and protocol updates. We have a new binary token format that is smaller, the wallet got a lot smarter with coin selection, the nutshell mint and wallet now support ecash fees, WebSocket updates, Multinut payments, and so much more.

This release includes a database migration for the mint. Make sure to back up your mint database before upgrading.

New features

New binary token format

The Cashu protocol introduced a new binary Cashu TokenV4 format (with prefix cashuB) that saves around 40% space compared to the previous token format (with prefix cashuA). The Nutshell wallet will produce TokenV4 tokens by default now. To produce tokens with the old format, you can use the command cashu send --legacy <amount> (or -l for short). If you created a new token already but you'd like to see the legacy version of it, enter cashu pending -l.

Offline wallet and improved coin selection

The Nutshell wallet is now equipped with a vastly improved coin selection algorithm that allows the user to make as many transactions offline as possible while also saving on future fees by avoiding swaps with the mint as much as possible. This improves the utility, speed, and privacy of the Nutshell wallet, as it requires less communication with the mint.

Ecash fees

Nutshell now supports fees for Ecash transactions according to changes in NUT-02. Fees are determined by the number of Ecash inputs to a transaction. Fees are given in parts per thousand (ppk). As an example, if the fee is set to 250 ppk (in Satoshis), a transaction spending 4 inputs will require 1 sat in fees. Mints can enable fees by setting MINT_INPUT_FEE_PPK to an integer value in parts per thousand. Fees will only affect newly generated keysets, not old ones.

Warning: Wallet support for fees is still in active development. Enabling fees will break compatibility with most wallets in their current state. Mint operators should enable fees later in the future when there is widespread support for fees.

WebSocket subscriptions

The Cashu protocol recently introduced WebSocket subscriptions in NUT-17 which allows wallets to get notifications for state changes of mint quotes, melt quotes, and ecash spent states and the witness used for unlocking a locked token. The Nutshell mint can now receive subscription requests and send out updates to its clients. For the Nutshell wallet, this improves the responsiveness when minting new tokens as it does not require constant polling anymore. This feature will also improve the execution of smart contracts that require a timely retrieval of the witness used to unlock a token (for example when making atomic swaps against Lightning payments).

Multinut payments

The Nutshell mint now supports Multinut payments with the LND backend (see NUT-15). This feature is still experimental. To enable it, set the env variable MINT_LND_ENABLE_MPP=TRUE. To initiate a partial payment with the Nutshell wallet, use cashu pay <invoice> <amount> where <amount> is the partial amount you want the mint to send. You can initiate partial payments from different mints by repeating this command with different mints that support this feature.

Getting ready for the cloud

A lot of work has been made to extract all state of the mint from the system's memory into the database. These are preparations for making Nutshell ready for parallel deployments in a Kubernetes cluster so that multiple instances of the mint can run on top of the same database. This will allow scaling Nutshell to process many more transactions than what was previously possible.

Support for EUR

We added initial support for Euro Ecash using the StrikeWallet backend for Strike users who have access to Euro balances. FakeWallet now also supports the Euro.

Support for CLN Rest

A new CLNRestWallet backend was added that now supports CLN through the clnrest.py plugin. Previously, CLN was only supported through the c-lightning-rest third party interface for which we will phase out support through the CoreLightningRestWallet.

Protocol updates

NUT-04 and NUT-5 state fields

Mint and melt quotes now have a new state enum field that represents the state of the quote (PR) to reflect changes in the corresponding NUT-04 and NUT-05 specifications.

What's Changed

New Contributors

Full Changelog: 0.15.3...0.16.0-rc1

What's Changed

Full Changelog: 0.16.0-rc1...0.16.0-rc2

What's Changed

Full Changelog: 0.16.0-rc2...0.16.0

Contributors

lollerfirst, elnosh, and 2 other contributors
Assets 2
Loading

0.16.0-rc2

17 Jul 12:18
@callebtc callebtc
0.16.0-rc2
040ee12
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
0.16.0-rc2 Pre-release
Pre-release

This is a huge major release with tons of new features, bug fixes, performance improvements, and protocol updates. We have a new binary token format that is smaller, the wallet got a lot smarter with coin selection, the nutshell mint and wallet now support ecash fees, WebSocket updates, Multinut payments, and so much more.

This release includes a database migration for the mint. Make sure to back up your mint database before upgrading.

New features

New binary token format

The Cashu protocol introduced a new binary Cashu TokenV4 format (with prefix cashuB) that saves around 40% space compared to the previous token format (with prefix cashuA). The Nutshell wallet will produce TokenV4 tokens by default now. To produce tokens with the old format, you can use the command cashu send --legacy <amount> (or -l for short). If you created a new token already but you'd like to see the legacy version of it, enter cashu pending -l.

Offline wallet and improved coin selection

The Nutshell wallet is now equipped with a vastly improved coin selection algorithm that allows the user to make as many transactions offline as possible while also saving on future fees by avoiding swaps with the mint as much as possible. This improves the utility, speed, and privacy of the Nutshell wallet, as it requires less communication with the mint.

Ecash fees

Nutshell now supports fees for Ecash transactions according to changes in NUT-02. Fees are determined by the number of Ecash inputs to a transaction. Fees are given in parts per thousand (ppk). As an example, if the fee is set to 250 ppk (in Satoshis), a transaction spending 4 inputs will require 1 sat in fees. Mints can enable fees by setting MINT_INPUT_FEE_PPK to an integer value in parts per thousand. Fees will only affect newly generated keysets, not old ones.

Warning: Wallet support for fees is still in active development. Enabling fees will break compatibility with most wallets in their current state. Mint operators should enable fees later in the future when there is widespread support for fees.

WebSocket subscriptions

The Cashu protocol recently introduced WebSocket subscriptions in NUT-17 which allows wallets to get notifications for state changes of mint quotes, melt quotes, and ecash spent states and the witness used for unlocking a locked token. The Nutshell mint can now receive subscription requests and send out updates to its clients. For the Nutshell wallet, this improves the responsiveness when minting new tokens as it does not require constant polling anymore. This feature will also improve the execution of smart contracts that require a timely retrieval of the witness used to unlock a token (for example when making atomic swaps against Lightning payments).

Multinut payments

The Nutshell mint now supports Multinut payments with the LND backend (see NUT-15). This feature is still experimental. To enable it, set the env variable MINT_LND_ENABLE_MPP=TRUE. To initiate a partial payment with the Nutshell wallet, use cashu pay <invoice> <amount> where <amount> is the partial amount you want the mint to send. You can initiate partial payments from different mints by repeating this command with different mints that support this feature.

Getting ready for the cloud

A lot of work has been made to extract all state of the mint from the system's memory into the database. These are preparations for making Nutshell ready for parallel deployments in a Kubernetes cluster so that multiple instances of the mint can run on top of the same database. This will allow scaling Nutshell to process many more transactions than what was previously possible.

Support for EUR

We added initial support for Euro Ecash using the StrikeWallet backend for Strike users who have access to Euro balances. FakeWallet now also supports the Euro.

Support for CLN Rest

A new CLNRestWallet backend was added that now supports CLN through the clnrest.py plugin. Previously, CLN was only supported through the c-lightning-rest third party interface for which we will phase out support through the CoreLightningRestWallet.

Protocol updates

NUT-04 and NUT-5 state fields

Mint and melt quotes now have a new state enum field that represents the state of the quote (PR) to reflect changes in the corresponding NUT-04 and NUT-05 specifications.

What's Changed

New Contributors

Full Changelog: 0.15.3...0.16.0-rc1

What's Changed

Full Changelog: 0.16.0-rc1...0.16.0-rc2

Contributors

lollerfirst, elnosh, and 2 other contributors
Assets 4
Loading

0.16.0-rc1

16 Jul 09:16
@callebtc callebtc
0.16.0-rc1
21f339c
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
0.16.0-rc1 Pre-release
Pre-release

This is a huge major release with tons of new features, bug fixes, performance improvements, and protocol updates. We have a new binary token format that is smaller, the wallet got a lot smarter with coin selection, the nutshell mint and wallet now support ecash fees, WebSocket updates, Multinut payments, and so much more.

This release includes a database migration for the mint. Make sure to back up your mint database before upgrading.

New features

New binary token format

The Cashu protocol introduced a new binary Cashu TokenV4 format (with prefix cashuB) that saves around 40% space compared to the previous token format (with prefix cashuA). The Nutshell wallet will produce TokenV4 tokens by default now. To produce tokens with the old format, you can use the command cashu send --legacy <amount> (or -l for short). If you created a new token already but you'd like to see the legacy version of it, enter cashu pending -l.

Offline wallet and improved coin selection

The Nutshell wallet is now equipped with a vastly improved coin selection algorithm that allows the user to make as many transactions offline as possible while also saving on future fees by avoiding swaps with the mint as much as possible. This improves the utility, speed, and privacy of the Nutshell wallet, as it requires less communication with the mint.

Ecash fees

Nutshell now supports fees for Ecash transactions according to changes in NUT-02. Fees are determined by the number of Ecash inputs to a transaction. Fees are given in parts per thousand (ppk). As an example, if the fee is set to 250 ppk (in Satoshis), a transaction spending 4 inputs will require 1 sat in fees. Mints can enable fees by setting MINT_INPUT_FEE_PPK to an integer value in parts per thousand. Fees will only affect newly generated keysets, not old ones.

Warning: Wallet support for fees is still in active development. Enabling fees will break compatibility with most wallets in their current state. Mint operators should enable fees later in the future when there is widespread support for fees.

WebSocket subscriptions

The Cashu protocol recently introduced WebSocket subscriptions in NUT-17 which allows wallets to get notifications for state changes of mint quotes, melt quotes, and ecash spent states and the witness used for unlocking a locked token. The Nutshell mint can now receive subscription requests and send out updates to its clients. For the Nutshell wallet, this improves the responsiveness when minting new tokens as it does not require constant polling anymore. This feature will also improve the execution of smart contracts that require a timely retrieval of the witness used to unlock a token (for example when making atomic swaps against Lightning payments).

Multinut payments

The Nutshell mint now supports Multinut payments with the LND backend (see NUT-15). This feature is still experimental. To enable it, set the env variable MINT_LND_ENABLE_MPP=TRUE. To initiate a partial payment with the Nutshell wallet, use cashu pay <invoice> <amount> where <amount> is the partial amount you want the mint to send. You can initiate partial payments from different mints by repeating this command with different mints that support this feature.

Getting ready for the cloud

A lot of work has been made to extract all state of the mint from the system's memory into the database. These are preparations for making Nutshell ready for parallel deployments in a Kubernetes cluster so that multiple instances of the mint can run on top of the same database. This will allow scaling Nutshell to process many more transactions than what was previously possible.

Support for EUR

We added initial support for Euro Ecash using the StrikeWallet backend for Strike users who have access to Euro balances. FakeWallet now also supports the Euro.

Support for CLN Rest

A new CLNRestWallet backend was added that now supports CLN through the clnrest.py plugin. Previously, CLN was only supported through the c-lightning-rest third party interface for which we will phase out support through the CoreLightningRestWallet.

Protocol updates

NUT-04 and NUT-6 state fields

Mint and melt quotes now have a new state enum field that represents the state of the quote (PR) to reflect changes in the corresponding NUT-04 and NUT-05 specifications.

What's Changed

New Contributors

Full Changelog: 0.15.3...0.16.0-rc1

Contributors

lollerfirst, elnosh, and 2 other contributors
Assets 4
Loading

0.15.3

19 Apr 10:12
@callebtc callebtc
0.15.3
72ad903
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
0.15.3

What's Changed

This release includes a database migration for the mint. Make sure to back up your mint database before upgrading.

This update improves the crash resistance of a mint. If the mint should fail during an outgoing Lightning payment, the startup routine will now pick up those payments and invalidate all pending proofs associated with them if the payment succeeded.

The wallet can now check pending invoices thanks to work by @Guilospanck using the command cashu invoices. Various flags have been added to the command which you can see using cashu invoices --help. The wallet can now also restore ecash from all keysets of a mint with the command cashu restore thanks to an improvement by @cjbeery24.

Wallet changes

Mint changes

New Contributors

Full Changelog: 0.15.2...0.15.3

Contributors

cjbeery24, Guilospanck, and callebtc
Assets 2
Loading

0.15.2

26 Mar 21:02
@callebtc callebtc
0.15.2
4ff9e6d
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
0.15.2

This update introduces a built-in rate limiter to the mint. It also includes multiple improvements for automated testing of USD backends and various other stability updates and bug fixes.

Mint

  • Mint: Add Slowapi rate limiter by @callebtc in #481
  • Mint: FakeWallet support for USD by @callebtc in #488
  • Set sat and usd wallets separately in .env (MINT_BACKEND_BOLT11_SAT, MINT_BACKEND_BOLT11_USD)
    • Note: This deprecates the old .env variable MINT_LIGHTNING_BACKEND
  • Fix: CLNRestWallet (tested with c-lightning:24.02.1 and c-lightning-rest:0.10.7) by @callebtc in #494

NUTs

Full Changelog: 0.15.1...0.15.2

Contributors

callebtc
Assets 2
Loading

0.15.1

17 Mar 12:31
@callebtc callebtc
0.15.1
30cdb81
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
0.15.1

This update introduces Blink as a Lightning backend for the mint and includes various other housekeeping items with smaller bug fixes.

This release includes a database migration for the mint. Make sure to back up your mint database before upgrading.

Mint

  • Add Blink as a Lightning funding source
  • Fix: Quote expiry with absolute Unix time
  • Fix: Catch CashuErrors and print them nicely
  • Fix: Do not check MeltQuote status before payment attempt
  • Fix: Mint seed encryption cashu/mint/encrypt.py

Wallet

  • Token invalidation: add setting for batch size

Protocol

New Contributors

Contributors

thesimplekid and findingsov
Assets 2
Loading