From ea892fce179c51ed7eb0a7c267655dc0cf312234 Mon Sep 17 00:00:00 2001 From: Joost Jager Date: Thu, 2 Jan 2020 17:32:46 +0100 Subject: [PATCH] channeldb: update UpdateCommitment description This method is only used to update the local commitment transaction. Updated comment accordingly. --- channeldb/channel.go | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/channeldb/channel.go b/channeldb/channel.go index 84e96c8ea..ac21b8178 100644 --- a/channeldb/channel.go +++ b/channeldb/channel.go @@ -1239,11 +1239,11 @@ func syncNewChannel(tx *bbolt.Tx, c *OpenChannel, addrs []net.Addr) error { return putLinkNode(nodeInfoBucket, linkNode) } -// UpdateCommitment updates the commitment state for the specified party -// (remote or local). The commitment stat completely describes the balance -// state at this point in the commitment chain. This method its to be called on -// two occasions: when we revoke our prior commitment state, and when the -// remote party revokes their prior commitment state. +// UpdateCommitment updates the local commitment state. It locks in the pending +// local updates that were received by us from the remote party. The commitment +// state completely describes the balance state at this point in the commitment +// chain. This method its to be called when we revoke our prior commitment +// state. func (c *OpenChannel) UpdateCommitment(newCommitment *ChannelCommitment) error { c.Lock() defer c.Unlock()