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

Wrong description/name for openchannel local_amt #1259

Closed
C-Otto opened this issue May 18, 2018 · 3 comments
Closed

Wrong description/name for openchannel local_amt #1259

C-Otto opened this issue May 18, 2018 · 3 comments
Labels
beginner Issues suitable for new developers documentation Documentation changes that do not affect code behaviour

Comments

@C-Otto
Copy link
Contributor

C-Otto commented May 18, 2018

When I open a channel using openchannel, the amount given as local_amt is the whole channel capacity. In other words, the push_amt is included in this amount. Instead, I expect the parameter to be named channel_capacity or similar.

When the channel is opened successfuly, the original local_amt is shown as capacity, while local_balance is whatever remains after deducting push_amt/remote_balance and fees/reserve.

Your environment

  • lnd version 0.4.1-beta commit=28b12116e42c83149b6c6b93b70d669a0702bd2d
  • Linux ftp 4.9.0-3-amd64 Fix name typo in README #1 SMP Debian 4.9.30-2+deb9u2 (2017-06-26) x86_64 GNU/Linux
  • Bitcoin Core 0.16.0
@Roasbeef
Copy link
Member

If you look at lncli openchannel -h, the local_amt is the total amount that you wish to commit to the channel. Optionally, you can push a portion of that amount immediately to the remote party. capacity = local_amt + push_amt. The fee is variable, and the reserve is a fixed amount that cannot be used.

@C-Otto
Copy link
Contributor Author

C-Otto commented May 18, 2018

Yes, that part of the help text is quite accurate (the name, however, is misleading). I also see this:

The channel will be initialized with local-amt satoshis local and push-amt
satoshis for the remote node.

I'd say the part "local-amt satoshis local" is, at least, misleading.

@Roasbeef Roasbeef added the documentation Documentation changes that do not affect code behaviour label May 26, 2018
@C-Otto
Copy link
Contributor Author

C-Otto commented Jun 13, 2018

Please re-open. The referenced commit does not clarify the confusion about local_amt (which actually is the channel capacity).

@halseth halseth reopened this Jun 18, 2018
@halseth halseth added the beginner Issues suitable for new developers label Jun 18, 2018
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
Projects
None yet
Development

No branches or pull requests

3 participants