Cardano HW CLI tool for signing transaction
The command-line interface is based on the official Cardano-CLI tool.
Check:
- releases https://github.com/vacuumlabs/cardano-hw-cli/releases
- installation instructions https://github.com/vacuumlabs/cardano-hw-cli/blob/develop/docs/installation.md
For running commands with ledger, you might need to use sudo
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.
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.
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 (so hw cli can match the keys of the change address, if present, and let the device hide it).
--mainnet | --testnet-magic NATURAL Use the mainnet magic id or specify testnet magic id.
--out-file FILE Output filepath of the Tx.
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 (so hw cli can match the keys of the change address, if present, and let the device hide it).
--mainnet | --testnet-magic NATURAL Use the mainnet magic id or specify testnet magic id.
--out-file FILE Output filepath of the Tx.
Verifies whether the tx body file (i.e. raw transaction) complies with restrictions imposed by hardware wallets.
cardano-hw-cli transaction validate-raw
--tx-body-file FILE Input filepath of the raw tx.
Exit code meaning:
0
transaction complies with all restrictions1
an error occured (e.g. the transaction could not be parsed)2
transaction contains validation errrors that cannot be fixed automatically (e.g. too many tx inputs)3
transaction contains validation errrors that can be fixed by runningtransaction transform-raw
(e.g. non-canonical CBOR)
Verifies whether the tx file complies with restrictions imposed by hardware wallets.
cardano-hw-cli transaction validate
--tx-file FILE Input filepath of the tx.
Exit code meaning:
0
transaction complies with all restrictions1
an error occured (e.g. the transaction could not be parsed)2
transaction contains validation errrors that cannot be fixed automatically (e.g. too many tx inputs)3
transaction contains validation errrors that can be fixed by runningtransaction transform
(e.g. non-canonical CBOR)
Tries to non-destructively transform the tx body file (i.e. raw transaction), so that it complies with restrictions imposed by hardware wallets.
cardano-hw-cli transaction transform-raw
--tx-body-file FILE Input filepath of the raw tx.
--out-file FILE Output filepath of the raw tx.
Tries to non-destructively transform the tx file, so that it complies with restrictions imposed by hardware wallets.
cardano-hw-cli transaction transform
--tx-file FILE Input filepath of the tx.
--out-file FILE Output filepath of the tx.
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.
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.
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 ed25519extended.
--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.
see Catalyst voting registration example
cardano-hw-cli transaction policyid
--script-file Path to a native script file
--hw-signing-file Input filepath of the hardware wallet signing file
see Policy id
cardano-hw-cli version
cardano-hw-cli device version
- Basic transaction
- Stake delegation
- Catalyst voting registration
- Stake pool registration
- Public keys bulk export
Install node version v12.19.1
nvm i v12.19.1
Install yarn:
npm install -g yarn
Install dependencies:
yarn install
Run unit test
yarn test-unit
Run application with
yarn dev ...
Install node version v12.19.1
nvm i v12.19.1
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