Skip to content

gitmachtl/cardano-hw-cli

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

219 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cardano HW cli tool

Cardano HW CLI tool for signing transaction

Installation

Check:

Usage

For running commands with ledger, you might need to use sudo

Generate public verification key and hardware wallet signing file

cardano-hw-cli address key-gen
--path PATH                     Derivation path to the key we want to sign with.
--verification-key-file FILE    Output filepath of the verification key.
--hw-signing-file FILE          Output filepath of the hardware wallet signing file.

Arguments can be specified multiple times for bulk export.

Generate public verification key

cardano-hw-cli key verification-key
--hw-signing-file FILE          Input filepath of the hardware wallet signing file.
--verification-key-file FILE    Output filepath of the verification key.

Sign transaction

cardano-hw-cli transaction sign
--tx-body-file FILE                    Input filepath of the TxBody.
--hw-signing-file FILE                 Input filepath of the hardware wallet signing file (one or more).
--change-output-key-file FILE          Input filepath of the hardware wallet signing file.
--mainnet | --testnet-magic NATURAL    Use the mainnet magic id or specify testnet magic id.
--out-file FILE                        Output filepath of the Tx.

Witness transaction

cardano-hw-cli transaction witness
--tx-body-file FILE                    Input filepath of the TxBody.
--hw-signing-file FILE                 Input filepath of the hardware wallet signing file.
--change-output-key-file FILE          Input filepath of the hardware wallet signing file.
--mainnet | --testnet-magic NATURAL    Use the mainnet magic id or specify testnet magic id.
--out-file FILE                        Output filepath of the Tx.

Show address on device

cardano-hw-cli address show 
--payment-path PAYMENTPATH    Payment derivation path.
--staking-path STAKINGPATH    Stake derivation path.
--address-file ADDRESS        Input filepath of the address.

Issue operational certificate

cardano-hw-cli node issue-op-cert
--kes-verification-key-file FILE                  Input filepath of the file with KES vkey.
--operational-certificate-issue-counter FILE      Input filepath of the file with certificate counter.
--kes-period UINT64                               Kes period for the certificate.
--out-file FILE                                   Output filepath for node certificate.
--hw-signing-file FILE                            Input filepath of the hardware wallet signing file.

Catalyst voting registration

cardano-hw-cli catalyst voting-key-registration-metadata
--mainnet | --testnet-magic NATURAL    Use the mainnet magic id or specify testnet magic id.
--vote-public-key FILE                 Input filepath of vote public key in ed25519.
--stake-signing-key FILE               Input filepath of the hardware wallet stake signing file, which will be used to to sign the voting registration.
--reward-address REWARDADDRESS         Staking address which will receive voting rewards.
--nonce NONCE                          Current slot number.
--reward-address-signing-key FILE      Input filepath of the reward address signing files.
--metadata-cbor-out-file FILE          Output filepath of metadata cbor.

Check app version

cardano-hw-cli version

Check device version

cardano-hw-cli device version

Examples

Running from source

Install node version v12.16.2

nvm i v12.16.2

Install yarn:

npm install -g yarn

Install dependencies:

yarn install

Run unit test

yarn test-unit

Run application with

yarn dev ...

Building from source

Install node version v12.16.2

nvm i v12.16.2

Install yarn:

npm install -g yarn

To build all artifacts for each OS run:

yarn build

To target specific artifact, run one of following commands:

yarn build-linux-deb
yarn build-linux-tar
yarn build-windows
yarn build-macos

About

Cardano CLI tool for hardware wallets

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • TypeScript 70.8%
  • JavaScript 24.9%
  • Shell 4.3%