Releases: cashubtc/nutshell
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
- [CI] prevent pypi upload on pre-releases by @callebtc in #520
- README: add testnut by @callebtc in #522
- Mint: refactor melt quote by @callebtc in #530
- Multinut LND by @callebtc in #492
- startup: do not print postgres connection string, closes #523 by @callebtc in #540
- Add fees by @callebtc in #503
- Use integer division for fee calculation by @callebtc in #549
- Fix false mpp payment handling of unsupported backends by @callebtc in #547
- Mint: add websockets for quote updates by @callebtc in #413
- NUT-04 and NUT-05: Add
state
field to quotes by @callebtc in #560 - [Mint] Add support for BTC and EUR in
StrikeWallet
backend, add EUR toFakeWallet
by @callebtc in #561 - add MINT_LND_REST_CERT_VERIFY env bool that when set to False allow to skip certificate validation for LND api call by @elliedev80 in #535
- LndRestWallet: edit warning messages by @callebtc in #562
- Fix: default witness is None, closes #559 by @callebtc in #563
- Fix: Nut 05 mint response model by @callebtc in #564
- TokenV4 CBOR serialization by @callebtc in #502
- Mint: Add
clnrest.py
Lightning backend by @lollerfirst in #551 - update poetry.lock by @callebtc in #567
- Mint: table locks by @callebtc in #566
- fix: cashu send --lock by @callebtc in #570
- Refactor database transactions by @callebtc in #571
- bump version to 0.16.0 by @callebtc in #573
- Update requirements and docker build by @callebtc in #572
- Fix Tokenv4 handling of base64 keysets by @callebtc in #575
- Fix
receive -a
to receive all pending tokens by @callebtc in #578 - Fix loading b64 keysets and add option to set b64 inactive in WalletSettings by @callebtc in #579
- Wallet: add CLI flag
--force-swap
flag and force swapping all inactive keysets by @callebtc in #580 CONTRIBUTING.md
: Update contributing guidelines and environment setup by @callebtc in #581StrikeWallet
: support USDT by @callebtc in #583- codecov: ignore cashu/nostr by @callebtc in #378
CONTRIBUTING.md
: Add instructions for .env file by @callebtc in #582- Wallet: default to
SIG_INPUTS
in P2PK lock by @elnosh in #584 - NUT-06: Mint contact info by @callebtc in #585
- Fix NUT-17 settings entry for NUT-06 by @callebtc in #587
- Fix parsing of old format contact field in wallet by @callebtc in #589
- Fix race condition by @lollerfirst in #586
- Edit README.md by @callebtc in #590
- Add docker compose instructions by @callebtc in #591
- Mint: enable
LNbitsWallet
invoice stream by @callebtc in #594 - Remove unused coinselection code by @callebtc in #597
New Contributors
- @elliedev80 made their first contribution in #535
- @lollerfirst made their first contribution in #551
- @elnosh made their first contribution in #584
Full Changelog: 0.15.3...0.16.0
0.16.0-rc3
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
- [CI] prevent pypi upload on pre-releases by @callebtc in #520
- README: add testnut by @callebtc in #522
- Mint: refactor melt quote by @callebtc in #530
- Multinut LND by @callebtc in #492
- startup: do not print postgres connection string, closes #523 by @callebtc in #540
- Add fees by @callebtc in #503
- Use integer division for fee calculation by @callebtc in #549
- Fix false mpp payment handling of unsupported backends by @callebtc in #547
- Mint: add websockets for quote updates by @callebtc in #413
- NUT-04 and NUT-05: Add
state
field to quotes by @callebtc in #560 - [Mint] Add support for BTC and EUR in
StrikeWallet
backend, add EUR toFakeWallet
by @callebtc in #561 - add MINT_LND_REST_CERT_VERIFY env bool that when set to False allow to skip certificate validation for LND api call by @elliedev80 in #535
- LndRestWallet: edit warning messages by @callebtc in #562
- Fix: default witness is None, closes #559 by @callebtc in #563
- Fix: Nut 05 mint response model by @callebtc in #564
- TokenV4 CBOR serialization by @callebtc in #502
- Mint: Add
clnrest.py
Lightning backend by @lollerfirst in #551 - update poetry.lock by @callebtc in #567
- Mint: table locks by @callebtc in #566
- fix: cashu send --lock by @callebtc in #570
- Refactor database transactions by @callebtc in #571
- bump version to 0.16.0 by @callebtc in #573
- Update requirements and docker build by @callebtc in #572
- Fix Tokenv4 handling of base64 keysets by @callebtc in #575
- Fix
receive -a
to receive all pending tokens by @callebtc in #578 - Fix loading b64 keysets and add option to set b64 inactive in WalletSettings by @callebtc in #579
- Wallet: add CLI flag
--force-swap
flag and force swapping all inactive keysets by @callebtc in #580 CONTRIBUTING.md
: Update contributing guidelines and environment setup by @callebtc in #581StrikeWallet
: support USDT by @callebtc in #583- codecov: ignore cashu/nostr by @callebtc in #378
CONTRIBUTING.md
: Add instructions for .env file by @callebtc in #582- Wallet: default to
SIG_INPUTS
in P2PK lock by @elnosh in #584 - NUT-06: Mint contact info by @callebtc in #585
New Contributors
- @elliedev80 made their first contribution in #535
- @lollerfirst made their first contribution in #551
- @elnosh made their first contribution in #584
Full Changelog: 0.15.3...0.16.0-rc1
What's Changed
- Fix NUT-17 settings entry for NUT-06 by @callebtc in #587
- Fix parsing of old format contact field in wallet by @callebtc in #589
- Fix race condition by @lollerfirst in #586
- Edit README.md by @callebtc in #590
Full Changelog: 0.16.0-rc1...0.16.0-rc2
What's Changed
- Add docker compose instructions by @callebtc in #591
- Mint: enable
LNbitsWallet
invoice stream by @callebtc in #594 - Remove unused coinselection code by @callebtc in #597
Full Changelog: 0.16.0-rc2...0.16.0
0.16.0-rc2
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
- [CI] prevent pypi upload on pre-releases by @callebtc in #520
- README: add testnut by @callebtc in #522
- Mint: refactor melt quote by @callebtc in #530
- Multinut LND by @callebtc in #492
- startup: do not print postgres connection string, closes #523 by @callebtc in #540
- Add fees by @callebtc in #503
- Use integer division for fee calculation by @callebtc in #549
- Fix false mpp payment handling of unsupported backends by @callebtc in #547
- Mint: add websockets for quote updates by @callebtc in #413
- NUT-04 and NUT-05: Add
state
field to quotes by @callebtc in #560 - [Mint] Add support for BTC and EUR in
StrikeWallet
backend, add EUR toFakeWallet
by @callebtc in #561 - add MINT_LND_REST_CERT_VERIFY env bool that when set to False allow to skip certificate validation for LND api call by @elliedev80 in #535
- LndRestWallet: edit warning messages by @callebtc in #562
- Fix: default witness is None, closes #559 by @callebtc in #563
- Fix: Nut 05 mint response model by @callebtc in #564
- TokenV4 CBOR serialization by @callebtc in #502
- Mint: Add
clnrest.py
Lightning backend by @lollerfirst in #551 - update poetry.lock by @callebtc in #567
- Mint: table locks by @callebtc in #566
- fix: cashu send --lock by @callebtc in #570
- Refactor database transactions by @callebtc in #571
- bump version to 0.16.0 by @callebtc in #573
- Update requirements and docker build by @callebtc in #572
- Fix Tokenv4 handling of base64 keysets by @callebtc in #575
- Fix
receive -a
to receive all pending tokens by @callebtc in #578 - Fix loading b64 keysets and add option to set b64 inactive in WalletSettings by @callebtc in #579
- Wallet: add CLI flag
--force-swap
flag and force swapping all inactive keysets by @callebtc in #580 CONTRIBUTING.md
: Update contributing guidelines and environment setup by @callebtc in #581StrikeWallet
: support USDT by @callebtc in #583- codecov: ignore cashu/nostr by @callebtc in #378
CONTRIBUTING.md
: Add instructions for .env file by @callebtc in #582- Wallet: default to
SIG_INPUTS
in P2PK lock by @elnosh in #584 - NUT-06: Mint contact info by @callebtc in #585
New Contributors
- @elliedev80 made their first contribution in #535
- @lollerfirst made their first contribution in #551
- @elnosh made their first contribution in #584
Full Changelog: 0.15.3...0.16.0-rc1
What's Changed
- Fix NUT-17 settings entry for NUT-06 by @callebtc in #587
- Fix parsing of old format contact field in wallet by @callebtc in #589
- Fix race condition by @lollerfirst in #586
- Edit README.md by @callebtc in #590
Full Changelog: 0.16.0-rc1...0.16.0-rc2
0.16.0-rc1
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
- [CI] prevent pypi upload on pre-releases by @callebtc in #520
- README: add testnut by @callebtc in #522
- Mint: refactor melt quote by @callebtc in #530
- Multinut LND by @callebtc in #492
- startup: do not print postgres connection string, closes #523 by @callebtc in #540
- Add fees by @callebtc in #503
- Use integer division for fee calculation by @callebtc in #549
- Fix false mpp payment handling of unsupported backends by @callebtc in #547
- Mint: add websockets for quote updates by @callebtc in #413
- NUT-04 and NUT-05: Add
state
field to quotes by @callebtc in #560 - [Mint] Add support for BTC and EUR in
StrikeWallet
backend, add EUR toFakeWallet
by @callebtc in #561 - add MINT_LND_REST_CERT_VERIFY env bool that when set to False allow to skip certificate validation for LND api call by @elliedev80 in #535
- LndRestWallet: edit warning messages by @callebtc in #562
- Fix: default witness is None, closes #559 by @callebtc in #563
- Fix: Nut 05 mint response model by @callebtc in #564
- TokenV4 CBOR serialization by @callebtc in #502
- Mint: Add
clnrest.py
Lightning backend by @lollerfirst in #551 - update poetry.lock by @callebtc in #567
- Mint: table locks by @callebtc in #566
- fix: cashu send --lock by @callebtc in #570
- Refactor database transactions by @callebtc in #571
- bump version to 0.16.0 by @callebtc in #573
- Update requirements and docker build by @callebtc in #572
- Fix Tokenv4 handling of base64 keysets by @callebtc in #575
- Fix
receive -a
to receive all pending tokens by @callebtc in #578 - Fix loading b64 keysets and add option to set b64 inactive in WalletSettings by @callebtc in #579
- Wallet: add CLI flag
--force-swap
flag and force swapping all inactive keysets by @callebtc in #580 CONTRIBUTING.md
: Update contributing guidelines and environment setup by @callebtc in #581StrikeWallet
: support USDT by @callebtc in #583- codecov: ignore cashu/nostr by @callebtc in #378
CONTRIBUTING.md
: Add instructions for .env file by @callebtc in #582- Wallet: default to
SIG_INPUTS
in P2PK lock by @elnosh in #584 - NUT-06: Mint contact info by @callebtc in #585
New Contributors
- @elliedev80 made their first contribution in #535
- @lollerfirst made their first contribution in #551
- @elnosh made their first contribution in #584
Full Changelog: 0.15.3...0.16.0-rc1
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
- [Wallet] Issue #313: allow checking pending invoices by @Guilospanck in #493
- [Wallet] Restore wallet now restores tokens for all mint keysets. by @cjbeery24 in #509
- [Wallet] Request Mint Refactor by @cjbeery24 in #507
- [Wallet] Fix regression bug for mint request by @callebtc in #513
Mint changes
- [Mint] Recover pending melts at startup by @callebtc in #499
- [Mint] Refactor: remove output.id optional by @callebtc in #504
- [Mint] Migrate duplicate keysets to db by @callebtc in #511
New Contributors
- @Guilospanck made their first contribution in #493
- @cjbeery24 made their first contribution in #509
Full Changelog: 0.15.2...0.15.3
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
andusd
wallets separately in.env
(MINT_BACKEND_BOLT11_SAT
,MINT_BACKEND_BOLT11_USD
)- Note: This deprecates the old
.env
variableMINT_LIGHTNING_BACKEND
- Note: This deprecates the old
- Fix: CLNRestWallet (tested with
c-lightning:24.02.1
andc-lightning-rest:0.10.7
) by @callebtc in #494
NUTs
- NUTs (cashubtc/nuts#82): info endpoint method settings by @callebtc in #487
- Use
PostRestoreRequest
for all restore operations by @callebtc in #483
Full Changelog: 0.15.1...0.15.2
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
- NUT-07: Token state check with
Y
(cashubtc/nuts#93) - NUT-09: Response model for v1 updated (cashubtc/nuts#87)
New Contributors
- @findingsov made their first contribution in #450
- @thesimplekid made their first contribution in #453
0.15.0
Nutshell upgrades to Cashu v1
The Cashu protocol has recently been updated to its first stable version. This release of Nutshell now supports the v1 protocol. The Cashu v1 protocol paves the way for Ecash with multiple denominations (sat, msat, usd, ...) and payment methods (Lightning, On-chain, ...). This update has been a long time in the making, with significant changes in the overall software architecture and several database migrations.
Mint runners: Always backup your mint database before upgrading.
With this release, Nutshell is also preparing for exciting upgrades in the future. These upgrades will enable you to run a Cashu mint with replication in a distributed cluster for highly available services and significantly increased throughput. Furthermore, a single deployment of a mint will be able to serve many "virtual mints" for different users.
Mint
- New v1 API implementation with backwards compatibility. Old v0 wallets will keep working with the mint.
- Mint can now rotate keysets by using BIP32 key derivation.
- Each keyset can now have a separate seed from which it is generated.
- Mint stores the seed for each keyset in the database. The seed can optionally be encrypted using a separate CLI tool
cashu/mint/decrypt.py
. - Fix P2PK multisig checks.
- Supports database backups before future migrations via env var
DB_BACKUP_PATH
- New safety settings for limiting the maximum balance of the mint (
MINT_MAX_BALANCE
) and the maximum amount for mint (MINT_MAX_PEG_IN
) and melt (MINT_MAX_PEG_OUT
) requests.
Wallet
- New v1 API implementation with backwards compatibility. The wallet will still work with old v0 mints.
- Support for multiple denomination in the same wallet.
- Many smaller issues fixed.
0.14.1
Updates in a Nutshell
- Stateless Mint: Nutshell mint can now be run "stateless" meaning that all state is in the database. This is a step towards being able to run multiple mints workers in parallel for heavy load scenarios.
- Max balance for mints: a new
MINT_MAX_BALANCE
environment flag makes sure that the mint can only hold a maximum amount. - CLI: Create an invoice without blocking with
cashu invoice <amount> -n
What's Changed
- Mint: Add LndRest and regtest tests by @callebtc in #359
- Add CoreLightningRestWallet by @callebtc in #362
- Upadte to c-lightning-REST v0.10.5 by @callebtc in #364
- Fix: Cast keyset keys (amount) to int by @callebtc in #368
- Mint: add max balance setting by @callebtc in #369
- index on db and read spent proofs from db by @callebtc in #370
- docker mint listen on 0.0.0.0 by @callebtc in #371
- add test private key by @callebtc in #372
- Test/mint_add_verification_balance by @callebtc in #373
- Mint: invalidate and generate promises in single db transaction for split by @callebtc in #374
- mint: fix postgres migrations by @callebtc in #375
- Wallet/fix_nostr_timeout by @callebtc in #376
- Mint/verify_outputs_not_already_signed by @callebtc in #377
- Mint: verify outputs first during mint by @callebtc in #379
- fix missing dleq proof in db by @callebtc in #380
Full Changelog: 0.14.0...0.14.1
0.14.0
Nutshell 0.14.0
brings many new features and improvements. These include a completely redesigned approach to use ecash spending conditions (programmable ecash) and the ability to transact offline (using offline signature validation). Protocol changes are according to the new specifications NUT-10, NUT-11, and NUT-12.
Protocol updates
Well-known spending conditions
Nutshell now supports NUT-10 spending conditions. This is a standardized way to create complex contracts between two Cashu users, if the mint supports a certain type of contract. One example is the P2PK implementation (see below).
Pay to Pubkey (P2PK)
P2PK allows you to lock a token to a specific pubkey. That way, only the intended receiver can redeem a token and nobody else. The recipient receives the token by providing a valid signature when redeeming it with the mint. The contract is enforced by the mint. To create a pubkey lock as a receiver, enter cashu lock
. To send to this lock, the sender enters cashu send <amount> --lock <p2pk_lock_of_receiver>
. This token can now be redeemed by the receiver. Read the specifications in NUT-11
DLEQ proofs
Discrete-log equality (DLEQ) proofs are now generated by the mint and handed over to wallets. Wallets can use these to verify the signature of the mint given their public key. Wallets can also send DLEQ proofs to other receiving wallets via cashu send --dleq <amount>
. Receiving wallets will validate the DLEQ proof before redeeming the token via the mint. Read more information in the DLEQ PR and the specification in NUT-12.
Other Improvements
- Wallet secret derivation fixed. Old tokens will not be restored with the new secret derivation. Use
cashu selfpay
to send yourself entire balance once. cashu info
now shows all mints- Wallet stores mint keysets for offline verification.
- Mint DB with Postgres support
- Include nostr submodule in project repo
- Improve Docker pipeline for wallet and mint
All changes
- FEAT: Add flake8 by @dni in #267
- Update makefile format check by @callebtc in #293
- [FEAT] add pre-commit by @dni in #294
- [FEAT] Improve tests by @dni in #296
- [DEV] add ruff and remove isort and flake by @dni in #300
- Show all mints in cashu info by @sihamon in #299
- quickfix ruff by @dni in #303
- [CHORE] updating dependencies, mainly fastapi by @dni in #302
- [Wallet] Refactor
restore_promises_from_to
by @callebtc in #307 - update requirements.txt by @callebtc in #308
- Mint/add_cors_to_error_response by @callebtc in #312
- load the proofs or we get a zero balance by @dyKiU in #310
- Refactor: P2PKSecret by @callebtc in #323
- [Wallet/Mint] DLEQ proofs by @callebtc in #175
- HTLCs by @callebtc in #325
- Tests: Test with
LIGHTNING=True
and refactor mint by @callebtc in #326 - Tests: mint operations by @callebtc in #328
- Bump to
0.14.0-rc1
by @callebtc in #329 - Ledger: add more type hints by @callebtc in #330
- Docker: Add wallet daemon and
docker-compose.yml
by @callebtc in #321 - Wallet: fix secret derivation & new CLI command
cashu selfpay
by @callebtc in #331 - update readme by @callebtc in #336
- readme: fix links by @callebtc in #337
- Coalesce all witness fields to
Proof.witness
by @callebtc in #342 - Remove P2SH by @callebtc in #341
- codecov nutshell by @callebtc in #343
- Update README.md by @callebtc in #344
- Wallet: Cache keysets by @callebtc in #333
- Join mint URL and endpoint in a safe way by @sihamon in #298
- [Wallet] Fix fee return for fee=0 by @callebtc in #345
- [Wallet] Add nostr dependency directly to repo by @callebtc in #346
- Format nostr submodule by @callebtc in #347
- Mint: Allow 0-valued amounts for blank outputs by @callebtc in #348
- Zero amount invoices: throw error before attempting a payment by @callebtc in #349
- Wallet: Lightning interface by @callebtc in #318
- Refactor secret conditions by @callebtc in #350
- use specific keyset for returned change by @callebtc in #351
- Fix LNbits backend to use proper BaseModels by @callebtc in #352
- Postgres migrations: remove balance view before children by @callebtc in #353
- fix proxy keys by @callebtc in #355
- Wallet: ensure that mint keys are loaded before calling appropriate api methods by @callebtc in #356
- Hide stacktrace for
DEBUG=FALSE
andProof.do_tict()
minor fixup by @callebtc in #357 - fakewallet: return preimage by @callebtc in #358
Full Changelog: 0.13.0...0.14.0