Skip to content

Cardano Wallet Backend - Jörmungandr@0.7.0-rc7

Pre-release
Pre-release
Compare
Choose a tag to compare
@KtorZ KtorZ released this 08 Nov 17:03
v2019-11-07
b84678e

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 ✔️