What the developer wrote
Authored by ziggie
channeldb: add channel store accessors
Add transitional OpenChannel accessors for the channel status and
confirmed SCID fields used by KV store code.
These helpers keep the fields private while allowing channeldb backend
code to continue hydrating and serializing channel state after
OpenChannel moves to chanstate.
What changed, and why it matters
This commit adds temporary getter and setter helper methods to access two internal fields of an open Lightning channel (channel status and confirmed short channel ID). The helpers intentionally skip the normal mutex lock because they are meant for internal database serialization code during a larger code reorganization. The commit does not fix a vulnerability; it is a structural refactor to keep private fields accessible while the data model is moved to a new package.
Treat as a low-risk refactor. Review follow-up commits to ensure the transitional accessors are removed once OpenChannel migration to chanstate is complete, and verify that all callers outside the intended KV store serialization paths continue to use the mutex-protected methods (ChanStatus, ApplyChanStatus, ClearChanStatus, ZeroConfRealScid).
Security signals we found
New unsynchronized accessors bypass existing mutex-protected equivalents (ChanStatus, ApplyChanStatus, ClearChanStatus, ZeroConfRealScid)
Commit message and comments explicitly frame the change as a transitional migration hook, not a security fix
No input validation added around the setter methods
No change to network-facing, RPC, or cryptographic code
No vendor disclosure or CVE references present in commit or supplied references
Evidence from the diff
The patch introduces four new transitional accessors on OpenChannel in channeldb/channel.go: ChannelStatusForStore/SetChannelStatusForStore and ConfirmedScidForStore/SetConfirmedScidForStore. They read/write c.chanStatus and c.confirmedScid without acquiring c.RLock/c.Lock. Existing serialization and persistence paths are updated to call these helpers instead of touching the fields directly. The change is explicitly described as a preliminary migration hook for KV-backed store code while OpenChannel moves toward chanstate, with callers responsible for synchronization.
Changed components
channeldb/channel.goOpenChannel struct accessorsChannelStateDB channel status and confirmed SCID persistence pathsInspect captured patch +59 / −13
diff --git a/channeldb/channel.go b/channeldb/channel.go
index 42f062a..0e1a04c 100644
--- a/channeldb/channel.go
+++ b/channeldb/channel.go
@@ -908,6 +908,27 @@ func (c *OpenChannel) ChanStatus() ChannelStatus {
return c.chanStatus
}
+// ChannelStatusForStore returns the in-memory channel status without taking
+// the channel mutex.
+//
+// NOTE: This is a preliminary migration hook for KV-backed store code that
+// still lives in channeldb while OpenChannel moves toward chanstate. Callers
+// are responsible for synchronization. Normal callers should use ChanStatus.
+func (c *OpenChannel) ChannelStatusForStore() ChannelStatus {
+ return c.chanStatus
+}
+
+// SetChannelStatusForStore updates the in-memory channel status without taking
+// the channel mutex.
+//
+// NOTE: This is a preliminary migration hook for KV-backed store code that
+// still lives in channeldb while OpenChannel moves toward chanstate. Callers
+// are responsible for synchronization. Normal callers should use
+// ApplyChanStatus or ClearChanStatus when the status change must be persisted.
+func (c *OpenChannel) SetChannelStatusForStore(status ChannelStatus) {
+ c.chanStatus = status
+}
+
// ApplyChanStatus allows the caller to modify the internal channel state in a
// thead-safe manner.
func (c *OpenChannel) ApplyChanStatus(status ChannelStatus) error {
@@ -946,6 +967,27 @@ func (c *OpenChannel) hasChanStatus(status ChannelStatus) bool {
return c.chanStatus&status == status
}
+// ConfirmedScidForStore returns the in-memory confirmed SCID without taking
+// the channel mutex.
+//
+// NOTE: This is a preliminary migration hook for KV-backed store code that
+// still lives in channeldb while OpenChannel moves toward chanstate. Callers
+// are responsible for synchronization. Normal callers should use
+// ZeroConfRealScid.
+func (c *OpenChannel) ConfirmedScidForStore() lnwire.ShortChannelID {
+ return c.confirmedScid
+}
+
+// SetConfirmedScidForStore updates the in-memory confirmed SCID without taking
+// the channel mutex.
+//
+// NOTE: This is a preliminary migration hook for KV-backed store code that
+// still lives in channeldb while OpenChannel moves toward chanstate. Callers
+// are responsible for synchronization.
+func (c *OpenChannel) SetConfirmedScidForStore(scid lnwire.ShortChannelID) {
+ c.confirmedScid = scid
+}
+
// BroadcastHeight returns the height at which the funding tx was broadcast.
func (c *OpenChannel) BroadcastHeight() uint32 {
c.RLock()
@@ -972,7 +1014,7 @@ func amendOpenChannelTlvData(channel *OpenChannel, auxData openChannelTlvData) {
channel.InitialRemoteBalance = lnwire.MilliSatoshi(
auxData.initialRemoteBalance.Val,
)
- channel.confirmedScid = auxData.realScid.Val
+ channel.SetConfirmedScidForStore(auxData.realScid.Val)
channel.ConfirmationHeight = auxData.confirmationHeight.Val
auxData.memo.WhenSomeV(func(memo []byte) {
@@ -1003,7 +1045,7 @@ func extractOpenChannelTlvData(channel *OpenChannel) openChannelTlvData {
uint64(channel.InitialRemoteBalance),
),
realScid: tlv.NewRecordT[tlv.TlvType4](
- channel.confirmedScid,
+ channel.ConfirmedScidForStore(),
),
confirmationHeight: tlv.NewPrimitiveRecord[tlv.TlvType8](
channel.ConfirmationHeight,
@@ -1483,7 +1525,7 @@ func (c *ChannelStateDB) MarkChannelRealScid(channel *OpenChannel,
return err
}
- diskChannel.confirmedScid = realScid
+ diskChannel.SetConfirmedScidForStore(realScid)
return putOpenChannel(chanBucket, diskChannel)
}, func() {})
@@ -1921,7 +1963,7 @@ func isChannelBorked(channel *OpenChannel, chanBucket kvdb.RBucket) (
return false, err
}
- return diskChannel.chanStatus != ChanStatusDefault, nil
+ return diskChannel.ChannelStatusForStore() != ChanStatusDefault, nil
}
// MarkCommitmentBroadcasted marks the channel as a commitment transaction has
@@ -2102,8 +2144,8 @@ func (c *ChannelStateDB) putChanStatus(channel *OpenChannel,
}
// Add this status to the existing bitvector found in the DB.
- status = diskChannel.chanStatus | status
- diskChannel.chanStatus = status
+ status = diskChannel.ChannelStatusForStore() | status
+ diskChannel.SetChannelStatusForStore(status)
if err := putOpenChannel(chanBucket, diskChannel); err != nil {
return err
@@ -2126,7 +2168,7 @@ func (c *ChannelStateDB) putChanStatus(channel *OpenChannel,
}
// Update the in-memory representation to keep it in sync with the DB.
- channel.chanStatus = status
+ channel.SetChannelStatusForStore(status)
return nil
}
@@ -2153,8 +2195,8 @@ func (c *ChannelStateDB) ClearChannelStatus(channel *OpenChannel,
}
// Unset this bit in the bitvector on disk.
- status = diskChannel.chanStatus & ^status
- diskChannel.chanStatus = status
+ status = diskChannel.ChannelStatusForStore() & ^status
+ diskChannel.SetChannelStatusForStore(status)
return putOpenChannel(chanBucket, diskChannel)
}, func() {}); err != nil {
@@ -2162,7 +2204,7 @@ func (c *ChannelStateDB) ClearChannelStatus(channel *OpenChannel,
}
// Update the in-memory representation to keep it in sync with the DB.
- channel.chanStatus = status
+ channel.SetChannelStatusForStore(status)
return nil
}
@@ -3866,7 +3908,9 @@ func archiveClosedChannel(tx kvdb.RwTx, chanKey []byte,
}
for _, s := range statuses {
- chanState.chanStatus |= s
+ chanState.SetChannelStatusForStore(
+ chanState.ChannelStatusForStore() | s,
+ )
}
if err := putOpenChannel(historicalChanBucket, chanState); err != nil {
@@ -4432,7 +4476,7 @@ func putChanInfo(chanBucket kvdb.RwBucket, channel *OpenChannel) error {
if err := WriteElements(&w,
channel.ChanType, channel.ChainHash, channel.FundingOutpoint,
channel.ShortChannelID, channel.IsPending, channel.IsInitiator,
- channel.chanStatus, channel.FundingBroadcastHeight,
+ channel.ChannelStatusForStore(), channel.FundingBroadcastHeight,
channel.NumConfsRequired, channel.ChannelFlags,
channel.IdentityPub, channel.Capacity, channel.TotalMSatSent,
channel.TotalMSatReceived,
@@ -4611,16 +4655,18 @@ func fetchChanInfo(chanBucket kvdb.RBucket, channel *OpenChannel) error {
}
r := bytes.NewReader(infoBytes)
+ var chanStatus ChannelStatus
if err := ReadElements(r,
&channel.ChanType, &channel.ChainHash, &channel.FundingOutpoint,
&channel.ShortChannelID, &channel.IsPending, &channel.IsInitiator,
- &channel.chanStatus, &channel.FundingBroadcastHeight,
+ &chanStatus, &channel.FundingBroadcastHeight,
&channel.NumConfsRequired, &channel.ChannelFlags,
&channel.IdentityPub, &channel.Capacity, &channel.TotalMSatSent,
&channel.TotalMSatReceived,
); err != nil {
return err
}
+ channel.SetChannelStatusForStore(chanStatus)
// For single funder channels that we initiated and have the funding
// transaction to, read the funding txn.
Why this scored 18/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.