Skip to content

Commit

Permalink
fixup! some wording
Browse files Browse the repository at this point in the history
Co-authored-by: Ajinkya  <[email protected]>
  • Loading branch information
spalmer25 and ajinkyaraj-23 committed Jan 14, 2025
1 parent cfd18d4 commit 6d92a85
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 21 deletions.
4 changes: 2 additions & 2 deletions docs/tutorials/bake-with-ledger.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ Keeping your private key on a Ledger device and only interacting with an applica
In this tutorial, we'll look at:
- how to install the Tezos baking application on your Ledger device
- how to configure your Ledger device so that the [Ledger baking application of Tezos](https://github.com/trilitech/ledger-app-tezos-baking) works properly
- how to launch a baker daemon by signing from your Ledger device using `octez-signer`
- how to use an external signer (`octez-signer`) while running your baker for enhanced protection

## Prerequisites

- You need Ledger device.
- To run the Octez daemons persistently, you need a cloud-based computer or a computer that stays running constantly.
- Baker program needs to run constantly, so you need a computer / cloud vm which can run without interruptions.
4 changes: 3 additions & 1 deletion docs/tutorials/bake-with-ledger/install-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ last_update:
---

[`Tezos Baking`](https://github.com/trilitech/ledger-app-tezos-baking) is the application developed to bake on Tezos using your Ledger device.
It allows you to sign block and consensus operations by preventing double-baking, double-attesting and double-pre-attesting. It also prevents the signing of non-baking operations such as transfers, smart-contract calls, etc.
It allows you to sign block and consensus operations while keeping your private keys secure in the Ledger hardware. Some of its additional features are:
1. HWM tracking to avoid double baking
2. Restricted signing permission, i.e. it only allows signing baking related operations. You can not approve signing of funds transfer using baking app on Ledger.

## Download `Ledger Live`

Expand Down
18 changes: 5 additions & 13 deletions docs/tutorials/bake-with-ledger/run-baker.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Now that the Ledger baking key is set up, you can follow the steps of [Run a Tez

## Set up a baker account

While nothing changes for [Step 1: Run an Octez node](/tutorials/join-dal-baker/run-node), this is not the case for [Step 2: Set up a baker account](/tutorials/join-dal-baker/prepare-account).
Complete the [Step 1: Run an Octez node](/tutorials/join-dal-baker/run-node) of the tutorial, and make following changes in [Step 2: Set up a baker account](/tutorials/join-dal-baker/prepare-account).
For this step, you already have a baker! No need to regenerate it, just import it:

```bash
Expand All @@ -18,24 +18,16 @@ For this step, you already have a baker! No need to regenerate it, just import i

> Replace the `tz...` with the public key hash of your Ledger baking key.
To be able to sign the operations you find in this step, you need to use the `Tezos Wallet (XTZ)` application.
To be able to sign the operations you find in **Step 2**, you need to use the `Tezos Wallet (XTZ)` application.
Quit the `Tezos Baking` application and open the `Tezos Wallet (XTZ)` application.

## Before running the Octez baking daemon

You can follow [Step 3: Run an Octez DAL node](/tutorials/join-dal-baker/run-dal-node) without any extra steps. However, before starting [Step 4: Run an Octez baking daemon](/tutorials/join-dal-baker/run-baker), in order to take advantage of the `octez-signer` checks and those of the `Tezos Baking` application, some steps are important.
Complete [Step 3: Run an Octez DAL node](/tutorials/join-dal-baker/run-dal-node). For the [Step 4: Run an Octez baking daemon](/tutorials/join-dal-baker/run-baker), make following changes to setup `octez-signer` and `Tezos Baking` application.

### Setup the Ledger high watermark (HWM)

When the baker daemon will be running, the `Tezos Baking` application will prevent double baking, double-attesting and double pre-attesting.

To initialize the checks made, you can set up the HWM maintained by the application with the block level of the chain for which you will have to start to bake.

:::note Warning

This step is not necessary to be able to bake. However, if the HWM is not initialized, the first level encountered in an operation or block to be signed will be used as the initialization level. For this first operation or block, double baking, double-attesting or double pre-attesting will not be detected. It is therefore **strongly recommended** to at least initialize the HWM with the level of the block at the head of the chain.

:::
For security reason, always reset HWM to highest block value before starting to bake. The highest block can be obtained from [Tzkt](https://www.tzkt.io/blocks?expand=1)

Go back to the `Tezos Baking` application and run:

Expand All @@ -55,7 +47,7 @@ Output:

:::note

The HWM can be set up directly from the setup command:
Alternatively, the HWM can be set up from the setup command:

```bash
octez-signer setup ledger to bake for my_ledger_key --main-hwm <LEVEL>
Expand Down
10 changes: 5 additions & 5 deletions docs/tutorials/bake-with-ledger/setup-ledger.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ last_update:

## Disable PIN lock

The Tezos baking application allows you to sign without you having to intervene. However, for your security, Ledger applications ensure that your Ledger device is unlocked before signing a transaction. You will therefore need to disable the automatic lock on your Ledger device.
The Tezos baking application allows you to bake securely without interruption. However, you will need to disable auto PIN lock feature in the Ledger to avoid getting locked out of the Ledger. Otherwise the Ledger device will lock itself and baking app will not work.

:::note Warning

Disabling the automatic lock on your Ledger device would allow someone with access to your Ledger unlock device to access the funds on your wallet.
The Tezos baking application only allows you to sign baking-related transactions and requires a PIN code to exit the application. The risks are therefore limited with this application. However, remember to **reactivate the automatic lock on your Ledger device if you stop using the Tezos baking application**.
Disabling the automatic lock on your Ledger device poses a risk that if any other app except baking-app is left open on your device, someone could get access to your funds by using that Ledger if left unattended.
The Tezos baking application is extremely secure and it only allows you to sign baking-related transactions and requires a PIN code to exit the application. However, remember to **reactivate the automatic lock on your Ledger device if you stop using the Tezos baking application on this device**.

:::

Expand All @@ -24,7 +24,7 @@ Go to the settings of your Ledger device and search for the automatic PIN lock o

In order to preserve the performance and integrity of your Ledger device, it is **strongly recommended** to activate the screen saver of your Ledger device. Go to the settings of your Ledger device and look for the screen saver option, then activate it for a value that suits you.
- For Nanos, Nanos+ and Nanox devices, go to `Settings` then `Security` and finally `Screen saver`.
- For Stax and Flex devices, there is no screen saver.
- For Stax and Flex devices, there is no screen saver as of writing this article (Jan 25).

## HWM option

Expand All @@ -37,4 +37,4 @@ In case of an abrupt interruption of the Ledger `Tezos Baking` application, e.g.

:::

In this tutorial we will use `octez-signer`, which keeps an HWM and prevents your Ledger device from signing blocks or operations that could lead to double-baking, double-attesting or double-preattesting, so it is possible to disable the option.
For additional protection from double-baking, we will demonstrate use of external signer (`octez-signer`), which keeps track of HWM and prevents double baking. Its recommended to use this external signer, when you disable the HWM feature on your Ledger device.

0 comments on commit 6d92a85

Please sign in to comment.