Add optional close address #3702

carlaKC · 2019-11-11T08:36:41Z

This PR adds a delivery_address field to lnrpc and lncli's CloseChannel request which allows users to specify an address to close out to on cooperative closure of a channel. If an upfront shutdown address was set on channel open, requesting to close the channel out to a specific address will fail.

This PR replaces #1462.

This PR is rebased on the open upfront shutdown PR #3655, as much of the logic is shared.
Only the last 3 commits in this PR are relevant for review.

joostjager · 2019-11-12T07:16:17Z

Needs rebase

lnrpc/rpc.swagger.json

bhandras

Really nice PR!

htlcswitch/switch.go

chancloser.go

bhandras · 2019-11-14T16:11:11Z

chancloser.go

+// checkRemoteDeliveryAddress checks that the address provided by the remote
+// peer matches the upfront shutdown address, if it is set. It does not perform
+// any validation on the address provided.
+func checkRemoteDeliveryAddress(upfront, address lnwire.DeliveryAddress) error {


I'd probably call this function sg like: Matches and maybe move it under lnwire.DeliveryAddress (and add a unit test). WDYT?

+1 for the unit test, see comment below for context on this check :)

bhandras · 2019-11-14T16:11:55Z

chancloser.go

+// any validation on the address provided.
+func checkRemoteDeliveryAddress(upfront, address lnwire.DeliveryAddress) error {
+	// If an upfront shutdown address is empty, return early.
+	if len(upfront) == 0 {


Does this check add anything (if yes: should emptyness checked for address)

So here we are checking whether the address our peer has provided matches the pre-negotiated upfront address. There are two cases:

They did not negotiate an upfront address (it's an optional feature), so we do not need to enforce close out to a specific address

They did negotiate an upfront address, and we need to check that they're sticking to it; if not, we need to disconnect as per the spec's instruction because they may be comporomised

chancloser_test.go

fundingmanager_test.go

bhandras · 2019-11-14T17:00:52Z

lnwallet/reservation.go

+	r.Lock()
+	defer r.Unlock()
+
+	r.ourContribution.UpfrontShutdown = shutdown


nit: As a reader it's really confusing to me that sometimes it's Shutdown, sometimes ShutdownScript. I guess this is because I'm not familiar with the code base yet.

That's an inconsistency on my side, trying to keep var names brief. I'll settle on one or the other,

lnwire/accept_channel_test.go

lnwire/shutdown.go

peer_test.go

carlaKC · 2019-11-19T08:46:57Z

Thanks for the review @bhandras!
Since this PR is rebased on #3655, only the last two commits are relevant for review in this PR, sorry for not making that clearer! I'm not going to reply to the comments on the original PR commits, because that's going to add noise to this PR, but I will address them on 3655.

rpcserver.go

carlaKC · 2019-11-20T10:00:46Z

Updated to address comments and rebased on #3655.

bhandras · 2019-11-26T14:56:33Z

channeldb/channel.go

+
+	// Finally, add optional shutdown scripts for the local and remote peer if
+	// they are present.
+	if err := putOptionalUpfrontShutdownScript(


After taking a closer look, it's always inside a Bolt transaction and therefore atomic.

lnrpc/rpc.swagger.json

bhandras · 2019-11-26T15:04:57Z

fundingmanager.go

+			if err != nil {
+				return nil, err
+			}
+			return txscript.PayToAddrScript(addr)


Duh :) Sorry, didn't pay attention to what txscropt.PayToAddrScript(addr) returns :)

carlaKC · 2019-12-03T09:44:42Z

Rebased, but going to hold off on review for this one until parent PR is in.

bhandras

Only nits, other than these: LGTM 💯

lnrpc/rpc.proto

chancloser.go

rpcserver.go

server.go

wpaulino

Nice to finally have this land! Just a few nits from me, also needs a rebase due to a proto conflict.

EDIT: I think it'd be nice to give the original author of the PR credit in the other commits as well.

cmd/lncli/commands.go

htlcswitch/switch.go

peer.go

peer_test.go

rpcserver.go

server.go

@Bluetegu

This commit is adapted from @Bluetegu's original pull request lightningnetwork#1462.

@Bluetegu

This commit is adapted from @Bluetegu's original pull request lightningnetwork#1462.

@Bluetegu

This commit is adapted from @Bluetegu's original pull request lightningnetwork#1462. This commit reads an optional address to pay funds out to from a user iniitiated close channel address. If the channel already has a shutdown script set, the request will fail if an address is provided. Otherwise, the cooperative close will pay out to the address provided.

carlaKC · 2019-12-10T10:14:25Z

Rebased to clear proto conflicts :)

carlaKC requested review from cfromknecht, halseth, Roasbeef and wpaulino as code owners November 11, 2019 08:36

carlaKC removed request for Roasbeef and wpaulino November 11, 2019 08:37

carlaKC added the v0.9.0 label Nov 11, 2019

carlaKC mentioned this pull request Nov 11, 2019

Add optional delivery address to cooperative channel close #1462

Closed

joostjager added this to the 0.9.0 milestone Nov 12, 2019

carlaKC force-pushed the lnrpc-addcloseaddress branch from 30168ae to 377e730 Compare November 12, 2019 15:53

Roasbeef requested review from bhandras and removed request for cfromknecht November 13, 2019 03:36

bhandras reviewed Nov 14, 2019

View reviewed changes

lnrpc/rpc.swagger.json Outdated Show resolved Hide resolved

bhandras reviewed Nov 14, 2019

View reviewed changes

carlaKC force-pushed the lnrpc-addcloseaddress branch from 377e730 to 38acea3 Compare November 20, 2019 09:55

carlaKC commented Nov 20, 2019

View reviewed changes

rpcserver.go Outdated Show resolved Hide resolved

halseth requested a review from bhandras November 21, 2019 13:40

bhandras requested changes Nov 26, 2019

View reviewed changes

carlaKC force-pushed the lnrpc-addcloseaddress branch from 38acea3 to ee36c82 Compare December 3, 2019 09:44

carlaKC force-pushed the lnrpc-addcloseaddress branch from ee36c82 to c128b6b Compare December 5, 2019 10:53

carlaKC requested a review from bhandras December 5, 2019 10:58

bhandras requested changes Dec 5, 2019

View reviewed changes

lnrpc/rpc.proto Outdated Show resolved Hide resolved

chancloser.go Show resolved Hide resolved

rpcserver.go Outdated Show resolved Hide resolved

server.go Show resolved Hide resolved

Roasbeef requested review from wpaulino and removed request for halseth December 5, 2019 18:48

wpaulino suggested changes Dec 5, 2019

View reviewed changes

cmd/lncli/commands.go Outdated Show resolved Hide resolved

htlcswitch/switch.go Outdated Show resolved Hide resolved

peer.go Outdated Show resolved Hide resolved

peer_test.go Outdated Show resolved Hide resolved

carlaKC force-pushed the lnrpc-addcloseaddress branch 3 times, most recently from e1b0b81 to 3ff4ba9 Compare December 6, 2019 14:09

wpaulino approved these changes Dec 6, 2019

View reviewed changes

carlaKC requested a review from bhandras December 8, 2019 12:57

halseth reviewed Dec 9, 2019

View reviewed changes

rpcserver.go Outdated Show resolved Hide resolved

server.go Show resolved Hide resolved

bhandras approved these changes Dec 9, 2019

View reviewed changes

carlaKC force-pushed the lnrpc-addcloseaddress branch from 3ff4ba9 to 6b3280c Compare December 9, 2019 13:51

Bluetegu and others added 3 commits December 10, 2019 09:12

lnrpc: Add optional delivery addresss to close channel

25caece

This commit is adapted from @Bluetegu's original pull request lightningnetwork#1462.

lncli: Add optional delivery address to close channel

ef4d933

This commit is adapted from @Bluetegu's original pull request lightningnetwork#1462.

carlaKC force-pushed the lnrpc-addcloseaddress branch from 6b3280c to 94d3eb6 Compare December 10, 2019 07:13

wpaulino merged commit 3c6be62 into lightningnetwork:master Dec 10, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add optional close address #3702

Add optional close address #3702

carlaKC commented Nov 11, 2019 •

edited

Loading

joostjager commented Nov 12, 2019

bhandras left a comment

bhandras Nov 14, 2019

carlaKC Nov 19, 2019

bhandras Nov 14, 2019

carlaKC Nov 19, 2019

bhandras Nov 14, 2019

carlaKC Nov 19, 2019

carlaKC commented Nov 19, 2019

carlaKC commented Nov 20, 2019

bhandras Nov 26, 2019

bhandras Nov 26, 2019

carlaKC commented Dec 3, 2019

bhandras left a comment

wpaulino left a comment •

edited

Loading

carlaKC commented Dec 10, 2019

Add optional close address #3702

Add optional close address #3702

Conversation

carlaKC commented Nov 11, 2019 • edited Loading

joostjager commented Nov 12, 2019

bhandras left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

carlaKC commented Nov 19, 2019

carlaKC commented Nov 20, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

carlaKC commented Dec 3, 2019

bhandras left a comment

Choose a reason for hiding this comment

wpaulino left a comment • edited Loading

Choose a reason for hiding this comment

carlaKC commented Dec 10, 2019

carlaKC commented Nov 11, 2019 •

edited

Loading

wpaulino left a comment •

edited

Loading