Merge pull request #1596 from lightninglabs/supply-leaf-height-query

universe+tapdb: add new `block_height` field to `universe_leaves` use that to implement block height based supply tree queries

Author: ffranr

tapdb/burn_tree.go

@@ -117,11 +117,17 @@ func insertBurnsInternal(ctx context.Context, db BaseUniverseStore,
 			IsBurn:   true,
 		}
 
+		var blockHeight lfn.Option[uint32]
+		height := burnLeaf.BurnProof.BlockHeight
+		if height > 0 {
+			blockHeight = lfn.Some(height)
+		}
+
 		// Call the generic upsert function for the burn sub-tree to
 		// update DB records. MetaReveal is nil for burns.
 		_, err = universeUpsertProofLeaf(
 			ctx, db, subNs, supplycommit.BurnTreeType.String(),
-			groupKey, leafKey, leaf, nil,
+			groupKey, leafKey, leaf, nil, blockHeight,
 		)
 		if err != nil {
 			return nil, fmt.Errorf("unable to upsert burn "+

tapdb/ignore_tree.go

@@ -113,6 +113,21 @@ func addTuplesInternal(ctx context.Context, db BaseUniverseStore,
 				"universe root: %w", err)
 		}
 
+		var blockHeight lfn.Option[uint32]
+		height := tup.IgnoreTuple.Val.BlockHeight
+		if height > 0 {
+			blockHeight = lfn.Some(height)
+		}
+
+		sqlBlockHeight := lfn.MapOptionZ(
+			blockHeight, func(num uint32) sql.NullInt32 {
+				return sql.NullInt32{
+					Int32: int32(num),
+					Valid: true,
+				}
+			},
+		)
+
 		scriptKey := ignoreTup.ScriptKey
 		err = db.UpsertUniverseLeaf(ctx, UpsertUniverseLeaf{
 			AssetGenesisID:    assetGenID,
@@ -121,6 +136,7 @@ func addTuplesInternal(ctx context.Context, db BaseUniverseStore,
 			LeafNodeKey:       smtKey[:],
 			LeafNodeNamespace: namespace,
 			MintingPoint:      ignorePointBytes,
+			BlockHeight:       sqlBlockHeight,
 		})
 		if err != nil {
 			return nil, fmt.Errorf("failed to upsert ignore "+

tapdb/migrations.go

@@ -24,7 +24,7 @@ const (
 	// daemon.
 	//
 	// NOTE: This MUST be updated when a new migration is added.
-	LatestMigrationVersion = 41
+	LatestMigrationVersion = 42
 )
 
 // DatabaseBackend is an interface that contains all methods our different

tapdb/multiverse.go

@@ -776,11 +776,16 @@ func (b *MultiverseStore) UpsertProofLeaf(ctx context.Context,
 
 	execTxFunc := func(dbTx BaseMultiverseStore) error {
 		// Register issuance in the asset (group) specific universe
-		// tree.
-		var err error
+		// tree. We don't need to decode the whole proof, we just
+		// need the block height.
+		blockHeight, err := SparseDecodeBlockHeight(leaf.RawProof)
+		if err != nil {
+			return err
+		}
+
 		uniProof, err = universeUpsertProofLeaf(
 			ctx, dbTx, id.String(), id.ProofType.String(),
-			id.GroupKey, key, leaf, metaReveal,
+			id.GroupKey, key, leaf, metaReveal, blockHeight,
 		)
 		if err != nil {
 			return fmt.Errorf("failed universe upsert: %w", err)
@@ -847,13 +852,22 @@ func (b *MultiverseStore) UpsertProofLeafBatch(ctx context.Context,
 			for idx := range items {
 				item := items[idx]
 
+				// We don't need to decode the whole proof, we
+				// just need the block height.
+				blockHeight, err := SparseDecodeBlockHeight(
+					item.Leaf.RawProof,
+				)
+				if err != nil {
+					return err
+				}
+
 				// Upsert into the specific universe tree to
 				// start with.
 				uniProof, err := universeUpsertProofLeaf(
 					ctx, store, item.ID.String(),
 					item.ID.ProofType.String(),
 					item.ID.GroupKey, item.Key, item.Leaf,
-					item.MetaReveal,
+					item.MetaReveal, blockHeight,
 				)
 				if err != nil {
 					return fmt.Errorf("failed universe "+

tapdb/sqlc/migrations/000042_universe_leaf_height.down.sql

@@ -0,0 +1 @@
+ALTER TABLE universe_leaves DROP COLUMN block_height;

tapdb/sqlc/migrations/000042_universe_leaf_height.up.sql

@@ -0,0 +1 @@
+ALTER TABLE universe_leaves ADD COLUMN block_height INTEGER;

tapdb/sqlc/models.go

@@ -43,6 +43,25 @@ JOIN universe_supply_roots r
 WHERE r.id = @supply_root_id AND
       (l.sub_tree_type = sqlc.narg('sub_tree_type') OR sqlc.narg('sub_tree_type') IS NULL);
 
+-- name: QuerySupplyLeavesByHeight :many
+SELECT
+    leaves.script_key_bytes,
+    gen.gen_asset_id,
+    nodes.value AS supply_leaf_bytes,
+    nodes.sum AS sum_amt,
+    gen.asset_id,
+    leaves.block_height
+FROM universe_leaves AS leaves
+JOIN mssmt_nodes AS nodes
+    ON leaves.leaf_node_key = nodes.key
+    AND leaves.leaf_node_namespace = nodes.namespace
+JOIN genesis_info_view AS gen
+    ON leaves.asset_genesis_id = gen.gen_asset_id
+WHERE
+    leaves.leaf_node_namespace = @namespace AND
+    (leaves.block_height >= sqlc.narg('start_height') OR sqlc.narg('start_height') IS NULL) AND
+    (leaves.block_height <= sqlc.narg('end_height') OR sqlc.narg('end_height') IS NULL);
+
 -- name: DeleteUniverseSupplyLeaves :exec
 DELETE FROM universe_supply_leaves
 WHERE supply_root_id = (

tapdb/sqlc/querier.go

@@ -38,17 +38,18 @@ WHERE namespace_root = @namespace_root;
 
 -- name: UpsertUniverseLeaf :exec
 INSERT INTO universe_leaves (
-    asset_genesis_id, script_key_bytes, universe_root_id, leaf_node_key, 
-    leaf_node_namespace, minting_point
+    asset_genesis_id, script_key_bytes, universe_root_id, leaf_node_key,
+    leaf_node_namespace, minting_point, block_height
 ) VALUES (
     @asset_genesis_id, @script_key_bytes, @universe_root_id, @leaf_node_key,
-    @leaf_node_namespace, @minting_point
+    @leaf_node_namespace, @minting_point, @block_height
 ) ON CONFLICT (minting_point, script_key_bytes, leaf_node_namespace)
-    -- This is a NOP, minting_point and script_key_bytes are the unique fields
-    -- that caused the conflict.
+    -- Update the block_height on conflict. The minting_point, script_key_bytes,
+    -- and leaf_node_namespace remain unchanged as they form the unique constraint.
     DO UPDATE SET minting_point = EXCLUDED.minting_point,
                   script_key_bytes = EXCLUDED.script_key_bytes,
-                  leaf_node_namespace = EXCLUDED.leaf_node_namespace;
+                  leaf_node_namespace = EXCLUDED.leaf_node_namespace,
+                  block_height = EXCLUDED.block_height;
 
 -- name: DeleteUniverseLeaves :exec
 DELETE FROM universe_leaves