Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an intermediate tuto for baking using a Ledger device #506

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

spalmer25
Copy link

@spalmer25 spalmer25 commented Jan 10, 2025

This PR adds an intermediate tutorial to present how to bake with a Ledger device.

It is presented all steps from the installation of the Ledger baking app of Tezos to security verifications.

Reference: Ledger maintainance announcement for Tezos Bakers

Copy link

vercel bot commented Jan 10, 2025

@spalmer25 is attempting to deploy a commit to the Trili Tech Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

@ajinkyaraj-23 ajinkyaraj-23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will review once again when its complete.


:::note

You won't need `Ledger Live` for the rest of the tutorial.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You dont need to mention this note.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed !


## Download `Tezos Wallet (XTZ)`

The `Tezos Baking` application does not allow you to sign some operations used in this tutorial. You will also need the `Tezos Wallet (XTZ)` application to sign them.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rephrase it like , to sign operations to setup baking you need Tezos wallet app. No need to mention tezos baking does not allow ...

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, indeed. I'll change it.

```

A validation from your Ledger device will be required.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a series of screenshots might help here. Not sure.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes

In a new terminal, run:

```bash
octez-client -R 'tcp://localhost:7732' config update

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this end here? Need to complete the command and some text below

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The command is complete.
I will add an explanatory text below.


In the `Tezos Baking` application, in order to avoid signing blocks or operations that could lead to double-baking, double-attesting or double-preattesting, checks are carried out on the blocks and operations whose signature has been requested.
These verifications require a High Watermark (HWM) to be stored in the RAM of your Ledger device. Saving information in RAM can be slow and can therefore slow down the performance of your device during baking.
You can disable this by disabling the `High Watermark` option in the `Settings` section of the `Tezos Baking` application. However, when this option is no longer active, it becomes possible to sign operations that would lead to double-baking, double-attesting or double-preattesting. You are therefore strongly advised not to deactivate this option if your block and operations provider does not also prevent double-baking, double-attesting and double-preattesting.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a wording we want, also incorrect.
THe HWM is stored in NVRAM (non-volatile memory) .
Refer to the wording i have put in word document.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, I will use the text of the reference doc.

@spalmer25 spalmer25 force-pushed the palmer@functori@tuto-running-baker-with-ledger branch from e91e9b9 to cfd18d4 Compare January 13, 2025 14:54
@spalmer25 spalmer25 marked this pull request as ready for review January 13, 2025 15:39
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`

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How to use an external signer (octez-signer) while running your baker for enhanced protection

docs/tutorials/bake-with-ledger.md Outdated Show resolved Hide resolved
docs/tutorials/bake-with-ledger/install-app.md Outdated Show resolved Hide resolved
docs/tutorials/bake-with-ledger/run-baker.md Outdated Show resolved Hide resolved
docs/tutorials/bake-with-ledger/setup-ledger.md Outdated Show resolved Hide resolved
```

A validation from your Ledger device will be required.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes

docs/tutorials/bake-with-ledger/run-baker.md Outdated Show resolved Hide resolved
docs/tutorials/bake-with-ledger/run-baker.md Outdated Show resolved Hide resolved
docs/tutorials/bake-with-ledger/run-baker.md Outdated Show resolved Hide resolved

:::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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dont give extra information. make it compulsory for the user.

LIne 30 to 36 can be replaced by
"Always reset HWM to highest block value before starting to bake. The highest block can be obtained from Tzkt"

Co-authored-by: Ajinkya  <145996984+ajinkyaraj-23@users.noreply.github.com>
@spalmer25 spalmer25 force-pushed the palmer@functori@tuto-running-baker-with-ledger branch from 9c9a8a9 to 6d92a85 Compare January 14, 2025 15:32
Copy link

@ajinkyaraj-23 ajinkyaraj-23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.
Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants