Delegation to Stake Pools

Overview

Compatible with Jö[email protected]

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
• 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
• Delegate all funds from a wallet to a stake pool
• Fetch total reward balance earned from delegation
• 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

• ⚠️ Only Jörmungandr Genesis/Praos node is supported.

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 [email protected] from the official repository.

2. Download [email protected] 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/[email protected] | tar xz -C $HOME/.local/bin

3. (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

4. Start cardano-wallet --help and see available parameters.

Mac OS 64-bit

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

2. Download [email protected] 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 [email protected] 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

• Week 47 - 2019-11-22
• Week 48 - 2019-11-29
• Week 49 - 2019-12-06

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

(WB-36) Credentials and address for reward account

PR	Description
#1142	Few more negative tests for mnemonic rewards-credentials
#1127	Credentials and address for reward account

Create Delegation Certificate

PR	Description
#1124	Core Benchmark Adjustments
#1118	change API response code for quit stake pool to 202 Accepted
#1084	Join stake - fee boundary values tests
#1083	Discover Delegation to None
#1080	Implement quit stake pool
#1068	Join stake pool endpoint (part 2 - add sign delegation cert)
#1061	Review DSL for joinStakePool and quitStakePool
#1059	Add TransactionLayer.mkDelegationCertTx
#1051	Fee Policy format additional tests
#970	Join stake pool endpoint (part 1 - no signCert impl)

Support Delegated Addresses

PR	Description
#1132	atomically write checkpoints, tx history and delegation certs when discovered
#1111	fix 'Hash' generation in benchmark: must be 32 bytes
#1082	Fetch reward account balance when reading or listing wallets
#1081	Change 'purposeIndex' for 1852'
#1079	Fix wallet reward balance field location.
#1075	Generalize IsOurs to work on different types of entity.
#1073	Use delegation address (grouped) only in the wallet
#1062	Enable remaining Jörmungandr addresses as transaction outputs
#1060	Revise Jörmungandr Binary Fragment Serializers
#1058	additional checks for wallet rewards field
#1057	Use Word31 as underlying type for EpochNo.
#1055	Golden test for Random discovery and addresses with non-hardened indexes
#1054	Correctly handle what are now 404 Not Found in Jörmungandr client
#1053	Additional negative tests for JormungandrClient endpoints
#1050	Scan stake pool registrations during wallet restoration.
#1046	Increase artificialEpochLength to maxBound :: Word32
#1043	Extend Block type to contain delegation certificate registrations.
#1024	Refactor (Tx, [TxWitness]) to SealedTx
#995	Implement GetAccountState operation for Jörmungandr API Client
#956	Remove obsolete code for testing generation of jormungandr-config.yaml

Usability & Compatibility

PR	Description
#1143	Use $STRIP instead of hardcoding strip
#1139	Update stack.yaml (add clock-0.8)
#1129	Buildkite: Check for modified golden test data after running tests
#1126	Update Jormungandr 0.8.0-rc7 -> 0.8.0-rc8
#1125	Fixing Windows failing tests
#1123	Change status code for create/restore wallet/byron-wallet from 202 Accepted -> 201 Created
#1117	Update Jormungandr 0.8.0-rc4 -> 0.8.0-rc7
#1113	Update iohk-monitoring version
#1109	Test.Utils.Paths: Fix the test data directory for Windows and Nix
#1108	Buildkite: Make docker push step soft-failable
#1104	jormungandr 0.8.0-rc1 - 0.8.0-rc4
#1101	tests: Use TH for getting data directory
#1085	Jormungandr 0.7.5 - 0.8.0-rc1
#1077	Jormungandr 0.7.4 -> 0.7.5
#1072	Jormungandr 0.7.0 -> 0.7.4
#1047	Add git revision to version strings
#1018	Add Docker image to Buildkite
#976	Make test data file paths relative to project root.

Signatures

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