v2022-05-27

Compatible with [email protected].

Changes

Added

• The constructTransaction endpoint now supports minting and burning of tokens (ADP-1191). See how to mint an NFT for more information.

• It's now possible to use a simpler metadata format in various endpoints that relate to transactions. (ADP-1596, PR-3253)

  • In the case of getTransaction and listTransaction, the wallet will use the simple metadata format if the simple-metadata query flag is set.
  • In the case of postTransaction and constructTransaction, it's possible to use the simpler metadata format without specifying a special flag.
  • See the this minting transaction guide for an example of how to use this simpler format.

• Transactions returned by the getTransaction and listTransactions API endpoints now have a collateral_outputs field. For the moment, this field is always empty, but after the Vasil hard fork we will use this field to list any collateral return outputs that are associated with transactions.
  (PR 3251, ADP-1715, ADP-1716, ADP-1717)

• It's now possible to change a Shelley wallet passphrase by specifying the wallet's mnemonic. Previously, it was only possible to do this by specifying the old passphrase. (ADP-1658, PR-3279)

Changed

• The method of calculating wallet IDs for shared wallets has changed. This affects both cardano-wallet and cardano-addresses. The wallet ID is now determined by the extended public account key, the payment script template, and the delegation script template if present.
  (ADP-1621, PR-3275).

• Restoring a wallet now has a smaller memory footprint. (ADP-1765, PR-3274)

Fixed

• Certain validity intervals that were mistakenly rejected are now accepted when calling constructTransaction. (ADP-1738, PR-3269)

• Certain API inconsistencies relating to validity and timelocks are now fixed: (PR 3249, ADP-1193)

  • It’s now forbidden to pass negative values in validity_interval.
  • It’s now required to pass invalid_before or invalid_hereafter or both.

API Changes

https://bump.sh/doc/cardano-wallet-diff/changes/215a1771-fce0-4d7d-a7b1-198272f8337c

Show API changes

• Modified: DELETE /stake-pools/*/wallets/{walletId}
  • 202 response was modified
    • collateral_outputs body attribute was added
    • mint body attribute was removed
      Breaking
    • metadata body attribute was modified
• Modified: GET /byron-wallets/{walletId}/transactions
  • 200 response was modified
    • collateral_outputs body attribute was added
    • mint body attribute was removed
      Breaking
    • metadata body attribute was modified
• Modified: GET /byron-wallets/{walletId}/transactions/{transactionId}
  • 200 response was modified
    • collateral_outputs body attribute was added
    • mint body attribute was removed
      Breaking
    • metadata body attribute was modified
• Modified: GET /wallets/{walletId}/transactions
  • simple-metadata query parameter was added
  • 200 response was modified
    • collateral_outputs body attribute was added
    • mint body attribute was removed
      Breaking
    • metadata body attribute was modified
• Modified: GET /wallets/{walletId}/transactions/{transactionId}
  • simple-metadata query parameter was added
  • 200 response was modified
    • collateral_outputs body attribute was added
    • mint body attribute was removed
      Breaking
    • metadata body attribute was modified
• Modified: POST /byron-wallets/{walletId}/migrations
  • 202 response was modified
    • collateral_outputs body attribute was added
    • mint body attribute was removed
      Breaking
    • metadata body attribute was modified
• Modified: POST /byron-wallets/{walletId}/transactions
  • 202 response was modified
    • collateral_outputs body attribute was added
    • mint body attribute was removed
      Breaking
    • metadata body attribute was modified
• Modified: POST /byron-wallets/{walletId}/transactions-construct
  • body was modified
    • metadata, validity_interval body attributes were modified
• Modified: POST /wallets/{walletId}/migrations
  • 202 response was modified
    • collateral_outputs body attribute was added
    • mint body attribute was removed
      Breaking
    • metadata body attribute was modified
• Modified: POST /wallets/{walletId}/signatures/{role}/{index}
  • body was modified
    • metadata body attribute was modified
• Modified: POST /wallets/{walletId}/transactions
  • 202 response was modified
    • collateral_outputs body attribute was added
    • mint body attribute was removed
      Breaking
    • metadata body attribute was modified
• Modified: POST /wallets/{walletId}/transactions-construct
  • body was modified
    • metadata, validity_interval body attributes were modified
• Modified: POST /wallets/{walletId}/transactions-decode
  • 202 response was modified
    • collateral_outputs, validity_interval body attributes were added
    • metadata body attribute was modified
• Modified: PUT /stake-pools/{stakePoolId}/wallets/{walletId}
  • 202 response was modified
    • collateral_outputs body attribute was added
    • mint body attribute was removed
      Breaking
    • metadata body attribute was modified
• Modified: PUT /wallets/{walletId}/passphrase
  • body was modified
    • old_passphrase, new_passphrase body attributes were modified, added mnemonic_sentence, mnemonic_second_factor.

Known Issues

• Potential regression in wallet restoration (ADP-1371)
• 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)
• Fee estimation slowness (up to 4x slower when there are many wallets, comparing with old selection algorithm) (ADP-702)
• Listing transaction time deteriorated (even up to 3x) (ADP-691)
• Wallet restoration time deteriorated 2x in v2021-01-28 (ADP-690)
• Wallet disappears after migration from v2021-09-09 to v2021-09-29 when there are pending transaction (ADP-1224)
• Error "restoreBlocks: given chain isn't a valid continuation" when quickly creating new wallets after startup (ADP-1148)
• Icarus wallets restoration is ~3x slower than random/shelley (ADP-785)
• Multi-addresses transactions sometimes result in an internal server error. (ADP-571)

Documentation

📕	💻	🐳
API Documentation	CLI Manual	Docker Manual

Installation Instructions

1. Install [email protected].

2. 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.

3. Start cardano-wallet --help and see available parameters.

Docker

Pull from DockerHub and verify the version matches 2022.5.27.

$ docker pull inputoutput/cardano-wallet:2022.5.27
$ docker run --rm inputoutput/cardano-wallet:2022.5.27 version

Signatures

Name	Role	Approval
Jonathan Knowles @jonathanknowles	Haskell Engineer	✔️
Piotr Stachyra @piotr-iohk	QA Engineer	✔️
Laurence Jenkins @LaurenceIO	Release Manager	✔️