Releases: cardano-foundation/cardano-wallet
v2024-08-11
Compatible with [email protected]
.
Docker Image
Changes
Added
-
Ability to delegate voting rights to a decentralized representative (DRep). Use
PUT /dreps/{drepId}/wallets/{walletId}
to delegate to a DRep given by the identifierdrepId
. This identifier can beabstain
,no_confidence
or a bech32-encoded DRep identifier (with prefixdrep
). See api #4693 -
Support for encryption and decryption of transaction metadata in accordance with CIP-83. Metadata encryption is optional and enabled in the construct tx endpoint via the
encrypt_metadata
field. Metadata decryption is optional and available in the decode tx endpoint in via thedecrypt_metadata
field. More information of this feature is available in spec and CIP-83. #4555, #4667
API changes
Show API changes
POST /shared-wallets/{walletId}/transactions-decode
- Response
- 403 response Added
POST /wallets/{walletId}/transactions-decode
- Response
- 403 response Added
PUT /dreps/{drepId}/wallets/{walletId}
Known Issues
- (ADP-2953) Revision of
cardano-node
is not reported within version in release bundle binary for Windows. - (ADP-2635) Database connections do not seem to gracefully terminate on stopping the wallet.
- (ADP-2298)
Deposit_returned
is falsely reported on some incoming transactions (intermittently). - (ADP-1831)
cardano-wallet
version from docker image does not report revision.
Signatures
Name | Role | Approval |
---|---|---|
Heinrich Apfelmus @HeinrichApfelmus | Software Engineer | ✔️ |
Paolo Veronelli @paolino | Software Engineer | ✔️ |
Pawel Jakubas @paweljakubas | Software Engineer | ✔️ |
v2024-07-27
Compatible with [email protected]
.
Docker Image
Changes
Changed
- Now compatible with
[email protected]
. #4703
API changes
No API changes
Known Issues
- (ADP-2953) Revision of
cardano-node
is not reported within version in release bundle binary for Windows. - (ADP-2635) Database connections do not seem to gracefully terminate on stopping the wallet.
- (ADP-2298)
Deposit_returned
is falsely reported on some incoming transactions (intermittently). - (ADP-1831)
cardano-wallet
version from docker image does not report revision.
Signatures
Name | Role | Approval |
---|---|---|
Pawel Jakubas @paweljakubas | Software Engineer | ✔️ |
Heinrich Apfelmus @HeinrichApfelmus | Software Engineer | ✔️ |
Paolo Veronelli @paolino | Software Engineer | ✔️ |
v2024-07-19
Compatible with [email protected]
.
Docker Image
Changes
Added
- The release artefacts now include configurations for multiple networks, such as
mainnet
,private
,sanchonet
, andpreprod
. #4679, #4680
Changed
-
Now compatible with
[email protected]
. #4657, #4672 -
The QuickStart documentation in the README is now based on a
run.sh
script which is automatically tested as part of our continuous integration (CI) infrastructure. #4679, #4681
API changes
No API changes
Known Issues
- (ADP-2953) Revision of
cardano-node
is not reported within version in release bundle binary for Windows. - (ADP-2635) Database connections do not seem to gracefully terminate on stopping the wallet.
- (ADP-2298)
Deposit_returned
is falsely reported on some incoming transactions (intermittently). - (ADP-1831)
cardano-wallet
version from docker image does not report revision.
Signatures
Name | Role | Approval |
---|---|---|
Heinrich Apfelmus @HeinrichApfelmus | Software Engineer | ✔️ |
Paolo Veronelli @paolino | Software Engineer | ✔️ |
v2024-07-07
Changes
Added
- In the
GET /wallets/{walletId}/transactions-construct
endpoint, added a fieldencrypt_method
for encrypting transaction metadata according to CIP-0083. #4555, #4588, #4589, #4651 - Added a machine-parseable
info
field to some of the HTTP error responses. Notably, this field now includes the requestwallet_id
in the event this identifier is 404 Not Found. #4590, #4597, #4622
Changed
- Now compatible with [email protected]. #4617, #4620, #4659
- Attempting to post a transaction from an old era that is no longer supported will now return an HTTP 403 error response. #4595
GET /wallets/{walletId}/transactions-balance
now resolves foreign inputs automatically by querying thecardano-node
UTxO. #4630
API changes
Show API changes
DELETE /byron-wallets/{walletId}/transactions/{transactionId}
- Response
- 403 response Modified
- application/json content type Modified
- info attribute Added
- application/json content type Modified
- 404 response Modified
- application/json content type Modified
- no_such_wallet, no_such_transaction alternatives Modified
- wallet_not_initialized alternative Added
- application/json content type Modified
DELETE /stake-pools/*/wallets/{walletId}
- Response
- 403 response Modified
- application/json content type Modified
- wrong_encryption_passphrase alternative Modified
- application/json content type Modified
DELETE /wallets/{walletId}/transactions/{transactionId}
- Response
- 403 response Modified
- application/json content type Modified
- info attribute Added
- application/json content type Modified
- 404 response Modified
- application/json content type Modified
- no_such_wallet, no_such_transaction alternatives Modified
- wallet_not_initialized alternative Added
- application/json content type Modified
GET /byron-wallets/{walletId}/transactions
- Response
- 400 response Modified
- application/json content type Modified
- start_time_later_than_end_time alternative Modified
- application/json content type Modified
GET /byron-wallets/{walletId}/transactions/{transactionId}
- Response
- 404 response Modified
- application/json content type Modified
- no_such_wallet, no_such_transaction alternatives Modified
- wallet_not_initialized alternative Added
- application/json content type Modified
GET /shared-wallets/{walletId}/transactions
- Response
- 400 response Modified
- application/json content type Modified
- start_time_later_than_end_time alternative Modified
- application/json content type Modified
GET /shared-wallets/{walletId}/transactions/{transactionId}
- Response
- 404 response Modified
- application/json content type Modified
- no_such_wallet, no_such_transaction alternatives Modified
- wallet_not_initialized alternative Added
- application/json content type Modified
GET /wallets/{walletId}/transactions
- Response
- 400 response Modified
- application/json content type Modified
- start_time_later_than_end_time alternative Modified ...
- application/json content type Modified
v2024-05-05
Compatible with [email protected]
.
Changes
Changed
- Now compatible with [email protected]. #4554
- In the Conway era, when using the Join stake pool HTTP endpoint, the wallet automatically votes to Abstain. By doing so, the user opts into the governance system and ensures that rewards can be withdrawn after the governance bootstrapping phase has ended. In particular, if the wallet is already delegating to a stake pool in the Babbage era, the user can now call the Join stake pool HTTP endpoint with the same pool again in the Conway era to automatically vote Abstain. (The previous version of the wallet would return an error message when trying to delegate to the same pool, irrespective of the change in voting status.) #4562
Fixed
- Fixed documentation for the CLI command
wallet create
. #4516
API changes
Show API changes
PUT /stake-pools/{stakePoolId}/wallets/{walletId}
- Response
-
403 response Modified
-
application/json content type Modified
- pool_already_joined_same_vote, same_vote alternatives Added
-
application/json content type Modified
Known Issues
- (ADP-2953) Revision of
cardano-node
is not reported within version in release bundle binary for Windows. - (ADP-2635) Database connections do not seem to gracefully terminate on stopping the wallet.
- (ADP-2298)
Deposit_returned
is falsely reported on some incoming transactions (intermittently). - (ADP-1831)
cardano-wallet
version from docker image does not report revision.
Signatures
Name | Role | Approval |
---|---|---|
Heinrich Apfelmus @HeinrichApfelmus | Software Engineer | ✔️ |
Paolo Veronelli @paolino | Software Engineer | ✔️ |
Jonathan Knowles @jonathanknowles | Software Engineer | ✔️ |
v2024-03-27
Compatible with [email protected]
.
Changes
Added
- Option to restore the wallet from any point on the blockchain. This feature reduces wallet synchronisation time when you are certain that the wallet cannot contain any transactions before that point, e.g. because its mnemonic was generated after that point.
⚠️ Warning: Using this feature incorrectly may result in an incorrect wallet balance; if in doubt, always restore from genesis. #4382 #4488
Changed
- Now compatible with [email protected]. #4511 #4510 #4507 #4503 #4496
- The CLI command
wallet create from-recovery-phrase
now expects a subcommandfrom-genesis
,from-checkpoint
orfrom-tip
. The previous mode of operation corresponds tofrom-genesis
. #4488
API changes
Show API changes
POST /wallets
- Body
- application/json content type Modified
- shelley alternative Modified
- restoration_mode attribute Added
- shelley alternative Modified
POST /wallets/{walletId}/transactions-balance
- Response
- 403 response Modified
- application/json content type Modified
- balance_tx_inline_plutus_v3_script_not_supported_in_babbage, translation_byron_tx_out_in_context alternatives Added
- application/json content type Modified
Known Issues
- (ADP-2953) Revision of
cardano-node
is not reported within version in release bundle binary for Windows. - (ADP-2635) Database connections do not seem to gracefully terminate on stopping the wallet.
- (ADP-2298)
Deposit_returned
is falsely reported on some incoming transactions (intermittently). - (ADP-1831)
cardano-wallet
version from docker image does not report revision.
Signatures
Name | Role | Approval |
---|---|---|
Heinrich Apfelmus @HeinrichApfelmus | Software Engineer | ✔️ |
Paolo Veronelli @paolino | Software Engineer | ✔️ |
v2024-03-01
Compatible with [email protected]
.
Changes
Added
Changed
- Now compatible with
[email protected]
. #4383 #4388
- In the Conway era, when using the Join stake pool HTTP endpoint, the wallet will now automatically vote to Abstain. By doing so, the user opts into the governance system and ensures that rewards can be withdrawn after the governance bootstrapping phase has ended. #4468 #4454
-
⚠️ When starting an updatedcardano-wallet
with an old database file, this database file will be migrated and can no longer be used with old versions ofcardano-wallet
. However, before migration, backup copies of your old database file will be created. -
Error messages
Fixed
- Fix bash instructions to start node and wallet containers in README. #4364
API changes
Show API changes
DELETE /stake-pools/*/wallets/{walletId}
- Response
- 403 response Modified
- application/json content type Modified
- no_utxos_available alternative Added
- application/json content type Modified
GET /shared-wallets
- Response
- 200 response Modified
- application/json content type Modified
- Active shared wallet (account public keys for each co-signers is collected) alternative Modified
- application/json content type Modified
GET /shared-wallets/{walletId}
- Response
- 200 response Modified
- application/json content type Modified
- Active shared wallet (account public keys for each co-signers is collected) alternative Modified
- application/json content type Modified
GET /wallets
- Response
- 200 response Modified
- application/json content type Modified
GET /wallets/{walletId}
- Response
- 200 response Modified
- application/json content type Modified
- delegation attribute Modified
- application/json content type Modified
GET /wallets/{walletId}/stake-keys
- Response
- 200 response Modified
- application/json content type Modified
- ours attribute Modified
- application/json content type Modified
PATCH /shared-wallets/{walletId}/delegation-script-template
- Response
- 200 response Modified
- application/json content type Modified
- Active shared wallet (account public keys for each co-signers is collected) alternative Modified
- application/json content type Modified
PATCH /shared-wallets/{walletId}/payment-script-template
- Response
- 200 response Modified
- application/json content type Modified
- Active shared wallet (account public keys for each co-signers is collected) alternative Modified
- application/json content type Modified
POST /byron-wallets/{walletId}/coin-selections/random
- Response
- 403 response Modified
- application/json content type Modified
- not_enough_money alternative Modified
- no_utxos_available alternative Added
- application/json content type Modified
POST /byron-wallets/{walletId}/payment-fees
- Response
- 403 response Modified
- application/json content type Modified
- not_enough_money alternativ...
- application/json content type Modified
v2023-12-18
Compatible with [email protected]
.
Changes
Added
- One change address mode to reduce resource consumption of Shelley- and Shared-style wallets #4129
- Ability to filter transactions by address in
GET /wallet/{wid}/transactions
#4004 - Ability to mint/burn assets using scripts from reference inputs #4074 #4086 #4114
- 🏗️ HTTP API extensions in preparation for Voltaire support #4236
- 🏗️ HTTP API extensions in preparation for metadata encryption #4176
Changed
- Fix inconsistency between the current epoch in the tip and delegation status within the wallet API response #4205
- Now compatible with
[email protected]
instead of[email protected]
Deprecated
- The
recovery-phrase
,address
andkey
CLI utilities previously re-exported fromcardano-addresses
. Please usecardano-addressees
instead.
API Changes
https://bump.sh/doc/cardano-wallet-diff/changes#event-change-1e3bb3d5-e168-4a12-ba28-c9b0cf31ef96
Show API changes
Modified: GET /byron-wallets/{walletId}/transactions
Query parameter added: address
Modified: GET /byron-wallets/{walletId}/utxo
Response modified: 200
Content type modified: application/json
Attribute modified: entries
Modified: GET /shared-wallets/{walletId}/transactions
Query parameter added: address
Modified: GET /shared-wallets/{walletId}/utxo
Response modified: 200
Content type modified: application/json
Attribute modified: entries
Modified: GET /wallets/{walletId}/transactions
Query parameter added: address
Modified: GET /wallets/{walletId}/utxo
Response modified: 200
Content type modified: application/json
Attribute modified: entries
Modified: POST /shared-wallets
Content type modified: application/json
Alternative modified: Create shared wallet from mnemonics
Attribute added: one_change_address_mode
Modified: POST /shared-wallets/{walletId}/transactions-construct
Content type modified: application/json
Attribute modified: mint_burn
Alternative added: minting via script reference
Attributes added: encrypt_metadata, vote, reference_policy_script_template
Modified: POST /shared-wallets/{walletId}/transactions-decode
Content type modified: application/json
Attribute added: decrypt_metadata
Modified: POST /wallets
Content type modified: application/json
Alternative modified: shelley
Attribute added: one_change_address_mode
Modified: POST /wallets/{walletId}/transactions-construct
Content type modified: application/json
Attribute modified: mint_burn
Alternative added: minting via script reference
Attributes added: encrypt_metadata, vote, reference_policy_script_template
Modified: POST /wallets/{walletId}/transactions-decode
Content type modified: application/json
Attribute added: decrypt_metadata
Modified: PUT /wallets/{walletId}
Content type modified: application/json
Attribute added: one_change_address_mode
Added: PUT /shared-wallets/{walletId}
Known Issues
- (ADP-2953) Revision of
cardano-node
is not reported within version in release bundle binary for Windows. - (ADP-2635) Database connections do not seem to gracefully terminate on stopping the wallet.
- (ADP-2298)
Deposit_returned
is falsely reported on some incoming transactions (intermittently). - (ADP-1831)
cardano-wallet
version from docker image does not report revision.
Installation Instructions
-
Install
[email protected]
. -
Download the provided
cardano-wallet
for your platform, and uncompress it in a directory that is on your$PATH
, e.g./usr/local/bin
. Or%PATH%
on Windows. -
Start
cardano-wallet --help
and see available parameters.
Docker
Pull from DockerHub and verify the version matches 2023.12.18.
$ docker pull cardanofoundation/cardano-wallet:2023.12.18
$ docker run --rm cardanofoundation/cardano-wallet:2023.12.18 version
Signatures
Name | Role | Approval |
---|---|---|
Heinrich Apfelmus @HeinrichApfelmus | Software Engineer | ✔️ |
Paolo Veronelli @paolino | Software Engineer | ✔️ |
Yura Lazaryev @Unisay | Software Engineer | ✔️ |
v2023-07-18
Compatible with [email protected]
.
Changes
Fixed
- Update links in Readme after repository moved to
cardano-foundation
. (PR 3999)
Changed
- Change organization from
inputouput
tocardanofoundation
for Docker image. (PR 4026 and ADP-3085) - Remove the input selection limit from coin selection. (PR 3921 and ADP-3029)
- When starting an updated
cardano-wallet
with an old database file, the tables containing delegation certificates will be migrated to a new format. (PR 3967 and ADP-3054)
Added
- Enabled delegation action for multisig wallets. Delegation is supported for construct, decode, sign and submit. (PR 3830 and ADP-2602)
- Enabled discovery and withdrawing of rewards for multisig wallets. (PR 3872, PR 3925 and ADP-2604, ADP-2603)
⚠️ When starting an updatedcardano-wallet
with an old database file, this database file will be migrated and can no longer be used with old versions ofcardano-wallet
. However, before migration, a backup copy of your old database file will now be created. (PR 3993, PR 3985 and ADP-3058)
Removed
-
Dropped support for creating transactions in Alonzo or older eras across all endpoints. (PR 3889 and ADP-2913)
- The error
balance_tx_era_not_supported
has been replaced bynode_not_yet_in_recent_era
.
- The error
-
Drop support for balancing transactions in eras more recent than the node tip. (PR 3923 and ADP-2990)
API Changes
https://bump.sh/doc/cardano-wallet-diff/changes#event-change-1bf4ed8f-909a-4084-baf7-113879d74334
Show API changes
-
Modified:
GET /network/parameters
-
200
response was modified-
execution_unit_prices
attribute was modified
-
-
-
Modified:
POST /shared-wallets
-
500
response was added
-
-
Modified:
POST /shared-wallets/{walletId}/transactions-construct
-
403
response was modified-
staking_invalid
alternative was added
-
-
-
Modified:
POST /wallets/{walletId}/transactions-balance
-
400
response was modified-
inline_scripts_not_supported_in_alonzo
,inline_datums_not_supported_in_alonzo
alternatives were removedBreaking
-
-
403
response was modified-
node_not_yet_in_recent_era
,tx_not_in_node_era
alternatives were addedBreaking -
balance_tx_era_not_supported
,balance_tx_max_size_limit_exceeded
alternatives were removedBreaking
-
-
-
Modified:
POST /wallets/{walletId}/transactions-construct
-
403
response was modified-
staking_invalid
alternative was added
-
-
Known Issues
- (ADP-2953) Revision of cardano-node is not reported within version in release bundle binary for Windows.
- (ADP-2635) Database connections does not seem to be gracefully terminated on stopping the wallet.
- (ADP-2298) Deposit_returned is falsely reported on some incoming transactions (intermittently).
- (ADP-1831) cardano-wallet version from docker image does not report revision.
- (ADP-1148) error "restoreBlocks: given chain isn't a valid continuation" when quickly creating new wallets after startup.
- (ADP-1052) Occasional invalid transaction error (MaxTxSizeUTxO) on wallets with big amounts of assets.
- (ADP-776) High memory usage observed in SPO testnet wallet.
- (ADP-773) Rare SQLite3 constraint errors when making transactions.
- (ADP-772) On really large wallets, postTransaction is slow and sometimes returns transaction_is_too_big.
- (ADP-571) Multi-addresses transactions sometimes result in an internal server error.
Documentation
📕 | 💻 | 🐳 |
---|---|---|
API Documentation | CLI Manual | Docker Manual |
Installation Instructions
-
Install
[email protected]
. -
Download the provided
cardano-wallet
for your platform, and uncompress it in a directory that is on your$PATH
, e.g./usr/local/bin
. Or%PATH%
on Windows. -
Start
cardano-wallet --help
and see available parameters.
Docker
Pull from DockerHub and verify the version matches 2023.7.18.
$ docker pull inputoutput/cardano-wallet:2023.7.18
$ docker run --rm inputoutput/cardano-wallet:2023.7.18 version
Signatures
Name | Role | Approval |
---|---|---|
Yura Lazarev @Unisay | Software Engineer | ✔️ |
Heinrich Apfelmus @HeinrichApfelmus | Software Engineer | ✔️ |
Paolo Veronelli @paolino | Software Engineer | ✔️ |
v2023-04-14
Compatible with [email protected]
.
Changes
Fixed
- The listStakePools endpoint no longer returns null values for the
metadata
andretirement
fields if no data is available. Instead, if no data is available, these fields are simply omitted from the JSON response. This fixes a regression introduced in the v2022-12-14 release. (ADP-2523, PR 3675) - When the wallet decodes a transaction that includes native scripts (that act as witnesses and contain key hashes):
- If the key hash belongs to the wallet (i.e., it is an "internal" hash), the wallet will mark these as belonging to the wallet and use an appropriate bech32 prefix in the JSON representation:
policy_vkh
addr_shared_vkh
stake_shared_vkh
- If the key hash does not belong to the wallet (i.e., it is an "external" hash), the wallet will represent these hashes with hexadecimal values, and not include a bech32 prefix in the JSON representation.
- If the key hash belongs to the wallet (i.e., it is an "internal" hash), the wallet will mark these as belonging to the wallet and use an appropriate bech32 prefix in the JSON representation:
This brings the wallet into compliance with CIP-0005 and CIP-1855.
The following endpoints are affected:
- Incomplete shared wallet is no longer silently syncing in background (ADP-2432, PR 3676)
- Tx history not available after receiving token from minting transaction made using reference script (ADP-2666)
- Unexpected "balance_tx_underestimated_fee" on the preprod Shelley/Shared wallet (ADP-2646)
Changed
⚠️ When starting an updatedcardano-wallet
with an old database file, all transactions that hadPending
orExpired
status will be forgotten about, so that the wallet will not attempt to re-submit these transactions. (Note that these transactions can still reappear withInLedger
status). This is due to an internal database migration. While inconvenient, user impact should be small, as:- this database migration will be performed only once (during the first startup of the updated wallet); and
- most
Pending
transactions will have expired naturally before the user opens their wallet again.
⚠️ When starting an updatedcardano-wallet
with an old database file, this database file will be migrated and can no longer be used with old versions ofcardano-wallet
. If you wish to revert to an old version of the software, please make a backup of the database file, or you will have to restore your wallets from scratch. (ADP-2367, PR 3717)- The transaction history is now stored on-disk again, reducing RAM usage at the expense of query time. (ADP-2780, PR 3763; ADP-2871, PR 3828)
- Fees are now reported for all transactions, both incoming and outgoing, in the transaction history. Previously, fees were only reported on outgoing transactions. However, please note that for transactions made during the Byron era, the fee will still be reported as 0. (ADP-2840)
Added
- User documentation for shared wallets. (ADP-2457)
- New endpoints for shared wallets (ADP-2636):
- Add an optional limit
max_count
to the number of transactions returned byGET /transactions
endpoint. This is useful to limit the resource consumption of this endpoint for large wallets. (ADP-2788, PR 3772)
Removed
- Removed all references to the stack build tool from user documentation, replacing these references with equivalent instructions to build with cabal (and nix) instead. (ADP-2102, PR 3671)
- Removed Blockfrost-related CLI options from the
cardano-wallet
executable, and all support for Blockfrost from Cardano Wallet. (ADP-2272, PR 3668)
API Changes
https://bump.sh/doc/cardano-wallet-diff/changes#event-change-95213dc1-6199-451f-80d8-b9898e7bb0d7
Known Issues
- error "restoreBlocks: given chain isn't a valid continuation" when quickly creating new wallets after startup (ADP-1148)
- Occasional invalid transaction error (MaxTxSizeUTxO) on wallets with big amounts of assets (ADP-1052)
- High memory usage observed in SPO testnet wallet (ADP-776)
- Rare SQLite3 constraint errors when making transactions (ADP-773)
- On really large wallets, postTransaction is slow and sometimes returns transaction_is_too_big (ADP-772)
- Multi-addresses transactions sometimes result in an internal server error. (ADP-571)
Documentation
📕 | 💻 | 🐳 |
---|---|---|
API Documentation | CLI Manual | Docker Manual |
Installation Instructions
-
Install
[email protected]
. -
Download the provided
cardano-wallet
for your platform, and uncompress it in a directory that is on your$PATH
, e.g./usr/local/bin
. Or%PATH%
on Windows. -
Start
cardano-wallet --help
and see available parameters.
Docker
Pull from DockerHub and verify the version matches 2023.4.14.
$ docker pull inputoutput/cardano-wallet:2023.4.14
$ docker run --rm inputoutput/cardano-wallet:2023.4.14 version
Signatures
Name | Role | Approval |
---|---|---|
Yura Lazarev @Unisay | Software Engineer | ✔️ |
Piotr Stachyra @piotr-iohk | QA Engineer | ✔️ |
Laurence Jenkins @LaurenceIO | Release Manager | ✔️ |