Skip to content

Releases: cardano-foundation/cardano-wallet

Addresses derivation paths & multisig foundations

08 Apr 18:42
v2021-04-08
b0701a9
Compare
Choose a tag to compare

This release contains API enhancements, and several bug fixes.

Compatible with cardano-node@1.25.1.

New Features

  • API: Include derivation paths in the Address List endpoint and POST address endpoint for Byron wallet. #2598 #2605
  • API: Add bech32 encodings of key hashes to the Inspect Address endpoint. #2562 #2606

Improvements

  • API: Hash Tx metadata before signing in the Sign Metadata endpoint, in accordance with recent updates to CIP-15. #2589

  • Preparatory work for the multi-signature wallet feature. #2508 #2604

  • Use a connection pool for wallet database connections, instead of a single shared connection per wallet. #2416

  • Slightly improve the cardano-wallet CLI option help page. #2559

  • Asset metadata JSON schema updates - fully remove the "unit" field. #2546 #2557 #2572

API Changes

  • Updated: GET /addresses/{addressId}
    • Response modified: 200
      • Body attributes added: spending_key_bech32, stake_key_bech32, script_hash_bech32
  • Updated: GET /byron-wallets/{walletId}/assets
    • Response modified: 200
  • Updated: GET /byron-wallets/{walletId}/assets/{policyId}/{assetName}
    • Response modified: 200
  • Updated: GET /byron-wallets/{walletId}/assets/{policyId}
    • Response modified: 200
  • Updated: GET /byron-wallets/{walletId}/addresses
    • Response modified: 200
      • Body attribute added: derivation_path
  • Updated: POST /byron-wallets/{walletId}/addresses
    • Response modified: 201
      • Body attribute added: derivation_path
  • Updated: GET /wallets/{walletId}/assets
    • Response modified: 200
  • Updated: GET /wallets/{walletId}/assets/{policyId}/{assetName}
    • Response modified: 200
  • Updated: GET /wallets/{walletId}/assets/{policyId}
    • Response modified: 200
  • Updated: GET /wallets/{walletId}/addresses
    • Response modified: 200
      • Body attribute added: derivation_path
  • Updated: POST /wallets/{walletId}/signatures/{role}/{index}
    • Response modified: 200
      • Signature scheme modified.

Quality improvements

  • cardano-wallet now builds with GHC 8.10.4. There is no guarantee that it will continue to build with GHC 8.6.5. #2533

  • Logging improvements: Error messages are now logged to stderr instead of stdout. Some log message for a few severities were adjusted. Better logging of tx submission. #2571 #2581 #2586

  • local-cluster: Change MA Faucet to use 24-word mnemonics #2569

  • Regenerate expired TLS certs for unit tests #2593

  • Repaired failing nightly benchmarks #2566 #2568 #2576 #2582

  • Test stability improvements #2580 #2574 #2573

  • E2E test CI environment fixes #2543 #2563 #2577

Resolved Issues

  • Prevent situations where the wallet could have created invalid transactions with too many assets. #2548 #2552 #2555 #2560

  • Fix metadata incoherence when switching stake pool metadata sources. #2567

  • API: Add the Content-Type header to all structured error responses. #2597

  • API: When coin selection fails, fix the error message, which was showing an incorrect calculation of the missing amount. #2542

Known Issues

  • Wallet remains stuck at 61% on shelley-qa (ADP-848)
  • Nightly restore benchmark runs out of memory (ADP-846)
  • 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)
  • Must retry LocalTxSubmission for all pending transactions (ADP-764)
  • 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)
  • 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 cardano-node@1.25.1.

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

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

Signatures

Name Role Approval
Matthias Benkort @KtorZ Technical Architect ✔️
Rodney Lorrimar @rvl Technical Team Lead ✔️
Piotr Stachyra @piotr-iohk QA Engineer ✔️
Laurence Jenkins @LaurenceIO Release Manager ✔️

Bug fix release

05 Mar 10:14
f4d697a
Compare
Choose a tag to compare

This release delivers a number of improvements and issue fixes as listed below.

Compatible with cardano-node@1.25.1.

New Features

  • Enable withdrawals and metadata support for standalone coin-selection endpoint #2528

Improvements

  • Asset metadata JSON schema updates. #2538 #2546
  • Fix calculation of missing balance in API error. #2542 #2548

API Changes

  • Updated: GET /wallets/{walletId}/assets
    • Response modified: 200
  • Updated: GET /wallets/{walletId}/assets/{policyId}/{assetName}
    • Response modified: 200
  • Updated: GET /wallets/{walletId}/assets/{policyId}
    • Response modified: 200
  • Updated: POST /wallets/{walletId}/coin-selections/random
    • Response modified: 200
      • Body attributes added: withdrawals, metadata
  • Updated: GET /byron-wallets/{walletId}/assets
    • Response modified: 200
  • Updated: GET /byron-wallets/{walletId}/assets/{policyId}/{assetName}
    • Response modified: 200
  • Updated: GET /byron-wallets/{walletId}/assets/{policyId}
    • Response modified: 200
  • Updated: POST /byron-wallets/{walletId}/coin-selections/random
    • Response modified: 200
      • Body attributes added: withdrawals, metadata

Quality Improvements

  • Add mock-token-metadata-server --port CLI option #2525
  • Fix memory leak in unit tests #2537
  • Run github windows tests on PR push #2356 #2527

Resolved Issues

  • Split change outputs with asset quantities exceeding the maximum #2536
  • Make SMASH metadata fetching faster #2432
  • OpenAPI docs
    • Add missing "Byron Assets" heading #2524
    • Fix asset metadata unit decimals minimum value #2529
    • Fix fingerprint example wrongly using 'token' HRP #2530

Known Issues

  • 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)
  • Must retry LocalTxSubmission for all pending transactions (ADP-764)
  • Coin selection can exceed max asset count in tx output (ADP-727)
  • Fee estimation slowness (up to 4x slower when there are many wallets) (ADP-702)
  • Listing transaction time deteriorated (even up to 3x) (ADP-691)
  • Wallet restoration time deteriorated 2x in v2021-01-28 (ADP-690)
  • On mainnet txs sometimes fail with the error "Whoops, it seems like I just experienced a hard-fork in the middle of other tasks. " (ADP-617)
  • Multi-addresses transactions sometimes result in an internal server error. (ADP-571)

Documentation

📕 💻 🐳
API Documentation CLI Manual Docker Manual

Installation Instructions

  1. Install cardano-node@1.25.1.

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

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

Signatures

Name Role Approval
Matthias Benkort @KtorZ Technical Architect ✔️
Rodney Lorrimar @rvl Technical Team Lead ✔️
Piotr Stachyra @piotr-iohk QA Engineer ✔️
Laurence Jenkins @LaurenceIO Release Manager ✔️

Fee estimation & minimum coins

16 Feb 09:34
@rvl rvl
v2021-02-15
a37c985
Compare
Choose a tag to compare

This hot fix release implements a missing function required by the Daedalus wallet.

Compatible with cardano-node@1.25.1.

New Features

  • Include minimum coin values in the fee estimation API response. #2518

Improvements

  • Remove obsolete "under development" notices from OpenAPI documentation. #2514
  • Fix incorrect occurrences of the asset fingerprint field in the OpenAPI documentation. #2515

API Changes

  • Updated: GET /byron-wallets/{walletId}/assets
    • Response modified: 200
      • Body attribute modified: fingerprint
  • Updated: GET /byron-wallets/{walletId}/assets/{policyId}/{assetName}
    • Response modified: 200
      • Body attribute modified: fingerprint
  • Updated: GET /byron-wallets/{walletId}/assets/{policyId}
    • Response modified: 200
      • Body attribute modified: fingerprint
  • Updated: POST /byron-wallets/{walletId}/payment-fees
    • Response modified: 202
      • Body attribute added: minimum_coins
  • Updated: GET /wallets/{walletId}/assets
    • Response modified: 200
      • Body attribute modified: fingerprint
  • Updated: GET /wallets/{walletId}/assets/{policyId}/{assetName}
    • Response modified: 200
      • Body attribute modified: fingerprint
  • Updated: GET /wallets/{walletId}/assets/{policyId}
    • Response modified: 200
      • Body attribute modified: fingerprint
  • Updated: POST /wallets/{walletId}/payment-fees
    • Response modified: 202
      • Body attribute added: minimum_coins
  • Updated: GET /wallets/{walletId}/delegation-fees
    • Response modified: 200
      • Body attribute added: minimum_coins

Known Issues

  • Cannot send funds from Byron random addresses created via cardano-address. (#2058)

  • Reward balance briefly appears to be zero while the wallet is still syncing. (ADP-621)

  • On mainnet, transactions sometimes fail with the error: "Whoops, it seems like I just experienced a hard-fork in the middle of other tasks." (ADP-617)

  • CLI has import and create commands which are not supported for Shelley wallets. (ADP-613)

  • DB migrations occur on every start. (ADP-612)

  • A wallet's balance temporarily increases when spending rewards. (ADP-611)

  • Performance issues on large wallets with regards to transaction sending. (ADP-586)

  • Multi-address transactions sometimes result in an internal server error. (ADP-571)

  • Wrong error message in case of unsupported Accept header in /wallet/{walletId}/signatures. (ADP-551)

  • Excessive log spam (ADP-630)

  • HTTP timeout on SMASH health-check prevent pools metadata synchronization entirely (ADP-636)

  • produced_blocks sometimes stop increasing #2463

  • Transaction with TTL=0 results in 'created_invalid_transaction' intermittently (ADP-674)

  • "Something went wrong" on delegation fee request while wallet and node are syncing through Byron era (ADP-679)

  • Wallet restoration time deteriorated 2x in v2021-01-28 (ADP-690)

  • Listing transaction time deteriorated (even up to 3x) (ADP-691)

  • Faulty error message on sending transaction when there are not enough tokens/ada (ADP-697)

  • Fee estimation slowness (up to 4x slower when there are many wallets) (ADP-702)

  • Low signal-to-noise ratio for logging (ADP-708)

  • List/get asset endpoints show assets that are involved in a transaction of the wallet, but even those that are not on wallet balance (ADP-710)

Documentation

📕 💻 🐳
API Documentation CLI Manual Docker Manual

Installation Instructions

  1. Install cardano-node@1.25.1.

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

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

Signatures

Name Role Approval
Matthias Benkort @KtorZ Technical Architect ✔️
Rodney Lorrimar @rvl Technical Team Lead ✔️
Piotr Stachyra @piotr-iohk QA Engineer ✔️
Laurence Jenkins @LaurenceIO Release Manager ✔️

Native Assets Metadata

12 Feb 12:21
@rvl rvl
v2021-02-12
d98f708
Compare
Choose a tag to compare

This release fixes performance issues related to the multi-asset UTxO, adds asset fields which were missing from some API endpoints, and adds support for getting the name and description of native assets in the wallet via a metadata server. Work on supporting multi-signature transactions continues.

Compatible with cardano-node@1.25.1.

New Features

  • When listing native assets for a wallet, metadata for these assets can be retrieved from a token metadata server. #2496 #2505 #2506 #2507 #2509
  • Assets in the API have a new fingerprint field following the CIP-0014 draft. #2512
  • Allow posting multi-sig scripts to the "any address" API endpoint. #2494 #2501
  • Update to cardano-addresses 3.2.0 with multi-sig features #2401

Improvements

Resolved Issues

  • Recover from a problem some users reported where their wallet database was partially migrated to the new schema. #2503

  • Multi-asset UTxO performance improvements:

    • Rework checkpoint reading from database to avoid quadratic queries with number of assets #2502
    • Repair database benchmarks #2499
    • Make estimateFee faster for large wallets #2491
  • Multi-asset coin selection bug fixes:

    • Return fewer change outputs when the minimum ada quantity cannot be satisfied. #2490
    • Allow constructing change output from any input #2484
    • Give priority to singleton asset bundles during coin selection #2482
    • Fix delegation fee wrongly including key deposit #2479
  • API: Get and list only assets associated with the wallet #2492

Quality Improvements

  • Add mock-token-metadata-server FILE command for testing #2511
  • Fix flaky WalletSpec property #2487
  • Add era-specific integration test assertions #2483
  • Let tests and cluster run in pre-mary eras again #2493
  • Remove 0.2% restore bench to prevent nightly timeouts #2477

API Changes

  • Added: GET /byron-wallets/{walletId}/assets

  • Added: GET /byron-wallets/{walletId}/assets/{policyId}/{assetName}

  • Added: GET /byron-wallets/{walletId}/assets/{policyId}

  • Updated: GET /wallets/{walletId}/assets/{policyId}/{assetName}

    • Response modified: 200
      • Body attribute added: fingerprint
  • Updated: GET /wallets/{walletId}/assets

    • Response modified: 200
      • Body attribute added: fingerprint
  • Updated: GET /wallets/{walletId}/assets/{policyId}

    • Response modified: 200
      Body attribute added: fingerprint
  • Updated: POST /addresses

    • Body attribute added: validation

Known Issues

  • Cannot send funds from Byron random addresses created via cardano-address. (#2058)

  • Reward balance briefly appears to be zero while the wallet is still syncing. (ADP-621)

  • On mainnet, transactions sometimes fail with the error: "Whoops, it seems like I just experienced a hard-fork in the middle of other tasks." (ADP-617)

  • CLI has import and create commands which are not supported for Shelley wallets. (ADP-613)

  • DB migrations occur on every start. (ADP-612)

  • A wallet's balance temporarily increases when spending rewards. (ADP-611)

  • Performance issues on large wallets with regards to transaction sending. (ADP-586)

  • Multi-address transactions sometimes result in an internal server error. (ADP-571)

  • Wrong error message in case of unsupported Accept header in /wallet/{walletId}/signatures. (ADP-551)

  • Excessive log spam (ADP-630)

  • HTTP timeout on SMASH health-check prevent pools metadata synchronization entirely (ADP-636)

  • produced_blocks sometimes stop increasing #2463

  • Transaction with TTL=0 results in 'created_invalid_transaction' intermittently (ADP-674)

  • "Something went wrong" on delegation fee request while wallet and node are syncing through Byron era (ADP-679)

  • Wallet restoration time deteriorated 2x in v2021-01-28 (ADP-690)

  • Listing transaction time deteriorated (even up to 3x) (ADP-691)

  • Faulty error message on sending transaction when there are not enough tokens/ada (ADP-697)

  • Fee estimation slowness (up to 4x slower when there are many wallets) (ADP-702)

  • Low signal-to-noise ratio for logging (ADP-708)

  • List/get asset endpoints show assets that are involved in a transaction of the wallet, but even those that are not on wallet balance (ADP-710)

Documentation

📕 💻 🐳
API Documentation CLI Manual Docker Manual

Installation Instructions

  1. Install cardano-node@1.25.1.

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

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

Signatures

Name Role Approval
Matthias Benkort @KtorZ Technical Architect ✔️
Rodney Lorrimar @rvl Technical Team Lead ✔️
Piotr Stachyra @piotr-iohk QA Engineer ✔️
Laurence Jenkins @LaurenceIO Release Manager ✔️

Native Multi-Assets UTxO

29 Jan 12:22
v2021-01-28
e82e58a
Compare
Choose a tag to compare
Pre-release

Compatible with cardano-node@1.25.1.

New Features

  • Native multi-assets UTxO support #2431 #2448 #2450 #2447 #2469 #2451 #2461 #2462
    ℹ️ Note: sending transaction with 0 ADA now results in sending minUTxOValue amount of ADA automatically. ℹ️
  • Make hard fork era configurable in local test cluster #2438
  • Expose account public keys via API #2466
  • Expose current node_era in API network information #2468

Improvements

  • Replace hardfork_at with eras object listing all eras starting date #2468

Resolved Issues

  • Re-write LocalStateQuery client logic to eliminate acquire failures #2449
  • Coin selection sometimes fails with transaction_is_too_big or cannot_cover_fee on testnet (ADP-615)
  • hardfork_at reports incoherent times (ADP-652)

API Changes

  • Updated: GET /wallets

    • Response modified: 200
      • Body attribute added: assets
  • Updated: POST /wallets

    • Response modified: 201
      • Body attribute added: assets
  • Updated: GET /wallets/{walletId}

    • Response modified: 200
      • Body attribute added: assets
  • Updated: PUT /wallets/{walletId}

    • Response modified: 200
      • Body attribute added: assets
  • Updated: GET /wallets/{walletId}/transactions

    • Response modified: 200
      • Body attribute added: mint (:information_source: unused yet)
      • Body attribute added: outputs.assets
      • Body attribute added: inputs.assets
  • Updated: POST /wallets/{walletId}/transactions

    • Response modified: 202
      • Body attribute added: mint (:information_source: unused yet)
      • Body attribute added: outputs.assets
      • Body attribute added: inputs.assets
  • Updated: GET /wallets/{walletId}/transactions/{transactionId}

    • Response modified: 200
      • Body attribute added: mint (:information_source: unused yet)
      • Body attribute added: outputs.assets
      • Body attribute added: inputs.assets
  • Updated: POST /wallets/{walletId}/coin-selections/random

    • Response modified: 200
      • Body attribute added: outputs.assets
      • Body attribute added: inputs.assets
  • Updated: DELETE /stake-pools/*/wallets/{walletId}

    • Response modified: 202
      • Body attribute added: mint (:information_source: unused yet)
      • Body attribute added: outputs.assets
      • Body attribute added: inputs.assets
  • Updated: PUT /stake-pools/{stakePoolId}/wallets/{walletId}

    • Response modified: 202
      • Body attribute added: mint (:information_source: unused yet)
      • Body attribute added: outputs.assets
      • Body attribute added: inputs.assets
  • Updated: PUT /byron-wallets/{walletId}

    • Response modified: 200
      • Body attribute added: assets
  • Updated: GET /byron-wallets/{walletId}/transactions

    • Response modified: 200
      • Body attribute added: mint (:information_source: unused yet)
      • Body attribute added: outputs.assets
      • Body attribute added: inputs.assets
  • Updated: POST /byron-wallets/{walletId}/transactions

    • Response modified: 202
      • Body attribute added: mint (:information_source: unused yet)
      • Body attribute added: outputs.assets
      • Body attribute added: inputs.assets
  • Updated: GET /byron-wallets/{walletId}/transactions/{transactionId}

    • Response modified: 200
      • Body attribute added: mint (:information_source: unused yet)
      • Body attribute added: outputs.assets
      • Body attribute added: inputs.assets
  • Updated: POST /byron-wallets/{walletId}/coin-selections/random

    • Response modified: 200
      • Body attribute added: outputs.assets
      • Body attribute added: inputs.assets
  • Updated: GET /network/information

    • Response modified: 200
      • Body attribute added: node_era
  • Updated: GET /network/parameters

    • Response modified: 200
      • Body attribute added: eras
      • ⚠️ BREAKING-CHANGE Body attribute removed: hardfork_at ⚠️
  • Added: GET /wallets/{walletId}/assets

  • Added: GET /wallets/{walletId}/assets/{policyId}/{assetName}

  • Added: GET /wallets/{walletId}/assets/{policyId}

  • Added: POST /wallets/{walletId}/keys/{index}

⚠️ BREAKING-CHANGE Endpoints temporarily disabled ⚠️

  • POST /wallets/{walletId}/migrations
  • GET /wallets/{walletId}/migrations
  • POST /byron-wallets/{walletId}/migrations
  • GET /byron-wallets/{walletId}/migrations

Known Issues

  • Cannot send funds from Byron random addresses created via cardano-address. (#2058)
  • Reward balance briefly appears to be zero while the wallet is still syncing. (ADP-621)
  • On mainnet, transactions sometimes fail with the error: "Whoops, it seems like I just experienced a hard-fork in the middle of other tasks." (ADP-617)
  • CLI has import and create commands which are not supported for Shelley wallets. (ADP-613)
  • DB migrations occur on every start. (ADP-612)
  • A wallet's balance temporarily increases when spending rewards. (ADP-611)
  • Performance issues on large wallets with regards to transaction sending. (ADP-586)
  • Multi-address transactions sometimes result in an internal server error. (ADP-571)
  • Wrong error message in case of unsupported Accept header in /wallet/{walletId}/signatures. (ADP-551)
  • HTTP timeout on SMASH health-check prevent pools metadata synchronization entirely (ADP-636)
  • produced_blocks sometimes stop increasing #2463
  • Transaction with TTL=0 results in 'created_invalid_transaction' intermittently (ADP-674)
  • Delegation fee response's estimated_max/min includes deposit but shouldn't (ADP-678)
  • "Something went wrong" on delegation fee request while wallet and node are syncing through Byron era (ADP-679)

Documentation

📕 💻 🐳
API Documentation CLI Manual Docker Manual

Installation Instructions

  1. Install cardano-node@1.25.1.

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

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

Signatures

Name Role Approval
Matthias Benkort @KtorZ Technical Team Lead ✔️
Piotr Stachyra @piotr-iohk QA Engineer ✔️
Laurence Jenkins @LaurenceIO Release Manager ✔️

Deposit vs fee and multi-assets foundation

12 Jan 13:42
v2021-01-12
4e49b1f
Compare
Choose a tag to compare

Compatible with cardano-node@1.24.2.

New Features

  • Show deposits for fees and transactions #2327

Improvements

  • Multi-Asset UTxO: Upgrade primitive types and database schema #2384
  • Clarify 'MsgFailedToParseGenesis' with regards to which genesis file is expected. #2413
  • Warn users about Personally Identified Information (PII) in API doc #2437
  • Switch to using UnliftIO to prevent resources from not being cleaned up properly on application interruption #2389

Resolved Issues

  • Update Roadmap URL in README.md #2435
  • Fixed imported addresses being affected by rollbacks on random wallets #2425
  • Fixed change addresses disappearing from listing as soon as a transaction is no longer pending #2370
  • Fix cardano-address version info and improve version info script #2336

API Changes

  • Updated: POST /byron-wallets/{walletId}/payment-fees
    • Response modified: 202
      • Body attribute added: deposit
  • Updated: GET /byron-wallets/{walletId}/transactions
    • Response modified: 200
      • Body attributes added: fee, deposit
  • Updated: POST /byron-wallets/{walletId}/transactions
    • Response modified: 202
      • Body attributes added: fee, deposit
  • Updated: GET /byron-wallets/{walletId}/transactions/{transactionId}
    • Response modified: 200
      • Body attributes added: fee, deposit
  • Updated: POST /byron-wallets/{walletId}/coin-selections/random
    • Response modified: 200
      • Body attribute added: deposits
  • Updated: POST /byron-wallets/{walletId}/migrations
    • Response modified: 200
      • Body attributes added: fee, deposit
  • Updated: DELETE /stake-pools/\*/wallets/{walletId}
    • Response modified: 202
      • Body attributes added: fee, deposit
  • Updated: PUT /stake-pools/{stakePoolId}/wallets/{walletId}
    • Response modified: 202
      • Body attributes added: fee, deposit
  • Updated: POST /wallets/{walletId}/payment-fees
    • Response modified: 202
      • Body attribute added: deposit
  • Updated: GET /wallets/{walletId}/transactions
    • Response modified: 200
      • Body attributes added: fee, deposit
  • Updated: POST /wallets/{walletId}/transactions
    • Response modified: 202
      • Body attributes added: fee, deposit
  • Updated: GET /wallets/{walletId}/transactions/{transactionId}
    • Response modified: 200
      • Body attributes added: fee, deposit
  • Updated: GET /wallets/{walletId}/delegation-fees
    • Response modified: 200
      • Body attribute added: deposit
  • Updated: POST /wallets/{walletId}/coin-selections/random
    • Response modified: 200
      • Body attribute added: deposits
  • Updated: POST /wallets/{walletId}/migrations
    • Response modified: 200
      • Body attributes added: fee, deposit

Known Issues

  • Cannot send funds from Byron random addresses created via cardano-address. (#2058)
  • Reward balance briefly appears to be zero while the wallet is still syncing. (ADP-621)
  • On mainnet, transactions sometimes fail with the error: "Whoops, it seems like I just experienced a hard-fork in the middle of other tasks." (ADP-617)
  • Coin selection sometimes fails with transaction_is_too_big or cannot_cover_fee on testnet. (ADP-615)
  • CLI has import and create commands which are not supported for Shelley wallets. (ADP-613)
  • DB migrations occur on every start. (ADP-612)
  • A wallet's balance temporarily increases when spending rewards. (ADP-611)
  • Performance issues on large wallets with regards to transaction sending. (ADP-586)
  • Multi-address transactions sometimes result in an internal server error. (ADP-571)
  • Wrong error message in case of unsupported Accept header in /wallet/{walletId}/signatures. (ADP-551)
  • HTTP timeout on SMASH health-check prevent pools metadata synchronization entirely (ADP-636)

Documentation

Installation Instructions

  1. Install cardano-node@1.24.2.

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

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

Signatures

Name Role Approval
Matthias Benkort @KtorZ Technical Team Lead ✔️
Piotr Stachyra @piotr-iohk QA Engineer ✔️
Laurence Jenkins @LaurenceIO Release Manager ✔️

Allegra compatibility improvements and improved error reporting

05 Jan 09:21
62df413
Compare
Choose a tag to compare

Compatible with cardano-node@1.24.2.

Improvements

  • Updated docker compose file with Allegra-compatible tags. (#2398)
  • Better JSON errors when parsing stake pool metadata. (#2367)

Resolved Issues

  • Transactions cannot be listed if the filter spans multiple eras. (#2397, ADP-626)
  • Incorrect mainnet network parameters returned from API. (#2387, ADP-609)

API Changes

  • The parameters object returned by getNetworkParameters has two modifications (#2387):
    • Field added: security_parameter
    • Field removed: epoch_stability

Known Issues

  • Concurrent requests to cardano-wallet cause sqlite to return an error, and endpoints to return non-JSON error messages. (#2280)
  • Cannot send funds from Byron random addresses created via cardano-address. (#2058)
  • Reward balance briefly appears to be zero while the wallet is still syncing. (ADP-621)
  • Imported Byron addresses can be lost on rollback. (ADP-619)
  • On mainnet, transactions sometimes fail with the error: "Whoops, it seems like I just experienced a hard-fork in the middle of other tasks." (ADP-617)
  • Coin selection sometimes fails with transaction_is_too_big or cannot_cover_fee on testnet. (ADP-615)
  • CLI has import and create commands which are not supported for Shelley wallets. (ADP-613)
  • DB migrations occur on every start. (ADP-612)
  • A wallet's balance temporarily increases when spending rewards. (ADP-611)
  • Performance issues on large wallets with regards to transaction sending. (ADP-586)
  • Multi-address transactions sometimes result in an internal server error. (ADP-571)
  • Wrong error message in case of unsupported Accept header in /wallet/{walletId}/signatures. (ADP-551)
  • Race condition between delete and get results in 500:wallet_not_responding error. (ADP-538)
  • Change addresses are not listed as soon as a transaction is no longer pending. (ADP-500)

Documentation

API Documentation
CLI Manual
Docker Manual

Installation Instructions

  1. Install cardano-node@1.24.2.

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

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

Signatures

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

Allegra support and health checks

09 Dec 11:22
bcbed39
Compare
Choose a tag to compare

Compatible with cardano-node@1.24.2.

New Features

Improvements

  • Added note about named pipes on Windows in CLI help text, and fail on Windows when named pipe has incorrect form #2342

Quality improvements

  • Improved unit test performance (from 360s down to 110s) #2355
  • Reworked and cleaned up slotting functions #2352 #2351

Known Issues

  • Concurrent requests to the cardano-wallet will cause sqlite to return error and enpoints return non-json error messages #2280
  • nix-build -A cardano-wallet fails on macOS Big Sur #2070
  • Cannot send funds from Byron random address created via cardano-address #2058
  • Balance temporarily increases when spending rewards #1955
  • Required wallet DB fields do not get persistently added #1743
  • cardano-wallet address CLI has import and create commands which are not supported for Shelley wallets #1733
  • Incorrect mainnet network parameters returned from API #2226

Documentation

API Documentation
CLI Manual
Docker Manual

Installation Instructions

  1. Install cardano-node@1.24.2.

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

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

Signatures

Name Role Approval
Matthias Benkort @KtorZ Technical Team Lead ✔️
Piotr Stachyra @piotr-iohk QA Engineer ✔️
Laurence Jenkins @LaurenceIO Release Manager ✔️

Simpler, Faster, Better Fee Estimation

27 Nov 14:59
v2020-11-26
5276dfd
Compare
Choose a tag to compare

Compatible with cardano-node@1.21.1.

Improvements

  • Faster fee estimation and transaction construction ADP-567

Resolved Issues

  • Cardano-wallet generates (sometimes) unbalanced transactions ADP-567
  • Fix nightly windows tests #2339
  • Estimating fees on empty Shelley wallet takes 5-6 s #2170

Quality improvements

  • Split internal modules into more smaller modules for improve compilation time #2329 #2335.
  • Integration test: Delegating addresses API roundtrip #2330
  • Get rid of Jormungandr-specific options in the fee balancing strategies #2346

Known Issues

  • Concurrent requests to the cardano-wallet will cause sqlite to return error and enpoints return non-json error messages #2280
  • nix-build -A cardano-wallet fails on macOS Big Sur #2070
  • Cannot send funds from Byron random address created via cardano-address #2058
  • Balance temporarily increases when spending rewards #1955
  • Required wallet DB fields do not get persistently added #1743
  • cardano-wallet address CLI has import and create commands which are not supported for Shelley wallets #1733
  • Incorrect mainnet network parameters returned from API #2226

Documentation

API Documentation
CLI Manual
Docker Manual

Installation Instructions

  1. Install cardano-node@1.21.1.

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

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

Signatures

Name Role Approval
Matthias Benkort @KtorZ Technical Team Lead ✔️
Piotr Stachyra @piotr-iohk QA Engineer ✔️
Laurence Jenkins @LaurenceIO Release Manager ✔️

Path to multi-sig and multi-asset

18 Nov 09:42
v2020-11-17
7767f33
Compare
Choose a tag to compare

This release is a step towards supporting multi-signature script addresses. It contains several fixes to reduce false negatives in our test suite, so that we can work faster. The codebase is being prepared for the multi-asset Cardano era.

Compatible with cardano-node@1.21.1.

New Features

  • Add CLI option for setting transaction TTL #2267
  • Allow deleting expired transactions from the API #2262
  • Allow creating multi-signature script addresses using the POST /v2/addresses endpoint #2253 #2318
    • ⚠️ BREAKING-CHANGE GET /wallets/{walletId}/keys/{role}/{index} now returns naked public keys (without chain code).
  • Update cardano-addresses to 3.1.0 as part of the ongoing work to support multi-signature script addresses #2317

Improvements

  • cardano-wallet-jormungandr is now a separate GitHub repository, and the Jörmungandr backend has been removed from this release #2284 #2313
  • Refactor the Hash type as part of ongoing work to support multi-asset wallets #2303

Resolved Issues

  • Get correct values of epoch and slot length for /v2/network/parameters by using the HFC History Interpreter #2246
  • Revise API error codes for the transactions API #2293
  • Garbage collect delisted stake pools from SMASH #2249 #2309 #2314
    • There's now a new field called flags attach to each stake pool. It can be an empty array, or a singleton array with the string "delisted" if the pool is marked as delisted from a configured SMASH server/
  • Additional testing of runtime modification to the stake pool metadata source #2225
  • Make nix-shell evaluation faster #2300

Quality improvements

  • Use the new openapi3 package to improve OpenAPI tests #2289
  • Fix nightly DB migration tests #2302
  • Add script for analysing bors CI failures #2306
  • Run integration tests in parallel #2191 #2297
  • Fix wrong setup/expectation in TRANS_CREATE_03 #2299

Known Issues

  • Concurrent requests to the cardano-wallet will cause sqlite to return error and enpoints return non-json error messages #2280
  • Incorrect mainnet network parameters returned from API #2226
  • Estimating fees on empty Shelley wallet takes 5-6 s #2170
  • nix-build -A cardano-wallet fails on macOS Big Sur #2070
  • Cannot send funds from Byron random address created via cardano-address #2058
  • Balance temporarily increases when spending rewards #1955
  • Required wallet DB fields do not get persistently added #1743
  • cardano-wallet address CLI has import and create commands which are not supported for Shelley wallets #1733

Documentation

Installation Instructions

  1. Install cardano-node@1.21.1.

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

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

Signatures

Name Role Approval
Matthias Benkort @KtorZ Technical Team Lead ✔️
Piotr Stachyra @piotr-iohk QA Engineer ✔️
Laurence Jenkins @LaurenceIO Release Manager ✔️