Merge remote-tracking branch 'obsidian/v2.2.4' into merge_obsidian_2_2_4
Showing
APDUs.md
0 → 100644
| ... | ... | @@ -90,7 +90,7 @@ restore your key. If you lose your Ledger device or destroy it somehow, you can |
| new one and set it up with the seed phrase from your old one, hence restoring | ||
| your tokens. | ||
| Consequently, is is extremely important that you keep your seed phrase written | ||
| Consequently, it is extremely important that you keep your seed phrase written | ||
| down somewhere safe. Losing it can mean you lose control of your account should | ||
| you, for example, lose your Ledger device. Keeping it somewhere a hacker could find it | ||
| (such as in a file on your internet-connected computer) means your private key | ||
| ... | ... | @@ -120,12 +120,12 @@ technique is that your dun be stored in the passphrase-protected and |
| deniable account, and that you delegate them to a baking account. This | ||
| way, the baking account won't actually store the vast majority of the dun. | ||
| ### Ledger Nano S firmware update | ||
| ### Ledger device firmware update | ||
| To use this app, you must be sure to have [up-to-date | ||
| firmware](https://support.ledgerwallet.com/hc/en-us/articles/360002731113) | ||
| on the Ledger device. This code was tested with version | ||
| 1.5.5. Please use [Ledger | ||
| 1.6.0. Please use [Ledger | ||
| Live](https://www.ledger.com/pages/ledger-live) to do this. | ||
| <!-- | ||
| ... | ... | @@ -143,7 +143,7 @@ If you've used Ledger Live for app installation, you can skip ahead to [Register |
| You should follow the instructions in [`BUILDING.md`](BUILDING.md), and | ||
| [`INSTALL_linux.md`](INSTALL_linux.md) or [`INSTALL_macosx.md`](INSTALL_macosx.md). | ||
| ## Registering the Ledger Nano S with the node | ||
| ## Registering the Ledger device with the node | ||
| For the remainder of this document, we assume you have a Dune node running and | ||
| `dune-client` installed. Also, Docker has some issues working with the Ledger device, | ||
| ... | ... | @@ -196,7 +196,14 @@ encryption system, is indicated by a root key hash, the Dune-specific base58 |
| encoding of the hash of the public key at `44'/1729'` on that Ledger Nano S. Because | ||
| all Dune paths start with this, in `dune-client` commands it is implied. | ||
| ### Importing the key from the Ledger Nano S | ||
| Beginning in version 0.5.0, there is also support for a `ed25519-bip32` derivation | ||
| method, which was made available in V1.5.5 of the Nano firmware. The existing `ed25519` | ||
| operation was purposefully not changed to preserve backwards compatibility. If you do | ||
| nothing, expect no changes. However, it is recommended that all new accounts use the `bip25519` | ||
| command instead of the legacy `ed25519`. After it is imported, the address can be treated | ||
| the same as any other. | ||
| ### Importing the key from the Ledger device | ||
| This section must be done regardless of whether you're going to be baking or | ||
| only using the Dune Wallet application. | ||
| ... | ... | @@ -207,7 +214,7 @@ Please run, with a Dune app open on your device, in whatever mode. |
| $ dune-client list connected ledgers | ||
| ``` | ||
| The output of this command includes three Dune addresses derived from the secret | ||
| The output of this command includes four Dune addresses derived from the secret | ||
| stored on the device, via different signing curves and BIP32 paths. | ||
| ``` | ||
| ... | ... | @@ -217,19 +224,20 @@ running on Ledger Nano S at [0003:000b:00]. |
| To use keys at BIP32 path m/44'/1729'/0'/0' (default Dune key path), use one | ||
| of: | ||
| dune-client import secret key my_ledger "ledger://major-squirrel-thick-hedgehog/ed25519/0'/0'" | ||
| dune-client import secret key my_ledger "ledger://major-squirrel-thick-hedgehog/secp256k1/0'/0'" | ||
| dune-client import secret key my_ledger "ledger://major-squirrel-thick-hedgehog/P-256/0'/0'" | ||
| dune-client import secret key my_ledger "ledger://major-squirrel-thick-hedgehog/bip25519/0h/0h" | ||
| dune-client import secret key my_ledger "ledger://major-squirrel-thick-hedgehog/ed25519/0h/0h" | ||
| dune-client import secret key my_ledger "ledger://major-squirrel-thick-hedgehog/secp256k1/0h/0h" | ||
| dune-client import secret key my_ledger "ledger://major-squirrel-thick-hedgehog/P-256/0h/0h" | ||
| ``` | ||
| These show you how to import keys with a specific signing curve (e.g. `ed25519`) and derivation path (e.g. `/0'/0'`). The | ||
| These show you how to import keys with a specific signing curve (e.g. `bip25519`) and derivation path (e.g. `/0'/0'`). The | ||
| animal-based name (e.g. `major-squirrel-thick-hedgehog`) is a unique identifier for your | ||
| Ledger device enabling the client to distinguish different Ledger devices. This is combined with | ||
| a derivation path (e.g. `/0'/0'`) to indicate one of the possible keys on the Ledger Nano S. Your *root* key is the full identifier without the derivation path (e.g. `major-squirrel-thick-hedgehog/ed25519` by itself) but you should not use the root key directly\*. | ||
| a derivation path (e.g. `/0'/0'`) to indicate one of the possible keys on the Ledger device. Your *root* key is the full identifier without the derivation path (e.g. `major-squirrel-thick-hedgehog/bip25519` by itself) but you should not use the root key directly\*. | ||
| \* *NOTE:* If you have used your root key in the past and need to import it, you can do so by simply running one of the commands but without the last derivation portion. From the example above, you would import your root key by running `dune-client import secret key my_ledger "ledger://major-squirrel-thick-hedgehog/ed25519"`. You should avoid using your root key. | ||
| The Ledger Nano S does not currently support non-hardened path components. All | ||
| The Ledger device does not currently support non-hardened path components. All | ||
| components of all paths must be hardened, which is indicated by following them | ||
| with a `'` character. This character may need to be escaped from the shell | ||
| through backslashes `\` or double-quotes `"`. | ||
| ... | ... | @@ -249,10 +257,10 @@ three things: |
| The `dune-client import secret key` operation copies only the public key; it | ||
| says "import secret key" to indicate that the Ledger hardware wallet's secret key will be | ||
| considered available for signing from them on, but it does not leave the Ledger Nano S. | ||
| considered available for signing from them on, but it does not leave the Ledger device. | ||
| This sends a BIP32 path to the device. You then need to click a button on the | ||
| Ledger device, and the Ledger Nano S then sends the public key back to the computer. | ||
| Ledger device and it sends the public key back to the computer. | ||
| After you perform this step, if you run the `list known addresses` command, you | ||
| should see the key you chose in the list: | ||
| ... | ... | @@ -281,7 +289,7 @@ set up purposes. |
| The sign command for the Wallet Mode prompts every time for transactions | ||
| and other "unsafe" operations, with the generic prompt saying "Sign?" We hope to | ||
| eventually display more transaction details along with this. When block headers | ||
| and endorsements are sent to the Ledger Nano S, they are rejected silently as if the | ||
| and endorsements are sent to the Ledger device, they are rejected silently as if the | ||
| user rejected them. | ||
| ### Faucet (testnet only) | ||
| ... | ... | @@ -319,7 +327,7 @@ $ dune-client get balance for <your-name> |
| ### Transfer | ||
| Now transfer the balance to the account whose key resides on your Ledger Nano S: | ||
| Now transfer the balance to the account whose key resides on your Ledger device: | ||
| ``` | ||
| $ dune-client transfer 66000 from <your-name> to ledger_<...>_ed_0_0 | ||
| ... | ... | @@ -369,7 +377,7 @@ someone. |
| If you want to delegate dun controlled by a Ledger Nano S account to another account to | ||
| bake, that requires the Wallet App. This is distinct from registering the Ledger Nano S | ||
| account itself to bake, which is also called "delegation," and which is covered | ||
| in the section on the baking app below. | ||
| in the section on the baking application below. | ||
| To delegate dun controlled by a Ledger device to someone else, | ||
| you must first originate an account. Please read more | ||
| ... | ... | @@ -388,7 +396,7 @@ $ dune-client originate account <NEW> for <MGR> transferring <QTY> from <SRC> -- |
| * `QTY` is the initial amount of dun to give to the originated account. | ||
| * `SRC` is the account where you'll be getting the dun from. | ||
| Subsequently, every transaction made with `<NEW>` will require the Ledger harware wallet mentioned in `<MGR>` | ||
| Subsequently, every transaction made with `<NEW>` will require the Ledger hardware wallet mentioned in `<MGR>` | ||
| to sign it. This is done with the wallet application, and includes setting a delegate with: | ||
| ``` | ||
| ... | ... | @@ -486,7 +494,7 @@ operation. |
| $ dune-baker-004-Pt24m4xi run with local node ~/.dune-node ledger_<...>_ed_0_0 | ||
| ``` | ||
| This won't actually be able bake successfully yet until you run the rest of | ||
| This won't actually be able to bake successfully yet until you run the rest of | ||
| these setup steps. This will run indefinitely, so you might want to do it in | ||
| a dedicated terminal or in a `tmux` or `screen` session. | ||
| ... | ... | @@ -508,7 +516,7 @@ You need to run a specific command to authorize a key for baking. Once a key is |
| authorized for baking, the user will not have to approve this command again. If | ||
| a key is not authorized for baking, signing endorsements and block headers with | ||
| that key will be rejected. This authorization data is persisted across runs of | ||
| the application, but not across app installations. Only one key can be authorized for baking per Ledger hardware wallet at a | ||
| the application, but not across application installations. Only one key can be authorized for baking per Ledger hardware wallet at a | ||
| time. | ||
| In order to authorize a public key for baking, use the APDU for setting up the ledger device to bake: | ||
| ... | ... | @@ -517,16 +525,16 @@ In order to authorize a public key for baking, use the APDU for setting up the l |
| $ dune-client setup ledger to bake for <ALIAS> | ||
| ``` | ||
| This only authorizes the key for baking on the Ledger Nano S, but does | ||
| This only authorizes the key for baking on the Ledger device, but does | ||
| not inform the blockchain of your intention to bake. This might | ||
| be necessary if you re-install the app, or if you have a different | ||
| be necessary if you reinstall the app, or if you have a different | ||
| paired Ledger device that you are using to bake for the first time. | ||
| ### Registering as a Delegate | ||
| *Note: The ledger device will not sign this operation unless you have already setup the device to bake using the command in the previous section.* | ||
| In order to bake from the Ledger Nano S account you need to register the key as a | ||
| In order to bake from the Ledger device account you need to register the key as a | ||
| delegate. This is formally done by delegating the account to itself. As a | ||
| non-originated account, an account directly stored on the Ledger device can only | ||
| delegate to itself. | ||
| ... | ... | @@ -556,7 +564,7 @@ have been baked so far -- is displayed on the device's screen, and is also |
| persisted between runs of the device. | ||
| The sign operation will be sent to the hardware wallet by the baking daemon when | ||
| configured to bake with a Ledger Nano S key. The Ledger device uses the first byte of the | ||
| configured to bake with a Ledger device key. The Ledger device uses the first byte of the | ||
| information to be signed -- the magic number -- to tell whether it is a block | ||
| header (which is verified with the High Watermark), an endorsement (which is | ||
| not), or some other operation (which it will reject, unless it is a | ||
| ... | ... | @@ -617,7 +625,7 @@ Alternatively, you can also set the High Watermark to the level of the most rece |
| $ dune-client set ledger high watermark for "ledger://<tz...>/" to <HWM> | ||
| ``` | ||
| The later will require the correct URL for the Ledger device acquired from: | ||
| The latter will require the correct URL for the Ledger device acquired from: | ||
| ``` | ||
| $ dune-client list connected ledgers | ||
| ... | ... | @@ -628,7 +636,7 @@ $ dune-client list connected ledgers |
| ### Display Debug Logs | ||
| If you are worried about bugs, you should configure your system to display debug logs. Add the | ||
| following line to `~/.bashrc` and to `~/.bash_profile`, or set the equivalent environnment | ||
| following line to `~/.bashrc` and to `~/.bash_profile`, or set the equivalent environment | ||
| variable in whatever system you use to launch your daemons: | ||
| ``` | ||
| ... | ... | @@ -663,7 +671,7 @@ ledgers at a time. Two Ledger devices of different seeds are fine and are fully |
| and the computer will automatically determine which one to send information to. | ||
| If you have one running the baking app, it is bad for security to also have the wallet app | ||
| plugged in simultaneously. Plug the wallet app in as-needed, removing the baking app, at a time | ||
| plugged in simultaneously. Plug the wallet application in as-needed, removing the baking app, at a time | ||
| when you are not going to be needed for endorsement or baking. Alternatively, use a different | ||
| computer for wallet transactions. | ||
| ... | ... | @@ -694,16 +702,52 @@ to connect to. Please ensure that you are running a node. `ps aux | grep dune-no |
| the process information for the current node. If it displays nothing, or just displays a `grep` | ||
| command, then there is no node running on your machine. | ||
| ### Ledger Nano S App Crashes | ||
| ### Ledger Application Crashes | ||
| If the Ledger Nano S app crashes when you load it, there are two primary causes: | ||
| If the Ledger application crashes when you load it, there are two primary causes: | ||
| * Quitting the `dune-client` process before the device responds. Even if you meant to cancel | ||
| the operation in question, cancel it from the device before pressing Ctrl-C, otherwise you | ||
| might have to restart the Ledger Nano S. | ||
| * Out of date firmware: If the Ledger Nano S app doesn't work at all, make sure you are running firmware | ||
| might have to restart the Ledger device. | ||
| * Out of date firmware: If the Ledger application doesn't work at all, make sure you are running firmware | ||
| version 1.5.5. | ||
| ### Error "Unexpected sequence number (expected 0, got 191)" on macOS | ||
| If `dune-client` on macOS intermittently fails with an error that looks like | ||
| ``` | ||
| client.signer.ledger: APDU level error: Unexpected sequence number (expected 0, got 191) | ||
| ``` | ||
| then your installation of `dune-client` was built with an older version of HIDAPI that doesn't work well with macOS (see [#30](https://github.com/obsidiansystems/ledger-app-tezos/issues/30)). | ||
| To fix this you need to get the yet-unreleased fixes from the [HIDAPI library](https://github.com/signal11/hidapi) and rebuild `tezos-client`. | ||
| If you got HIDAPI from Homebrew, you can update to the `master` branch of HIDAPI like this: | ||
| ```shell | ||
| $ brew install hidapi --HEAD | ||
| ``` | ||
| Then start a full rebuild of `dune-client` with HIDAPI's `master` branch: | ||
| ```shell | ||
| $ brew unlink hidapi # remove the current one | ||
| $ brew install autoconf automake libtool # Just keep installing stuff until the following command succeeds: | ||
| $ brew install hidapi --HEAD | ||
| ``` | ||
| Finally, rebuild `ocaml-hidapi` with Tezos. In the `tezos` repository: | ||
| ```shell | ||
| $ opam reinstall hidapi | ||
| $ make all build-test | ||
| $ ./tezos-client list connected ledgers # should now work consistently | ||
| ``` | ||
| Note that you may still see warnings similar to `Unexpected sequence number (expected 0, got 191)` even after this update. The reason is that there is a separate, more cosmetic, issue in `tezos-client` itself which has already been fixed but may not be in your branch yet (see the [merge request](https://gitlab.com/tezos/tezos/merge_requests/600)). | ||
| ### Contact Us | ||
| You can email us at [email protected] and come to our channel on Discord. |
WELCOME.md
0 → 100644
default.nix
deleted
100644 → 0
michelson_ops.png
0 → 100644
129 KB
| ... | ... | @@ -20,8 +20,14 @@ for arg in "[email protected]"; do |
| echo | ||
| set -x | ||
| appFlag="0x00" | ||
| if [ $target == "nano_x" ]; then | ||
| appFlag="0x240" | ||
| fi | ||
| python -m ledgerblue.loadApp \ | ||
| --appFlags 0x00 \ | ||
| --appFlags "$appFlag" \ | ||
| --dataSize "${nvram_size:?manifest file is missing field}" \ | ||
| --tlv \ | ||
| --curve ed25519 \ | ||
| ... | ... |
src/apdu.c
0 → 100644