Skip to content

Byron rewrite, new launcher & NTP support
Compare
Choose a tag to compare
@WilliamKingNoel-Bot WilliamKingNoel-Bot released this 12 Mar 15:07
v2020-03-11
This tag was signed with the committer’s verified signature.
KtorZ Matthias Benkort
GPG key ID: 33173CB6F77F4277
Verified
Learn about vigilant mode.
1333dff
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

Overview

Compatible with Jö[email protected]

Artifact Platform Description
cardano-wallet-jormungandr-linux64-v2020-03-11.tar.gz 
Linux 64-bit
 Linux executable with auto-completion script for bash shell.
cardano-wallet-jormungandr-macos64-v2020-03-11.tar.gz 
MacOs 64-bit
 MacOS executable with required system libraries.
cardano-wallet-jormungandr-win64-v2020-03-11.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 syncing status
  • List available stake-pools
  • Generate testnet reward credentials from a given mnemonic sentence
  • Get network parameters
  • Manage cryptographic keys
    • Generate root private key from mnemonic sentence
    • Derive child keys from parent keys
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
    • Now available for Byron wallets.
  • List known (used or unused) addresses of a wallet
  • API and server logs
  • Estimate transaction fee
    • Now available for Byron wallets.
  • Visualize wallet's UTxO distribution
  • List transaction history
  • Submit already signed transactions
  • Get network syncing status
  • 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
  • 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
  • Get network parameters
  • Get NTP (Network Time Protocol) drift offset
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
  • Per-component log management

Known Limitations

Bug Fixes

  • Weird log line regarding delegation status #1376
  • 0.5% profit margin of pool is rounded to 0% #1331
  • Cannot list wallets when using same state directory but different genesis #1292

Known Issues

  • Windows tests are failing on hydra #1283
  • Random wallet restoration is extremely slow on Windows #1398
  • Wallets disappear from list when their worker dies unexpectedly #1292

Installation Instructions

Linux 64-bit

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

  2. Download cardano-wallet-jormungandr-linux64-v2020-03-11.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-03-11/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-03-11.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-03-11.zip and uncompress it in a directory that is on your %PATH%.

Docker

  1. Pull from DockerHub.
$ docker pull inputoutput/cardano-wallet:2020.3.11-jormungandr
  1. Verify the image using the command-line.
$ docker run --rm inputoutput/cardano-wallet:2020.3.11-jormungandr version

Documentation

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

Weekly Reports

Changelog

Miscellaneous
PR Description
#1351 use iohk-nix and haskell.nix as overlays
#1357 Fix latency benchmarking
#1364 Move to swagger 3.0
#1365 Bump to Jormungandr 0.8.11
#1371 eventually with description for better identification when action inside eventually fails
#1375 Jormungandr v0.8.12 bump
#1385 Update to [email protected]
#1387 Improve on delegation logging
#1388 Bump Jormungandr.nix to 0.8.13
#1399 Rework use of Percentage type
#1402 nix: Fix build caching
#1404 Fix nightly DB migration tests
#1405 Bump package versions to 2020.3.3
#1406 Adjust SIGKILL case in POSIXSpec
#1415 stdoutTextTracer: Use line-buffered print statements
#1417 Move remaining integration tests to ApiSpec.hs
#1418 Typo in TrackBlockHeight.md
#1419 correct Buildable WalletDelegationNext
#1420 Fix test failure by making clean shutdown handler optional
#1422 Disable running integration tests on Hydra CI
#1426 bump versions to v2020-03-11
(ADP-141) Multiple next's support in delegation reporting
PR Description
#1361 Testing delegation active/next
#1392 Unit tests delegation transition
#1403 Fix prop_guardQuitJoin not to use precondition for filtering pools.
(ADP-159) Local Tx Submission Integration
PR Description
#1350 Extend byron API to support making transactions from byron wallets
#1358 Bump cardano-node and its dependencies to 1.5.0, and stack LTS in the meantime
#1407 Integration Setup Foundation for cardano-node w/ Byron
#1408 add cardano-node to shell.nix and integration build inputs
#1413 Fix threads synchronization in around all
#1414 cardano-node OBFT - test integration setup
(ADP-193) NTP status via CLI
PR Description
#1428 CLI support for ntp status
(ADP-52) Hardware Wallet: Restore Sequential Wallet From Public Key
PR Description
#1360 Extend wallet restore endpoint to accept also account public key
#1400 HW wallets tests
(ADP-81) Wallet: Command-line utils for key derivation
PR Description
#1321 Add CLI command for extracting root xprvs
#1370 Add cli key child command
#1393 Add key public cli command
#1397 Add quick key inspect cli command
#1409 Enable key cli commands for cardano-wallet-byron executable
(ADP-84) network clock endpoint for NTP status
PR Description
#1396 Implement network clock endpoint using ntp-client
#1410 Testing /network/clock
(ADP-92) Launcher: New launcher (no updates)
PR Description
#1315 Add shutdown handler for new launcher
(ADP-94) Bech32 Library Extraction
PR Description
#1362 Remove local Codec.Binary.Bech32.TH module.

Signatures

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