Skip to content

Releases: cardano-foundation/cardano-wallet

Delegation to Stake Pools

13 Dec 15:33
v2019-12-09
eedb9d4
Compare
Choose a tag to compare

Overview

Compatible with Jörmungandr@v0.8.0-rc8

Artifact Platform Description
cardano-wallet-jormungandr-linux64-v2019-12-09.tar.gz
Linux 64-bit
Linux executable with auto-completion script for bash shell.
cardano-wallet-jormungandr-macos64-v2019-12-09.tar.gz
MacOs 64-bit
MacOS executable with required system libraries.
cardano-wallet-jormungandr-win64-v2019-12-09.zip
Windows 64-bit
Windows executable with required DLLs.

Main Features

cardano-wallet

command-line
  • Create and Delete wallet
  • Get details of a particular wallet
  • List all known wallets
  • Generate BIP-39 mnemonic sentence (English) of various sizes
  • Update wallet metadata
  • Create and submit transactions from a single wallet
  • List known (used or unused) addresses of a wallet
  • Estimate transaction fee
  • Visualize wallet's UTxO distribution
  • Update wallet encryption passphrase
  • List transaction history
  • Submit already signed transactions
  • Serve wallet against Jörmungandr
    • --sync-tolerance option for tweaking server tolerance regarding network syncing.
  • Launch wallet against Jörmungandr
    • --sync-tolerance option passed down to the server.
  • Get network information
  • List available stake pools, ordered by apparent performance
  • ![][new] Generate testnet reward credentials from a given mnemonic sentence
web server
  • Create and delete wallet
  • Get details of a particular wallet
  • List all known wallets
  • Update wallet metadata & wallet encryption passphrase
  • Create and submit transactions from a single wallet
  • List known (used or unused) addresses of a wallet
  • API and server logs
  • Estimate transaction fee
  • Visualize wallet's UTxO distribution
  • List transaction history
  • Submit already signed transactions
  • Get network information
  • Create Byron wallets
  • Delete Byron wallets
  • Get and List Byron wallets
  • Forget pending transaction of Shelley wallets
  • List transaction history of Byron wallets
  • Forget pending transaction of a Byron wallet
  • Migrate Byron wallets to Shelley wallets
  • List available stake pools, ordered by apparent performance
  • ![][new] Delegate all funds from a wallet to a stake pool
  • ![][new] Fetch total reward balance earned from delegation
  • ![][new] Stop delegating funds from a wallet
miscellaneous
  • Node.js-compatible IPC server with custom protocol
  • Data-persistence to disk via SQLite
  • Support for Ouroboros Genesis/Praos and proper chain following in the events of chain switches

Known Limitations

Bug Fixes

  • Byron addresses have derivation indexes that are not only hardened. #1041
  • Daedalus IPC working intermittently on windows #1036

Known Issues

  • CentOS, RHEL 6+ and SuSe Linux defect for libcrypto.so.1.0.0 #923
  • --logging-config FILE.YAML more info and tests #961

Installation Instructions

Linux 64-bit

  1. Install jormungandr@0.8.0-rc8 from the official repository.

  2. Download cardano-wallet-jormungandr@v2019-12-09.linux64.tar.gz and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin.

$ curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2019-12-09/cardano-wallet-jormungandr@v2019-12-09.linux64.tar.gz | tar xz -C $HOME/.local/bin
  1. (optional) Install the bash/zsh auto-completion script:
$ mv $HOME/.local/bin/cardano-wallet.sh > /etc/bash_completion.d/cardano-wallet.sh
$ source /etc/bash_completion.d/cardano-wallet.sh
  1. Start cardano-wallet --help and see available parameters.

Mac OS 64-bit

  1. Install jormungandr@0.8.0-rc8 from the official repository.

  2. Download cardano-wallet-jormungandr@v2019-12-09.macos64.tar.gz and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin.

Note: Make sure all *.dylib files are in the same directory as cardano-wallet binary.

Windows 64-bit

  1. Install jormungandr@0.8.0-rc8 from the official repository.

  2. Download cardano-wallet-jormungandr@v2019-12-09.win64.zip and uncompress it in a directory that is on your %PATH%.

Documentation

Link Audience
API Documentation Users of the Cardano Wallet API
Haddock Documentation Haskell Developers using the cardano-wallet as a library
CLI Manual Users of the Cardano Wallet API

Weekly Reports

Changelog

null
PR Description
#1151 update compatibility matrix in README
#1149 bump versions to v2019.12.9
#1140 release pipeline revisions
#1137 Add an extra scenario to illustrate the delegation "latency"
#1128 neat-picks on README
#1052 Review Github templates and README
(WB-18) API latency
PR Description
#1148 Adding more interesting benchmarks
#1105 Measure latencies for two fixture wallets
(WB-25) Collect stake pool metadata
PR Description
#1100 use IOHK fork for 'zip' to disable system dependency on bzlib2
#1093 Binary decoder for stake pool registrations.
#1078 Stake pool registry format updates
#1070 Additional case for too short ticker in StakePoolMetadata
#1069 Fetch stake pool metadata
#1066 Add stake pool metadata to swagger.yaml
(WB-32) Estimate cost of delegation
PR Description
#1147 fix pool id swagger schema and are extra details in description of pool endpoints
#1145 Use fee estimator instead of hard-coded fee value for stake pools joining
#1116 Estimate fees for joining a stake pool
(WB-33) Next epoch available when querying network information
PR Description
#1122 Add nextEpoch field to ApiNetworkInformation type.
#1121 Simplify property tests for epoch{Ceiling,Floor}.
#1114 Add epochCeiling function to Primitive.Types.
#1095 Add ApiEpochInfo type.
(WB-34) Deal with bootstrapping of the `apparent_performance` for stake pools
PR Description
#1112 Order pools arbitrarily in the first epoch
#1110 Seeded Random Shuffle
Read more

Incentivized Testnet Phase 1: Balance Check - Hotfix

18 Nov 22:57
Compare
Choose a tag to compare

Overview

Compatible with Jörmungandr@v0.7.0

Artifact Platform Description
cardano-wallet-jormungandr@v2019-11-18.linux64.sha256
Linux 64-bit
Checksum for the Linux executable.
cardano-wallet-jormungandr@v2019-11-18.linux64.tar.gz
Linux 64-bit
Linux executable with auto-completion script for bash shell.
cardano-wallet-jormungandr@v2019-11-18.macos64.sha256
MacOs 64-bit
Checksum for the MacOS executable.
cardano-wallet-jormungandr@v2019-11-18.macos64.tar.gz
MacOs 64-bit
MacOS executable with necessary system libraries.
cardano-wallet-jormungandr@v2019-11-18.win64.sha256
Windows 64-bit
Checksum for Windows executable.
cardano-wallet-jormungandr@v2019-11-18.win64.zip
Windows 64-bit
Windows executable with necessary DLLs.

Main Features

cardano-wallet

  • A command-line interface which exposes the following features (see CLI manual):

    • Create and Delete wallet
    • Get details of a particular wallet
    • List all known wallets
    • Generate BIP-39 mnemonic sentence (English) of various sizes
    • Update wallet metadata
    • Create and submit transactions from a single wallet
    • List known (used or unused) addresses of a wallet
    • Estimate transaction fee
    • Visualize wallet's UTxO distribution
    • Update wallet encryption passphrase
    • List transaction history
    • Submit already signed transactions
    • Serve wallet against Jörmungandr
      • --sync-tolerance option for tweaking server tolerance regarding network syncing.
    • Launch wallet against Jörmungandr
      • --sync-tolerance option passed down to the server.
    • Get network information
    • List available stake pools, ordered by apparent performance
  • A web server which exposes the following features (see API Documentation below):

    • Create and delete wallet
    • Get details of a particular wallet
    • List all known wallets
    • Update wallet metadata & wallet encryption passphrase
    • Create and submit transactions from a single wallet
    • List known (used or unused) addresses of a wallet
    • API and server logs
    • Estimate transaction fee
    • Visualize wallet's UTxO distribution
    • List transaction history
    • Submit already signed transactions
    • Get network information
    • Create Byron wallets
    • Delete Byron wallets
    • Get and List Byron wallets
    • Forget pending transaction of Shelley wallets
    • List transaction history of Byron wallets
    • Forget pending transaction of a Byron wallet
    • Migrate Byron wallets to Shelley wallets
    • List available stake pools, ordered by apparent performance
  • Node.js-compatible IPC server with custom protocol

  • Data-persistence to disk via SQLite

  • Support for Ouroboros Genesis/Praos and proper chain following in the events of chain switches

Known Limitations

Bug Fixes

  • Byron addresses have derivation indexes that are not only hardened. #1041
  • Daedalus IPC working intermittently on windows #1036

Known Issues

  • CentOS, RHEL 6+ and SuSe Linux defect for libcrypto.so.1.0.0 #923
  • --logging-config FILE.YAML more info and tests #961

Installation Instructions

Linux 64-bit

  1. Install jormungandr@0.7.0 from the official repository.

  2. Download cardano-wallet-jormungandr@v2019-11-18.linux64.tar.gz and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin.

$ curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2019-11-18/cardano-wallet-jormungandr@v2019-11-18.linux64.tar.gz | tar xz -C $HOME/.local/bin
  1. (optional) Install the bash/zsh auto-completion script:
$ mv $HOME/.local/bin/cardano-wallet.sh > /etc/bash_completion.d/cardano-wallet.sh
$ source /etc/bash_completion.d/cardano-wallet.sh
  1. Start cardano-wallet --help and see available parameters.

Mac OS 64-bit

  1. Install jormungandr@0.7.0 from the official repository.

  2. Download cardano-wallet-jormungandr@v2019-11-18.macos64.tar.gz and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin.

Note: Make sure all *.dylib files are in the same directory as cardano-wallet binary.

Windows 64-bit

  1. Install jormungandr@0.7.0 from the official repository.

  2. Download cardano-wallet-jormungandr@v2019-11-18.win64.zip and uncompress it in a directory that is on your %PATH%.

Documentation

Link Audience
API Documentation Users of the Cardano Wallet API
Haddock Documentation Haskell Developers using the cardano-wallet as a library
CLI Manual Users of the Cardano Wallet API

Weekly Reports

Changelog

Bug fixes
PR Description
#1044 Fix DaedalusIPC startup issue on Windows
#1042 use a special 'WholeDomain' index with range going from 0 to 2^32
Usability & Compatibility
PR Description
#1045 Bump version to 2019.11.18

Signatures

Name Role Approval
Matthias Benkort @KtorZ Technical Team Lead
Piotr Stachyra @piotr-iohk QA Engineer ✔️
Tatyana Valkevych @tatyanavych Release Manager

Incentivized Testnet Phase 1: Balance Check

18 Nov 14:11
v2019-11-14
b792178
Compare
Choose a tag to compare

Overview

Compatible with Jörmungandr@v0.7.0

Artifact Platform Description
cardano-wallet-jormungandr@v2019-11-14.linux64.sha256
Linux 64-bit
Checksum for the Linux executable.
cardano-wallet-jormungandr@v2019-11-14.linux64.tar.gz
Linux 64-bit
Linux executable with auto-completion script for bash shell.
cardano-wallet-jormungandr@v2019-11-14.macos64.sha256
MacOs 64-bit
Checksum for the MacOS executable.
cardano-wallet-jormungandr@v2019-11-14.macos64.tar.gz
MacOs 64-bit
MacOS executable with necessary system libraries.
cardano-wallet-jormungandr@v2019-11-14.win64.sha256
Windows 64-bit
Checksum for Windows executable.
cardano-wallet-jormungandr@v2019-11-14.win64.zip
Windows 64-bit
Windows executable with necessary DLLs.

Main Features

cardano-wallet

  • A command-line interface which exposes the following features (see CLI manual):

    • Create and Delete wallet
    • Get details of a particular wallet
    • List all known wallets
    • Generate BIP-39 mnemonic sentence (English) of various sizes
    • Update wallet metadata
    • Create and submit transactions from a single wallet
    • List known (used or unused) addresses of a wallet
    • Estimate transaction fee
    • Visualize wallet's UTxO distribution
    • Update wallet encryption passphrase
    • List transaction history
    • Submit already signed transactions
    • Serve wallet against Jörmungandr
      • ![][new] --sync-tolerance option for tweaking server tolerance regarding network syncing.
    • Launch wallet against Jörmungandr
      • ![][new] --sync-tolerance option passed down to the server.
    • Get network information
    • List available stake pools, ordered by apparent performance
  • A web server which exposes the following features (see API Documentation below):

    • Create and delete wallet
    • Get details of a particular wallet
    • List all known wallets
    • Update wallet metadata & wallet encryption passphrase
    • Create and submit transactions from a single wallet
    • List known (used or unused) addresses of a wallet
    • API and server logs
    • Estimate transaction fee
    • Visualize wallet's UTxO distribution
    • List transaction history
    • Submit already signed transactions
    • Get network information
    • Create Byron wallets
    • Delete Byron wallets
    • Get and List Byron wallets
    • Forget pending transaction of Shelley wallets
    • List transaction history of Byron wallets
    • Forget pending transaction of a Byron wallet
    • Migrate Byron wallets to Shelley wallets
    • List available stake pools, ordered by apparent performance
  • Node.js-compatible IPC server with custom protocol

  • Data-persistence to disk via SQLite

  • Support for Ouroboros Genesis/Praos and proper chain following in the events of chain switches

Known Limitations

Bug Fixes

  • Calculating migration cost of the wallet that cannot be migrated should return 403 #1007
  • Incorrect transaction amount reported on pending transactions #1004
  • Chain follower does not backoff on errors #1027
  • Word16 Overflow in Jörmungandr binary (SlotId) #1025
  • Race condition in DaedalusIPC: not receiving 'Started' msg #1036

Known Issues

  • CentOS, RHEL 6+ and SuSe Linux defect for libcrypto.so.1.0.0 #923
  • --logging-config FILE.YAML more info and tests #961

Installation Instructions

Linux 64-bit

  1. Install jormungandr@0.7.0 from the official repository.

  2. Download cardano-wallet-jormungandr@v2019-11-14.linux64.tar.gz and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin.

$ curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2019-11-14/cardano-wallet-jormungandr@v2019-11-14.linux64.tar.gz | tar xz -C $HOME/.local/bin
  1. (optional) Install the bash/zsh auto-completion script:
$ mv $HOME/.local/bin/cardano-wallet.sh > /etc/bash_completion.d/cardano-wallet.sh
$ source /etc/bash_completion.d/cardano-wallet.sh
  1. Start cardano-wallet --help and see available parameters.

Mac OS 64-bit

  1. Install jormungandr@0.7.0 from the official repository.

  2. Download cardano-wallet-jormungandr@v2019-11-14.macos64.tar.gz and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin.

Note: Make sure all *.dylib files are in the same directory as cardano-wallet binary.

Windows 64-bit

  1. Install jormungandr@0.7.0 from the official repository.

  2. Download cardano-wallet-jormungandr@v2019-11-14.win64.zip and uncompress it in a directory that is on your %PATH%.

Documentation

Link Audience
API Documentation Users of the Cardano Wallet API
Haddock Documentation Haskell Developers using the cardano-wallet as a library
CLI Manual Users of the Cardano Wallet API

Weekly Reports

Changelog

Miscellanous
PR Description
#1038 reduce network exponential backoff maximum cap to 10s
#1037 Fix DaedalusIPC race-condition when sending 'Started' too quickly
#1035 Fix underflow in performance calculation
#1034 bump version to 2019-11-14
#1033 remove race condition from TRANS_DELETE_01
#1031 Test that follow doesn't retry too often
#1030 Make sure application exits when Daedalus IPC channel closes
#1029 Additional fixes for integration tests on Windows
#1028 Fix the initial sleep delay in the chain following
#1023 add roundtrip tests for mkPaymentKeyFingerprint ~ liftPaymentFingerprint
#1020 revise db bench setup to demand lazy pattern-match on environment
#1017 Update stylish-haskell to latest (v0.9.4.4)
#1016 Unit tests passing on both Windows and Wine
#1015 nix: Make a separate testing bundle for windows
#1014 Versions bump to v2019.11.12
#1011 Can run Windows integration tests under Wine
#1010 Refactor test for 1004 regression
#1006 Fix apparent performance calculation
#1005 Fix pending meta amount calculation when some outputs are ours
#1003 Attempt to fix intermittent startup issues with Jörmungandr
#1002 Review option parsing order in Jörmungandr executable
#1000 Consistent Address prefix with other services (Jörmungandr, Explorer)
#991 --sync-tolerance to control the tolerance in the sync progress calculation
#987 Produce appropriate error on failure to parse JSON within API call payload.
#985 Produce more appropriate error message on failing to decode a Shelley address.
Byron Wallet Support

PR | Descr...

Read more

Cardano Wallet Backend - Jörmungandr@0.7.0-rc7

08 Nov 17:03
v2019-11-07
b84678e
Compare
Choose a tag to compare

Overview

Program Platform Description
cardano-wallet-jormungandr.tar.gz
linux-x86_64
A CLI tool to start and interact with a wallet server using Jörmungandr as a chain producer. See Main Features below.
cardano-wallet-jormungandr.sha256
N/A
Checksum for the executable in cardano-wallet-jormungandr.tar.gz
cardano-wallet.sh
linux-x86_64
Auto-completion script for cardano-wallet (works for all flavours)

Main Features

cardano-wallet

  • A command-line interface which exposes the following features (see CLI manual):

    • Create and Delete wallet
    • Get details of a particular wallet
    • List all known wallets
    • Generate BIP-39 mnemonic sentence (English) of various sizes
    • Update wallet metadata
    • Create and submit transactions from a single wallet
    • List known (used or unused) addresses of a wallet
    • Estimate transaction fee
    • Visualize wallet's UTxO distribution
    • Update wallet encryption passphrase
    • List transaction history
    • Submit already signed transactions
    • Serve wallet against Jörmungandr
    • Launch wallet against Jörmungandr
    • Get network information
    • List available stake pools, ordered by apparent performance
  • A web server which exposes the following features (see API Documentation below):

    • Create and delete wallet
    • Get details of a particular wallet
    • List all known wallets
    • Update wallet metadata & wallet encryption passphrase
    • Create and submit transactions from a single wallet
    • List known (used or unused) addresses of a wallet
    • API and server logs
    • Estimate transaction fee
    • Visualize wallet's UTxO distribution
    • List transaction history
    • Submit already signed transactions
    • Get network information
    • Create Byron wallets
    • Delete Byron wallets
    • Get and List Byron wallets
    • Forget pending transaction of Shelley wallets
    • List transaction history of Byron wallets
    • Forget pending transaction of a Byron wallet
    • Migrate Byron wallets to Shelley wallets
    • List available stake pools, ordered by apparent performance
  • Node.js-compatible IPC server with custom protocol

  • Data-persistence to disk via SQLite

  • Support for Ouroboros Genesis/Praos and proper chain following in the events of chain switches

Known Limitations

Bug Fixes

  • "Invalid Address first byte": error message could be more user-friendly #953

Known Issues

  • CentOS, RHEL 6+ and SuSe Linux defect for libcrypto.so.1.0.0 #923
  • --logging-config FILE.YAML more info and tests #961

Installation Instructions

Please note that currently only Unix\Linux platform is supported.

with Jörmungandr@0.7.0-rc7

  1. Install jormungandr@0.7.0-rc7 from the source.

  2. Download cardano-wallet-jormungandr.tar.gz and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin.

$ curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2019-11-07/cardano-wallet-jormungandr.tar.gz | tar xz -C $HOME/.local/bin
  1. (optional) Download and install bash/zsh auto-completion script:
$ curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2019-11-07/cardano-wallet.sh > /etc/bash_completion.d/cardano-wallet.sh
$ source /etc/bash_completion.d/cardano-wallet.sh
  1. Start cardano-wallet --help and see available parameters.

Documentation

Link Audience
API Documentation Users of the Cardano Wallet API
Haddock Documentation Haskell Developers using the cardano-wallet as a library
CLI Manual Users of the Cardano Wallet API

Weekly Reports

Changelog

Forget Pending Transaction
PR Description
#978 Turn on disabled 'forget tx' integration tests for Byron
List Stake Pool
PR Description
#962 Stake pools join quit stub tests
Usability & Compatibility
PR Description
#988 Jormungandr 0.7.0-rc7
#983 Jörmungandr v0.7.0-rc4 → v0.7.0-rc5
#982 bump versions to 2019.11.7
#981 Make API Golden tests filenames compatible with Windows
#972 Move the Test.Hspec.Extra module to cardano-wallet-test-utils
#971 tests: Fix ServerSpec and SqliteSpec on windows
#965 Use whileM (not <$> isEmpty) for better binary error messages
Miscellaneous
PR Description
#987 Produce appropriate error on failure to parse JSON within API call payload.
#985 Produce more appropriate error message on failing to decode a Shelley address.
#977 Manual test for syncProgress
#973 Make large numbers more readable.

Signatures

Name Role Approval
Matthias Benkort @KtorZ Technical Team Lead ✔️
Piotr Stachyra @piotr-iohk QA Engineer ✔️
Tatyana Valkevych @tatyanavych Release Manager ✔️

Cardano Wallet Backend - Byron Wallets & Stake Pools

06 Nov 15:11
v2019-11-06
1988f22
Compare
Choose a tag to compare

Overview

Program Platform Description
cardano-wallet-jormungandr.tar.gz
linux-x86_64
A CLI tool to start and interact with a wallet server using Jörmungandr as a chain producer. See Main Features below.
cardano-wallet-jormungandr.sha256
N/A
Checksum for the executable in cardano-wallet-jormungandr.tar.gz
cardano-wallet.sh
linux-x86_64
Auto-completion script for cardano-wallet (works for all flavours)

Main Features

cardano-wallet

  • A command-line interface which exposes the following features (see CLI manual):

    • Create and Delete wallet
    • Get details of a particular wallet
    • List all known wallets
    • Generate BIP-39 mnemonic sentence (English) of various sizes
    • Update wallet metadata
    • Create and submit transactions from a single wallet
    • List known (used or unused) addresses of a wallet
    • Estimate transaction fee
    • Visualize wallet's UTxO distribution
    • Update wallet encryption passphrase
    • List transaction history
    • Submit already signed transactions
    • Serve wallet against Jörmungandr
    • Launch wallet against Jörmungandr
    • Get network information
    • ![][new] List available stake pools, ordered by apparent performance
  • A web server which exposes the following features (see API Documentation below):

    • Create and delete wallet
    • Get details of a particular wallet
    • List all known wallets
    • Update wallet metadata & wallet encryption passphrase
    • Create and submit transactions from a single wallet
    • List known (used or unused) addresses of a wallet
    • API and server logs
    • Estimate transaction fee
    • Visualize wallet's UTxO distribution
    • List transaction history
    • Submit already signed transactions
    • Get network information
    • Create Byron wallets
    • Delete Byron wallets
    • Get and List Byron wallets
    • ![][new] Forget pending transaction of Shelley wallets
    • ![][new] List transaction history of Byron wallets
    • ![][new] Forget pending transaction of a Byron wallet
    • ![][new] Migrate Byron wallets to Shelley wallets
    • ![][new] List available stake pools, ordered by apparent performance
  • Node.js-compatible IPC server with custom protocol

  • Data-persistence to disk via SQLite

  • Support for Ouroboros Genesis/Praos and proper chain following in the events of chain switches

Known Limitations

Bug Fixes

  • Improper shutdown of iohk-monitoring switchboard #851
  • Error reported in the log after deleting a wallet #807
  • Providing -- --config node_config.yaml on launch makes wallet exit ugly #848
  • Pending txs when listed on the wallet have inserted_at field instead of pending_since #935
  • Test failures -> Cardano.Wallet.Primitive.Types.Ranges #917

Known Issues

  • "Invalid Address first byte": error message could be more user-friendly #953
  • CentOS, RHEL 6+ and SuSe Linux defect for libcrypto.so.1.0.0 #923
  • --logging-config FILE.YAML more info and tests #961

Installation Instructions

Please note that currently only Unix\Linux platform is supported.

with Jörmungandr@eb0b7bb1

  1. Install jormungandr@eb0b7bb1 from the source.

⚠️ This pre-release requires a very specific revision (eb0b7bb14af8e573a44bf38b0a683ba2d4579c7d) which is ahead of and incompatible with 0.7.0-rc4 ⚠️

  1. Download cardano-wallet-jormungandr.tar.gz and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin.
$ curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2019-11-06/cardano-wallet-jormungandr.tar.gz | tar xz -C $HOME/.local/bin
  1. (optional) Download and install bash/zsh auto-completion script:
$ curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2019-11-06/cardano-wallet.sh > /etc/bash_completion.d/cardano-wallet.sh
$ source /etc/bash_completion.d/cardano-wallet.sh
  1. Start cardano-wallet --help and see available parameters.

Documentation

Link Audience
API Documentation Users of the Cardano Wallet API
Haddock Documentation Haskell Developers using the cardano-wallet as a library
CLI Manual Users of the Cardano Wallet API

Weekly Reports

Changelog

Byron Wallet Support
PR   | Description
--   | --
#966 | More tests for byron wallets migration, in particular migrating from big wallets
#960 | Test that `migrateByronWallet` appropriately deposits funds into a target wallet.
#952 | review golden tests for legacy transaction and generate witnesses using jcli
#950 | Test that `migrateByronWallet` migrates funds correctly.
#916 | Byron migration integration tests
#915 | Remove length invariant from `Cardano.Wallet.Jormungandr.Binary.putAddress`.
#911 | Fix Arithmetic Underflow in Migration Coin Selection
#890 | Add `deleteByronTransaction` endpoint.
#884 | More integration tests for Byron wallets
#882 | Add handlers for Byron migration
#878 | Support for legacy UTxO witness in Jörmungandr
#873 | Byron wallet transaction list integration tests
#871 | Special coin selection function for handling migration of legacy wallets
#849 | Enable faucet random wallets
#844 | Add and 'implement' "listByronTransactions" to the API
Create Delegation Certificate
PR   | Description
--   | --
#954 | Make `core.Tx` a concrete type and remove `DefineTx` and `PersistTx`
#946 | extend FeePolicy definition
#932 | Extend binary format for stake delegation tx
#920 | Api types for delegation endpoints
#907 | Fix `FromText` instance for `Double` (and `FeePolicy`).
#889 | Correct `ToText` and `FromText` instances for `FeePolicy`.
#634 | Remove cardano-wallet-http-bridge
Forget Pending Transaction
PR   | Description
--   | --
#939 | few more forget tx tests for CLI
#930 | Forget pending tx endpoint spec update
#912 | more '...
Read more

Cardano Wallet Backend - Rollbacks

17 Oct 07:26
v2019-10-16
5209c1a
Compare
Choose a tag to compare
Pre-release

Overview

Program Platform Description
cardano-wallet-jormungandr.tar.gz
linux-x86_64
A CLI tool to start and interact with a wallet server using Jörmungandr as a chain producer. See Main Features below.
cardano-wallet-jormungandr.sha256
N/A
Checksum for the executable in cardano-wallet-jormungandr.tar.gz
cardano-wallet-http-bridge.tar.gz
linux-x86_64
A CLI tool to start and interact with a wallet server using cardano-http-bridge as a chain producer. See Main Features below.
cardano-wallet-http-bridge.sha256
N/A
Checksum for the executable in cardano-wallet-http-bridge.tar.gz
cardano-wallet.sh
linux-x86_64
Auto-completion script for cardano-wallet (works for all flavours)

Main Features

cardano-wallet

  • A command-line interface which exposes the following features (see CLI manual):

    • Create and Delete wallet
    • Get details of a particular wallet
    • List all known wallets
    • Generate BIP-39 mnemonic sentence (English) of various sizes
    • Update wallet metadata
    • Create and submit transactions from a single wallet
    • List known (used or unused) addresses of a wallet
    • Estimate transaction fee
    • Visualize wallet's UTxO distribution
    • Update wallet encryption passphrase
    • List transaction history
    • Submit already signed transactions
    • Serve wallet against cardano-http-bridge
    • Launch wallet against cardano-http-bridge
    • Serve wallet against Jörmungandr
    • Launch wallet against Jörmungandr
      • ![][new] Allow passing extra options down to Jörmungandr
    • ![][new] Get network information
  • A web server which exposes the following features (see API Documentation below):

    • Create and delete wallet
    • Get details of a particular wallet
      • ![][new] A tip field is now included in the response
    • List all known wallets
    • Update wallet metadata & wallet encryption passphrase
    • Create and submit transactions from a single wallet
    • List known (used or unused) addresses of a wallet
    • API and server logs
    • Estimate transaction fee
    • Visualize wallet's UTxO distribution
    • List transaction history
      • ![][new] A block height is now included in the timestamp
      • ![][new] depth is now given in blocks instead of slots
      • ![][new] Pending transactions now have an extra field pending_since
    • Submit already signed transactions
    • ![][new] Get network information
    • ![][new] Create Byron wallets
    • ![][new] Delete Byron wallets
    • ![][new] Get and List Byron wallets
  • Node.js-compatible IPC server with custom protocol

  • Data-persistence to disk via SQLite

  • ![][new] Support for Ouroboros Genesis/Praos and proper chain following in the events of chain switches.

Known Limitations

  • ⚠️ Only Jörmungandr Genesis/Praos node is supported.
  • ⚠️ Submitting already signed transactions works only on Jörmungandr backend

Bug Fixes

Known Issues

  • Improper shutdown of iohk-monitoring switchboard #851
  • Error reported in the log after deleting a wallet #807
  • Providing -- --config node_config.yaml on launch makes wallet exit ugly #848

Installation Instructions

Please note that currently only Unix\Linux platform is supported.

with Jörmungandr@v0.6.1

  1. Install jormungandr@v0.6.1 from the official repository.

  2. Download cardano-wallet-jormungandr.tar.gz and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin.

$ curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2019-10-16/cardano-wallet-jormungandr.tar.gz | tar xz -C $HOME/.local/bin
  1. (optional) Download and install bash/zsh auto-completion script:
$ curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2019-10-16/cardano-wallet.sh > /etc/bash_completion.d/cardano-wallet.sh
$ source /etc/bash_completion.d/cardano-wallet.sh
  1. Start cardano-wallet --help and see available parameters.

with cardano-http-bridge

  1. Install cardano-http-bridge from our fork.

    • Install the rust toolchain.
    • In terminal run cargo install --git https://github.com/KtorZ/cardano-http-bridge.git --branch cardano-wallet-integration
    • make sure $HOME/.cargo/bin is on your $PATH
  2. Download cardano-wallet-http-bridge.tar.gz and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin.

$ curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2019-10-16/cardano-wallet-http-bridge.tar.gz | tar xz -C $HOME/.local/bin
  1. (optional) Download and install bash/zsh auto-completion script:
$ curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2019-10-16/cardano-wallet.sh > /etc/bash_completion.d/cardano-wallet.sh
$ source /etc/bash_completion.d/cardano-wallet.sh
  1. Start cardano-wallet --help and see available parameters.

Documentation

Link Audience
API Documentation Users of the Cardano Wallet API
Haddock Documentation Haskell Developers using the cardano-wallet as a library
CLI Manual Users of the Cardano Wallet API

Weekly Reports

Changelog

Miscellaneous
PR Description
#847 bump versions to v2019.10.16
Byron Wallet Support
PR Description
#846 More integration tests for byron restore, get, list, delete
#841 Group tags by era (Shelley vs Byron) in swagger documentation
#839 Network Information endpoint adjustments
#837 Change the return type of migrateByronWallet to be a list of transactions.
#834 DaedalusIPC: Fix isWindows function
#829 add test Wallet has the same tip as network/information
#827 Add syncProgressRelativeToCurrentTime helper
#825 Add block heights in various plac...
Read more

Cardano Wallet Backend - Upgrades

13 Sep 10:41
v2019-09-13
83a66da
Compare
Choose a tag to compare
Pre-release

Overview

This release upgrades the Jörmungandr integration to work with Jörmungandr@v0.3.3. It also offers a more complete HTTP API with new capabilities like accessing wallets' transaction history. Many changes introduced in the Haskell core library to prepare the support of legacy wallets aren't visible to the end-user but are available for Haskell developers.

Program Platform Description
cardano-wallet-jormungandr.tar.gz
linux-x86_64
A CLI tool to start and interact with a wallet server using Jörmungandr as a chain producer. See Main Features below.
cardano-wallet-jormungandr.sha256
N/A
Checksum for the executable in cardano-wallet-jormungandr.tar.gz
cardano-wallet-http-bridge.tar.gz
linux-x86_64
A CLI tool to start and interact with a wallet server using cardano-http-bridge as a chain producer. See Main Features below.
cardano-wallet-http-bridge.sha256
N/A
Checksum for the executable in cardano-wallet-http-bridge.tar.gz
cardano-wallet.sh
linux-x86_64
Auto-completion script for cardano-wallet (works for all flavours)

Main Features

cardano-wallet

  • A command-line interface which exposes the following features (see CLI manual):

    • Create and Delete wallet
    • Get details of a particular wallet
    • List all known wallets
    • Generate BIP-39 mnemonic sentence (English) of various sizes
    • Update wallet metadata
    • Create and submit transactions from a single wallet
    • List known (used or unused) addresses of a wallet
    • Estimate transaction fee
    • Visualize wallet's UTxO distribution
    • Update wallet encryption passphrase
    • ![][new] List transaction history
    • ![][new] Submit already signed transactions
    • Serve wallet against cardano-http-bridge
    • Launch wallet against cardano-http-bridge
    • Serve wallet against Jörmungandr
    • Launch wallet against Jörmungandr
  • A web server which exposes the following features (see API Documentation below):

    • Create and delete wallet
    • Get details of a particular wallet
    • List all known wallets
    • Update wallet metadata & wallet encryption passphrase
    • Create and submit transactions from a single wallet
    • List known (used or unused) addresses of a wallet
    • API and server logs
    • Estimate transaction fee
    • Visualize wallet's UTxO distribution
    • ![][new] List transaction history
    • ![][new] Submit already signed transactions
  • Node.js-compatible IPC server with custom protocol

  • Data-persistence to disk via SQLite

Known Limitations

  • ⚠️ Only one address derivation scheme is supported: sequential scheme (a.k.a. Icarus' address style or, addresses à la BIP-44).
  • ⚠️ Only Jörmungandr BFT node is currently supported
  • ⚠️ Submitting already signed transactions works only on Jörmungandr backend

Bug Fixes

Known Issues

Installation Instructions

Please note that currently only Unix\Linux platform is supported.

with Jörmungandr@v0.3.3

  1. Install jormungandr@v0.3.3 from the official repository.

  2. Download cardano-wallet-jormungandr.tar.gz and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin.

$ curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2019-09-13/cardano-wallet-jormungandr.tar.gz | tar xz -C $HOME/.local/bin
  1. (optional) Download and install bash/zsh auto-completion script:
$ curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2019-09-13/cardano-wallet.sh > /etc/bash_completion.d
$ source /etc/bash_completion.d/cardano-wallet.sh
  1. Start cardano-wallet --help and see available parameters.

with cardano-http-bridge

  1. Install cardano-http-bridge from our fork.

    • Install the rust toolchain.
    • In terminal run cargo install --git https://github.com/KtorZ/cardano-http-bridge.git --branch cardano-wallet-integration
    • make sure $HOME/.cargo/bin is on your $PATH
  2. Download cardano-wallet-http-bridge.tar.gz and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin.

$ curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2019-09-13/cardano-wallet-http-bridge.tar.gz | tar xz -C $HOME/.local/bin
  1. (optional) Download and install bash/zsh auto-completion script:
$ curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2019-09-13/cardano-wallet.sh > /etc/bash_completion.d
$ source /etc/bash_completion.d/cardano-wallet.sh
  1. Start cardano-wallet --help and see available parameters.

Documentation

Link Audience
API Documentation Users of the Cardano Wallet API
Haddock Documentation Haskell Developers using the cardano-wallet as a library
CLI Manual Users of the Cardano Wallet API

Weekly Reports

Changelog

List Stake Pools
PR Description
#701 Correct proof-length of praos/genesis blocks
Support Rollbacks
PR Description
#660 Cardano.Wallet.DB.Model
#662 Track block height in Wallet checkpoints,
#667 Improve documentation for function invariant.,
#668 Make applyBlocks return a list of incrementally-updated wallet states.,
#669 Make restoreBlocks safer by requiring non-empty list of blocks.,
#670 ModelSpec: add applyBlocks blockHeight property,
#672 SQLite: Prepare schema for rollback,
#673 Always call applyBlock, even if block is empty,
#674 Create a checkpoint for every block applied within restoreBlocks.,
#684 Only create checkpoints for unstable blocks,
Signed Transaction Submission

PR | Descri...

Read more

Cardano Wallet Backend - Jörmungandr

25 Jul 08:20
v2019-07-24
b9a860f
Compare
Choose a tag to compare
Pre-release

Overview

This release introduces a new target chain producer for the wallet backend: Jörmungandr@v0.2.3. The software therefore comes in two different flavours though users are expected to pick only one and stick to it for the underlying networks behind cardano-http-bridge and Jörmungandr aren't compatible. The support for cardano-http-bridge is indeed provisional and will soon become legacy. New users should favor cardano-wallet-jormungandr for a better experience.

Program Platform Description
cardano-wallet-jormungandr.tar.gz
linux-x86_64
A CLI tool to start and interact with a wallet server using Jörmungandr as a chain producer. See Main Features below.
cardano-wallet-jormungandr.sha256
N/A
Checksum for the executable in cardano-wallet-jormungandr.tar.gz
cardano-wallet-http-bridge.tar.gz
linux-x86_64
A CLI tool to start and interact with a wallet server using cardano-http-bridge as a chain producer. See Main Features below.
cardano-wallet-http-bridge.sha256
N/A
Checksum for the executable in cardano-wallet-http-bridge.tar.gz
cardano-wallet.sh
linux-x86_64
Auto-completion script for cardano-wallet (works for all flavours)

Main Features

cardano-wallet

  • A command-line interface which exposes the following features (see CLI manual below):

    • Create and Delete wallet
    • Get details of a particular wallet
    • List all known wallets
    • Generate BIP-39 mnemonic sentence (english) of various sizes
    • Update wallet metadata
    • Create and submit transactions from a single wallet
    • List known (used or unused) addresses of a wallet
    • Serve wallet against cardano-http-bridge
    • Launch wallet against cardano-http-bridge
    • ![][new] Serve wallet against Jörmungandr
    • ![][new] Launch wallet against Jörmungandr
    • ![][new] Estimate transaction fee
    • ![][new] Visualize wallet's UTxO distribution
    • ![][new] Update wallet encryption passphrase
  • A web server which exposes the following features (see API Documentation below):

    • Create and delete wallet
    • Get details of a particular wallet
    • List all known wallets
    • Update wallet metadata & wallet encryption passphrase
    • Create and submit transactions from a single wallet
    • List known (used or unused) addresses of a wallet
    • API and server logs
    • ![][new] Estimate transaction fee
    • ![][new] Visualize wallet's UTxO distribution
  • Node.js-compatible IPC server with custom protocol

  • Data-persistence to disk via SQLite

Known Limitations

  • ⚠️ Only one address derivation scheme is supported: sequential scheme (a.k.a. Icarus' address style or, addresses à la BIP-44).
  • ⚠️ Only Jörmungandr BFT node is currently supported

Bug Fixes

Ticket Title
#409 cardano-wallet server fails with unpleasant error when does not connect to http-bridge within a few seconds
#423 Starting mainnet server on testnet bridge results in unfriendly error message.
#551 Unstable order when reading transaction history

Known Issues

Installation Instructions

Please note that currently only Unix\Linux platform is supported.

with Jörmungandr@v0.2.3

  1. Install jormungandr@v0.2.3 from the official repository.

  2. Download cardano-wallet-jormungandr.tar.gz and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin.

$ curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2019-07-24/cardano-wallet-jormungandr.tar.gz | tar xz -C $HOME/.local/bin
  1. (optional) Download and install bash/zsh auto-completion script:
$ curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2019-07-24/cardano-wallet.sh > /etc/bash_completion.d
$ source /etc/bash_completion.d/cardano-wallet.sh
  1. Start cardano-wallet --help and see available parameters.

with cardano-http-bridge

  1. Install cardano-http-bridge from our fork.

    • Install the rust toolchain.
    • In terminal run cargo install --git https://github.com/KtorZ/cardano-http-bridge.git --branch cardano-wallet-integration
    • make sure $HOME/.cargo/bin is on your $PATH
  2. Download cardano-wallet-http-bridge.tar.gz and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin.

$ curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2019-07-24/cardano-wallet-http-bridge.tar.gz | tar xz -C $HOME/.local/bin
  1. (optional) Download and install bash/zsh auto-completion script:
$ curl -L https://github.com/input-output-hk/cardano-wallet/releases/download/v2019-07-24/cardano-wallet.sh > /etc/bash_completion.d
$ source /etc/bash_completion.d/cardano-wallet.sh
  1. Start cardano-wallet --help and see available parameters.

Documentation

Link Audience
API Documentation Users of the Cardano Wallet API
Haddock Documentation Haskell Developers using the cardano-wallet as a library
CLI Manual Users of the Cardano Wallet API

Changelog

Jörmungandr Integration Testing
PR Description
#476 Jörmungandr binary roundtrips
#496 Enable Integration Tests for Jörmungandr (Part III: Command-Line tests)
#503 Review deployment script to include both jormungandr and http-bridge
#504 Preliminary integration tests cleanup before turning on remaining ones on Jörmungandr
#506 PORT_ tests for Jörmungandr
#508 Create Jormungandr Config from command-line options
#509 Enable launcher specs on Jörmungandr,
#517 Better errors for --genesis-block and --bft-leaders
#520 Pass --quiet and --verbose options down to Jörmungandr
#523 Fix coin selection max number of inputs not diminishing as expected
#525 Jormungandr.NetworkSpec: Add more error path tests
#528 Timeout test for serve for jormungandr and http-bridge
#530 Jormungandr test coverage
#537 CLI golden tests for common command usage
#540 add unknown input unit tests in Jormungandr
#570 add tooBigTransaction Jormungandr unit tests
Review Coin Selection
PR Description
#536 Use tx max size & estimator to figure out the right input upper-bound in coin selection
Finalize 'Transactions' API endpoints
PR Description
#495 Transaction estimateMaxNumberOfInputs
#497 Add listTransactions in WalletLayer
#500 Integration tests covering ErrInputsDepleted case
#507 Add estimate fee endpo...
Read more

Cardano Wallet Backend - Logging & SQLite (hotfix)

02 Jul 16:11
v2019-07-02
8049616
Compare
Choose a tag to compare

Overview

Program Platform Description
cardano-wallet
linux-x86_64
A CLI tool to start and interact with a wallet server. See Key Features below.
cardano-wallet.sh
linux-x86_64
Auto-completion script for cardano-wallet

This release is a hotfix for v2019-06-24 which had a flaw regarding the wallet restoration: restoration workers wouldn't be restarted with restarts of the wallet server.

Main Features

See v2019-06-24

Bug Fixes

Ticket Title
#484 Restoration workers aren't restarted with the server

Known Issues

Ticket Title
#409 cardano-wallet server fails with an unfriendly error when it does not connect to http-bridge within a few seconds
#423 Starting mainnet server on testnet bridge results in unfriendly error message.

Installation Instruction

See v2019-06-24

Documentation

See v2019-06-24

Changelog

Bugs Sprint 25-26
PR Description
#458 Scenarios for 0 amount tx for multi and single output for CLI and API
#486 re-start restoration workers when restarting the application,
Jörmungandr Integration
PR Description
#463 Implement Jörmungandr NetworkLayer postTx
#464 fix Jörmungandr witness calculation
#470 Turn on integration tests for Jörmungandr (Part I: Addresses & Wallets scenarios),
#471 Make faucet with 10 available UTxO for Jörmungandr,
#473 Get initial fee policy from the network (Jörmungandr),
#475 Turn on integration tests for Jörmungandr (Part II: Transactions scenarios),
#480 Move generic CLI functionality into cardano-wallet-cli library.,
#483 Integrate Jörmungandr backend with CLI.,
#487 Stricter jörmungandr binary encoders regarding integer overflow,
Logging
PR Description
#492 Sqlite: Use the structured logging approach,
#485 Review logging in API layer,
#449 tests: Add a small test of Sqlite logging
Miscellaneous / Technical Debts
PR Description
#489 Test invalid cli args and params,
#482 Provide ToText and FromText instances for Hash \Genesis\,
#479 Add development flag for cardano-wallet target.,
#478 Add ToText/FromText instances for String.,
#477 Use arbitraryBoundedEnum instead of genericArbitrary where possible.,
#468 Add missing roundtrip ToText/FromText tests for Cardano.Wallet.Primitive data types.,
#459 update 'listWallets' status in API specifications,
#457 Fixed wrong timeout in test expectations + update API specification with latest feature availability,
#456 bump revision for iohk-monitoring-framework,
#455 bump version to 2019.6.24, preparing next release,
#454 Integration Test Scenarios on top of Jörmungandr (Initial Setup),
#453 another attempt trying to cope with 500 when fetching network tip shortly after init (bridge),
#452 Review transaction ids golden tests (only new addresses),
#451 Parameterize Tx data-type over the wallet core engine (allowing to work with different representations),
#450 Replace CLI --min-log-severity argument with --quiet and --verbose switches.

Full Changelog

Signatures

Name Role Approval
Matthias Benkort @KtorZ Technical Team Lead ✔️
Piotr Stachyra @piotr-iohk QA Engineer ✔️
Tatyana Valkevych @tatyanavych Release Manager ✔️

Cardano Wallet Backend - Logging & SQLite

24 Jun 16:09
v2019-06-24
2de07c5
Compare
Choose a tag to compare

Overview

Program Platform Description
cardano-wallet
linux-x86_64
A CLI tool to start and interact with a wallet server. See Key Features below.
cardano-wallet.sh
linux-x86_64
Auto-completion script for cardano-wallet

This release tries to close the gap for allowing Daedalus to start integrating with the wallet backend. It also comes bundled with an SQLite persistence layer to allow saving to disk the wallet state. On the way to testnet and mainnet releases, we have also introduced better structured logging in this release, with some degrees of control regarding the verbosity of the software.

We have simplified a bit the software organization and merged together cardano-wallet and cardano-wallet-launcher in a single binary cardano-wallet. The launcher is now available as a launch command.

⚠️ This release contains a critical issue regarding wallet restoration (see #484).

This issue is fixed in v2019-07-02.

Main Features

cardano-wallet

  • A command-line interface which exposes the following features (see CLI manual below):

    • Create and Delete wallet
    • Get details of a particular wallet
    • List all known wallets
    • Generate BIP-39 mnemonic sentence (english) of various sizes
    • Update wallet metadata
    • Create and submit transactions from a single wallet
    • List known (used or unused) addresses of a wallet
    • ![][new] --state option for cardano-wallet address list
    • ![][new] serve command (replaces server ⚠️ breaking-change ⚠️)
    • ![][new] launch command (replaces cardano-wallet-launcher ⚠️ breaking-change ⚠️)
    • ![][new] --state-dir option for cardano-wallet launch
    • ![][new] --database option for cardano-wallet serve
    • ![][new] --random-port option for cardano-wallet launch and cardano-wallet serve
    • ![][new] --quiet and --verbose options for cardano-wallet launch and cardano-wallet serve
  • A web server which exposes the following features (see API Documentation below):

    • Create and Delete wallet
    • Get details of a particular wallet
    • List all known wallets
    • Update wallet metadata & wallet encryption passphrase
    • Create and submit transactions from a single wallet
    • List known (used or unused) addresses of a wallet
    • ![][new] Filter addresses by state (used or unused)
    • ![][new] SQLite backend to persist the wallet state to disk!
    • ![][new] API request / response logging
    • ![][new] Database debug logs
    • ![][new] (Partial) application-level logs
  • ![][new] Node.js-compatible IPC server with custom protocol

Known Limitations

  • ⚠️ Only one address derivation scheme is supported: sequential scheme (a.k.a. Icarus' address style or, addresses à la BIP-44).

  • ⚠️ So far, only one backend is supported: cardano-http-bridge (run on the Byron-OFT era, experimental stability).

Bug Fixes

Ticket Title
#250 GET v2/wallets does not list wallets from oldest to newest
#260 No additional error message in case of 4xx responses
#324 Bech32 occassionally fails when decoding a string with an omitted character
#326 Cannot post transaction after updating wallet's passphrase
#333 Sending transaction to not-valid address (yet being base58 encoded string) gives HTTP 500 -> "Something went wrong"
#364 Transaction with amount 0 on http bridge fails with error HTTP 500
#397 CLI wrongly returns exit code 0 when providing not existing wallet id
#398 CLI unnecessarily asks for password when posting transaction from a non-existing wallet
#403 API swagger specification isn't a valid swagger file

Known Issues

Ticket Title
#409 cardano-wallet server fails with unpleasant error when does not connect to http-bridge within a few seconds
#423 Starting mainnet server on testnet bridge results in unfriendly error message.
#484 Restoration workers aren't restarted with the server

Installation Instruction

Please note that currently only Unix\Linux platform is supported.

  1. Install cardano-http-bridge from our fork.

    • Install the rust toolchain.
    • In terminal run cargo install --git https://github.com/KtorZ/cardano-http-bridge.git --branch cardano-wallet-integration
    • make sure $HOME/.cargo/bin is on your $PATH
  2. Download cardano-wallet and put it in the directory that is on your $PATH, e.g. /usr/local/bin. Make sure to add exec permissions on binary files:

    • chmod u+x cardano-wallet
  3. Start cardano-wallet --help and see available parameters.

Documentation

Link Audience
API Documentation Users of the Cardano Wallet API
Haddock Documentation Haskell Developers using the cardano-wallet as a library
CLI Manual Users of the Cardano Wallet API

Changelog

SQLite implementation for the DB Layer
PR Description
#259 Generate DBLayer tests with quickcheck-state-machine
#337 Sqlite: add more locking to DBLayer methods
#341 Sqlite: Initial benchmark for putTxHistory
#347 Sqlite: use repsertMany instead of deleteMany+putMany
#348 Sqlite benchmark: Use a file-based DB
#349 Some small fixes to DB.StateMachine module.
#360 Sqlite: Fix deletion for larger numbers of checkpoints/transactions
#367 Make DB QSM tests fail if one or more tags are not covered.
#370 Recreate passing tests and file-based and in-memory runQuery
#377 cli: Add "local" network to launcher, and --state-dir for the database
#378 Clean ups of Sqlite test code
#379 Use SQLite in restoration benchmark (instead of MVar implementation)
#406 Use SQLite in integration tests scenarios (instead of MVar)
#413 Additional tests checking if files exists when using --database and --state-dir options
Jörmungandr Integration
PR Description
#310 Add Jörmungandr Servant Api Type
#313 Address Format in Shelley Era (Part 1: abstract over the address encoding)
#321 Jormungandr m with getTipId implementation
#322 Simplify folder structure, e.g. s/Binary.HttpBridge/HttpBridge.Binary/
#323 Miscellaneous Bech32 library fixes and improvements.
#325 Add Cardano.Wallet.Jormungandr.Network.Api
#327 Add extra debugging information to Bech32 decoding corruption tests.
#328 Add known-to-fail counterexamples to Bech32 string corruption tests.
#329 move Cardano.Environment.{HttpBridge,Jormungandr} to Cardano.Wallet.{HttpBridge,Jormungandr}.Environment
#332 Fix the Bech32 character mutation test.
#336 Address Format in Shelley (Part 2: implementing address encoder and decoders + tests)
#338 Fix index limits in Bech32 mutation tests
#340 Strengthen the precondition for the Bech32 mixed-case mutation test.
#362 Add initial support for serializing signed transaction
#369 Implement Jörmungandr getBlock and getDescendants
#382 review & fix jormungandr configuration to enable block production in BFT mode
#383 Jörmungandr: mkNetworkLayer with networkTip
#384 Change wallet currentTip from SlotId to BlockHeader
#385 Add labels to binary decoders for improved debugging
#394 Handle getBlockHeader special cases for proofs
#396 Relocate reusable integration tests components to core
#400 Preliminary integration tests between Jormungandr <-> Network Layer (networkTip)
#405 Implement NetworkLayer getNext for Jörmungandr
#417 Jörmungandr: Separate concern between keyToAddress and get/putAddress
#424 Cr...
Read more