Skip to content

doc: Added fundchannel man page. - #1463

Merged
rustyrussell merged 1 commit into
ElementsProject:masterfrom
wythe:man-fundchannel
May 8, 2018
Merged

doc: Added fundchannel man page.#1463
rustyrussell merged 1 commit into
ElementsProject:masterfrom
wythe:man-fundchannel

Conversation

@wythe

@wythe wythe commented May 5, 2018

Copy link
Copy Markdown
Contributor

This describes fundchannel as it works today (as I understand it). #1360

It definitely could use better error codes instead of -1 for everything.

Is there a better way to tell if the channel is ready than the one I described?

@ZmnSCPxj ZmnSCPxj left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Some nits, also request to change formatting slightly.

Comment thread doc/lightning-fundchannel.7.txt Outdated
-----------
The *fundchannel* RPC command opens a payment channel with a peer by commiting
a funding transaction to the blockchain as defined in BOLT #2. Once the
transaction is confirmed, normal channel operations may begin. Readiness is

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggest adding newlines at end of sentence. That way, even if an earlier sentence is later amended, only that sentence needs to be reformatted and later sentences in the same paragraph need not be affected. E.g.

The *fundchannel* RPC command opens a payment channel with a peer by commiting
a funding transaction to the blockchain as defined in BOLT #2.
Once the transaction is confirmed, normal channel operations may begin.
Readiness is indicated by *listfunds* reporting a `short_channel_id` for
the channel.

Then later if we amend it:

The *fundchannel* RPC is a totally radical command that opens a really cool payment
channel with a peer by commiting a funding transaction to the blockchain as defined
in the outrageously awesome BOLT #2.
Once the transaction is confirmed, normal channel operations may begin.
Readiness is indicated by *listfunds* reporting a `short_channel_id` for
the channel.

Comment thread doc/lightning-fundchannel.7.txt Outdated
a funding transaction to the blockchain as defined in BOLT #2. Once the
transaction is confirmed, normal channel operations may begin. Readiness is
indicated by *listfunds* reporting a 'short_channel_id' for the channel.
Channel status can then be monitored using *listchannels*.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

listchannels, despite its name, lists all channels known in the public network, i.e. the entire routemap. Local channels are listed in listpeers.


The above error may include a descriptive message indicating:

* The 'id' is invalid.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yes, we should probably start an effort at some point to give unique error codes for some of the more complex commands. Since it is a JSON-RPC change this will probably have to be done pre-0.6 release too. This is fine for now though; we can update the docs later when we finally have unique error codes.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yeah that's what I was thinking.

This was referenced May 6, 2018
@wythe
wythe force-pushed the man-fundchannel branch from 38bc07f to 21090f7 Compare May 6, 2018 13:25
@cdecker

cdecker commented May 7, 2018

Copy link
Copy Markdown
Member

Should probably also mention that an existing connection is required, and that fundchannel does not attempt to open a connection by itself.

@ZmnSCPxj
ZmnSCPxj dismissed their stale review May 7, 2018 14:30

covered

This describes 'fundchannel' as it works today.

It definitely could use better error codes instead of -1 for everything.
@wythe
wythe force-pushed the man-fundchannel branch from 21090f7 to aa0de20 Compare May 7, 2018 20:48
@rustyrussell

rustyrussell commented May 8, 2018

Copy link
Copy Markdown
Contributor

Ack aa0de20

@rustyrussell
rustyrussell merged commit 9153688 into ElementsProject:master May 8, 2018
@wythe
wythe deleted the man-fundchannel branch May 8, 2018 15:39
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.

5 participants