Merge pull request #904 from lightninglabs/rfq-poc-modifications

RFQ modifications derived from the tap channels proof-of-concept

Author: guggero

cmd/tapd/main.go

@@ -8,6 +8,7 @@ import (
 
 	"github.com/jessevdk/go-flags"
 	"github.com/lightninglabs/taproot-assets/fn"
+	"github.com/lightninglabs/taproot-assets/rfq"
 	"github.com/lightninglabs/taproot-assets/tapcfg"
 	"github.com/lightningnetwork/lnd/signal"
 )
@@ -66,8 +67,15 @@ func main() {
 	errQueue.Start()
 	defer errQueue.Stop()
 
+	// Use a no-op SCID alias manager temporarily. This will be replaced
+	// with a real SCID alias manager when the server configuration is
+	// generated. Passing in the manager at this point facilitates mocking
+	// in tests.
+	scidAliasManager := fn.None[rfq.ScidAliasManager]()
+
 	server, err := tapcfg.CreateServerFromConfig(
-		cfg, cfgLogger, shutdownInterceptor, errQueue.ChanIn(),
+		cfg, cfgLogger, scidAliasManager, shutdownInterceptor,
+		errQueue.ChanIn(),
 	)
 	if err != nil {
 		err := fmt.Errorf("error creating server: %w", err)

go.mod

@@ -28,12 +28,13 @@ require (
 	github.com/lib/pq v1.10.9
 	github.com/lightninglabs/aperture v0.1.21-beta.0.20230705004936-87bb996a4030
 	github.com/lightninglabs/lightning-node-connect/hashmailrpc v1.0.2
-	github.com/lightninglabs/lndclient v1.0.1-0.20240301093332-e39221e5a641
+	github.com/lightninglabs/lndclient v1.0.1-0.20240517142031-cd497ef62933
 	github.com/lightninglabs/neutrino/cache v1.1.2
-	github.com/lightningnetwork/lnd v0.17.0-beta.rc6.0.20240423171224-7fb233326eec
+	github.com/lightningnetwork/lnd v0.17.0-beta.rc6.0.20240514180557-7953d67dbc28
 	github.com/lightningnetwork/lnd/cert v1.2.2
 	github.com/lightningnetwork/lnd/clock v1.1.1
-	github.com/lightningnetwork/lnd/tlv v1.2.3
+	github.com/lightningnetwork/lnd/fn v1.0.5
+	github.com/lightningnetwork/lnd/tlv v1.2.6
 	github.com/lightningnetwork/lnd/tor v1.1.2
 	github.com/ory/dockertest/v3 v3.10.0
 	github.com/prometheus/client_golang v1.14.0
@@ -121,7 +122,6 @@ require (
 	github.com/lightninglabs/lightning-node-connect v0.2.5-alpha // indirect
 	github.com/lightninglabs/neutrino v0.16.0 // indirect
 	github.com/lightningnetwork/lightning-onion v1.2.1-0.20230823005744-06182b1d7d2f // indirect
-	github.com/lightningnetwork/lnd/fn v1.0.5 // indirect
 	github.com/lightningnetwork/lnd/healthcheck v1.2.4 // indirect
 	github.com/lightningnetwork/lnd/kvdb v1.4.6 // indirect
 	github.com/lightningnetwork/lnd/queue v1.1.1 // indirect

go.sum

@@ -477,8 +477,8 @@ github.com/lightninglabs/lightning-node-connect v0.2.5-alpha h1:ZRVChwczFXK0CEbx
 github.com/lightninglabs/lightning-node-connect v0.2.5-alpha/go.mod h1:A9Pof9fETkH+F67BnOmrBDThPKstqp73wlImWOZvTXQ=
 github.com/lightninglabs/lightning-node-connect/hashmailrpc v1.0.2 h1:Er1miPZD2XZwcfE4xoS5AILqP1mj7kqnhbBSxW9BDxY=
 github.com/lightninglabs/lightning-node-connect/hashmailrpc v1.0.2/go.mod h1:antQGRDRJiuyQF6l+k6NECCSImgCpwaZapATth2Chv4=
-github.com/lightninglabs/lndclient v1.0.1-0.20240301093332-e39221e5a641 h1:gOzlAcE1EL8prHCISjDpFD1tvb9HDxtLEdTVD+ebuc0=
-github.com/lightninglabs/lndclient v1.0.1-0.20240301093332-e39221e5a641/go.mod h1:FuD4SXEL3t4J5bu04O+N+k4UcPjsUvGAaT9csWfovbw=
+github.com/lightninglabs/lndclient v1.0.1-0.20240517142031-cd497ef62933 h1:lI2pgYoCxvADkf3T5zqBogjiUNo3sdWZgQOnxDDcUVg=
+github.com/lightninglabs/lndclient v1.0.1-0.20240517142031-cd497ef62933/go.mod h1:BfM5v3NkYq+RaZuEmTgffsHIqBBHn1szarWj6th75oM=
 github.com/lightninglabs/neutrino v0.16.0 h1:YNTQG32fPR/Zg0vvJVI65OBH8l3U18LSXXtX91hx0q0=
 github.com/lightninglabs/neutrino v0.16.0/go.mod h1:x3OmY2wsA18+Kc3TSV2QpSUewOCiscw2mKpXgZv2kZk=
 github.com/lightninglabs/neutrino/cache v1.1.2 h1:C9DY/DAPaPxbFC+xNNEI/z1SJY9GS3shmlu5hIQ798g=
@@ -487,8 +487,8 @@ github.com/lightninglabs/protobuf-go-hex-display v1.30.0-hex-display h1:pRdza2wl
 github.com/lightninglabs/protobuf-go-hex-display v1.30.0-hex-display/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
 github.com/lightningnetwork/lightning-onion v1.2.1-0.20230823005744-06182b1d7d2f h1:Pua7+5TcFEJXIIZ1I2YAUapmbcttmLj4TTi786bIi3s=
 github.com/lightningnetwork/lightning-onion v1.2.1-0.20230823005744-06182b1d7d2f/go.mod h1:c0kvRShutpj3l6B9WtTsNTBUtjSmjZXbJd9ZBRQOSKI=
-github.com/lightningnetwork/lnd v0.17.0-beta.rc6.0.20240423171224-7fb233326eec h1:nLB831P63UL5syyBF6N+tiM5fe0kyy0quppIMazFl04=
-github.com/lightningnetwork/lnd v0.17.0-beta.rc6.0.20240423171224-7fb233326eec/go.mod h1:ScU5uVqH+KgPHquZZMCJO5RHVfMMnreLk0t89L4TfD4=
+github.com/lightningnetwork/lnd v0.17.0-beta.rc6.0.20240514180557-7953d67dbc28 h1:vS+pP+VAqTXeOElI0kFbzZgR07SLo1Wzh6ECcAa6z1Y=
+github.com/lightningnetwork/lnd v0.17.0-beta.rc6.0.20240514180557-7953d67dbc28/go.mod h1:ScU5uVqH+KgPHquZZMCJO5RHVfMMnreLk0t89L4TfD4=
 github.com/lightningnetwork/lnd/cert v1.2.2 h1:71YK6hogeJtxSxw2teq3eGeuy4rHGKcFf0d0Uy4qBjI=
 github.com/lightningnetwork/lnd/cert v1.2.2/go.mod h1:jQmFn/Ez4zhDgq2hnYSw8r35bqGVxViXhX6Cd7HXM6U=
 github.com/lightningnetwork/lnd/clock v1.1.1 h1:OfR3/zcJd2RhH0RU+zX/77c0ZiOnIMsDIBjgjWdZgA0=
@@ -505,8 +505,8 @@ github.com/lightningnetwork/lnd/sqldb v1.0.1 h1:lpNoJ6qRh3D02oeIUsKQLZUzjcgZ9ppM
 github.com/lightningnetwork/lnd/sqldb v1.0.1/go.mod h1:nSovU1U+gTPDWhfwmXu/kW8l8EJpwbvZQ05ijnkQzkA=
 github.com/lightningnetwork/lnd/ticker v1.1.1 h1:J/b6N2hibFtC7JLV77ULQp++QLtCwT6ijJlbdiZFbSM=
 github.com/lightningnetwork/lnd/ticker v1.1.1/go.mod h1:waPTRAAcwtu7Ji3+3k+u/xH5GHovTsCoSVpho0KDvdA=
-github.com/lightningnetwork/lnd/tlv v1.2.3 h1:If5ibokA/UoCBGuCKaY6Vn2SJU0l9uAbehCnhTZjEP8=
-github.com/lightningnetwork/lnd/tlv v1.2.3/go.mod h1:zDkmqxOczP6LaLTvSFDQ1SJUfHcQRCMKFj93dn3eMB8=
+github.com/lightningnetwork/lnd/tlv v1.2.6 h1:icvQG2yDr6k3ZuZzfRdG3EJp6pHurcuh3R6dg0gv/Mw=
+github.com/lightningnetwork/lnd/tlv v1.2.6/go.mod h1:/CmY4VbItpOldksocmGT4lxiJqRP9oLxwSZOda2kzNQ=
 github.com/lightningnetwork/lnd/tor v1.1.2 h1:3zv9z/EivNFaMF89v3ciBjCS7kvCj4ZFG7XvD2Qq0/k=
 github.com/lightningnetwork/lnd/tor v1.1.2/go.mod h1:j7T9uJ2NLMaHwE7GiBGnpYLn4f7NRoTM6qj+ul6/ycA=
 github.com/ltcsuite/ltcd v0.0.0-20190101042124-f37f8bf35796 h1:sjOGyegMIhvgfq5oaue6Td+hxZuf3tDC8lAPrFldqFw=

itest/mock.go

@@ -0,0 +1,27 @@
+package itest
+
+import (
+	"github.com/lightninglabs/taproot-assets/rfq"
+	"github.com/lightningnetwork/lnd/lnwire"
+)
+
+// MockAliasManager is a mock implementation of the AliasManager interface.
+type MockAliasManager struct {
+}
+
+// AddLocalAlias is a mock implementation of the AliasManager interface.
+func (m *MockAliasManager) AddLocalAlias(_ lnwire.ShortChannelID,
+	_ lnwire.ShortChannelID, _ bool, _ bool) error {
+
+	return nil
+}
+
+// DeleteLocalAlias is a mock implementation of the AliasManager interface.
+func (m *MockAliasManager) DeleteLocalAlias(_ lnwire.ShortChannelID,
+	_ lnwire.ShortChannelID) error {
+
+	return nil
+}
+
+// Ensure MockAliasManager implements the AliasAdder interface.
+var _ rfq.ScidAliasManager = (*MockAliasManager)(nil)

itest/rfq_test.go

@@ -74,9 +74,10 @@ func testRfqAssetBuyHtlcIntercept(t *harnessTest) {
 	require.NoError(t.t, err)
 
 	// Carol sends a buy order to Bob for some amount of the newly minted
-	// asset.
-	purchaseAssetAmt := uint64(200)
-	bidAmt := uint64(42000)
+	// asset. These quantities were selected to work with the price oracle
+	// mock.
+	purchaseAssetAmt := uint64(5)
+	bidAmt := uint64(90000)
 	buyOrderExpiry := uint64(time.Now().Add(24 * time.Hour).Unix())
 
 	_, err = ts.CarolTapd.AddAssetBuyOrder(
@@ -95,6 +96,8 @@ func testRfqAssetBuyHtlcIntercept(t *harnessTest) {
 			// node to send a request for quote message to Bob's
 			// node.
 			PeerPubKey: ts.BobLnd.PubKey[:],
+
+			TimeoutSeconds: 5,
 		},
 	)
 	require.NoError(t.t, err, "unable to upsert asset buy order")
@@ -333,7 +336,8 @@ func testRfqAssetSellHtlcIntercept(t *harnessTest) {
 		aliceBobHop.CustomRecords = make(map[uint64][]byte)
 	}
 
-	aliceBobHop.CustomRecords[rfq.LnCustomRecordType] =
+	var htlcRfqIDTlvType rfq.HtlcRfqIDTlvType
+	aliceBobHop.CustomRecords[uint64(htlcRfqIDTlvType.TypeVal())] =
 		acceptedQuote.Id[:]
 
 	// Update the route with the modified first hop.

itest/tapd_harness.go

@@ -15,7 +15,9 @@ import (
 
 	"github.com/btcsuite/btcd/chaincfg"
 	tap "github.com/lightninglabs/taproot-assets"
+	"github.com/lightninglabs/taproot-assets/fn"
 	"github.com/lightninglabs/taproot-assets/proof"
+	"github.com/lightninglabs/taproot-assets/rfq"
 	"github.com/lightninglabs/taproot-assets/tapcfg"
 	"github.com/lightninglabs/taproot-assets/tapdb"
 	"github.com/lightninglabs/taproot-assets/taprpc"
@@ -290,11 +292,21 @@ func (hs *tapdHarness) start(expectErrExit bool) error {
 	cfgLogger := hs.ht.logWriter.GenSubLogger("CONF", func() {})
 
 	var (
+		// mockScidAliasManager is a mock implementation of the SCID
+		// alias manager. The SCID alias manager is responsible for
+		// registering SCID aliases with LND and mapping them to their
+		// corresponding real channel SCIDs.
+		mockScidAliasManager = fn.Some[rfq.ScidAliasManager](
+			&MockAliasManager{},
+		)
+
 		err         error
 		mainErrChan = make(chan error, 10)
 	)
+
 	hs.server, err = tapcfg.CreateServerFromConfig(
-		hs.clientCfg, cfgLogger, hs.ht.interceptor, mainErrChan,
+		hs.clientCfg, cfgLogger, mockScidAliasManager,
+		hs.ht.interceptor, mainErrChan,
 	)
 	if err != nil {
 		return fmt.Errorf("could not create tapd server: %w", err)

itest/test_list_on_test.go

@@ -255,10 +255,14 @@ var testCases = []*testCase{
 		name: "rfq asset buy htlc intercept",
 		test: testRfqAssetBuyHtlcIntercept,
 	},
-	{
-		name: "rfq asset sell htlc intercept",
-		test: testRfqAssetSellHtlcIntercept,
-	},
+
+	// TODO(ffranr): Re-enable this test once we have a way to set the
+	//  `WireCustomRecords` field in the first hop `UpdateAddHtlc` p2p
+	//  message
+	//{
+	//	name: "rfq asset sell htlc intercept",
+	//	test: testRfqAssetSellHtlcIntercept,
+	//},
 
 	{
 		name: "multi signature on all levels",

rfq/custom_channel_data.go

@@ -0,0 +1,46 @@
+package rfq
+
+// TODO(guggero): De-duplicate by putting into same shared package as the other
+//  custom channel data structs.
+
+// JsonAssetBalance is a struct that represents the balance of a single asset ID
+// within a channel.
+type JsonAssetBalance struct {
+	AssetID       string `json:"asset_id"`
+	Name          string `json:"name"`
+	LocalBalance  uint64 `json:"local_balance"`
+	RemoteBalance uint64 `json:"remote_balance"`
+}
+
+// JsonAssetGenesis is a struct that represents the genesis information of an
+// asset.
+type JsonAssetGenesis struct {
+	GenesisPoint string `json:"genesis_point"`
+	Name         string `json:"name"`
+	MetaHash     string `json:"meta_hash"`
+	AssetID      string `json:"asset_id"`
+}
+
+// JsonAssetUtxo is a struct that represents the UTXO information of an asset
+// within a channel.
+type JsonAssetUtxo struct {
+	Version      int64            `json:"version"`
+	AssetGenesis JsonAssetGenesis `json:"asset_genesis"`
+	Amount       uint64           `json:"amount"`
+	ScriptKey    string           `json:"script_key"`
+}
+
+// JsonAssetChanInfo is a struct that represents the channel information of a
+// single asset within a channel.
+type JsonAssetChanInfo struct {
+	AssetInfo     JsonAssetUtxo `json:"asset_utxo"`
+	Capacity      uint64        `json:"capacity"`
+	LocalBalance  uint64        `json:"local_balance"`
+	RemoteBalance uint64        `json:"remote_balance"`
+}
+
+// JsonAssetChannel is a struct that represents the channel information of all
+// assets within a channel.
+type JsonAssetChannel struct {
+	Assets []JsonAssetChanInfo `json:"assets"`
+}