RPC: Add Ignore Tree Endpoints #1554

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

Closes #1534

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 16072230475

Details

180 of 923 (19.5%) changed or added relevant lines in 20 files are covered.
24 unchanged lines in 10 files lost coverage.
Overall coverage decreased (-0.2%) to 39.039%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
tapdb/supply_commit.go	8	10	80.0%
log.go	0	4	0.0%
server.go	0	4	0.0%
universe/supplycommit/env.go	17	21	80.95%
universe/supplycommit/log.go	0	6	0.0%
wallet_anchor.go	0	12	0.0%
tapdb/asset_minting.go	70	85	82.35%
itest/utils.go	0	17	0.0%
asset/asset.go	0	24	0.0%
rpcutils/marshal.go	0	30	0.0%

Files with Coverage Reduction	New Missed Lines	%
tapdb/supply_commit.go	1	69.81%
asset/group_key.go	2	62.64%
rpcserver.go	2	0.0%
tapgarden/caretaker.go	2	68.0%
tappsbt/create.go	2	26.74%
universe/supplycommit/env.go	2	93.02%
universe/supplycommit/transitions.go	2	77.79%
tapchannel/aux_leaf_signer.go	3	43.43%
commitment/tap.go	4	71.59%
tapfreighter/interface.go	4	48.0%

Totals
Change from base Build 16059643780:	-0.2%
Covered Lines:	30822
Relevant Lines:	78952

💛 - 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.

ffranr · 2025-07-02T16:14:54Z

Current status

Introduced required changes to LND; PR opened at chainntnfs: export NotifierOptions and internal field for interface use lightningnetwork/lnd#10028.
Successfully published a supply-commitment transaction, but still need to verify that it commits to the intended state.

Remaining work before we can merge this PR

Merge chainntnfs: export NotifierOptions and internal field for interface use lightningnetwork/lnd#10028 and bump the LND dependency in tapd.
DONE: ~~Populate ErrorReporter in protofsm.StateMachineCfg (see TODO).~~
DONE: ~~Replace the InternalKey field in oldCommitment (within newRootCommitment) with the full KeyDescriptor so we can spend old commitments (we can already spend pre-commitments in this PR).~~

Add `DeriveNextKey` method to `LndRpcWalletAnchor`, enabling it to satisfy the `supplycommit.Wallet` interface.

Add context argument to `SupplyTreeView` interface methods to allow `tapdb.SupplyTreeStore` to satisfy the interface.

Introduces `DefaultCommitConfTarget`, a constant for the default confirmation target (in blocks) for a supply commitment transaction. This constant provides a sensible default for fee estimation, ensuring that the commitment transaction is confirmed in a timely manner without overpaying. Centralizing this value makes it easier to manage and adjust in the future.

The state machine that curates a supply commit transaction is specific to an asset group key. To manage multiple such state machines across asset groups at the RPC layer, introduce the MultiStateMachineManager. The manager caches separate state machines for each asset group.

Populate the SupplyCommitManager field in the config so that the rpcserver can invoke methods on the supply commitment manager.

Allows deriving a supply commit TxOut without specifying all RootCommitment fields.

Refactor newRootCommitment to ensure the commit transaction is fully defined before it is set as a field in RootCommitment.

This allows derivation of PSBT BIP32 paths for a keychain.KeyDescriptor using network-specific parameters. The new field is unread in this commit but will be used later.

chain_bridge.go now contains multiple Lightning clients: invoices, transport, and router. The new name lnd_services.go reflects this richer scope and improves discoverability.

ffranr · 2025-07-03T22:15:46Z

I'm going to split this PR into smaller PRs. Here's the first: #1638

* Bump lnd to latest master commit. * Point lnd/sqldb to same commit for local replace compatibility. * Fix taprootassets.Server implementation to satisfy upgraded htlcswitch.AuxTrafficShaper. We bump LND here because the next commit requires access to chainntnfs.DefaultNotifierOptions and similar functionality that is currently private.

Introduce LndFsmDaemonAdapters, a struct implementing the protofsm.DaemonAdapters interface. This is passed into supplycommit.NewMultiStateMachineManager, which then propagates it to each asset group-specific state machine.

Update the FetchUnspentPrecommits SQL query to retrieve the full internal key descriptor for pre-commitment outputs. This enables BIP32 derivation when spending these outputs.

SignAndFinalizePsbt can't currently handle tapd family keys.

FetchSupplyCommit now returns the full key descriptor for the internal key. RootCommitment struct now includes the full internal key descriptor instead of just the public key. This enables specifying BIP32 derivations when spending supply commitment transactions during the creation of a new supply commitment transaction. And also specifying BIP32 derivations in PSBT outputs, and so on.

Add PSBT output with BIP32 derivation. This makes use of the full internal key descriptor that we made available in the previous commit.

When creating a supply commitment transaction, there are two types of inputs that can be spent: * Pre-commitment outputs from mint anchor transactions * Outputs from previous supply commitment transactions This commit adds support for a PSBT input to handle the latter case, allowing spending of a previous supply commitment transaction output.

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.

Refactored handleEvents by extracting the handleSubEventChan function. handleSubEventChan now accepts an event channel directly. The original handleEvents function delegates to handleSubEventChan.

This introduces a new RPC endpoint, `SubscribeSupplyCommitEvents`, allowing clients to stream event notifications from the supply commitment state machine. Subscribing to these events is beneficial for real-time monitoring, testing, and debugging of the supply commitment process. For example, it enables developers to trace the lifecycle of a commitment and diagnose issues without relying solely on logs.

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

ffranr force-pushed the wip/1534-ignore-tree/1534-add-ignoreasset-rpc branch 2 times, most recently from 71fcd9f to 4c23905 Compare July 3, 2025 21:41

ffranr added 9 commits July 3, 2025 22:48

wallet: add method LndRpcWalletAnchor.DeriveNextKey()

53ff347

Add `DeriveNextKey` method to `LndRpcWalletAnchor`, enabling it to satisfy the `supplycommit.Wallet` interface.

supplycommit: add context arg to SupplyTreeView interface methods

3324f1b

Add context argument to `SupplyTreeView` interface methods to allow `tapdb.SupplyTreeStore` to satisfy the interface.

tapcfg: add SupplyCommitManager field to config for RPC access

0a61abb

Populate the SupplyCommitManager field in the config so that the rpcserver can invoke methods on the supply commitment manager.

supplycommit: extract rootCommitTxOut from RootCommitment.TxOut

fc60888

Allows deriving a supply commit TxOut without specifying all RootCommitment fields.

supplycommit: define commit tx before setting it in RootCommitment

a989199

Refactor newRootCommitment to ensure the commit transaction is fully defined before it is set as a field in RootCommitment.

supplycommit: add ChainParams to supply commit state machine env

3ccfcc7

This allows derivation of PSBT BIP32 paths for a keychain.KeyDescriptor using network-specific parameters. The new field is unread in this commit but will be used later.

rename chain_bridge.go to lnd_services.go for clarity

71eeb59

chain_bridge.go now contains multiple Lightning clients: invoices, transport, and router. The new name lnd_services.go reflects this richer scope and improves discoverability.

ffranr added 16 commits July 4, 2025 11:48

multi: add LndFsmDaemonAdapters for state machine manager

75683e3

Introduce LndFsmDaemonAdapters, a struct implementing the protofsm.DaemonAdapters interface. This is passed into supplycommit.NewMultiStateMachineManager, which then propagates it to each asset group-specific state machine.

supplycommit: add logging support

551274f

supplycommit: add basic asset group state machine error reporter

17eca64

supplycommit+tapdb: fetch full key descriptor for unspent pre-commit out

0d2f5f9

Update the FetchUnspentPrecommits SQL query to retrieve the full internal key descriptor for pre-commitment outputs. This enables BIP32 derivation when spending these outputs.

supplycommit: formulate new root commitment PSBT with signing fields

c097e68

supplycommit: sign PSBT with SignPsbt instead of SignAndFinalizePsbt

dcd00cf

SignAndFinalizePsbt can't currently handle tapd family keys.

supplycommit: add output to supply commit PSBT

afd6e2e

Add PSBT output with BIP32 derivation. This makes use of the full internal key descriptor that we made available in the previous commit.

universe: add GenSignedIgnore method to IgnoreTuple

d9184ef

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

5e3d380

taprpc: add endpoint IgnoreAssetOutPoint

7cd9433

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.

rpcserver: extract handleSubEventChan from handleEvents

61fbe48

Refactored handleEvents by extracting the handleSubEventChan function. handleSubEventChan now accepts an event channel directly. The original handleEvents function delegates to handleSubEventChan.

WIP: add RPC UpdateSupplyCommit and itest

0ed7096

ffranr force-pushed the wip/1534-ignore-tree/1534-add-ignoreasset-rpc branch from 4c23905 to 0ed7096 Compare July 4, 2025 10:59

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 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Roasbeef May 22, 2025

Uh oh!

guggero May 22, 2025

Uh oh!

Uh oh!

guggero left a comment

Uh oh!

guggero May 22, 2025

Uh oh!

Uh oh!

Uh oh!

ffranr commented May 27, 2025

Uh oh!

ffranr commented Jul 2, 2025 •

edited

Loading

Uh oh!

ffranr commented Jul 3, 2025

Uh oh!

Uh oh!

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

Uh oh!

Pull Request Test Coverage Report for Build 16072230475

Details

💛 - Coveralls

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Roasbeef May 22, 2025

Choose a reason for hiding this comment

Uh oh!

guggero May 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

guggero left a comment

Choose a reason for hiding this comment

Uh oh!

guggero May 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ffranr commented May 27, 2025

Uh oh!

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

Uh oh!

Uh oh!

ffranr commented Jul 3, 2025

Uh oh!

Uh oh!

ffranr commented May 21, 2025 •

edited

Loading

coveralls commented May 21, 2025 •

edited

Loading

ffranr commented Jul 2, 2025 •

edited

Loading