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

Documentation on macaroons is wrong #5444

Closed
jblachly opened this issue Jun 28, 2021 · 4 comments
Closed

Documentation on macaroons is wrong #5444

jblachly opened this issue Jun 28, 2021 · 4 comments
Labels
beginner Issues suitable for new developers documentation Documentation changes that do not affect code behaviour good first issue Issues suitable for first time contributors to LND macaroons

Comments

@jblachly
Copy link
Contributor

Background

Macaroons are created after wallet creation. However, the documentation in the main installation (https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md) states the following:

Running lnd for the first time will by default generate the admin.macaroon, read_only.macaroon, and macaroons.db files that are used to authenticate into lnd.

As a first-time LND user, I was bitten by this today because I first wanted to run lncli getinfo; it took some searching to realize I had to first run lncli create in order to create the macaroon files.

As you can see, this has confused users for a long time: this old closed issue #1190 which is reflective of the same wrong documentation, had a user post as recently as late 2020.

Your environment

  • version of lnd: v0.13.0-beta
  • Linux hostname 4.15.0-74-generic #84-Ubuntu SMP Thu Dec 19 08:06:28 UTC 2019 x86_64 x86_64 x86_64 GNU/Linux
  • bitcoin-0.18.0

Steps to reproduce

  1. Run lnd for the first time, connecting via RPC to bitcoind
  2. Run lncli getinfo

Expected behaviour

Should not fail with macaroon error

Actual behaviour

Macaroons do not yet exist, which is in direct conflict with the documentation

@guggero
Copy link
Collaborator

guggero commented Jun 28, 2021

Yes, the doc could be improved here. PRs are welcome.

@guggero guggero added documentation Documentation changes that do not affect code behaviour macaroons labels Jun 28, 2021
@Roasbeef Roasbeef added beginner Issues suitable for new developers good first issue Issues suitable for first time contributors to LND labels Aug 31, 2021
@gabbyprecious
Copy link
Contributor

Hi @guggero can I send a quick pr for this?

@tvolk131
Copy link
Contributor

tvolk131 commented May 9, 2022

@guggero this is fixed with #6348, right?

@guggero
Copy link
Collaborator

guggero commented May 9, 2022

Yes, thanks for the reminder, @tvolk131!

Fixed by #6348.

@guggero guggero closed this as completed May 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginner Issues suitable for new developers documentation Documentation changes that do not affect code behaviour good first issue Issues suitable for first time contributors to LND macaroons
Projects
None yet
Development

No branches or pull requests

5 participants