Release v2024-09-29

Node Compatibility

Compatible with [email protected].

DockerHub Image

Image

Changes

Changed

• Now distributed with [email protected].

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	✔️
Pawel Jakubas @paweljakubas	Software Engineer
Johannes Lund @Anviking	Software Engineer
David Clark @david-a-clark	Product Manager	✔️

Release v2024-09-26

Node Compatibility

Compatible with [email protected].

Docker Image

Image

Changes

Changed

• Now compatible with [email protected]. #4790

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	✔️
Pawel Jakubas @paweljakubas	Software Engineer
Johannes Lund @Anviking	Software Engineer
David Clark @david-a-clark	Product Manager

Release v2024-09-03

Node Compatibility

Compatible with [email protected].

Pull from DockerHub

docker pull cardanofoundation/cardano-wallet:2024.9.3 

Changes

API Changes on bump.sh

https://bump.sh/hal-cardano-foundation/doc/cardano-wallet-backend/changes/31688a16

The changes reported in bump.sh didn't really happen. We have fixed the yaml format to support the bump.sh parser and now the parser recognized a field which was already there

Changed

• Now compatible with [email protected]. #4763

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	✔️
David Clark @david-a-clark	Product Manager

v2024-08-11

Compatible with [email protected].

Docker Image

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 identifier drepId. This identifier can be abstain, no_confidence or a bech32-encoded DRep identifier (with prefix drep). 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 the decrypt_metadata field. More information of this feature is available in spec and CIP-83. #4555, #4667

API changes

bump.hs

Show API changes

Modified

POST /shared-wallets/{walletId}/transactions-decode

• Response
• 403 response Added

POST /wallets/{walletId}/transactions-decode

• Response
• 403 response Added

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

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

Image

Changes

Added

• The release artefacts now include configurations for multiple networks, such as mainnet, private, sanchonet, and preprod. #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 field encrypt_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 request wallet_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 the cardano-node UTxO. #4630

API changes

bump.sh

Show API changes

Modified

DELETE /byron-wallets/{walletId}/transactions/{transactionId}

• Response
• 403 response Modified
  • application/json content type Modified
    • info attribute Added
• 404 response Modified
  • application/json content type Modified
    • no_such_wallet, no_such_transaction alternatives Modified
    • wallet_not_initialized alternative Added

DELETE /stake-pools/*/wallets/{walletId}

• Response
• 403 response Modified
  • application/json content type Modified
    • wrong_encryption_passphrase alternative Modified

DELETE /wallets/{walletId}/transactions/{transactionId}

• Response
• 403 response Modified
  • application/json content type Modified
    • info attribute Added
• 404 response Modified
  • application/json content type Modified
    • no_such_wallet, no_such_transaction alternatives Modified
    • wallet_not_initialized alternative Added

GET /byron-wallets/{walletId}/transactions

• Response
• 400 response Modified
  • application/json content type Modified
    • start_time_later_than_end_time alternative 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

GET /shared-wallets/{walletId}/transactions

• Response
• 400 response Modified
  • application/json content type Modified
    • start_time_later_than_end_time alternative 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

GET /wallets/{walletId}/transactions

• Response
• 400 response Modified
  • application/json content type Modified
    • start_time_later_than_end_time alternative 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

bump.sh

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

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 subcommand from-genesis, from-checkpoint or from-tip. The previous mode of operation corresponds to from-genesis. #4488

API changes

bump.sh

Show API changes

POST /wallets

• Body
• application/json content type Modified
  • shelley alternative Modified
    • restoration_mode attribute Added

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

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

• Support the Conway era. #4410 #4424

  • Support for Sanchonet in Docker Compose configuration file. #4421

  • Support vote delegation to a decentralised representative (DRep). #4427 #4428 #4432 #4438 #4454

• Support aarch64-darwin architecture, i.e. macOS machines with M1 chips and later. #4452 #4259

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 updated cardano-wallet with an old database file, this database file will be migrated and can no longer be used with old versions of cardano-wallet. However, before migration, backup copies of your old database file will be created.

• Error messages

  • If the wallet is asked to create a transaction in a situation where there are no UTxOs available, then the wallet will return a no_utxos_available error instead of a not_enough_money error. #4366

  • Make the not_enough_money API error machine-readable. #4348

Fixed

• Fix bash instructions to start node and wallet containers in README. #4364

API changes

bump.sh

Show API changes

DELETE /stake-pools/*/wallets/{walletId}

• Response
• 403 response Modified
  • application/json content type Modified
    • no_utxos_available alternative Added

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

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

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

GET /wallets/{walletId}/stake-keys

• Response
• 200 response Modified
  • application/json content type Modified
    • ours attribute 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

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

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

POST /byron-wallets/{walletId}/payment-fees

• Response
• 403 response Modified
  • application/json content type Modified
    • not_enough_money alternativ...