RPC: Add Ignore Tree Endpoints #1554

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

Closes #1534

EDIT: depends on #1655

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.

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

Pull Request Test Coverage Report for Build 16472678428

Details

520 of 1426 (36.47%) changed or added relevant lines in 15 files are covered.
40 unchanged lines in 10 files lost coverage.
Overall coverage decreased (-0.001%) to 56.47%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
asset/asset.go	21	25	84.0%
tapdb/supply_commit.go	26	34	76.47%
rpcutils/marshal.go	20	30	66.67%
universe/ignore_records.go	41	56	73.21%
taprpc/universerpc/universe_grpc.pb.go	55	78	70.51%
taprpc/tapcommon.pb.go	5	49	10.2%
taprpc/universerpc/universe.pb.json.go	0	63	0.0%
cmd/commands/universe.go	0	95	0.0%
rpcserver.go	221	331	66.77%
taprpc/universerpc/universe.pb.gw.go	3	257	1.17%

Files with Coverage Reduction	New Missed Lines	%
taprpc/universerpc/universe_grpc.pb.go	1	65.11%
taprpc/universerpc/universe.pb.gw.go	1	4.97%
tapdb/multiverse.go	2	81.69%
tapdb/sqlc/universe.sql.go	2	75.88%
tapgarden/custodian.go	2	76.17%
asset/asset.go	4	79.82%
tapdb/assets_store.go	5	79.39%
mssmt/compacted_tree.go	6	79.49%
tapfreighter/chain_porter.go	6	81.19%
tapdb/universe.go	11	81.46%

Totals
Change from base Build 16443362480:	-0.001%
Covered Lines:	58643
Relevant Lines:	103848

💛 - Coveralls

universe/archive.go

universe/ignore_records.go

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?

rpcserver.go

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?

taprpc/taprootassets.proto

ffranr · 2025-05-27T22:01:28Z

I've rebased on to branch supply-commit-machine.

Roasbeef

Nice work! Comments mostly related to extra validation or error reporting we can do at the RPC call site.

rpcserver.go

Roasbeef · 2025-07-21T20:50:30Z

rpcserver.go

+
+	// Fetch the full delegation key locator.
+	delegationKey, err := r.cfg.TapAddrBook.FetchInternalKeyLocator(
+		ctx, &delegationPubKey,


So this'll reliably fail if we weren't the ones that actually issued the asset right? Or will signing fail below?

Either way, we should amke thsi check and the related failure explicit.

I've made the endpoint's error message more explicit and extended the integration test to include a case where a non-owner node attempts to create a signed ignore tuple and correctly fails.

Did you forget to push this up maybe? I don't see the addition to the itests.

Here: https://github.com/lightninglabs/taproot-assets/pull/1554/files#diff-0a6ab6eac652089a797c6a8ad1a73fa59bb983d6422044ef62c8b4cd1baa68a8R388-R392

rpcserver.go

taprpc/universerpc/universe.proto

itest/supply_commit_test.go

Roasbeef · 2025-07-21T20:59:42Z

itest/supply_commit_test.go

+		}
+	}
+
+	require.True(t.t, foundCommitTxOut)


Yeah the syncer/verifier isn't hooked up yet.

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

This functionality will be used in the next commit which adds the IgnoreAssetOutPoint RPC endpoint.

taprpc/universerpc/universe.yaml

guggero

Very nice, LGTM 🎉

cmd/commands/universe.go

taprpc/taprootassets.proto

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.

Introduce the UpdateSupplyCommit endpoint to trigger the creation and broadcast of a new on-chain supply commitment transaction for a given asset group. This allows clients to manually update supply commitments as needed.

Modified FetchSupplyCommit to include metadata from the mined Bitcoin block containing the supply commit transaction.

Updated the RootCommitment struct to include metadata from the mined Bitcoin block.

Add FetchSupplyCommit endpoint to retrieve the on-chain supply commitment for a specific asset group. The response includes optional inclusion proofs for any provided leaf keys.

Add CLI commands to: - Ignore an asset outpoint in the supply commitment, - Trigger a manual on-chain update of the supply commitment, - Fetch the current supply commitment state.

Replaced usages of the LeafNode concrete type with the more general Node interface in function signatures where applicable. This adds flexibility which will become useful in a future itest.

Update the sendAssetAndAssert integration test helper to return the RPC response from the SendAsset call. This allows callers to access the full response data for further assertions or processing.

Add integration test to ensure universe supply commitments properly handle ignored asset outpoints. The test confirms that once an outpoint is marked as ignored, it is correctly placed in the ignore subtree of the supply commitment, and that this state is reflected in the mined commitment transaction.

Roasbeef

LGTM 🐈‍⬛

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

ffranr force-pushed the wip/1534-ignore-tree/1534-add-ignoreasset-rpc branch from 661466c to 32da29f Compare May 27, 2025 22:00

ffranr changed the base branch from main to supply-commit-machine May 27, 2025 22:01

ffranr force-pushed the wip/1534-ignore-tree/1534-add-ignoreasset-rpc branch from 32da29f to 6fbc382 Compare June 3, 2025 19:07

Roasbeef force-pushed the supply-commit-machine branch 5 times, most recently from d7efd50 to c2c394f Compare June 12, 2025 01:35

Roasbeef force-pushed the supply-commit-machine branch 11 times, most recently from 37bdcfa to b5a6c5e Compare June 25, 2025 00:27

Roasbeef force-pushed the supply-commit-machine branch from b5a6c5e to c59b408 Compare June 25, 2025 02:00

levmi added this to the v0.7 milestone Jul 21, 2025

levmi added the P0 label Jul 21, 2025

Roasbeef requested changes Jul 21, 2025

View reviewed changes

ffranr force-pushed the wip/1534-ignore-tree/1534-add-ignoreasset-rpc branch from 543c669 to 8654ab9 Compare July 22, 2025 00:19

ffranr changed the base branch from wip/supplycommit/bugfix-state-machine to main July 22, 2025 00:19

ffranr requested a review from guggero July 22, 2025 00:24

ffranr added 3 commits July 22, 2025 14:10

universe: add GenSignedIgnore method to IgnoreTuple

f24b303

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

universe: add unit test for method IgnoreTuple.GenSignedIgnore

7c15ada

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

f968a69

This functionality will be used in the next commit which adds the IgnoreAssetOutPoint RPC endpoint.

ffranr force-pushed the wip/1534-ignore-tree/1534-add-ignoreasset-rpc branch 2 times, most recently from ff1e6db to 2994e96 Compare July 22, 2025 18:51

guggero reviewed Jul 22, 2025

View reviewed changes

taprpc/universerpc/universe.yaml Show resolved Hide resolved

ffranr force-pushed the wip/1534-ignore-tree/1534-add-ignoreasset-rpc branch from 2994e96 to 786df50 Compare July 22, 2025 20:54

ffranr requested review from guggero and Roasbeef July 22, 2025 21:47

guggero approved these changes Jul 23, 2025

View reviewed changes

cmd/commands/universe.go Show resolved Hide resolved

taprpc/taprootassets.proto Outdated Show resolved Hide resolved

ffranr added 9 commits July 23, 2025 14:43

taprpc: add endpoint IgnoreAssetOutPoint

7afb140

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.

taprpc: add endpoint UpdateSupplyCommit

9066338

Introduce the UpdateSupplyCommit endpoint to trigger the creation and broadcast of a new on-chain supply commitment transaction for a given asset group. This allows clients to manually update supply commitments as needed.

sqlc: extend FetchSupplyCommit to return mined block metadata

a7366fb

Modified FetchSupplyCommit to include metadata from the mined Bitcoin block containing the supply commit transaction.

supplycommit+tapdb: populate block metadata in RootCommitment struct

66348ac

Updated the RootCommitment struct to include metadata from the mined Bitcoin block.

taprpc: add endpoint FetchSupplyCommit

bf8e101

Add FetchSupplyCommit endpoint to retrieve the on-chain supply commitment for a specific asset group. The response includes optional inclusion proofs for any provided leaf keys.

cmd: add supply commit ignore, update, and fetch commands

1f576a2

Add CLI commands to: - Ignore an asset outpoint in the supply commitment, - Trigger a manual on-chain update of the supply commitment, - Fetch the current supply commitment state.

mssmt: use Node interface instead of LeafNode concrete type in func sigs

5a23f0a

Replaced usages of the LeafNode concrete type with the more general Node interface in function signatures where applicable. This adds flexibility which will become useful in a future itest.

itest: return RPC response from SendAsset in sendAssetAndAssert

1d0a85d

Update the sendAssetAndAssert integration test helper to return the RPC response from the SendAsset call. This allows callers to access the full response data for further assertions or processing.

ffranr force-pushed the wip/1534-ignore-tree/1534-add-ignoreasset-rpc branch from 786df50 to 1fdd9da Compare July 23, 2025 13:54

Roasbeef approved these changes Jul 23, 2025

View reviewed changes

Roasbeef merged commit b33cb3c into main Jul 23, 2025
17 of 18 checks passed

github-project-automation bot moved this from 👀 In review to ✅ Done in Taproot-Assets Project Board Jul 23, 2025

guggero deleted the wip/1534-ignore-tree/1534-add-ignoreasset-rpc branch July 24, 2025 06:08

RPC: Add Ignore Tree Endpoints #1554

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 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 16472678428

Details

💛 - Coveralls

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

guggero left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ffranr commented May 27, 2025

Uh oh!

Roasbeef 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

guggero left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Roasbeef left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ffranr commented May 21, 2025 •

edited

Loading

coveralls commented May 21, 2025 •

edited

Loading