Skip to content

sweepbatcher: notify caller about confirmations #919

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
starius merged 13 commits into from
Jun 12, 2025
Merged

sweepbatcher: notify caller about confirmations #919

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
6a32b46
sweepbatcher: mark channels receive- or send-only
starius Apr 8, 2025
501faa8
sweepbatcher: unblock sending if notifier quits
starius Apr 8, 2025
39f859a
sweepbatcher: send spend error to notifier
starius Apr 8, 2025
7636ffd
test: fix error messages
starius Apr 8, 2025
c036c2a
sweepbatcher: fix mock TotalSweptAmount
starius Apr 8, 2025
cb7c31c
sweepbatcher: fix mistake in batch reading from DB
starius Apr 8, 2025
2f05934
test/chainnotifier_mock: support errors
starius Apr 8, 2025
01664ad
sweepbatcher: cancel spendCtx after processing
starius Apr 8, 2025
fa1bc48
sweepbatcher: remove unneeded for loops
starius Apr 8, 2025
7edbfea
sweepbatcher: store batch status before monitoring
starius Apr 8, 2025
980c7d4
sweepbatcher: align dbBatch type with DB schema
starius Apr 8, 2025
8466e0f
sweepbatcher: test spending notification and error
starius Apr 8, 2025
c70257a
sweepbatcher: notify caller about confirmations
starius Apr 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 6 additions & 17 deletions sweepbatcher/store.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,8 +213,8 @@ type dbBatch struct {
// ID is the unique identifier of the batch.
Copy link
Member

@sputn1ck sputn1ck Apr 10, 2025

Choose a reason for hiding this comment

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

Maybe stupid question, but missing lots of context. This commit changes more than the mock, and feels a bit complicated, can you maybe elaborate what the changes to the other files are?

Copy link
Collaborator Author

@starius starius Apr 13, 2025

Choose a reason for hiding this comment

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

I updated the commit message:

sweepbatcher: align dbBatch type with DB schema

Previously, dbBatch had a State field (enum: Open, Closed, Confirmed), but in
the database it is represented as a boolean Confirmed. The Closed state was
stored the same way as Open. This wasn't an issue in practice, since an Open
batch is quickly transitioned to Closed after startup.

However, the in-memory mock stores plain dbBatch instances, leading to
inconsistent behavior between the mock and the real DB-backed store. This
commit updates dbBatch to match the database representation by replacing

Also added a note to the description of Closed const:

// Closed is the state in which the batch is no longer able to accept
// new sweeps. NOTE: this state exists only in-memory. In the database
// it is stored as Open and converted to Closed after a spend
// notification arrives (quickly after start of Batch.Run).
Closed batchState = 1

ID int32

// State is the current state of the batch.
State string
// Confirmed is set when the batch is fully confirmed.
Confirmed bool

// BatchTxid is the txid of the batch transaction.
BatchTxid chainhash.Hash
Expand Down Expand Up @@ -255,11 +255,8 @@ type dbSweep struct {
// convertBatchRow converts a batch row from db to a sweepbatcher.Batch struct.
func convertBatchRow(row sqlc.SweepBatch) *dbBatch {
batch := dbBatch{
ID: row.ID,
}

if row.Confirmed {
batch.State = batchOpen
ID: row.ID,
Confirmed: row.Confirmed,
}

if row.BatchTxID.Valid {
Expand Down Expand Up @@ -288,7 +285,7 @@ func convertBatchRow(row sqlc.SweepBatch) *dbBatch {
// it into the database.
func batchToInsertArgs(batch dbBatch) sqlc.InsertBatchParams {
args := sqlc.InsertBatchParams{
Confirmed: false,
Confirmed: batch.Confirmed,
BatchTxID: sql.NullString{
Valid: true,
String: batch.BatchTxid.String(),
Expand All @@ -305,10 +302,6 @@ func batchToInsertArgs(batch dbBatch) sqlc.InsertBatchParams {
MaxTimeoutDistance: batch.MaxTimeoutDistance,
}

if batch.State == batchConfirmed {
args.Confirmed = true
}

return args
}

Expand All @@ -317,7 +310,7 @@ func batchToInsertArgs(batch dbBatch) sqlc.InsertBatchParams {
func batchToUpdateArgs(batch dbBatch) sqlc.UpdateBatchParams {
args := sqlc.UpdateBatchParams{
ID: batch.ID,
Confirmed: false,
Confirmed: batch.Confirmed,
BatchTxID: sql.NullString{
Valid: true,
String: batch.BatchTxid.String(),
Expand All @@ -333,10 +326,6 @@ func batchToUpdateArgs(batch dbBatch) sqlc.UpdateBatchParams {
},
}

if batch.State == batchConfirmed {
args.Confirmed = true
}

return args
}

Expand Down
8 changes: 4 additions & 4 deletions sweepbatcher/store_mock.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ func (s *StoreMock) FetchUnconfirmedSweepBatches(ctx context.Context) (

result := []*dbBatch{}
for _, batch := range s.batches {
if batch.State != "confirmed" {
if !batch.Confirmed {
result = append(result, &batch)
}
}
Expand Down Expand Up @@ -91,7 +91,7 @@ func (s *StoreMock) ConfirmBatch(ctx context.Context, id int32) error {
return errors.New("batch not found")
}

batch.State = "confirmed"
batch.Confirmed = true
s.batches[batch.ID] = batch

return nil
Expand Down Expand Up @@ -201,7 +201,7 @@ func (s *StoreMock) TotalSweptAmount(ctx context.Context, batchID int32) (
return 0, errors.New("batch not found")
}

if batch.State != batchConfirmed && batch.State != batchClosed {
if !batch.Confirmed {
return 0, nil
}

Expand All @@ -212,5 +212,5 @@ func (s *StoreMock) TotalSweptAmount(ctx context.Context, batchID int32) (
}
}

return 0, nil
return total, nil
}
Loading