staticaddr: persist withdrawal info #938

hieblmi · 2025-05-09T13:18:17Z

addresses #936

sample output:

loop --network=regtest s listwithdrawals  
{
    "withdrawals": [
        {
            "tx_id": "9379f48176ad724396322018b1a6f04ae6a19e868bd5fb0ef1d44a28889bf6a9",
            "outpoints": [
                "4cf5f636a598ffdb4fcd9ba9f2574a4a4cb2347decce88f25c4b0efa9e7a4e58:0",
                "29062f15a18cd1fc16a7701acbd608c232e3063302716a138f34b908de371d69:1"
            ],
            "total_deposit_amount_satoshis": "500000",
            "withdrawn_amount_satoshis": "483150",
            "change_amount_satoshis": "0",
            "confirmation_height": 129
        },
        {
            "tx_id": "5f2943ef018617cc3b0e3967b6e34a1ca472c5896282425f96c2bae159da25d9",
            "outpoints": [
                "25a16919cc297f21e6d25812dd4cb6d9c5f6b7158dba25522d3b658fefd8bc0a:1",
                "be4f24f4dde6cc51b5f9e06132cf5fcad895afcb0b7b471c627cd3bd71003e53:0",
                "5a5b8c7ea10409c81c6f8637402b83c008a4f3fdf4f5b02b52069b72df50ba11:0",
                "0dc433eef2191ecefdf950e111850f650905d9b9f2350a90766fee137e476858:0",
                "5bed66d98a76bda5fa1e35cd86060e8c15a3d7432a2d3c4708294decc54852d2:0"
            ],
            "total_deposit_amount_satoshis": "1034600",
            "withdrawn_amount_satoshis": "1000000",
            "change_amount_satoshis": "34216",
            "confirmation_height": 150
        }
    ]
}

UPDATE:

 loop --network=regtest s listwithdrawals
{
    "withdrawals": [
        {
            "tx_id": "65034b12a722ca48bbd09cbd587ab0ac8635a0c1caee9fd7fbf0170c632574ae",
            "deposits": [
                {
                    "id": "1de5c33d7504aba6d3fc43775ef32d9102e519a43ff27c5287dcc2b60bab1f45",
                    "state": "WITHDRAWN",
                    "outpoint": "806bbe5581ba17a3600b1f37b4c737f83de0eca0880883c8f1f916af67a9f42d:0",
                    "value": "250000",
                    "confirmation_height": "141",
                    "blocks_until_expiry": "0"
                },
                {
                    "id": "59ea2b6718a1578607227f35581eeec3c4c06372c0c3b960170a71b16be1e852",
                    "state": "WITHDRAWN",
                    "outpoint": "7aafba908731ef1c4187ef889e6c69282dc285449f9857e2a15b2108ff6bf83e:0",
                    "value": "250000",
                    "confirmation_height": "141",
                    "blocks_until_expiry": "0"
                }
            ],
            "total_deposit_amount_satoshis": "500000",
            "withdrawn_amount_satoshis": "498315",
            "change_amount_satoshis": "0",
            "confirmation_height": 147
        },
        {
            "tx_id": "bbcd158b3bf1a6ff0c5061e9971119408686d9cd925b90aec714bde8fbe78a79",
            "deposits": [
                {
                    "id": "94eb9b597ecebc7bb63776698793d078da8280b5a76b6cd7137b1d436a9ed000",
                    "state": "WITHDRAWN",
                    "outpoint": "708d4e59b3059870d030fb3f9b18377253bc46ca73b9b240b2d15b114bf13442:1",
                    "value": "250000",
                    "confirmation_height": "129",
                    "blocks_until_expiry": "0"
                }
            ],
            "total_deposit_amount_satoshis": "250000",
            "withdrawn_amount_satoshis": "249889",
            "change_amount_satoshis": "0",
            "confirmation_height": 135
        }
    ]
}

hieblmi · 2025-05-15T13:31:43Z

Rebased.

hieblmi · 2025-05-20T07:50:33Z

Rebased

sputn1ck

LGTM, but I think a quick sql store unit test would be nice

sputn1ck · 2025-05-20T08:19:43Z

staticaddr/withdraw/sql_store.go

+
+// SqlStore is the backing store for static address withdrawals.
+type SqlStore struct {
+	baseDB *loopdb.BaseDB


this exposes the full queries to this package, which IMO is not neccessary. as we usually define a Querier interface.

sputn1ck · 2025-05-20T08:24:17Z

loopdb/sqlc/migrations/000015_static_address_withdrawals.up.sql

+
+    -- deposit_outpoints is a concatenated list of outpoints that are used for
+    -- this withdrawal. The list has the format txid1:idx;txid2:idx;...
+    deposit_outpoints TEXT NOT NULL,


could it make sense to really sqlize this? and reference the db deposit id?
So add a table with:
ID, withdrawal_id REFRERNCES withdrawals.id(or tx_id), deposit_id REFERENCES(deposits.deposit_id)
I noticed we don't do the same in static loop ins, but it would allow for more interesting queries i feel.

I normalized the withdrawal and depoist tables by adding a new table withdrawal_deposits and removed the deposit outpoints from the withdrawal record.

sputn1ck · 2025-05-20T08:24:46Z

staticaddr/withdraw/sql_store.go

+}
+
+// CreateWithdrawal creates a static address withdrawal record in the database.
+func (s *SqlStore) CreateWithdrawal(ctx context.Context, tx *wire.MsgTx,


I propose adding a light unit test for future regressions.

added sql_store_test.go.

bhandras

Really nice feature, added a couple of comments/suggestions.

loopdb/sqlc/migrations/000015_static_address_withdrawals.up.sql

bhandras · 2025-05-20T11:39:41Z

loopdb/sqlc/migrations/000015_static_address_withdrawals.up.sql

+
+    -- deposit_outpoints is a concatenated list of outpoints that are used for
+    -- this withdrawal. The list has the format txid1:idx;txid2:idx;...
+    deposit_outpoints TEXT NOT NULL,


bhandras · 2025-05-20T11:40:40Z

loopdb/sqlc/migrations/000015_static_address_withdrawals.up.sql

+
+    -- confirmation_height is the block height at which the withdrawal was
+    -- first confirmed.
+    confirmation_height BIGINT NOT NULL


Should this be allowed to be NULL until the withdrawal confirms?

bhandras · 2025-05-20T11:42:05Z

staticaddr/withdraw/manager.go

 				m.mu.Lock()
 				delete(m.finalizedWithdrawalTxns, txHash)
 				m.mu.Unlock()

+				// Persist info about the finalized withdrawal.
+				err = m.cfg.Store.CreateWithdrawal(


It'd be nicer to add the withdrawal at the time it is requested then later on set it to confirmed.

I've reworked this so that we store a withdrawal at user request time with CreateWithdrawal and then when its confirmed its updated with UpdateWithdrawal.

bhandras · 2025-05-20T11:42:36Z

staticaddr/withdraw/sql_store.go

+}
+
+// CreateWithdrawal creates a static address withdrawal record in the database.
+func (s *SqlStore) CreateWithdrawal(ctx context.Context, tx *wire.MsgTx,


lightninglabs-deploy · 2025-05-27T12:16:46Z

@hieblmi, remember to re-request review from reviewers when ready

…ormation

sputn1ck

LGTM! Thanks for the sql improvements and tests 💯

bhandras

Looks good, just one question!

bhandras · 2025-06-10T12:28:22Z

staticaddr/withdraw/sql_store.go

+	createArgs := sqlc.CreateWithdrawalParams{
+		WithdrawalID:       id[:],
+		TotalDepositAmount: int64(totalAmount),
+		InitiationTime:     time.Now(),


nit: use the clock.

Also I noticed that there's mixed use of UTC vs non UTC timestamps in the staticaddr databases. I think we should always try to use UTC when possible.

staticaddr/withdraw/sql_store.go

bhandras

LGTM 🎉

staticaddr/withdraw/sql_store.go

hieblmi marked this pull request as draft May 9, 2025 13:18

hieblmi self-assigned this May 9, 2025

hieblmi force-pushed the withdraw-info branch 2 times, most recently from aab693b to e22b2b2 Compare May 13, 2025 09:40

hieblmi marked this pull request as ready for review May 13, 2025 09:40

hieblmi force-pushed the withdraw-info branch from e22b2b2 to 2190b80 Compare May 13, 2025 09:48

hieblmi requested review from sputn1ck, bhandras and starius May 13, 2025 10:01

hieblmi force-pushed the withdraw-info branch from 2190b80 to 5b0262a Compare May 15, 2025 13:31

hieblmi force-pushed the withdraw-info branch from 5b0262a to cc1d386 Compare May 20, 2025 07:20

sputn1ck reviewed May 20, 2025

View reviewed changes

bhandras reviewed May 20, 2025

View reviewed changes

bhandras removed the request for review from starius May 20, 2025 11:43

hieblmi added the static-loop-in label May 23, 2025

staticaddr: simplify handleWithdrawal

b780a9a

hieblmi force-pushed the withdraw-info branch 3 times, most recently from c835f14 to ba77fff Compare June 2, 2025 13:57

hieblmi added 2 commits June 3, 2025 12:57

loopdb: withdrawal table and queries

94aeae8

looprpc: add ListStaticAddressWithdrawals for historic withdrawal inf…

cd9bcdf

…ormation

hieblmi force-pushed the withdraw-info branch 2 times, most recently from 469b6a2 to 8d95a80 Compare June 3, 2025 11:30

hieblmi requested review from bhandras and sputn1ck June 3, 2025 11:31

sputn1ck approved these changes Jun 3, 2025

View reviewed changes

bhandras reviewed Jun 10, 2025

View reviewed changes

hieblmi force-pushed the withdraw-info branch from 8d95a80 to 130b69a Compare June 10, 2025 14:33

hieblmi requested a review from bhandras June 10, 2025 14:33

bhandras approved these changes Jun 10, 2025

View reviewed changes

staticaddr/withdraw/sql_store.go Show resolved Hide resolved

hieblmi added 3 commits June 10, 2025 17:07

staticaddr: store historic withdrawal info

5718f11

loopd: retrieve historic withdrawal info

614d619

cmd: add listwithdrawals command

06bbb90

hieblmi force-pushed the withdraw-info branch from 130b69a to 06bbb90 Compare June 10, 2025 15:07

hieblmi merged commit 80828c2 into lightninglabs:master Jun 10, 2025
4 checks passed

hieblmi deleted the withdraw-info branch June 10, 2025 15:49

staticaddr: persist withdrawal info #938

staticaddr: persist withdrawal info #938

Uh oh!

Conversation

hieblmi commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hieblmi commented May 15, 2025

Uh oh!

hieblmi commented May 20, 2025

Uh oh!

sputn1ck left a comment

Choose a reason for hiding this comment

Uh oh!

sputn1ck May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bhandras left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lightninglabs-deploy commented May 27, 2025

Uh oh!

sputn1ck left a comment

Choose a reason for hiding this comment

Uh oh!

bhandras left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bhandras left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hieblmi commented May 9, 2025 •

edited

Loading

sputn1ck May 20, 2025 •

edited

Loading