Skip to content

Byron Yoroi Support

Compare
Choose a tag to compare
@KtorZ KtorZ released this 30 Dec 13:10
v2019-12-23
398565c

Overview

Compatible with Jörmungandr@v0.8.5

Artifact Platform Description
cardano-wallet-jormungandr-linux64-v2019-12-23.tar.gz
Linux 64-bit
Linux executable with auto-completion script for bash shell.
cardano-wallet-jormungandr-macos64-v2019-12-23.tar.gz
MacOs 64-bit
MacOS executable with required system libraries.
cardano-wallet-jormungandr-win64-v2019-12-23.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 Yoroi 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
  • 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

  • Rollbacks issue in stake pool worker #1200
  • Misleading Mnemonic Sentence Error message #1153
  • Non-linear sync progress from not considering active_slot_coeff #1197
  • Possible missing db migration between balance-check version and latest one #1177

Known Issues

  • --logging-config FILE.YAML more info and tests #961
  • Failing tests integration tests on Windows #1115
  • Missing database migration for active_slot_coeff #1251
  • Unhandled Data.Binary.Get error observed in node logs #1228
  • Zero balance reported on the wallet despite receiving funds from faucet #1146

Installation Instructions

Linux 64-bit

  1. Install jormungandr@0.8.5 from the official repository.

  2. Download cardano-wallet-jormungandr-linux64-v2019-12-23.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-23/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 jormungandr@0.8.5 from the official repository.

  2. Download cardano-wallet-jormungandr-macos64-v2019-12-23.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.5 from the official repository.

  2. Download cardano-wallet-jormungandr-win64-v2019-12-23.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
#1198 Take active_slot_coeff into account for sync progress calculation
#1201 Fix pool registration rollback
#1202 Fix flaky next epoch test
#1203 Gratuitous fixes in restoration worker (wrong log line + move pruning inside same tx)
#1205 Review and clean State Machine file
#1211 Split Servant API client code into Cardano.Wallet.Api.Client
#1212 Refine mnemonic error msg
(WB-18) API latency
PR Description
#1163 add utxo benchmarks
(WB-27) Support Byron Yoroi Wallets
PR Description
#1199 API layer house-keeping in preparation of byron Yoroi support
#1206 Make api handlers more polymorphic to reduce duplication
#1209 Add support for Icarus keys derived from 15-word mnemonic sentences
#1220 Use big pool gap for Icarus wallet first scan
#1222 Fix listing interleave of legacy wallets
Miscellaneous
PR Description
#1210 Upgrade Jörmungandr integration to 0.8.3 / 0.8.4 (when available)
#1213 bump Jörmungandr to 0.8.4
#1215 Bump Jörmungandr to v0.8.5-alpha1
#1221 Update Jormungandr 0.8.5
#1223 bump versions to 2019-12-23

Signatures

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