proof: implement and hook up ignore checker #1716

guggero · 2025-08-08T12:09:29Z

Implements and hooks up a caching ignore tree checker.

coveralls · 2025-08-08T15:27:11Z

Pull Request Test Coverage Report for Build 16940968541

Details

404 of 536 (75.37%) changed or added relevant lines in 25 files are covered.
40 unchanged lines in 12 files lost coverage.
Overall coverage increased (+8.1%) to 56.7%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
tapfreighter/wallet.go	14	16	87.5%
server.go	0	8	0.0%
tapchannel/aux_closer.go	0	8	0.0%
tapchannel/aux_funding_controller.go	0	8	0.0%
tapdb/multiverse.go	0	10	0.0%
proof/verifier.go	53	64	82.81%
tapchannel/aux_sweeper.go	0	11	0.0%
tapdb/supply_ignore_checker.go	149	166	89.76%
tapdb/supply_tree.go	77	100	77.0%
monitoring/db_collector.go	0	34	0.0%

Files with Coverage Reduction	New Missed Lines	%
proof/verifier.go	1	86.82%
fn/iter.go	2	62.07%
monitoring/db_collector.go	2	0.0%
tapdb/mssmt.go	2	90.45%
tapdb/multiverse.go	2	79.79%
tapdb/supply_tree.go	2	63.77%
itest/multisig.go	3	97.91%
universe/archive.go	3	79.81%
mssmt/compacted_tree.go	4	79.49%
tapdb/universe.go	4	81.11%

Totals
Change from base Build 16913585335:	8.1%
Covered Lines:	60786
Relevant Lines:	107206

💛 - Coveralls

To better support the actual implementation of the ignore checker, we add a context and also allow returning an error through the use of a fn.Result return type.

To allow a proof to be validated at least partially, we extract all the steps (1 through 7) into its own method, called VerifyProofIntegrity. These steps are all verification steps that can be executed without needing access to the previous asset snapshot (the inputs being spent), which aren't available in some situations. This refactor allows us to make sure a proof is structurally sound (e.g. all Taproot/Tapscript inclusion/exclusion proofs are valid) and the proof isn't being ignored.

To make sure ignored assets can't be sent out in the first place, we add the better proof integrity check that includes the ignore check to the asset wallet.

To make sure we don't always hit the DB when we encounter a new asset point that is _not_ ignored, we add an LRU cache that tracks asset points that are currently _not_ ignored. The cache will be invalidated by the supply verifier that watches the chain for new supply commitment updates and is aware of new potential ignore tuples.

This commit makes the negative lookup LRU cache size configurable by the user.

With this commit we hook up the different caches we have in the multiverse store and the supply ignore checker to the Prometheus metrics collector.

To make sure we don't have old entries in our negative lookup cache, we invalidate the ignore checker's LRU cache as soon as we have written a new supply update to disk.

guggero · 2025-08-13T14:55:23Z

Added the negative LRU cache, hooked up the cache stats to our Prometheus metrics and implemented the cache invalidation.

Roasbeef · 2025-08-15T19:55:46Z

tapdb/supply_tree.go

+// FetchSupplyLeavesByType fetches all supply leaves for a given asset specifier
+// and a specific supply sub-tree.
+func (s *SupplyTreeStore) FetchSupplyLeavesByType(ctx context.Context,
+	spec asset.Specifier, tree supplycommit.SupplySubTree, startHeight,


tree -> treeType ?

Roasbeef · 2025-08-15T19:57:08Z

proof/verifier.go

@@ -45,7 +45,7 @@ type IgnoreChecker interface {
 	// IsIgnored returns true if the given prevID is known to be invalid. A
 	// prevID is used here, but the check should be tested against a proof
 	// result, or produced output.
-	IsIgnored(prevID AssetPoint) bool
+	IsIgnored(ctx context.Context, prevID AssetPoint) lfn.Result[bool]


Roasbeef · 2025-08-15T19:58:11Z

asset/asset.go

+// String returns a human-readable description of the PrevID.
+func (id PrevID) String() string {
+	return fmt.Sprintf("PrevID(outpoint=%s, id=%s, script_key=%x)",
+		id.OutPoint.String(), id.ID.String(), id.ScriptKey.CopyBytes())


CopyBytes() as an alternative to just slicing into the underlying byte slice?

Roasbeef · 2025-08-15T20:00:28Z

tapdb/supply_ignore_checker.go

+// IgnoreCheckerCfg is a configuration struct for the CachingIgnoreChecker.
+type IgnoreCheckerCfg struct {
+	// GroupQuery is used to query asset groups by their asset ID.
+	GroupQuery assetGroupQuery


Hmm, if the config struct itself is publicly exported, then shouldn't the interfaces exported also be?

Roasbeef · 2025-08-15T20:04:56Z

tapdb/supply_ignore_checker.go

+	// group (or 0 if we haven't encountered this group yet).
+	specifier := asset.NewSpecifierFromGroupKey(*groupPubKey)
+	bestHeight := c.bestHeightLookup[groupKey]
+	leaves, err := c.cfg.Store.FetchSupplyLeavesByType(


One alternative here would be doing a more precise query just that that particular ignore point. On the other ahdn wit hthis approach, we do the broad look up once, then just cache it from there on.

Roasbeef · 2025-08-15T20:12:53Z

tapcfg/server.go

+		Store:      supplyTreeStore,
+	})
+
+	var ignoreCheckerIface proof.IgnoreChecker = ignoreChecker


An alternative to adding an explicit type param to the lfn.Some call below?

Roasbeef · 2025-08-15T20:22:14Z

tapfreighter/wallet.go

+				return nil, fmt.Errorf("input proof is nil")
+			}
+
+			_, err := assetProof.VerifyProofIntegrity(ctx, vCtx)


Nice to do additional verification here as well.

Roasbeef · 2025-08-15T20:37:51Z

itest/supply_commit_test.go

+		withError("is ignored"),
+	)
+
+	// TODO(ffranr): The above only tests that the node that issued the


Can make an issue for this 👍

Roasbeef · 2025-08-15T20:46:58Z

tapdb/supply_ignore_checker.go

@@ -3,8 +3,10 @@ package tapdb
 import (
 	"context"
 	"errors"
+	"fmt"


Re the commit message: do we need a supply verifier to invalidate it? Couldn't we just invalidate it selectively when/if an asset in that group is ignored?

Roasbeef · 2025-08-15T20:49:40Z

universe/supplycommit/transitions.go

+		// We know our tree has been updated, so we need to make sure
+		// the negative lookup cache of the ignore checker is flushed
+		// and the new ignore leaves are loaded from disk.
+		env.IgnoreCheckerCache.InvalidateCache()


Couldn't we just selectively invalidate the cache for this particular group key?

Even before that, we can check to see if this batch adds any new ignored assets, only invalidating if so.

levmi assigned guggero Aug 11, 2025

levmi added this to Taproot-Assets Project Board Aug 11, 2025

github-project-automation bot moved this to 🆕 New in Taproot-Assets Project Board Aug 11, 2025

levmi moved this from 🆕 New to 🏗 In progress in Taproot-Assets Project Board Aug 11, 2025

guggero added 11 commits August 13, 2025 14:26

tapdb: add FetchSupplyLeavesByType

1b451d0

proof: add context to verifier, return Result type

bd1fc9a

To better support the actual implementation of the ignore checker, we add a context and also allow returning an error through the use of a fn.Result return type.

tapd: add supply ignore checker

8d41ee7

multi: hook up ignore checker to proof verifier

a8a892c

multi: verify input proofs when signing virtual packets

fa7590e

To make sure ignored assets can't be sent out in the first place, we add the better proof integrity check that includes the ignore check to the asset wallet.

itest: add ignore verifier test case

bc54565

tapcfg+simple-tapd.conf: make cache size configurable

53ea5c7

This commit makes the negative lookup LRU cache size configurable by the user.

multi: collect database cache statistics for Prometheus

b867553

With this commit we hook up the different caches we have in the multiverse store and the supply ignore checker to the Prometheus metrics collector.

tapcfg+universe: invalidate ignore checker cache on supply update

2da4253

To make sure we don't have old entries in our negative lookup cache, we invalidate the ignore checker's LRU cache as soon as we have written a new supply update to disk.

guggero force-pushed the ignore-checker branch from 717b0ef to 2da4253 Compare August 13, 2025 14:53

docs: add release notes

d2a3ed5

guggero marked this pull request as ready for review August 13, 2025 14:54

guggero requested review from Roasbeef and ffranr August 13, 2025 14:55

levmi moved this from 🏗 In progress to 👀 In review in Taproot-Assets Project Board Aug 14, 2025

Roasbeef requested changes Aug 15, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

proof: implement and hook up ignore checker #1716

proof: implement and hook up ignore checker #1716

Uh oh!

guggero commented Aug 8, 2025 •

edited

Loading

Uh oh!

coveralls commented Aug 8, 2025 •

edited

Loading

Uh oh!

guggero commented Aug 13, 2025

Uh oh!

Roasbeef Aug 15, 2025

Uh oh!

Roasbeef Aug 15, 2025

Uh oh!

Roasbeef Aug 15, 2025

Uh oh!

Roasbeef Aug 15, 2025

Uh oh!

Roasbeef Aug 15, 2025

Uh oh!

Roasbeef Aug 15, 2025

Uh oh!

Roasbeef Aug 15, 2025

Uh oh!

Roasbeef Aug 15, 2025

Uh oh!

Roasbeef Aug 15, 2025

Uh oh!

Roasbeef Aug 15, 2025

Uh oh!

Uh oh!

proof: implement and hook up ignore checker #1716

Are you sure you want to change the base?

proof: implement and hook up ignore checker #1716

Uh oh!

Conversation

guggero commented Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 16940968541

Details

💛 - Coveralls

Uh oh!

guggero commented Aug 13, 2025

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

guggero commented Aug 8, 2025 •

edited

Loading

coveralls commented Aug 8, 2025 •

edited

Loading