tapdb: add proof_delivery_complete and position to transfer outputs

Add the `proof_delivery_complete` and `position` columns to the
`asset_transfer_outputs` table. The `position` column indicates the
position of the output in the transfer output list.

The position and anchor outpoint uniquely identify a transfer output.

This change updates the row insertion and retrieval SQL statements for
this table. Additionally, new SQL statements are included for modifying
these new columns.

Author: ffranr

tapdb/migrations.go

@@ -22,7 +22,7 @@ const (
 	// daemon.
 	//
 	// NOTE: This MUST be updated when a new migration is added.
-	LatestMigrationVersion = 21
+	LatestMigrationVersion = 22
 )
 
 // MigrationTarget is a functional option that can be passed to applyMigrations

tapdb/sqlc/migrations/000022_transfer_outputs_proof_delivered.down.sql

@@ -0,0 +1,10 @@
+-- Remove the unique constraint on the `transfer_id` and `position` columns in
+-- the `asset_transfer_outputs` table.
+DROP INDEX asset_transfer_outputs_transfer_id_position_unique;
+
+-- Remove the `proof_delivery_complete` column from the `asset_transfer_outputs`
+-- table.
+ALTER TABLE asset_transfer_outputs DROP COLUMN proof_delivery_complete;
+
+-- Remove the `position` column from the `asset_transfer_outputs` table.
+ALTER TABLE asset_transfer_outputs DROP COLUMN position;

tapdb/sqlc/migrations/000022_transfer_outputs_proof_delivered.up.sql

@@ -0,0 +1,28 @@
+-- Add a column to track if the proof has been delivered for an asset transfer
+-- output.
+ALTER TABLE asset_transfer_outputs
+ADD COLUMN proof_delivery_complete BOOL;
+
+-- Add column `position` which indicates the index of the output in the list of
+-- outputs for a given transfer. This index position in conjunction with the
+-- transfer id can be used to uniquely identify a transfer output.
+--
+-- We'll be inserting an actual value in the next query, so we just start
+-- with -1.
+ALTER TABLE asset_transfer_outputs
+ADD COLUMN position INTEGER NOT NULL DEFAULT -1;
+
+-- Update the position to be the same as the output id for existing entries.
+-- We'll use the position integer as a uniquely identifiable number of an output
+-- within a transfer, so setting the default to the output_id is just to make
+-- sure we have a unique value that also satisfies the unique constraint we add
+-- below.
+UPDATE asset_transfer_outputs SET position = CAST(output_id AS INTEGER)
+WHERE position = -1;
+
+-- We enforce a unique constraint such that for a given transfer, the position
+-- of an output is unique.
+CREATE UNIQUE INDEX asset_transfer_outputs_transfer_id_position_unique
+ON asset_transfer_outputs (
+    transfer_id, position
+);

tapdb/sqlc/models.go

@@ -23,11 +23,24 @@ INSERT INTO asset_transfer_outputs (
     amount, serialized_witnesses, split_commitment_root_hash,
     split_commitment_root_value, proof_suffix, num_passive_assets,
     output_type, proof_courier_addr, asset_version, lock_time,
-    relative_lock_time
+    relative_lock_time, proof_delivery_complete, position
 ) VALUES (
-    $1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15
+    $1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16, $17
 );
 
+-- name: SetTransferOutputProofDeliveryStatus :exec
+WITH target(output_id) AS (
+    SELECT output_id
+    FROM asset_transfer_outputs output
+    JOIN managed_utxos
+      ON output.anchor_utxo = managed_utxos.utxo_id
+    WHERE managed_utxos.outpoint = @serialized_anchor_outpoint
+      AND output.position = @position
+)
+UPDATE asset_transfer_outputs
+SET proof_delivery_complete = @delivery_complete
+WHERE output_id = (SELECT output_id FROM target);
+
 -- name: QueryAssetTransfers :many
 SELECT
     id, height_hint, txns.txid, transfer_time_unix
@@ -55,8 +68,8 @@ ORDER BY input_id;
 SELECT
     output_id, proof_suffix, amount, serialized_witnesses, script_key_local,
     split_commitment_root_hash, split_commitment_root_value, num_passive_assets,
-    output_type, proof_courier_addr, asset_version, lock_time,
-    relative_lock_time,
+    output_type, proof_courier_addr, proof_delivery_complete, position,
+    asset_version, lock_time, relative_lock_time,
     utxos.utxo_id AS anchor_utxo_id,
     utxos.outpoint AS anchor_outpoint,
     utxos.amt_sats AS anchor_value,