mirror of
https://github.com/lightningnetwork/lnd.git
synced 2025-02-23 14:40:30 +01:00
funding: replace fundingLocked found in docs
This commit is created by running,
```shell
find . -name "*.go" -exec sed -i '' 's/fundingLocked/channelReady/g' {} \;
```
This commit is contained in:
yyforyongyu
parent
465285efb8
commit
d4ad5f362f
2 changed files with 51 additions and 51 deletions
|
|
@ -377,7 +377,7 @@ type Config struct {
|
|||
|
||||
// NotifyWhenOnline allows the FundingManager to register with a
|
||||
// subsystem that will notify it when the peer comes online. This is
|
||||
// used when sending the fundingLocked message, since it MUST be
|
||||
// used when sending the channelReady message, since it MUST be
|
||||
// delivered after the funding transaction is confirmed.
|
||||
//
|
||||
// NOTE: The peerChan channel must be buffered.
|
||||
|
|
@ -584,18 +584,18 @@ type channelOpeningState uint8
|
|||
|
||||
const (
|
||||
// markedOpen is the opening state of a channel if the funding
|
||||
// transaction is confirmed on-chain, but fundingLocked is not yet
|
||||
// transaction is confirmed on-chain, but channelReady is not yet
|
||||
// successfully sent to the other peer.
|
||||
markedOpen channelOpeningState = iota
|
||||
|
||||
// fundingLockedSent is the opening state of a channel if the
|
||||
// fundingLocked message has successfully been sent to the other peer,
|
||||
// channelReadySent is the opening state of a channel if the
|
||||
// channelReady message has successfully been sent to the other peer,
|
||||
// but we still haven't announced the channel to the network.
|
||||
channelReadySent
|
||||
|
||||
// addedToRouterGraph is the opening state of a channel if the
|
||||
// channel has been successfully added to the router graph
|
||||
// immediately after the fundingLocked message has been sent, but
|
||||
// immediately after the channelReady message has been sent, but
|
||||
// we still haven't announced the channel to the network.
|
||||
addedToRouterGraph
|
||||
)
|
||||
|
|
@ -1000,7 +1000,7 @@ func (f *Manager) stateStep(channel *channeldb.OpenChannel,
|
|||
|
||||
switch channelState {
|
||||
// The funding transaction was confirmed, but we did not successfully
|
||||
// send the fundingLocked message to the peer, so let's do that now.
|
||||
// send the channelReady message to the peer, so let's do that now.
|
||||
case markedOpen:
|
||||
err := f.sendChannelReady(channel, lnChannel)
|
||||
if err != nil {
|
||||
|
|
@ -1008,7 +1008,7 @@ func (f *Manager) stateStep(channel *channeldb.OpenChannel,
|
|||
err)
|
||||
}
|
||||
|
||||
// As the fundingLocked message is now sent to the peer, the
|
||||
// As the channelReady message is now sent to the peer, the
|
||||
// channel is moved to the next state of the state machine. It
|
||||
// will be moved to the last state (actually deleted from the
|
||||
// database) after the channel is finally announced.
|
||||
|
|
@ -1026,7 +1026,7 @@ func (f *Manager) stateStep(channel *channeldb.OpenChannel,
|
|||
|
||||
return nil
|
||||
|
||||
// fundingLocked was sent to peer, but the channel was not added to the
|
||||
// channelReady was sent to peer, but the channel was not added to the
|
||||
// router graph and the channel announcement was not sent.
|
||||
case channelReadySent:
|
||||
// We must wait until we've received the peer's funding locked
|
||||
|
|
@ -2890,7 +2890,7 @@ func (f *Manager) handleFundingConfirmation(
|
|||
return nil
|
||||
}
|
||||
|
||||
// sendChannelReady creates and sends the fundingLocked message.
|
||||
// sendChannelReady creates and sends the channelReady message.
|
||||
// This should be called after the funding transaction has been confirmed,
|
||||
// and the channelState is 'markedOpen'.
|
||||
func (f *Manager) sendChannelReady(completeChan *channeldb.OpenChannel,
|
||||
|
|
@ -2930,15 +2930,15 @@ func (f *Manager) sendChannelReady(completeChan *channeldb.OpenChannel,
|
|||
}
|
||||
|
||||
// If the peer has disconnected before we reach this point, we will need
|
||||
// to wait for him to come back online before sending the fundingLocked
|
||||
// message. This is special for fundingLocked, since failing to send any
|
||||
// to wait for him to come back online before sending the channelReady
|
||||
// message. This is special for channelReady, since failing to send any
|
||||
// of the previous messages in the funding flow just cancels the flow.
|
||||
// But now the funding transaction is confirmed, the channel is open
|
||||
// and we have to make sure the peer gets the fundingLocked message when
|
||||
// and we have to make sure the peer gets the channelReady message when
|
||||
// it comes back online. This is also crucial during restart of lnd,
|
||||
// where we might try to resend the fundingLocked message before the
|
||||
// where we might try to resend the channelReady message before the
|
||||
// server has had the time to connect to the peer. We keep trying to
|
||||
// send fundingLocked until we succeed, or the fundingManager is shut
|
||||
// send channelReady until we succeed, or the fundingManager is shut
|
||||
// down.
|
||||
for {
|
||||
peer, err := f.waitForPeerOnline(completeChan.IdentityPub)
|
||||
|
|
@ -3140,7 +3140,7 @@ func (f *Manager) addToRouterGraph(completeChan *channeldb.OpenChannel,
|
|||
}
|
||||
|
||||
// annAfterSixConfs broadcasts the necessary channel announcement messages to
|
||||
// the network after 6 confs. Should be called after the fundingLocked message
|
||||
// the network after 6 confs. Should be called after the channelReady message
|
||||
// is sent and the channel is added to the router graph (channelState is
|
||||
// 'addedToRouterGraph') and the channel is ready to be used. This is the last
|
||||
// step in the channel opening process, and the opening state will be deleted
|
||||
|
|
@ -3412,7 +3412,7 @@ func (f *Manager) handleChannelReady(peer lnpeer.Peer,
|
|||
return
|
||||
}
|
||||
|
||||
// If not already handling fundingLocked for this channel, set up
|
||||
// If not already handling channelReady for this channel, set up
|
||||
// barrier, and move on.
|
||||
f.handleChannelReadyBarriers[msg.ChanID] = struct{}{}
|
||||
f.handleChannelReadyMtx.Unlock()
|
||||
|
|
@ -3532,7 +3532,7 @@ func (f *Manager) handleChannelReady(peer lnpeer.Peer,
|
|||
}
|
||||
|
||||
// If the RemoteNextRevocation is non-nil, it means that we have
|
||||
// already processed fundingLocked for this channel, so ignore. This
|
||||
// already processed channelReady for this channel, so ignore. This
|
||||
// check is after the alias logic so we store the peer's most recent
|
||||
// alias. The spec requires us to validate that subsequent
|
||||
// channel_ready messages use the same per commitment point (the
|
||||
|
|
|
|||
|
|
@ -1405,7 +1405,7 @@ func TestFundingManagerNormalWorkflow(t *testing.T) {
|
|||
assertMarkedOpen(t, alice, bob, fundingOutPoint)
|
||||
|
||||
// After the funding transaction is mined, Alice will send
|
||||
// fundingLocked to Bob.
|
||||
// channelReady to Bob.
|
||||
channelReadyAlice := assertFundingMsgSent(
|
||||
t, alice.msgChan, "ChannelReady",
|
||||
).(*lnwire.ChannelReady)
|
||||
|
|
@ -1418,7 +1418,7 @@ func TestFundingManagerNormalWorkflow(t *testing.T) {
|
|||
// Check that the state machine is updated accordingly
|
||||
assertChannelReadySent(t, alice, bob, fundingOutPoint)
|
||||
|
||||
// Exchange the fundingLocked messages.
|
||||
// Exchange the channelReady messages.
|
||||
alice.fundingMgr.ProcessFundingMsg(channelReadyBob, bob)
|
||||
bob.fundingMgr.ProcessFundingMsg(channelReadyAlice, alice)
|
||||
|
||||
|
|
@ -1635,7 +1635,7 @@ func TestFundingManagerRestartBehavior(t *testing.T) {
|
|||
)
|
||||
|
||||
// After the funding transaction gets mined, both nodes will send the
|
||||
// fundingLocked message to the other peer. If the funding node fails
|
||||
// channelReady message to the other peer. If the funding node fails
|
||||
// before this message has been successfully sent, it should retry
|
||||
// sending it on restart. We mimic this behavior by letting the
|
||||
// SendToPeer method return an error, as if the message was not
|
||||
|
|
@ -1666,7 +1666,7 @@ func TestFundingManagerRestartBehavior(t *testing.T) {
|
|||
assertMarkedOpen(t, alice, bob, fundingOutPoint)
|
||||
|
||||
// After the funding transaction was mined, Bob should have successfully
|
||||
// sent the fundingLocked message, while Alice failed sending it. In
|
||||
// sent the channelReady message, while Alice failed sending it. In
|
||||
// Alice's case this means that there should be no messages for Bob, and
|
||||
// the channel should still be in state 'markedOpen'
|
||||
select {
|
||||
|
|
@ -1684,11 +1684,11 @@ func TestFundingManagerRestartBehavior(t *testing.T) {
|
|||
// Alice should still be markedOpen
|
||||
assertDatabaseState(t, alice, fundingOutPoint, markedOpen)
|
||||
|
||||
// While Bob successfully sent fundingLocked.
|
||||
// While Bob successfully sent channelReady.
|
||||
assertDatabaseState(t, bob, fundingOutPoint, channelReadySent)
|
||||
|
||||
// We now recreate Alice's fundingManager with the correct sendMessage
|
||||
// implementation, and expect it to retry sending the fundingLocked
|
||||
// implementation, and expect it to retry sending the channelReady
|
||||
// message. We'll explicitly shut down Alice's funding manager to
|
||||
// prevent a race when overriding the sendMessage implementation.
|
||||
if err := alice.fundingMgr.Stop(); err != nil {
|
||||
|
|
@ -1710,7 +1710,7 @@ func TestFundingManagerRestartBehavior(t *testing.T) {
|
|||
t, alice.msgChan, "ChannelReady",
|
||||
).(*lnwire.ChannelReady)
|
||||
|
||||
// The state should now be fundingLockedSent
|
||||
// The state should now be channelReadySent
|
||||
assertDatabaseState(t, alice, fundingOutPoint, channelReadySent)
|
||||
|
||||
// Check that the channel announcements were never sent
|
||||
|
|
@ -1722,7 +1722,7 @@ func TestFundingManagerRestartBehavior(t *testing.T) {
|
|||
// Expected
|
||||
}
|
||||
|
||||
// Exchange the fundingLocked messages.
|
||||
// Exchange the channelReady messages.
|
||||
alice.fundingMgr.ProcessFundingMsg(channelReadyBob, bob)
|
||||
bob.fundingMgr.ProcessFundingMsg(channelReadyAlice, alice)
|
||||
|
||||
|
|
@ -1771,7 +1771,7 @@ func TestFundingManagerRestartBehavior(t *testing.T) {
|
|||
|
||||
// TestFundingManagerOfflinePeer checks that the fundingManager waits for the
|
||||
// server to notify when the peer comes online, in case sending the
|
||||
// fundingLocked message fails the first time.
|
||||
// channelReady message fails the first time.
|
||||
func TestFundingManagerOfflinePeer(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
|
|
@ -1791,8 +1791,8 @@ func TestFundingManagerOfflinePeer(t *testing.T) {
|
|||
)
|
||||
|
||||
// After the funding transaction gets mined, both nodes will send the
|
||||
// fundingLocked message to the other peer. If the funding node fails
|
||||
// to send the fundingLocked message to the peer, it should wait for
|
||||
// channelReady message to the other peer. If the funding node fails
|
||||
// to send the channelReady message to the peer, it should wait for
|
||||
// the server to notify it that the peer is back online, and try again.
|
||||
// We'll save the current implementation of sendMessage to restore the
|
||||
// original behavior later on.
|
||||
|
|
@ -1823,7 +1823,7 @@ func TestFundingManagerOfflinePeer(t *testing.T) {
|
|||
assertMarkedOpen(t, alice, bob, fundingOutPoint)
|
||||
|
||||
// After the funding transaction was mined, Bob should have successfully
|
||||
// sent the fundingLocked message, while Alice failed sending it. In
|
||||
// sent the channelReady message, while Alice failed sending it. In
|
||||
// Alice's case this means that there should be no messages for Bob, and
|
||||
// the channel should still be in state 'markedOpen'
|
||||
select {
|
||||
|
|
@ -1841,7 +1841,7 @@ func TestFundingManagerOfflinePeer(t *testing.T) {
|
|||
// Alice should still be markedOpen
|
||||
assertDatabaseState(t, alice, fundingOutPoint, markedOpen)
|
||||
|
||||
// While Bob successfully sent fundingLocked.
|
||||
// While Bob successfully sent channelReady.
|
||||
assertDatabaseState(t, bob, fundingOutPoint, channelReadySent)
|
||||
|
||||
// Alice should be waiting for the server to notify when Bob comes back
|
||||
|
|
@ -1881,15 +1881,15 @@ func TestFundingManagerOfflinePeer(t *testing.T) {
|
|||
bob.sendMessage = workingSendMessage
|
||||
con <- bob
|
||||
|
||||
// This should make Alice send the fundingLocked.
|
||||
// This should make Alice send the channelReady.
|
||||
channelReadyAlice := assertFundingMsgSent(
|
||||
t, alice.msgChan, "ChannelReady",
|
||||
).(*lnwire.ChannelReady)
|
||||
|
||||
// The state should now be fundingLockedSent
|
||||
// The state should now be channelReadySent
|
||||
assertDatabaseState(t, alice, fundingOutPoint, channelReadySent)
|
||||
|
||||
// Exchange the fundingLocked messages.
|
||||
// Exchange the channelReady messages.
|
||||
alice.fundingMgr.ProcessFundingMsg(channelReadyBob, bob)
|
||||
bob.fundingMgr.ProcessFundingMsg(channelReadyAlice, alice)
|
||||
|
||||
|
|
@ -2273,7 +2273,7 @@ func TestFundingManagerFundingNotTimeoutInitiator(t *testing.T) {
|
|||
}
|
||||
|
||||
// TestFundingManagerReceiveChannelReadyTwice checks that the fundingManager
|
||||
// continues to operate as expected in case we receive a duplicate fundingLocked
|
||||
// continues to operate as expected in case we receive a duplicate channelReady
|
||||
// message.
|
||||
func TestFundingManagerReceiveChannelReadyTwice(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
|
@ -2310,7 +2310,7 @@ func TestFundingManagerReceiveChannelReadyTwice(t *testing.T) {
|
|||
assertMarkedOpen(t, alice, bob, fundingOutPoint)
|
||||
|
||||
// After the funding transaction is mined, Alice will send
|
||||
// fundingLocked to Bob.
|
||||
// channelReady to Bob.
|
||||
channelReadyAlice := assertFundingMsgSent(
|
||||
t, alice.msgChan, "ChannelReady",
|
||||
).(*lnwire.ChannelReady)
|
||||
|
|
@ -2323,7 +2323,7 @@ func TestFundingManagerReceiveChannelReadyTwice(t *testing.T) {
|
|||
// Check that the state machine is updated accordingly
|
||||
assertChannelReadySent(t, alice, bob, fundingOutPoint)
|
||||
|
||||
// Send the fundingLocked message twice to Alice, and once to Bob.
|
||||
// Send the channelReady message twice to Alice, and once to Bob.
|
||||
alice.fundingMgr.ProcessFundingMsg(channelReadyBob, bob)
|
||||
alice.fundingMgr.ProcessFundingMsg(channelReadyBob, bob)
|
||||
bob.fundingMgr.ProcessFundingMsg(channelReadyAlice, alice)
|
||||
|
|
@ -2341,7 +2341,7 @@ func TestFundingManagerReceiveChannelReadyTwice(t *testing.T) {
|
|||
// Expected
|
||||
}
|
||||
|
||||
// Another fundingLocked should also be ignored, since Alice should
|
||||
// Another channelReady should also be ignored, since Alice should
|
||||
// have updated her database at this point.
|
||||
alice.fundingMgr.ProcessFundingMsg(channelReadyBob, bob)
|
||||
select {
|
||||
|
|
@ -2384,7 +2384,7 @@ func TestFundingManagerReceiveChannelReadyTwice(t *testing.T) {
|
|||
}
|
||||
|
||||
// TestFundingManagerRestartAfterChanAnn checks that the fundingManager properly
|
||||
// handles receiving a fundingLocked after the its own fundingLocked and channel
|
||||
// handles receiving a channelReady after the its own channelReady and channel
|
||||
// announcement is sent and gets restarted.
|
||||
func TestFundingManagerRestartAfterChanAnn(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
|
@ -2421,7 +2421,7 @@ func TestFundingManagerRestartAfterChanAnn(t *testing.T) {
|
|||
assertMarkedOpen(t, alice, bob, fundingOutPoint)
|
||||
|
||||
// After the funding transaction is mined, Alice will send
|
||||
// fundingLocked to Bob.
|
||||
// channelReady to Bob.
|
||||
channelReadyAlice := assertFundingMsgSent(
|
||||
t, alice.msgChan, "ChannelReady",
|
||||
).(*lnwire.ChannelReady)
|
||||
|
|
@ -2434,7 +2434,7 @@ func TestFundingManagerRestartAfterChanAnn(t *testing.T) {
|
|||
// Check that the state machine is updated accordingly
|
||||
assertChannelReadySent(t, alice, bob, fundingOutPoint)
|
||||
|
||||
// Exchange the fundingLocked messages.
|
||||
// Exchange the channelReady messages.
|
||||
alice.fundingMgr.ProcessFundingMsg(channelReadyBob, bob)
|
||||
bob.fundingMgr.ProcessFundingMsg(channelReadyAlice, alice)
|
||||
|
||||
|
|
@ -2454,7 +2454,7 @@ func TestFundingManagerRestartAfterChanAnn(t *testing.T) {
|
|||
waitForOpenUpdate(t, updateChan)
|
||||
|
||||
// At this point we restart Alice's fundingManager, before she receives
|
||||
// the fundingLocked message. After restart, she will receive it, and
|
||||
// the channelReady message. After restart, she will receive it, and
|
||||
// we expect her to be able to handle it correctly.
|
||||
recreateAliceFundingManager(t, alice)
|
||||
|
||||
|
|
@ -2482,7 +2482,7 @@ func TestFundingManagerRestartAfterChanAnn(t *testing.T) {
|
|||
|
||||
// TestFundingManagerRestartAfterReceivingChannelReady checks that the
|
||||
// fundingManager continues to operate as expected after it has received
|
||||
// fundingLocked and then gets restarted.
|
||||
// channelReady and then gets restarted.
|
||||
func TestFundingManagerRestartAfterReceivingChannelReady(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
|
|
@ -2518,7 +2518,7 @@ func TestFundingManagerRestartAfterReceivingChannelReady(t *testing.T) {
|
|||
assertMarkedOpen(t, alice, bob, fundingOutPoint)
|
||||
|
||||
// After the funding transaction is mined, Alice will send
|
||||
// fundingLocked to Bob.
|
||||
// channelReady to Bob.
|
||||
channelReadyAlice := assertFundingMsgSent(
|
||||
t, alice.msgChan, "ChannelReady",
|
||||
).(*lnwire.ChannelReady)
|
||||
|
|
@ -2531,10 +2531,10 @@ func TestFundingManagerRestartAfterReceivingChannelReady(t *testing.T) {
|
|||
// Check that the state machine is updated accordingly
|
||||
assertChannelReadySent(t, alice, bob, fundingOutPoint)
|
||||
|
||||
// Let Alice immediately get the fundingLocked message.
|
||||
// Let Alice immediately get the channelReady message.
|
||||
alice.fundingMgr.ProcessFundingMsg(channelReadyBob, bob)
|
||||
|
||||
// Also let Bob get the fundingLocked message.
|
||||
// Also let Bob get the channelReady message.
|
||||
bob.fundingMgr.ProcessFundingMsg(channelReadyAlice, alice)
|
||||
|
||||
// Check that they notify the breach arbiter and peer about the new
|
||||
|
|
@ -2611,7 +2611,7 @@ func TestFundingManagerPrivateChannel(t *testing.T) {
|
|||
assertMarkedOpen(t, alice, bob, fundingOutPoint)
|
||||
|
||||
// After the funding transaction is mined, Alice will send
|
||||
// fundingLocked to Bob.
|
||||
// channelReady to Bob.
|
||||
channelReadyAlice := assertFundingMsgSent(
|
||||
t, alice.msgChan, "ChannelReady",
|
||||
).(*lnwire.ChannelReady)
|
||||
|
|
@ -2624,7 +2624,7 @@ func TestFundingManagerPrivateChannel(t *testing.T) {
|
|||
// Check that the state machine is updated accordingly
|
||||
assertChannelReadySent(t, alice, bob, fundingOutPoint)
|
||||
|
||||
// Exchange the fundingLocked messages.
|
||||
// Exchange the channelReady messages.
|
||||
alice.fundingMgr.ProcessFundingMsg(channelReadyBob, bob)
|
||||
bob.fundingMgr.ProcessFundingMsg(channelReadyAlice, alice)
|
||||
|
||||
|
|
@ -2734,7 +2734,7 @@ func TestFundingManagerPrivateRestart(t *testing.T) {
|
|||
assertMarkedOpen(t, alice, bob, fundingOutPoint)
|
||||
|
||||
// After the funding transaction is mined, Alice will send
|
||||
// fundingLocked to Bob.
|
||||
// channelReady to Bob.
|
||||
channelReadyAlice := assertFundingMsgSent(
|
||||
t, alice.msgChan, "ChannelReady",
|
||||
).(*lnwire.ChannelReady)
|
||||
|
|
@ -2747,7 +2747,7 @@ func TestFundingManagerPrivateRestart(t *testing.T) {
|
|||
// Check that the state machine is updated accordingly
|
||||
assertChannelReadySent(t, alice, bob, fundingOutPoint)
|
||||
|
||||
// Exchange the fundingLocked messages.
|
||||
// Exchange the channelReady messages.
|
||||
alice.fundingMgr.ProcessFundingMsg(channelReadyBob, bob)
|
||||
bob.fundingMgr.ProcessFundingMsg(channelReadyAlice, alice)
|
||||
|
||||
|
|
@ -3169,7 +3169,7 @@ func TestFundingManagerCustomChannelParameters(t *testing.T) {
|
|||
}
|
||||
|
||||
// After the funding transaction is mined, Alice will send
|
||||
// fundingLocked to Bob.
|
||||
// channelReady to Bob.
|
||||
channelReadyAlice := assertFundingMsgSent(
|
||||
t, alice.msgChan, "ChannelReady",
|
||||
).(*lnwire.ChannelReady)
|
||||
|
|
@ -3179,7 +3179,7 @@ func TestFundingManagerCustomChannelParameters(t *testing.T) {
|
|||
t, bob.msgChan, "ChannelReady",
|
||||
).(*lnwire.ChannelReady)
|
||||
|
||||
// Exchange the fundingLocked messages.
|
||||
// Exchange the channelReady messages.
|
||||
alice.fundingMgr.ProcessFundingMsg(channelReadyBob, bob)
|
||||
bob.fundingMgr.ProcessFundingMsg(channelReadyAlice, alice)
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue