RPC: Add Ignore Tree Endpoints #1554

ffranr · 2025-05-21T15:02:38Z

Sharing early to get early feedback on naming and architecture. Still missing itests and query RPC endpoint.

This PR will not include the verifier, I will add that in a separate PR.

This PR adds RPC endpoints to populate and query from ignore trees.

This new field will be used to interact with ignore trees from the RPC server.

Add a new column to the asset_seedlings table to store a reference to the universe commitment delegation key. The delegation public key is included in the asset metadata. It can be used to query the internal_keys table to retrieve full key information, including key family and key index.

Adds a method to generate a Schnorr signature over the TLV serialization of an IgnoreTuple.

Introduce a new RPC endpoint to add an asset outpoint to the asset's ignore tree. This allows asset issuers to explicitly exclude certain asset outpoints.

coveralls · 2025-05-21T15:24:03Z

Pull Request Test Coverage Report for Build 15165694648

Details

27 of 360 (7.5%) changed or added relevant lines in 7 files are covered.
49 unchanged lines in 9 files lost coverage.
Overall coverage decreased (-0.2%) to 36.973%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
universe/archive.go	0	7	0.0%
asset/asset.go	0	24	0.0%
tapdb/asset_minting.go	24	49	48.98%
universe/ignore_records.go	0	54	0.0%
rpcutils/marshal.go	0	105	0.0%
rpcserver.go	0	118	0.0%

Files with Coverage Reduction	New Missed Lines	%
commitment/tap.go	2	72.05%
tappsbt/create.go	2	26.74%
asset/asset.go	3	44.45%
tapchannel/aux_leaf_signer.go	3	43.43%
asset/mock.go	4	64.71%
tapdb/universe.go	4	80.4%
tapgarden/caretaker.go	7	68.21%
address/address.go	8	67.47%
address/mock.go	16	86.93%

Totals
Change from base Build 15160950886:	-0.2%
Covered Lines:	26994
Relevant Lines:	73010

💛 - Coveralls

Roasbeef · 2025-05-22T02:31:24Z

universe/archive.go

@@ -24,6 +25,10 @@ type ArchiveConfig struct {
 	// if the identifier has never been seen before.
 	NewBaseTree func(id Identifier) StorageBackend

+	// IgnoreTreeArchive is an archive of all known ignore trees across all
+	// assets.
+	IgnoreTreeArchive IgnoreTreeArchive


FWIW, the I envisioned things originally is that you almost never serve the ignore tree by itself. It's always accompanied with two additional layers of inclusion proofs: first into the mains supply tree, and then the block header proof into the blockchain.

Roasbeef · 2025-05-22T02:32:28Z

universe/archive.go

+//
+// NOTE: Ignore proofs are not included in the multiverse, as they are purely
+// off-chain. Only issuance and transfer proofs are included in the multiverse.
+func (a *Archive) UpsertIgnoreTuples(ctx context.Context,


In the context of the greater system, we wouldn't want to insert ignore tuples directly into the tree. We want to make sure that we're always serving information that's consistent with the latest commitment on chain. Hence the way we stage updates as state transitions in #1508.

Roasbeef · 2025-05-22T02:34:22Z

universe/ignore_records.go

+
+// GenSig generates a Schnorr signature over the IgnoreTuple using the
+// provided SignerClient and key locator.
+func (i *IgnoreTuple) GenSig(ctx context.Context, signer lndclient.SignerClient,


What about instead having a method that accepts the same params, but returns a SIgnedIgnoreTuple?

Roasbeef · 2025-05-22T02:34:55Z

asset/asset.go

@@ -569,6 +606,10 @@ func (id PrevID) Hash() [sha256.Size]byte {
 	return *(*[sha256.Size]byte)(h.Sum(nil))
 }

+// OutPoint is a type alias for an asset outpoint. It links the anchor outpoint
+// to the asset it secures.
+type OutPoint = PrevID


Or AnchorPoint (to be used as asset.AnchorPoint which reads nicely IMO) to not confuse it with a purely on-chain wire.OutPoint?

Roasbeef · 2025-05-22T02:37:12Z

rpcserver.go

+	// Upsert a signed ignore tuple into the ignore tree archive and
+	// get back the authenticated ignore tuples.
+	signedIgnore := universe.NewSignedIgnoreTuple(ignoreTuple, ignoreSig)
+	authIgnoreTuples, err := r.cfg.UniverseArchive.UpsertIgnoreTuples(


Rather than insert directly into the DB, we should call into the supply commit state machine:

taproot-assets/universe/supplycommit/supply_commit_states.go

Lines 96 to 101 in 648cb72

// NewIgnoreEvent signals that a caller wishes to update the ignore portion of

// the supply tree with a new outpoint + script key combo.

type NewIgnoreEvent struct {

universe.SignedIgnoreTuple

}

guggero

Looks pretty good, did a quick first pass.

guggero · 2025-05-22T09:10:34Z

asset/asset.go

@@ -569,6 +606,10 @@ func (id PrevID) Hash() [sha256.Size]byte {
 	return *(*[sha256.Size]byte)(h.Sum(nil))
 }

+// OutPoint is a type alias for an asset outpoint. It links the anchor outpoint
+// to the asset it secures.
+type OutPoint = PrevID


Or AnchorPoint (to be used as asset.AnchorPoint which reads nicely IMO) to not confuse it with a purely on-chain wire.OutPoint?

guggero · 2025-05-22T09:18:58Z

taprpc/taprootassets.proto

+
+        // The 32-byte asset ID encoded as a hex string. Use this field when
+        // interacting via REST.
+        string asset_id_str = 2;


What's the reason for not just using the raw bytes for an asset ID? We don't have the same problem here as we have with TXIDs that the content is reversed in the bytes vs. the human-readable string version.
And if a response has a oneof type, which one will be set?

guggero · 2025-05-22T09:19:56Z

taprpc/taprootassets.proto

+    oneof script_key {
+        // The script key in raw byte form. Use this field when interacting
+        // via gRPC.
+        bytes script_key_bytes = 4;


Same question here: Why do we need both forms? On the CLI it should look the same. But in an itest I'd never easily know which field would actually be set by the RPC server (without looking up the code or calling the RPC).

ffranr added 5 commits May 20, 2025 20:02

tapcfg+universe: add field IgnoreTreeArchive to ArchiveConfig

d689efb

This new field will be used to interact with ignore trees from the RPC server.

universe: add GenSig method to IgnoreTuple

49f92bd

Adds a method to generate a Schnorr signature over the TLV serialization of an IgnoreTuple.

asset: add helper functionality for SerializedKey, asset ID, and PrevID

7144ebe

taprpc: add endpoint IgnoreAssetOutPoint

661466c

Introduce a new RPC endpoint to add an asset outpoint to the asset's ignore tree. This allows asset issuers to explicitly exclude certain asset outpoints.

ffranr requested a review from guggero May 21, 2025 15:02

ffranr self-assigned this May 21, 2025

ffranr changed the title ~~RPC: add ignore tree RPC endpoints~~ RPC: Add Ignore Tree Endpoints May 21, 2025

Roasbeef requested changes May 22, 2025

View reviewed changes

guggero reviewed May 22, 2025

View reviewed changes

levmi added this to Taproot-Assets Project Board May 22, 2025

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

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

RPC: Add Ignore Tree Endpoints #1554

RPC: Add Ignore Tree Endpoints #1554

Uh oh!

ffranr commented May 21, 2025 •

edited

Loading

Uh oh!

coveralls commented May 21, 2025

Uh oh!

Roasbeef May 22, 2025

Uh oh!

Roasbeef May 22, 2025

Uh oh!

Roasbeef May 22, 2025

Uh oh!

Roasbeef May 22, 2025

Uh oh!

guggero May 22, 2025

Uh oh!

Roasbeef May 22, 2025

Uh oh!

guggero left a comment

Uh oh!

guggero May 22, 2025

Uh oh!

guggero May 22, 2025

Uh oh!

guggero May 22, 2025

Uh oh!

Uh oh!


	// NewIgnoreEvent signals that a caller wishes to update the ignore portion of
	// the supply tree with a new outpoint + script key combo.
	type NewIgnoreEvent struct {
	universe.SignedIgnoreTuple
	}

RPC: Add Ignore Tree Endpoints #1554

Are you sure you want to change the base?

RPC: Add Ignore Tree Endpoints #1554

Uh oh!

Conversation

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

Uh oh!

Uh oh!

coveralls commented May 21, 2025

Pull Request Test Coverage Report for Build 15165694648

Details

💛 - Coveralls

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!

guggero left a comment

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!

ffranr commented May 21, 2025 •

edited

Loading