Skip to content

Releases: cardano-foundation/cardano-wallet

Shelley MVP

07 Jul 16:27
@WilliamKingNoel-Bot WilliamKingNoel-Bot
v2020-07-06
This tag was signed with the committer’s verified signature.
KtorZ Matthias Benkort
GPG key ID: 33173CB6F77F4277
Learn about vigilant mode.
9a910f3
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
Shelley MVP

Compatible with jormungandr@v0.9.0 and cardano-node@1.14.2.

New Features

  • Remaining API endpoints in cardano-wallet-shelley completed, which include delegation / undelegation support, and stake pools listing with metadata support #1722 #1738 #1744 #1747 #1752 #1753 #1763 #1765 #1769 #1775 #1776 #1783 #1800 #1801 #1806 #1807 #1810 . Note the following details:

    • ⚠️ The stake pool resource is different from cardano-wallet-itn, both models are documented in the API documentation under different tabs. Key changes are summarized in the table below:

      jörmungandr (itn) cardano-node (shelley)
      apparent_performance removed
      metadata.pledge_address replaced by pledge
      desirability replaced by metrics.non_myopic_member_rewards
      saturation replaced by metrics.saturation
      metrics.controlled_stake replaced by metrics.relative_stake
      metadata.owner removed

    • ⚠️ cost, margin, pledge and metadata are fetched asynchronously and may therefore be null temporarily. Although, once set, they should remain set

    • ⚠️ Stake pools are no longer ordered by desirability, but are ordered by non-myopic member rewards which require an indented delegated stake to be provided as a query parameter

    • ⚠️ Metadata are no longer tight to the owner, but are tight to the stake pool itself. Yet, if two stake pools register the same metadata, it is still possible to find duplicates

  • Support for submission of already signed and serialized Shelley transactions #1766

  • Support for bech32 encoding for Shelley addresses. The server will however still accept addresses encoded as base16 to keep compatibility with cardano-cli #1746

  • Support for fetching transaction (both Byron & Shelley) by id #1795 #1804

  • Support of recovery phrases of various lengths for Icarus and random Byron wallets #1809

  • Addition of the decentralization level (a.k.a d-parameter) alongside other protocol parameters #1735 #1736 #1739

  • Addition of the desired number of pools (a.k.a k-parameter) alongside other protocol parameters #1827 #1848

  • Support for spending rewards as part of a payment transaction. The rewards will be converted as UTxO and used to pay for some of the fees. Rewards are consumed only when deemed worthy (adding them does not cost more than their value), and by explicit demand using a query flag #1843

Improvements

  • Extensive fully automated integration tests for cardano-node in Shelley mode. We've developed a framework for running a local cluster of node made of 3 stake pools, 1 BFT leader and one passive node, all fully connected and running a private blockchain at will. The cluster uses a genesis file with pre-registered funds attached to HD wallets which can be restored using their recovery phrase to be used to write various test scenarios #1729 #1731 #1732 #1734 #1748 #1754 #1772 #1790

  • More code re-use from cardano-addresses and in particular the command-line declarations for keys and recovery phrase manipulation. #1780. As a consequence, there are breaking changes in the command-line (see CLI breaking changes)

  • Show latest value of protocol parameters instead of their value from genesis #1760

  • Small API documentation reorganization to group endpoints by verbs #1802

  • Faster fee estimation for Shelley transactions #1834

CLI breaking changes

  • ⚠️ The mnemonic command has been renamed to recovery-phrase
  • ⚠️ The key root command has been renamed to key from-recovery-phrase
  • ⚠️ The wallet create from-mnemonic command has been renamed to wallet create from-recovery-phrase

Known Issues

  • #1572 Recovery from chain-following exceptions may cause node to crash
  • #1708 cardano-wallet-shelley workers crash
  • #1713 Performance issues /v2/byron-wallets/{walletId}/addresses API
  • #1733 cardano-wallet-shelley address CLI has import and create commands which are not supported for Shelley wallets
  • #1743 Required wallet DB fields do not get persistently added
  • #1823 Trying to join pool returns 500 when there's no next delegation
  • #1833 There are un-joinable pools on shelley_testnet
  • #1867 Wallet doesn't show meta data re-registered (in case of changing metadata url without changing metadata hash)

Documentation

Link Audience
API Documentation Users of the Cardano Wallet API
CLI Manual: Jörmungandr / cardano-node Users of the Cardano Wallet API
Docker Manual Users of the Cardano Wallet API

Supported Operating Systems

  • Linux 64 bit
  • MacOS 64 bit
  • Windows 64 bit

Installation Instructions

Shelley testnet (cardano-node)

  1. Install cardano-node@1.14.2

  2. Download the provided cardano-wallet-shelley for your platform, and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin. Or %PATH% on Windows

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

Docker

Pull from DockerHub and verify the version matches 2020.7.6:

$ docker pull inputoutput/cardano-wallet:2020.7.6-shelley
$ docker run --rm inputoutput/cardano-wallet:2020.7.6-shelley version

ITN (jormungandr)

  1. Install jormungandr@v0.9.0

  2. Download the provided cardano-wallet-jormungandr for your platform, and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin. Or %PATH% on Windows

  3. (optional) Install the bash/zsh auto-completion script according to the jormungandr cli manual

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

Docker

Pull from DockerHub and verify the version matches 2020.7.6:

$ docker pull inputoutput/cardano-wallet:2020.7.6-jormungandr
$ docker run --rm inputoutput/cardano-wallet:2020.7.6-jormungandr version

Byron (cardano-node)

  1. Install cardano-node@1.14.2

  2. Download the provided cardano-wallet-byron for your platform, and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin. Or %PATH% on Windows

  3. (optional) Install the bash/zsh auto-completion script according to the byron cli manual

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

Docker

Pull from DockerHub and verify the version matches 2020.7.6:

$ docker pull inputoutput/cardano-wallet:2020.7.6-byron
$ docker run --rm inputoutput/cardano-wallet:2020.7.6-byron version

Additional notes

  • On macOS: Make sure all *.dylib files are in the same directory as cardano-wallet binary

Signatures

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

Basic Shelley Testnet Support

10 Jun 12:19
@WilliamKingNoel-Bot WilliamKingNoel-Bot
v2020-06-05
This tag was signed with the committer’s verified signature.
KtorZ Matthias Benkort
GPG key ID: 33173CB6F77F4277
Learn about vigilant mode.
5290acf
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
Basic Shelley Testnet Support

Compatible with jormungandr@v0.8.18 and cardano-node@1.13.0.

New Features

  • New cardano-wallet-shelley executable targeting the first Shelley-only testnet that contains wallet, address and transaction support #1626 #1669 #1673 #1677 (Delegation features will be added in a further release)
  • Live reporting of the decentralization parameter d for the mainnet Byron-to-Shelley transition #1725
  • Support for restoring sequential Byron wallets from account public keys (previously only supported for Shelley) #1721
  • New migration endpoints which support migrating funds from any wallet to any set of addresses. Previously migration only allowed migration from a Byron wallet to a known new wallet #1664, #1645, #1678, #1687, #1684

Improvements

  • Up to 40% faster wallet restoration using pipelined chain sync #1615 #1665
  • Reduced randomness when estimating transaction fees from running multiple selections #1679 #1653
  • Usability and documentation improvements
    • Exemplary docker-compose.yaml for cardano-wallet and cardano-node #1634
    • API and CLI documentation improvements
      • Clarified the description of getNetworkParameters in the API and CLI. #1698
    • Code and Haddock documentation improvements #1728 #1715
    • Reduced / adjusted logging for NetworkLayer and NTP client #1630 #1636
    • Better rendering of bech32 error messages in key derivation CLI #1625 #1654

Removed

  • #1694 Breaking ⚠️ Removed epochId argument from getNetworkParameters.

Resolved Issues

  • #1701 Wallet "passphrase" info gets lost after updating cardano-wallet (#1704, #1717)
  • #1647 cardano-wallet-jormungandr: Blockchain tip not set in REST context (#1681)
  • #1670 Different behavior regarding resolved inputs when listing transactions with and without query parameters (#1685, #1696, #1697)
  • #1683 Incorrectly documented HTTP response code for fee-estimation (should be 202 instead of 200)
  • #1659 Race condition between byron addresses creation and wallet restoration
  • #1660 The latest docker tag is now available as latest, instead of separate tags for each revisions, to avoid cluttering
  • #1638 Modifed docker-compose.yml example so it is possible to run mainnet and testnet interchangeably

Known issues

  • #1733 cardano-wallet-shelley address CLI has import and create commands which are not supported for Shelley wallets
  • #1708 cardano-wallet-shelley workers crash
  • #1572 Recovery from chain-following exceptions may cause node to crash

Documentation

Link Audience
API Documentation Users of the Cardano Wallet API
CLI Manual: ITN / Byron Users of the Cardano Wallet API
Docker Manual Users of the Cardano Wallet API

Supported Operating Systems

  • Windows 64 bit
  • Linux 64 bit
  • MacOS 64 bit

Installation Instructions

Shelley testnet (cardano-node)

  1. Install cardano-node@1.13.0

  2. Download the provided cardano-wallet-shelley for your platform, and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin. Or %PATH% on Windows

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

Docker

Pull from DockerHub and verify the version matches 2020.6.5:

$ docker pull inputoutput/cardano-wallet:2020.6.5-shelley
$ docker run --rm inputoutput/cardano-wallet:2020.6.5-shelley version

ITN (jormungandr)

  1. Install jormungandr@v0.8.18

  2. Download the provided cardano-wallet-jormungandr for your platform, and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin. Or %PATH% on Windows

  3. (optional) Install the bash/zsh auto-completion script according to the jormungandr cli manual

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

Docker

Pull from DockerHub and verify the version matches 2020.6.5:

$ docker pull inputoutput/cardano-wallet:2020.6.5-jormungandr
$ docker run --rm inputoutput/cardano-wallet:2020.6.5-jormungandr version

Byron (cardano-node)

  1. Install cardano-node@1.13.0

  2. Download the provided cardano-wallet-byron for your platform, and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin. Or %PATH% on Windows

  3. (optional) Install the bash/zsh auto-completion script according to the byron cli manual

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

Docker

Pull from DockerHub and verify the version matches 2020.6.5:

$ docker pull inputoutput/cardano-wallet:2020.6.5-byron
$ docker run --rm inputoutput/cardano-wallet:2020.6.5-byron version

Additional notes

  • On macOS: Make sure all *.dylib files are in the same directory as cardano-wallet binary

Troubleshooting

cardano-wallet: error while loading shared libraries: libcrypto.so.1.0.0: cannot open shared object file: No such file or directory

libcrypto 1.0.0 is no longer shipped with RHEL for a while (since ver. 6) and
SuSE. On these distributions, it is impossible to install it using native
package manager (e.g. yum).

One possible work-around is to create an artificial symbolic link from a newer version of libcrypto:

sudo ln -s /usr/lib64/libcrypto.so.1.1.1 /usr/lib64/libcrypto.so.1.0.0

Alternatively, one may also try using the docker image instead.

Signatures

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

Local State Query Protocol

06 May 13:39
@rvl rvl
v2020-05-06
This tag was signed with the committer’s verified signature.
rvl Rodney Lorrimar
GPG key ID: D8B75C95FB4D1143
Learn about vigilant mode.
cf3d9c9
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
Local State Query Protocol

Compatible with jormungandr@v0.8.18 and cardano-node@1.11.0.

New Features

  • The cardano-wallet keys command-line interface supports hexadecimal and bech32 encodings.
  • (Byron) Transaction protocol parameters are updated from the chain.

Improvements

  • For the cardano-wallet keys commands, key material is now provided on stdin.
  • Initial work to retrieve stake pool metadata on Shelley.

Removed features

  • ⚠️ breaking-change ⚠️ The force resync feature has been removed.

Resolved Issues

  • #1621 Fixed database migration tests failing
  • #1609 Fixed broken doc link for listByronAddresses.
  • #1608 Fixed Database migration script failing on nightly build.
  • #1534 Fixed force resync = Something went wrong on Windows.

Known Issues

  • #1552 Migration issue on Jormungandr (v2020-03-16 → v2020-04-01 | 07).
  • #1571 Byron initCursor does not seem to cause DB to rollback.

Changelog

(ADP-158) Shelley address format and using cardano-addresses
PR Description
#1616 Remove rest mnemonic bits
#1605 Use mnemonics from cardano addresses
(ADP-190, ADP-195) Public key derivation and bech32 support for CLI key utilities
PR Description
#1622 Only support keys as stdin and move tests
#1619 Better bech32 error messages
#1599 Support Bech32 keys in CLI (and rework the implementation to be less fancy)
(ADP-258) Rework metadata aggregation to work with the new aggregation server API
PR Description
#1623 Mock metadata aggregation server
#1614 Metadata aggregation client & mock server
#1598 Relocate Jörmungandr-specific metadata & pools code inside cardano-wallet-jormungandr
(ADP-83) Local State Query
PR Description
#1624 Fix migration error on checkpoint table
#1618 Unit test for LocalStateQuery
#1606 Don't deserialise blocks in the chain sync node client
#1580 Add LocalStateQuery to byron network layer
Miscellaneous build/test fixes
PR Description
#1627 Bump version from 2020.4.28 to 2020.5.6
#1620 Latency benchmarks second look
#1613 Remove force resync feature
#1612 Fix caching in first scenarion latency benchmarking
#1611 Fix listByronAddresses swagger operation id
#1610 Buildkite all-tests-pass branch
#1604 nix: remove socket files from source trees before building

Weekly Reports

Documentation

Link Audience
API Documentation Users of the Cardano Wallet API
CLI Manual: ITN / Byron 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

Installation Instructions

Jormungandr / ITN

  1. Install jormungandr@v0.8.18.

  2. Download the provided cardano-wallet-jormungandr for your platform, and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin. Or %PATH% on Windows.

  3. (optional) Install the bash/zsh auto-completion script according to the jormungandr cli manual

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

Docker

Pull from DockerHub and verify version is matching 2020.5.6

$ docker pull inputoutput/cardano-wallet:2020.5.6-jormungandr
$ docker run --rm inputoutput/cardano-wallet:2020.5.6-jormungandr version

cardano-node / Byron

  1. Install cardano-node@1.11.0.

  2. Download the provided cardano-wallet-byron for your platform, and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin. Or %PATH% on Windows.

  3. (optional) Install the bash/zsh auto-completion script according to the byron cli manual

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

Docker

Pull from DockerHub and verify version is matching 2020.5.6

$ docker pull inputoutput/cardano-wallet:2020.5.6-byron
$ docker run --rm inputoutput/cardano-wallet:2020.5.6-byron version

Additional notes

  • On macOS: Make sure all *.dylib files are in the same directory as cardano-wallet binary.

TroubleShooting

cardano-wallet: error while loading shared libraries: libcrypto.so.1.0.0: cannot open shared object file: No such file or directory

libcrypto 1.0.0 is no longer shipped with RHEL for a while (since ver. 6) and
SuSE. On these distributions, it is impossible to install it using native
package manager (e.g. yum).

One possible work-around is to create an artificial symbolic link from a newer version of libcrypto:

sudo ln -s /usr/lib64/libcrypto.so.1.1.1 /usr/lib64/libcrypto.so.1.0.0

Alternatively, one may also try using the docker image instead.

Signatures

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

Flight Take-Off

29 Apr 14:38
@WilliamKingNoel-Bot WilliamKingNoel-Bot
v2020-04-28
This tag was signed with the committer’s verified signature.
KtorZ Matthias Benkort
GPG key ID: 33173CB6F77F4277
Learn about vigilant mode.
aa46adf
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
Flight Take-Off

Compatible with jormungandr@v0.8.18 and cardano-node@1.11.0.

New Features

  • New API flag 'forceCheck' for GET /v2/network/clock #1592
  • New discovery field for Byron wallets giving the type of discovery scheme used (e.g. random or sequential) #1568
  • Support public key derivation in CLI #1588
  • Plot restoration benchmark results in Buildkite #1496

Improvements

  • Integration with cardano-node@1.11.0 #1593
  • Integration with jormungandr@0.8.18 #1589
  • Run benchmarks on a dedicated buildkite agent #1592
  • Cabal: Set -Werror and -Ox only with release flag #1587
  • Run jormungandr integration tests in the nightly pipeline #1586

Resolved Issues

  • Do not force a blocking NTP check by default but use cached result #1592
  • Remove passphrase validations on legacy endpoints using passphrase #1584
  • ⚠️ BREAKING-CHANGE ⚠️ API does not return a depth field anymore for pending transactions. The field is however still present on transaction that are in ledger #1583
  • Fixed data consistency after rollbacks between tx meta and certificates #1579
  • Fixed fee balancing for non-stable size estimation algorithms, like in Byron #1578

Known Issues

  • Forcing resync triggers leads to an unexpected error on Windows #1534
  • Migration issue on Jormungandr (v2020-03-16 => v2020-04-01 | 07) #1552
  • Byron initCursor does not seem to cause DB to rollback #1571
  • Database migration script is failing on nightly build #1608

Weekly Reports

Documentation

Link Audience
API Documentation Users of the Cardano Wallet API
CLI Manual: ITN / Byron 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

Installation Instructions

Jormungandr / ITN

  1. Install jormungandr@v0.8.18.

  2. Download the provided cardano-wallet-jormungandr for your platform, and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin. Or %PATH% on Windows.

  3. (optional) Install the bash/zsh auto-completion script according to the jormungandr cli manual

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

Docker

Pull from DockerHub and verify version.

$ docker pull inputoutput/cardano-wallet:2020.4.28-jormungandr
$ docker run --rm inputoutput/cardano-wallet:2020.4.28-jormungandr version

cardano-node / Byron

  1. Install cardano-node@1.11.0.

  2. Download the provided cardano-wallet-byron for your platform, and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin. Or %PATH% on Windows.

  3. (optional) Install the bash/zsh auto-completion script according to the byron cli manual

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

Docker

Pull from DockerHub and verify version.

$ docker pull inputoutput/cardano-wallet:2020.4.28-byron
$ docker run --rm inputoutput/cardano-wallet:2020.4.28-byron version

Additional notes

  • On macOS: Make sure all *.dylib files are in the same directory as cardano-wallet binary.

TroubleShooting

cardano-wallet: error while loading shared libraries: libcrypto.so.1.0.0: cannot open shared object file: No such file or directory

libcrypto 1.0.0 is no longer shipped with RHEL for a while (since ver. 6) and
SuSE. On these distributions, it is impossible to install it using native
package manager (e.g. yum).

One possible work-around is to create an artificial symbolic link from a newer version of libcrypto:

sudo ln -s /usr/lib64/libcrypto.so.1.1.1 /usr/lib64/libcrypto.so.1.0.0

Alternatively, one may also try using the docker image instead.

Signatures

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

Byron Reboot Polish

08 Apr 15:14
@WilliamKingNoel-Bot WilliamKingNoel-Bot
v2020-04-07
This tag was signed with the committer’s verified signature.
paweljakubas Pawel Jakubas
GPG key ID: 2CA72948F4D5B403
Learn about vigilant mode.
9543cdf
This commit was signed with the committer’s verified signature.
paweljakubas Pawel Jakubas
GPG key ID: 2CA72948F4D5B403
Learn about vigilant mode.
Compare
Choose a tag to compare
Byron Reboot Polish

Compatible with jormungandr@v0.8.15 and cardano-node@1.9.3.

Improvements

  • Added cardano-wallet-byron static builds #1526
  • Included cardano-wallet-byron in pushed Docker images #1537
  • Got network/clock tests working on Windows #1519
  • Added more integration tests for cardano-wallet-byron #1539
  • Enabled nightly Windows tests #1411
  • Added more required jobs from Hydra, including tests on Windows #1536
  • Added latency benchmarking for cardano-wallet-byron in nightly #1530
  • Improved error message when generating addresses of Icarus wallets #1543
  • Used more convenient Map functions #1516
  • Improved release template & artifacts publication #1533 | #1545 | #1544

CLI breaking changes

  • Removed DaedalusIPC #1424
  • Removed wrong "reward-credentials" command from cardano-wallet-byron mnemonic #1531

Resolved Issues

  • Fixed unit tests on MacOS #1525
  • Fixed wrong key fingerprint for Icarus addresses on Testnet #1535
  • Fixed broken benchmark with up-to-date config from nix #1458
  • Made sure to only generate addresses using the Hardened index convention #1541

Known Issues

  • jormungandr and cardano-node release artifacts are broken for MacOS #1553
  • Migration issue on Jormungandr (v2020-03-16 => v2020-04-01 | 07) #1552
  • Force resync = Something went wrong for Jormungandr #1534
  • Cannot force resync wallet and cardano-node crash as a result #1505
  • Submit transaction on staging_shelley gives 500 #1492
  • cardano-node: Cannot send transaction on testnet (cardano-node + cardano-wallet-byron) #1462
  • Windows tests are failing on hydra #1283

Weekly Reports

Documentation

Link Audience
API Documentation Users of the Cardano Wallet API
CLI Manual: ITN / Byron 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

Installation Instructions

Jormungandr / ITN

  1. Install jormungandr@v0.8.15.

  2. Download the provided cardano-wallet-jormungandr for your platform, and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin. Or %PATH% on Windows.

  3. (optional) Install the bash/zsh auto-completion script according to the jormungandr cli manual

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

Docker

Pull from DockerHub and verify version.

$ docker pull inputoutput/cardano-wallet:2020.4.7-jormungandr
$ docker run --rm inputoutput/cardano-wallet:2020.4.7-jormungandr version

cardano-node / Byron

  1. Install cardano-node@1.9.3.

  2. Download the provided cardano-wallet-byron for your platform, and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin. Or %PATH% on Windows.

  3. (optional) Install the bash/zsh auto-completion script according to the byron cli manual

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

Docker

Pull from DockerHub and verify version.

$ docker pull inputoutput/cardano-wallet:2020.4.7-byron
$ docker run --rm inputoutput/cardano-wallet:2020.4.7-byron version

Additional notes

  • On macOS: Make sure all *.dylib files are in the same directory as cardano-wallet binary.

TroubleShooting

cardano-wallet: error while loading shared libraries: libcrypto.so.1.0.0: cannot open shared object file: No such file or directory

libcrypto 1.0.0 is no longer shipped with RHEL for a while (since ver. 6) and
SuSE. On these distributions, it is impossible to install it using native
package manager (e.g. yum).

One possible work-around is to create an artificial symbolic link from a newer version of libcrypto:

sudo ln -s /usr/lib64/libcrypto.so.1.1.1 /usr/lib64/libcrypto.so.1.0.0

Alternatively, one may also try using the docker image instead.

Signatures

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

Byron Reboot

03 Apr 17:37
@WilliamKingNoel-Bot WilliamKingNoel-Bot
v2020-04-01
This tag was signed with the committer’s verified signature.
Anviking Johannes Lund
GPG key ID: 6275E0F0A64A8ABB
Learn about vigilant mode.
72fabed
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
Byron Reboot

This release brings many features required for the Byron reboot and improvements to the command line interface.

Compatible with jormungandr@v0.8.15 and cardano-node@1.9.3.

New Features

Improvements

  • Byron wallet restoration now also accepts legacy-style extended private key and password hash (such that old Daedalus wallets can be migrated).

Resolved Issues

  • Wallets disappear from list when their worker dies unexpectedly #1292

Known Issues

  • Icarus wallets are created with Mainnet addresses even if the server is in 'Testnet' mode #1535
  • Force resync = Something went wrong for Jormungandr #1534
  • Cannot force resync wallet and cardano-node crash as a result #1505
  • Submit transaction on staging_shelley gives 500 #1492
  • cardano-node: Cannot send transaction on testnet (cardano-node + cardano-wallet-byron) #1462
  • Windows tests are failing on hydra #1283

Changelog

(ADP-192) Restore from public account key in CLI
PR Description
#1440 more HWWallets CLI tests
(ADP-210) Restore byron wallets from xpriv+passwd hash
PR Description
#1497 Integration test updating wallet name, that is restored from Xprv
#1476 Byron wallet restoration from xprv endpoint integration test
#1456 Distinguish (internally) between legacy and new passphrase encryptions
#1454 Byron wallet restoration from xprv endpoint impl
#1450 Small update of byron restore summary
#1439 Byron wallet restoration from xprv endpoint preparation
(ADP-223, ADP-224) Byron wallet CRUD operations (update-name, update-spending password) and getting UTxO statistics
PR Description
#1520 Fix passphrase conversion when coming from legacy wallets
#1512 report empty legacy passphrase as no passphrase
#1511 Fix passphrase check when coming from empty legacy passphrase
#1495 Update password endpoint for byron
#1486 Update wallet name and utxo statistics for byron
(ADP-229) CLI support for Byron wallet
PR Description
#1493 API endpoints for byron addresses endpoints
#1478 Support for wallet & transactions commands in cardano-wallet-byron
(ADP-97) Nightly syncing tests with Byron TestNet/Mainnet
PR Description
#1507 Store bench node socket in tmp dir
#1499 Fix indentation in nightly.yml
#1498 Add Buildable instance for UTxO Statistics & print from bench
#1482 Re-add old wallet restoration benchmark
#1480 Add cardano-node to "stack --nix test" environment
#1459 Move cardano-node config/launch setup to separate library
Miscellaneous
PR Description
#1529 Bump from 2020.3.16 to 2020.4.1
#1528 update cardano-node matrix
#1524 nix: Update test-suite name to jormungandr-integration
#1523 Sync with libs used by cardano-node-1.9.3
#1518 bump cardano-node's libraries to 1.9.1
#1515 Update cardano-node matrix
#1513 nix: Fix build of cardano-wallet-jormungandr-tests-win64
#1510 bump ntp-client revision to 1.9.1
#1509 Fix fee calculation on Byron
#1508 skip jormungandr integration tests in CI, but enable cardano-node instead
#1506 Update byron launcher and fix integration tests
#1504 Allow serving API through TLS w/ client authentication
#1500 cardano-node: bump to 1.9.1
#1491 Add tracer showing raw binary transaction on submission
#1488 Shutdown handler rework
#1487 nix: add cardano-node configuration to the windows build products
#1485 Revise exception handling in the chain follower to be more resilient
#1484 disable Mux & Chain sync traces
#1481 Fix testnet discrimination and intersection always being genesis
#1475 make NETWORK_BYRON work on cardano-node and jormungandr
#1474 Mark wallet as "not_responding" when underlying workers die
#1473 Use less verbose QuickCheck helpers in tests
#1472 Staging / Temporary
#1451 Bump stack.yaml dependencies to support cardano-node 1.8
#1449 read protocol magic from genesis file instead of command-line option
#1447 Update cardano-node to latest master version
#1441 cardano-wallet server on any arbitrary testnet
#1425 Fix launcher unit tests on windows

Weekly Reports

Documentation

Link Audience
API Documentation Users of the Cardano Wallet API
CLI Manual w/ jormungandr
CLI Manual w/ cardano-node		 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

Installation Instructions

Jormungandr / ITN

  1. Install jormungandr@v0.8.15.

  2. Download the provided cardano-wallet-itn for your platform, and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin. Or %PATH% on Windows.

  3. (optional) Install the bash/zsh auto-completion script according to the jormungandr cli manual

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

Cardano-node / Byron

  1. Install cardano-node@1.9.3.

  2. Download the provided cardano-wallet for your platform, and uncompress it in a directory that is on your $PATH, e.g. /usr/local/bin. Or %PATH% on Windows.

  3. (optional) Install the bash/zsh auto-completion script according to the byron cli manual

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

Additional notes

  • On macOS: Make sure all *.dylib files are in the same directory as cardano-wallet binary.

TroubleShooting

cardano-wallet: error while loading shared libraries: libcrypto.so.1.0.0: cannot open shared object file: No such file or directory

libcrypto 1.0.0 is no longer shipped with RHEL for a while (since ver. 6) and
SuSE. On these distributions, it is impossible to install it using native
package manager (e.g. yum).

One possible work-around is to create an artificial symbolic link from a newer version of libcrypto:

sudo ln -s /usr/lib64/libcrypto.so.1.1.1 /usr/lib64/libcrypto.so.1.0.0

Alternatively, one may also try using the docker image instead.

Docker

  1. ...
Read more
Assets 8
Loading

Jormungandr v0.8.14 hotfixes

16 Mar 11:47
@WilliamKingNoel-Bot WilliamKingNoel-Bot
v2020-03-16
This tag was signed with the committer’s verified signature.
KtorZ Matthias Benkort
GPG key ID: 33173CB6F77F4277
Learn about vigilant mode.
8316bff
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
Jormungandr v0.8.14 hotfixes

Overview

Compatible with Jörmungandr@v0.8.14

Artifact Platform Description
cardano-wallet-jormungandr-linux64-v2020-03-16.tar.gz 
Linux 64-bit
 Linux executable with auto-completion script for bash shell.
cardano-wallet-jormungandr-macos64-v2020-03-16.tar.gz 
MacOs 64-bit
 MacOS executable with required system libraries.
cardano-wallet-jormungandr-win64-v2020-03-16.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
  • Launch wallet against Jörmungandr
  • Get network syncing status
  • List available stake-pools
  • Generate testnet reward credentials from a given mnemonic sentence
  • Get network parameters
  • Manage cryptographic keys
  • ![][new] Create wallet from public account key
  • ![][new] Get NTP (Network Time Protocol) drift offset
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 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
  • Create wallet from public account key
  • 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

  • Unable to retrieve stake-pool list #1442
  • Desirability and apparent performance is inconsistent across machines #1335

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 jormungandr@0.8.14 from the official repository.

  2. Download cardano-wallet-jormungandr-linux64-v2020-03-16.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-16/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.14 from the official repository.

  2. Download cardano-wallet-jormungandr-macos64-v2020-03-16.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.14 from the official repository.

  2. Download cardano-wallet-jormungandr-win64-v2020-03-16.zip and uncompress it in a directory that is on your %PATH%.

Docker

  1. Pull from DockerHub.
$ docker pull inputoutput/cardano-wallet:2020.3.16-jormungandr
  1. Verify the image using the command-line.
$ docker run --rm inputoutput/cardano-wallet:2020.3.16-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
#1437 Add cardano-wallet-byron serve --shutdown-handler option
#1429 Allow serving wallet w/ cardano-node on either testnet or mainnet
(ADP-192) Restore from public account key in CLI
PR Description
#1421 CLI support for account public key restoration
(ADP-193) NTP status via CLI
PR Description
#1438 Better response example in api doc for network/clock
Bug Fixes PR | Description -- | -- #1444 | Store pool retirement certificates + fix stake distribution fetching & combining. #1432 | fix LAUNCH - Restoration workers restart hanging infinitely #1430 | Protect against syncProgress division by zero #1423 | Buildkite: don't cache stack logs

Signatures

Name Role Approval
Matthias Benkort @KtorZ Technical Team Lead ✔️
Piotr Stachyra @piotr-iohk QA Engineer :h...
Read more
Assets 5
Loading

Byron rewrite, new launcher & NTP support

12 Mar 15:07
@WilliamKingNoel-Bot WilliamKingNoel-Bot
v2020-03-11
This tag was signed with the committer’s verified signature.
KtorZ Matthias Benkort
GPG key ID: 33173CB6F77F4277
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
Learn about vigilant mode.
Compare
Choose a tag to compare
Byron rewrite, new launcher & NTP support

Overview

Compatible with Jörmungandr@v0.8.13

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
  • ![][new] Manage cryptographic keys
    • ![][new] Generate root private key from mnemonic sentence
    • ![][new] 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
    • ![][new] Now available for Byron wallets.
  • List known (used or unused) addresses of a wallet
  • API and server logs
  • Estimate transaction fee
    • ![][new] 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
  • ![][new] 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 jormungandr@0.8.13 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 jormungandr@0.8.13 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 jormungandr@0.8.13 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 redoc@2.0.0-rc.23
#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...
Read more
Assets 5
Loading

Experimental cardano-node

17 Feb 15:57
@WilliamKingNoel-Bot WilliamKingNoel-Bot
v2020-02-17
This tag was signed with the committer’s verified signature.
KtorZ Matthias Benkort
GPG key ID: 33173CB6F77F4277
Learn about vigilant mode.
fb51675
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
Experimental cardano-node

Overview

Compatible with Jörmungandr@v0.8.9

Artifact Platform Description
cardano-wallet-jormungandr-linux64-v2020-02-17.tar.gz 
Linux 64-bit
 Linux executable with auto-completion script for bash shell.
cardano-wallet-jormungandr-macos64-v2020-02-17.tar.gz 
MacOs 64-bit
 MacOS executable with required system libraries.
cardano-wallet-jormungandr-win64-v2020-02-17.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
  • ![][new] Get network parameters
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 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
  • ![][new] Get network parameters
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

  • ⚠️ Only Jörmungandr Genesis/Praos node is supported.
  • 🎉 Early experimental support for cardano-node is now available but not considered stable yet.

Bug Fixes

  • persistent library clears foreign tables on automatic migration due to cascading delete #1279

Known Issues

  • Cannot list wallets when using same state directory but different genesis #1292
  • Windows tests are failing on hydra #1283

Installation Instructions

Linux 64-bit

  1. Install jormungandr@0.8.9 from the official repository.

  2. Download cardano-wallet-jormungandr-linux64-v2020-02-17.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-02-17/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.9 from the official repository.

  2. Download cardano-wallet-jormungandr-macos64-v2020-02-17.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.9 from the official repository.

  2. Download cardano-wallet-jormungandr-win64-v2020-02-17.zip and uncompress it in a directory that is on your %PATH%.

Docker

  1. Pull from DockerHub.
$ docker pull inputoutput/cardano-wallet:2020.2.17-jormungandr
  1. Verify the image using the command-line.
$ docker run --rm inputoutput/cardano-wallet:2020.2.17-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
#1352 bump versions to v2020-02-17
#1340 Disable foreign key constraints during automatic database migration.
#1319 Jörmungandr 0.8.9 bump
#1310 Correct link label
#1309 Update compat matrix in Readme.
#1301 Simplify worker registration lifecycle.
(ADP-111) Better reporting of delays in delegation status
PR Description
#1322 Better delegation reporiting - impl
#1318 Better delegation status impl - swagger and types
(ADP-141) Multiple next's support in delegation reporting
PR Description
#1349 Remove pool id path parameter from the quit delegation endpoint
#1337 Correct the delegation certificates DB retrieval logic and move the logic downstream
(ADP-159) Local Tx Submission Integration
PR Description
#1348 LocalTxSubmission real implementation (remove 'localTxSubmissionNull' placeholder)
(ADP-81) Wallet: Command-line utils for key derivation
PR Description
#1343 Introduce SomeMnemonic as source of ...
Read more
Assets 5
Loading

Saturation & Desirability

28 Jan 10:28
@WilliamKingNoel-Bot WilliamKingNoel-Bot
v2020-01-27
23e12d1
Compare
Choose a tag to compare
Saturation & Desirability

Overview

Compatible with Jörmungandr@v0.8.7

Artifact Platform Description
cardano-wallet-jormungandr-linux64-v2020-01-27.tar.gz 
Linux 64-bit
 Linux executable with auto-completion script for bash shell.
cardano-wallet-jormungandr-macos64-v2020-01-27.tar.gz 
MacOs 64-bit
 MacOS executable with required system libraries.
cardano-wallet-jormungandr-win64-v2020-01-27.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
    • ![][new] ordered by desirability
    • ![][new] 'desirability' field returned for each stake-pool
    • ![][new] 'saturation' field returned for each stake-pool
  • Generate testnet reward credentials from a given mnemonic sentence
web server
  • Create and delete wallet
  • ![][new] Force resync Shelley 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
  • ![][new] Force resync Byron wallet
  • 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
    • ![][new] ordered by desirability
    • ![][new] 'desirability' field returned for each stake-pool
    • ![][new] 'saturation' field returned for each stake-pool
  • 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
  • Per-component log management
    • ![][new] Revision on the available tracers

Known Limitations

Bug Fixes

  • Missing database migration for active_slot_coeff #1251
  • "Something went wrong" when listing stake pools from inside a Docker container #1256
  • Failing tests integration tests on Windows #1115
  • Log of severity "DEBUG" shows up as "INFO" #1273
  • Possible missing db migration between balance-check version and latest one #1177
  • Migration failing on Windows due to stake-pools.sqlite lock #1224
  • Rolling back stake pools take ages #1281

Known Issues

  • Cannot list wallets when using same state directory but different genesis #1292
  • Windows tests are failing on hydra #1283
  • persistent library clears foreign tables on automatic migration due to cascading delete #1279

⚠️ Issue #1279 results in the legacy Byron wallets to show 0 balance after upgrading to cardano-wallet v2020-01-27. As a temporary workaround users are advised to remove and restore such wallet again from the mnemonic sentence.

Installation Instructions

Linux 64-bit

  1. Install jormungandr@0.8.7 from the official repository.

  2. Download cardano-wallet-jormungandr-linux64-v2020-01-27.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-27/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.7 from the official repository.

  2. Download cardano-wallet-jormungandr-macos64-v2020-01-27.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.7 from the official repository.

  2. Download cardano-wallet-jormungandr-win64-v2020-01-27.zip and uncompress it in a directory that is on your %PATH%.

Docker

  1. Pull from DockerHub.
$ docker pull inputoutput/cardano-wallet:2020.1.27-jormungandr
  1. Verify the image using the command-line.
$ docker run --rm inputoutput/cardano-wallet:2020.1.27-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

(WB-14) Review API best practices about security
PR Description
#1287 OWASP api security
(WB-31) Allow logs to be filtered by components
PR Description
#1286 document --trace-NAME option and extend doc descriptions
#1282 cardano-wallet-jormungandr: Set default minimum log-level to Debug
#1257 Add integration test for CLI tracer op...
Read more
Assets 5
Loading