From 386d54d59428bc5f63a3153880fc893cc1e76b1d Mon Sep 17 00:00:00 2001 From: moisses89 <7888669+moisses89@users.noreply.github.com> Date: Thu, 26 Oct 2023 15:16:39 +0200 Subject: [PATCH] Add ledger module documentation --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index f456ac3d..9cdd0695 100644 --- a/README.md +++ b/README.md @@ -121,7 +121,20 @@ the information about the Safe using: ``` > refresh ``` +## Ledger module +Ledger module is an optional feature of safe-cli to sign transactions with the help of [ledgereth](https://github.com/mikeshultz/ledger-eth-lib) library based on [ledgerblue](https://github.com/LedgerHQ/blue-loader-python). +To enable, safe-cli must be installed as follows: +``` +pip install safe-cli[ledger] +``` +When running on Linux, make sure the following rules have been added to `/etc/udev/rules.d/`: +```commandline +SUBSYSTEMS=="usb", ATTRS{idVendor}=="2c97", ATTRS{idProduct}=="0000", MODE="0660", TAG+="uaccess", TAG+="udev-acl" OWNER="" +SUBSYSTEMS=="usb", ATTRS{idVendor}=="2c97", ATTRS{idProduct}=="0001", MODE="0660", TAG+="uaccess", TAG+="udev-acl" OWNER="" +SUBSYSTEMS=="usb", ATTRS{idVendor}=="2c97", ATTRS{idProduct}=="0004", MODE="0660", TAG+="uaccess", TAG+="udev-acl" OWNER="" +``` +**NOTE**: before to sign anything ensure that the sign data proposed on ledger is the same than the safe-cli data. ## Creating a new Safe Use `safe-creator --owners --threshold --salt-nonce `.