Skip to content

Hardware wallets mnemonics restoration

Compare
Choose a tag to compare
@WilliamKingNoel-Bot WilliamKingNoel-Bot released this 09 Jan 16:00
v2020-01-07
d150ed6

Overview

Compatible with [email protected]

Artifact Platform Description
cardano-wallet-jormungandr-linux64-v2020-01-07.tar.gz
Linux 64-bit
Linux executable with auto-completion script for bash shell.
cardano-wallet-jormungandr-macos64-v2020-01-07.tar.gz
MacOs 64-bit
MacOS executable with required system libraries.
cardano-wallet-jormungandr-win64-v2020-01-07.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
  • 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
    • Allow restoration and manipulation of Byron Ledger wallets mnemonic sentences
    • Allow restoration and manipulation of Byron Trezor wallets mnemonic sentences
  • 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
  • Delegate all funds from a wallet to a stake-pool
  • Fetch total reward balance earned from delegation
  • Stop delegating funds from a wallet
  • Support stake pool off-chain metadata
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

  • Zero balance reported on the wallet despite receiving funds from faucet #1146
  • Migration failing on Windows due to stake-pools.sqlite lock #1224
  • Unhandled Data.Binary.Get error observed in node logs #1228

Known Issues

  • --logging-config FILE.YAML more info and tests #961
  • Failing tests integration tests on Windows #1115
  • Error in the log after deleting a wallet #1242
  • Missing database migration for active_slot_coeff #1251
  • Benchmarks are failing #1252

Installation Instructions

Linux 64-bit

  1. Install [email protected] from the official repository.

  2. Download cardano-wallet-jormungandr-linux64-v2020-01-07.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/v2020-01-07/cardano-wallet-jormungandr-linux64-v2019-12-16.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 [email protected] from the official repository.

  2. Download cardano-wallet-jormungandr-macos64-v2020-01-07.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 [email protected] from the official repository.

  2. Download cardano-wallet-jormungandr-win64-v2020-01-07.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
#1248 Fix database error that occurs during wallet deletion.
#1246 Revisions of the logic handling roll backs
#1231 Fix missing test data in windows testing bundle
#1229 Define and use safe 'eitherRunGet' to avoid throwing on binary decoding
#1226 Pool.DB.Sqlite: Close the database before attempting to wipe it
(WB-46) Hardware Ledger Auxiliary Seed Generation
PR Description
#1247 Add type-safe module to construct API links
#1239 Trezor mnemonics in genesis file + README update
#1236 API hardware wallet restoration
#1234 Support Hardware Ledger Auxiliary Seed Generation Method
Miscellaneous
PR Description
#1106 Update to latest haskell.nix
#1218 Fix cabal v2-build
#1219 Buildkite: fix weeder
#1225 Update Hercules-CI build file
#1227 Update manual tests and db migration manual scenario
#1249 bump version to 2020.1.7 and licenses copyright to 2020
#1254 Buildkite: Only run weeder if the stack build succeeds

Signatures

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